config.io_helidon_integrations_oci_metrics_OciMetricsSupport.adoc Maven / Gradle / Ivy

Go to download
///////////////////////////////////////////////////////////////////////////////

    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.integrations.oci.metrics.OciMetricsSupport
:keywords: helidon, config, io.helidon.integrations.oci.metrics.OciMetricsSupport
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.integrations.oci.metrics.OciMetricsSupport
include::{rootdir}/includes/attributes.adoc[]

= OciMetricsSupport (integrations.oci.metrics) Configuration

// tag::config[]


Type: link:{javadoc-base-url}/io.helidon.integrations.oci.metrics/io/helidon/integrations/oci/metrics/OciMetricsSupport.html[io.helidon.integrations.oci.metrics.OciMetricsSupport]




== Configuration options



.Optional configuration options
[cols="3,3a,2,5a"]

|===
|key |type |default value |description

|`batch-delay` |long |`1` |Sets the delay interval if metrics are posted in batches
 (defaults to `DEFAULT_BATCH_DELAY`).
|`batch-size` |int |`50` |Sets the maximum no. of metrics to send in a batch
 (defaults to `DEFAULT_BATCH_SIZE`).
|`compartment-id` |string |{nbsp} |Sets the compartment ID.
|`delay` |long |`60` |Sets the delay interval between metric posting
 (defaults to `DEFAULT_SCHEDULER_DELAY`).
|`description-enabled` |boolean |`true` |Sets whether the description should be enabled or not.

     Defaults to `true`.
 
|`enabled` |boolean |`true` |Sets whether metrics transmission to OCI is enabled.

     Defaults to `true`.
 
|`initial-delay` |long |`1` |Sets the initial delay before metrics are sent to OCI
 (defaults to `DEFAULT_SCHEDULER_INITIAL_DELAY`).
|`namespace` |string |{nbsp} |Sets the namespace.
|`resource-group` |string |{nbsp} |Sets the resource group.
|`scheduling-time-unit` |TimeUnit (NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS) |`TimeUnit.SECONDS` |Sets the time unit applied to the initial delay and delay values (defaults to `TimeUnit.SECONDS`).
|`scopes` |String[] |`All scopes` |Sets which metrics scopes (e.g., base, vendor, application) should be sent to OCI.

     If this method is never invoked, defaults to all scopes.
 

|===

// end::config[]