vertx / io.vertx.kotlin.ext.hawkular / VertxHawkularOptions

VertxHawkularOptions

fun VertxHawkularOptions(authenticationOptions: AuthenticationOptions? = null, batchDelay: Int? = null, batchSize: Int? = null, disabledMetricsTypes: Iterable<MetricsType>? = null, enabled: Boolean? = null, host: String? = null, httpHeaders: JsonObject? = null, httpOptions: HttpClientOptions? = null, metricTagsMatches: Iterable<MetricTagsMatch>? = null, metricsBridgeAddress: String? = null, metricsBridgeEnabled: Boolean? = null, metricsServiceUri: String? = null, port: Int? = null, prefix: String? = null, schedule: Int? = null, sendTenantHeader: Boolean? = null, taggedMetricsCacheSize: Int? = null, tags: JsonObject? = null, tenant: String? = null): VertxHawkularOptions

A function providing a DSL for building io.vertx.ext.hawkular.VertxHawkularOptions objects.

Vert.x Hawkular monitoring configuration.

Parameters

authenticationOptions - Set the options for authentication.

batchDelay - Set the maximum delay between two consecutive batches (in seconds). To reduce the number of HTTP exchanges, metric data is sent to the Hawkular server in batches. A batch is sent as soon as the number of metrics collected reaches the configured batchSize, or after the batchDelay expires. Defaults to 1 second.

batchSize - Set the maximum number of metrics in a batch. To reduce the number of HTTP exchanges, metric data is sent to the Hawkular server in batches. A batch is sent as soon as the number of metrics collected reaches the configured batchSize, or after the batchDelay expires. Defaults to 50.

disabledMetricsTypes - Sets metrics types that are disabled.

enabled - Set whether metrics will be enabled on the Vert.x instance. Metrics are not enabled by default.

host - Set the Hawkular Metrics service host. Defaults to localhost.

httpHeaders - Set specific headers to include in HTTP requests.

httpOptions - Set the configuration of the Hawkular Metrics HTTP client.

metricTagsMatches - Sets a list of io.vertx.ext.hawkular.MetricTagsMatch.

metricsBridgeAddress - Sets the metric bridge address on which the application is sending the custom metrics. Application can send metrics to this event bus address. The message is a JSON object specifying at least the id and value fields. Don't forget to also enable the bridge with metricsBridgeEnabled.

metricsBridgeEnabled - Sets whether or not the metrics bridge should be enabled. The metrics bridge is disabled by default.

metricsServiceUri - Set the Hawkular Metrics service URI. Defaults to /hawkular/metrics. This can be useful if you host the Hawkular server behind a proxy and manipulate the default service URI.

port - Set the Hawkular Metrics service port. Defaults to 8080.

prefix - Set the metric name prefix. Metric names are not prefixed by default. Prefixing metric names is required to distinguish data sent by different Vert.x instances.

schedule - Set the metric collection interval (in seconds). Defaults to 1.

sendTenantHeader - Set whether Hawkular tenant header should be sent. Defaults to true. Must be set to false when working with pre-Alpha13 Hawkular servers.

taggedMetricsCacheSize - Set the number of metric names to cache in order to avoid repeated tagging requests.

tags - Set tags applied to all metrics.

tenant - Set the Hawkular tenant. Defaults to default.