config.io_helidon_webserver_observe_metrics_MetricsObserver.adoc Maven / Gradle / Ivy
///////////////////////////////////////////////////////////////////////////////
Copyright (c) 2024 Oracle and/or its affiliates.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
///////////////////////////////////////////////////////////////////////////////
ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.webserver.observe.metrics.MetricsObserver
:keywords: helidon, config, io.helidon.webserver.observe.metrics.MetricsObserver
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.webserver.observe.metrics.MetricsObserver
include::{rootdir}/includes/attributes.adoc[]
= MetricsObserver (webserver.observe.metrics) Configuration
// tag::config[]
Type: link:{javadoc-base-url}/io.helidon.webserver.observe.metrics/io/helidon/webserver/observe/metrics/MetricsObserver.html[io.helidon.webserver.observe.metrics.MetricsObserver]
This is a standalone configuration type, prefix from configuration root: `metrics`
This type provides the following service implementations:
- `io.helidon.webserver.observe.spi.ObserveProvider`
== Configuration options
.Optional configuration options
[cols="3,3a,2,5a"]
|===
|key |type |default value |description
|`app-name` |string |{nbsp} |Value for the application tag to be added to each meter ID.
Application tag value
|`app-tag-name` |string |{nbsp} |Name for the application tag to be added to each meter ID.
Application tag name
|`enabled` |boolean |`true` |Whether metrics functionality is enabled.
If metrics are configured to be enabled
|`endpoint` |string |`metrics` |
|[.line-through]#`gc-time-type`# |GcTimeType (GAUGE, COUNTER) |`GcTimeType.COUNTER` |*Deprecated* Whether the `gc.time` meter should be registered as a gauge (vs. a counter).
The `gc.time` meter is inspired by the MicroProfile Metrics spec, in which the meter was originally checked to
be a counter but starting in 5.1 was checked be a gauge. For the duration of Helidon 4.x users can choose which
type of meter Helidon registers for `gc.time`.
The type of meter to use for registering `gc.time`
@deprecated Provided for backward compatibility only; no replacement
Allowed values:
- `GAUGE`: Implement the meter as a gauge. This is backward-incompatible with Helidon 4.0.x releases but complies with
MicroProfile 5.1.
- `COUNTER`: Implement the meter as a counter. This is backward-compatible with Helidon 4.0.x releases but does not comply with
MicroProfile 5.1.
|`key-performance-indicators` |xref:{rootdir}/config/io_helidon_metrics_api_KeyPerformanceIndicatorMetricsConfig.adoc[KeyPerformanceIndicatorMetricsConfig] |{nbsp} |Key performance indicator metrics settings.
Key performance indicator metrics settings
|`permit-all` |boolean |`true` |Whether to allow anybody to access the endpoint.
Whether to permit access to metrics endpoint to anybody, defaults to `true`
See roles()
|`rest-request-enabled` |boolean |`false` |Whether automatic REST request metrics should be measured.
True/false
|`roles` |string[] |`observe` |Hints for role names the user is expected to be in.
List of hints
|`scoping` |xref:{rootdir}/config/io_helidon_metrics_api_ScopingConfig.adoc[ScopingConfig] |{nbsp} |Settings related to scoping management.
Scoping settings
|`tags` |xref:{rootdir}/config/io_helidon_metrics_api_Tag.adoc[Tag[]] |{nbsp} |Global tags.
Name/value pairs for global tags
|===
// end::config[]