config.io_helidon_metrics_api_MetricsConfig.adoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-docs
There is a newer version: 4.1.4
///////////////////////////////////////////////////////////////////////////////

    Copyright (c) 2023 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.metrics.api.MetricsConfig
:keywords: helidon, config, io.helidon.metrics.api.MetricsConfig
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.metrics.api.MetricsConfig
include::{rootdir}/includes/attributes.adoc[]

= MetricsConfig (metrics.api) Configuration

// tag::config[]


Type: link:{javadoc-base-url}/io.helidon.metrics.api/io/helidon/metrics/api/MetricsConfig.html[io.helidon.metrics.api.MetricsConfig]


This is a standalone configuration type, prefix from configuration root: `metrics`



== 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.

 @return application tag value
|`app-tag-name` |string |{nbsp} |Name for the application tag to be added to each meter ID.

 @return application tag name
|`enabled` |boolean |`true` |Whether metrics functionality is enabled.

 @return if metrics are configured to be enabled
|`key-performance-indicators` |xref:{rootdir}/config/io_helidon_metrics_api_KeyPerformanceIndicatorMetricsConfig.adoc[KeyPerformanceIndicatorMetricsConfig] |{nbsp} |Key performance indicator metrics settings.

 @return key performance indicator metrics settings
|`permit-all` |boolean |{nbsp} |Whether to allow anybody to access the endpoint.

 @return whether to permit access to metrics endpoint to anybody, defaults to `true`
 @see #roles()
|`rest-request-enabled` |boolean |{nbsp} |Whether automatic REST request metrics should be measured.

 @return true/false
|`roles` |string[] |{nbsp} |Hints for role names the user is expected to be in.

 @return list of hints
|`scoping` |xref:{rootdir}/config/io_helidon_metrics_api_ScopingConfig.adoc[ScopingConfig] |{nbsp} |Settings related to scoping management.

 @return scoping settings
|`tags` |xref:{rootdir}/config/io_helidon_metrics_api_Tag.adoc[Tag[]] |{nbsp} |Global tags.

 @return name/value pairs for global tags

|===

// end::config[]