Package com.azure.cosmos.models

Class CosmosMicrometerMeterOptions

java.lang.Object
com.azure.cosmos.models.CosmosMicrometerMeterOptions
public final class CosmosMicrometerMeterOptions extends Object
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.

  • Constructor Details

    • CosmosMicrometerMeterOptions

      public CosmosMicrometerMeterOptions()
      Instantiates new options for a specific Cosmos DB meter

  • Method Details

    • suppressTagNames

      public CosmosMicrometerMeterOptions suppressTagNames(CosmosMetricTagName... tags)
      Sets the tags that should be used for this meter (when applicable)
      Parameters:
      tags - - the tags to be used (when applicable) for this meter
      Returns:
      current CosmosMeterOptions instance

    • enableHistograms

      public CosmosMicrometerMeterOptions enableHistograms(boolean isEnabled)
      Sets the tags that should be used for this meter (when applicable)
      Parameters:
      isEnabled - - a flag indicating whether histogram publishing is enabled for this meter
      Returns:
      current CosmosMeterOptions instance

    • configurePercentiles

      public CosmosMicrometerMeterOptions configurePercentiles(double... percentiles)
      Sets the percentiles that should be captured for this meter (when applicable)
      Parameters:
      percentiles - - a flag indicating whether histogram publishing is enabled for this meter
      Returns:
      current CosmosMeterOptions instance

    • setEnabled

      public CosmosMicrometerMeterOptions setEnabled(boolean enabled)
      Enables or disables this meter. By default, meters are enabled.
      Parameters:
      enabled - pass true to enable the meter.
      Returns:
      the updated MetricsOptions object.