com.azure.cosmos.models.CosmosMicrometerMeterOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-cosmos Show documentation
This Package contains Microsoft Azure Cosmos SDK (with Reactive Extension Reactor support) for Azure Cosmos DB SQL API
There is a newer version: 4.63.3
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.cosmos.models;

import com.azure.cosmos.implementation.clienttelemetry.TagName;

import java.util.EnumSet;

/**
 * Options of a Cosmos client-side meter that can be used to enable/disable it, change the percentile and histogram
 * capturing (if percentiles are applicable for the meter) and allows suppressing tags that are not desired.
 */
public final class CosmosMicrometerMeterOptions {

    private Boolean isHistogramPublishingEnabled;
    private double[] percentiles;
    private EnumSet suppressedTagNames;
    private Boolean isEnabled;

    private Boolean applyDiagnosticThresholds;

    /**
     * Instantiates new options for a specific Cosmos DB meter
     */
    public CosmosMicrometerMeterOptions() {
        this.isHistogramPublishingEnabled = null;
        this.percentiles = null;
        this.suppressedTagNames = null;
        this.isEnabled = null;
    }

    /**
     * Sets the tags that should be used for this meter (when applicable)
     *
     * @param tags - the tags to be used (when applicable) for this meter
     * @return current CosmosMeterOptions instance
     */
    public CosmosMicrometerMeterOptions suppressTagNames(CosmosMetricTagName... tags) {
        EnumSet newTagNames = EnumSet.noneOf(TagName.class);
        if (tags != null && tags.length > 0) {
            for (CosmosMetricTagName t: tags) {
                for (TagName tagName: t.getTagNames()) {
                    if (!TagName.MINIMUM_TAGS.contains(tagName)) {
                        newTagNames.add(tagName);
                    }
                }
            }
        }

        this.suppressedTagNames = newTagNames;

        return this;
    }

    /**
     * Sets a flag whether the diagnostic thresholds should be applied for this meter. If enabled
     * a meter will only reflect operations violating diagnostic thresholds. This can be used to reduce
     * the cardinality of dimensions (the number of time series a meter emits). Request-level metrics usually
     * are used to capture metrics per backend endpoint/replica - a high cardinality dimension. Filtering by
     * diagnostic thresholds reduces the overhead - but also means request-level metrics can only be used
     * for debugging purposes - not for monitoring purposes. So, it is important to use the unfiltered
     * operation-level metrics for health monitoring in this case.
     *
     * @param isEnabled - a flag indicating whether the diagnostic thresholds should be applied for this meter - when
     *      not specified the default provided in
     *      {@link CosmosMicrometerMetricsOptions#applyDiagnosticThresholdsForTransportLevelMeters(boolean)} is used.
     * @return current CosmosMeterOptions instance
     */
    public CosmosMicrometerMeterOptions applyDiagnosticThresholds(boolean isEnabled) {
        this.applyDiagnosticThresholds = isEnabled;

        return this;
    }

    /**
     * Sets the tags that should be used for this meter (when applicable)
     *
     * @param isEnabled - a flag indicating whether histogram publishing is enabled for this meter
     * @return current CosmosMeterOptions instance
     */
    public CosmosMicrometerMeterOptions enableHistograms(boolean isEnabled) {
        this.isHistogramPublishingEnabled = isEnabled;

        return this;
    }

    /**
     * Sets the percentiles that should be captured for this meter (when applicable)
     *
     * @param percentiles - a flag indicating whether histogram publishing is enabled for this meter
     * @return current CosmosMeterOptions instance
     */
    public CosmosMicrometerMeterOptions configurePercentiles(double... percentiles) {
        if (percentiles == null || percentiles.length == 0) {
            this.percentiles = new double[0];
        } else {
            this.percentiles = percentiles.clone();
        }

        return this;
    }

    /**
     * Enables or disables this meter. By default, meters are enabled.
     *
     * @param enabled pass {@code true} to enable the meter.
     * @return the updated {@code MetricsOptions} object.
     */
    public CosmosMicrometerMeterOptions setEnabled(boolean enabled) {
        this.isEnabled = enabled;
        return this;
    }

    EnumSet getSuppressedTagNames() {
        return this.suppressedTagNames;
    }

    Boolean getIsHistogramPublishingEnabled() {
        return this.isHistogramPublishingEnabled;
    }

    Boolean getIsEnabled() {
        return this.isEnabled;
    }

    Boolean getApplyDiagnosticThresholdsEnabled() {
        return this.applyDiagnosticThresholds;
    }

    double[] getPercentiles() {
        return this.percentiles;
    }
}