public class VertxPrometheusOptions extends Object
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_EMBEDDED_SERVER_ENDPOINT
The default metrics endpoint = /metrics when using an embedded server.
|
static boolean |
DEFAULT_ENABLED
Default value for enabled = false.
|
static boolean |
DEFAULT_PUBLISH_QUANTILES
Default value for publishing histogram quantiles = false.
|
static boolean |
DEFAULT_START_EMBEDDED_SERVER
Default value for starting an embedded server = false.
|
Constructor and Description |
---|
VertxPrometheusOptions()
Default constructor
|
VertxPrometheusOptions(JsonObject json)
Create an instance from a
JsonObject |
VertxPrometheusOptions(VertxPrometheusOptions other)
Copy constructor
|
Modifier and Type | Method and Description |
---|---|
String |
getEmbeddedServerEndpoint()
Get the HTTP endpoint used if an embedded server is configured
|
HttpServerOptions |
getEmbeddedServerOptions()
Get the HTTP server options of the embedded server, if any
|
boolean |
isEnabled()
Will Prometheus reporting be enabled?
|
boolean |
isPublishQuantiles() |
boolean |
isStartEmbeddedServer()
Returns true if it is configured to init an embedded web server to expose Prometheus metrics
|
VertxPrometheusOptions |
setEmbeddedServerEndpoint(String embeddedServerEndpoint)
Set metrics endpoint.
|
VertxPrometheusOptions |
setEmbeddedServerOptions(HttpServerOptions embeddedServerOptions)
HTTP server options for the embedded server
|
VertxPrometheusOptions |
setEnabled(boolean enabled)
Set true to enable Prometheus reporting
|
VertxPrometheusOptions |
setPublishQuantiles(boolean publishQuantiles)
Set true to publish histogram stats, necessary to compute quantiles.
|
VertxPrometheusOptions |
setStartEmbeddedServer(boolean startEmbeddedServer)
When true, an embedded server will init to expose metrics with Prometheus format.
|
JsonObject |
toJson() |
public static final boolean DEFAULT_ENABLED
public static final boolean DEFAULT_START_EMBEDDED_SERVER
public static final String DEFAULT_EMBEDDED_SERVER_ENDPOINT
public static final boolean DEFAULT_PUBLISH_QUANTILES
public VertxPrometheusOptions()
public VertxPrometheusOptions(VertxPrometheusOptions other)
other
- The other VertxPrometheusOptions
to copy when creating thispublic VertxPrometheusOptions(JsonObject json)
JsonObject
json
- the JsonObject to create it frompublic JsonObject toJson()
public boolean isEnabled()
public VertxPrometheusOptions setEnabled(boolean enabled)
public boolean isStartEmbeddedServer()
public VertxPrometheusOptions setStartEmbeddedServer(boolean startEmbeddedServer)
public HttpServerOptions getEmbeddedServerOptions()
public VertxPrometheusOptions setEmbeddedServerOptions(HttpServerOptions embeddedServerOptions)
embeddedServerOptions
- the server optionspublic VertxPrometheusOptions setEmbeddedServerEndpoint(String embeddedServerEndpoint)
embeddedServerEndpoint
- metrics endpointpublic String getEmbeddedServerEndpoint()
public boolean isPublishQuantiles()
public VertxPrometheusOptions setPublishQuantiles(boolean publishQuantiles)
publishQuantiles
- the publishing quantiles flagCopyright © 2023 Eclipse. All rights reserved.