PrometheusHandler

ditto

import ocean.net.http.HttpConnectionHandler;
class PrometheusHandler
class PrometheusHandler : HttpConnectionHandler {
class EpollSelectDispatcher via import ocean.io.select.EpollSelectDispatcher : EpollSelectDispatcher;;
class HttpRequest via import ocean.net.http.HttpRequest : HttpRequest;;
enum HttpResponseCode via import ocean.net.http.HttpConst : HttpResponseCode;;
enum HttpMethod via import ocean.net.http.consts.HttpMethod : HttpMethod;;
bool sformat(FormatterSink sink, cstring fmt, Args args) via import ocean.text.convert.Formatter : sformat;;
import ocean.meta.types.Qualifiers;;
class Logger via import ocean.util.log.Logger : Logger, Log;;
struct Log via import ocean.util.log.Logger : Logger, Log;;
class CollectorRegistry via import ocean.util.prometheus.collector.CollectorRegistry : CollectorRegistry;;
this(FinalizeDg finalizer, CollectorRegistry collector_registry, EpollSelectDispatcher epoll, size_t stack_size);
HttpResponseCode handleRequest(cstring response_msg_body);
void notifyIOException(ErrnoException e, bool is_error);
}

Constructors

this this(FinalizeDg finalizer, CollectorRegistry collector_registry, EpollSelectDispatcher epoll, size_t stack_size): Constructor.

Members

Functions

handleRequest HttpResponseCode handleRequest(cstring response_msg_body): Handles responses for incoming HTTP requests. Responds with stats when the request endpoint is /metrics. For all other endpoints, returns HttpResponseCode.NotImplemented. If stat collection throws an error, responds with HttpResponseCode.InternalServerError, with the exception message as the response message body;
notifyIOException void notifyIOException(ErrnoException e, bool is_error): Logs an warning or error message when an IOWarning or IOError, respectively, is caught.

Inherited Members

From HttpConnectionHandler

HttpResponseCode alias HttpResponseCode = .HttpResponseCode: Type aliases as convenience for a subclass
HttpRequest alias HttpRequest = .HttpRequest: Undocumented in source.
HttpResponse alias HttpResponse = .HttpResponse: Undocumented in source.
HttpMethod alias HttpMethod = .HttpMethod: Undocumented in source.
HttpException alias HttpException = .HttpException: Undocumented in source.
HttpServerException alias HttpServerException = .HttpServerException: Undocumented in source.
ErrnoException alias ErrnoException = .ErrnoException: Undocumented in source.
IOError alias IOError = .IFiberSelectProtocol.IOError: Undocumented in source.
IOWarning alias IOWarning = .IFiberSelectProtocol.IOWarning: Undocumented in source.
request HttpRequest request;: HTTP request message parser and response message generator
response HttpResponse response;: Undocumented in source.
http_exception HttpException http_exception;: Reused exception instance; may be thrown by a subclass as well.
keep_alive_maxnum uint keep_alive_maxnum;: Maximum number of requests through the same connection when using persistent connections; 0 disables using persistent connections.
default_exception_status_code auto default_exception_status_code;: Status code for the case when a required message header parameters are missing.
handle void handle(): Connection handler method.
reset void reset(): Resettable interface method; resets the request.
handleRequest HttpResponseCode handleRequest(cstring response_msg_body): Handles the request.
onResponseSent void onResponseSent(): Called after handleRequest() has returned and when the response message buffer is no longer referenced or after handleRequest() has thrown an exception. A subclass may override this method to release resources. This is useful especially when a large number of persistent connections is open where each connection is only used sporadically.
request_msg_body_length size_t request_msg_body_length(): Tells the request message body length. This method should be overridden when a request message body is expected. It is invoked when the message header is completely parsed. The default behaviour is expecting no request message body.
handleHttpServerException bool handleHttpServerException(HttpServerException e): Handles HTTP server exception e which was thrown while parsing the request message or from handleRequest() or request_msg_body_length() and is not a HttpException. A subclass may override this method to be notified when an exception is thrown and decide whether the connection may stay persistent or should be closed after the response has been sent. The default behaviour is allowing the connection to stay persistent.
handleHttpException bool handleHttpException(HttpException e): Handles HTTP exception e which was thrown while parsing the request message or from handleRequest() or request_msg_body_length(). A subclass may override this method to be notified when an exception is thrown and decide whether the connection may stay persistent or should be closed after the response has been sent. The default behaviour is allowing the connection being persistent unless the status code indicated by the exception is 413: "Request Entity Too Large".
notifyIOException void notifyIOException(ErrnoException e, bool is_error): Called when an IOWarning or IOError is caught. May be overridden by a subclass to be notified.

PrometheusHandler

Constructors

Members

Functions

Inherited Members

From HttpConnectionHandler

Meta

Source