Package io.micrometer.stackdriver

Interface StackdriverConfig

All Superinterfaces:
io.micrometer.core.instrument.config.MeterRegistryConfig, io.micrometer.core.instrument.push.PushRegistryConfig, io.micrometer.core.instrument.step.StepRegistryConfig
public interface StackdriverConfig extends io.micrometer.core.instrument.step.StepRegistryConfig
StepRegistryConfig for Stackdriver.
Since:
1.1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    default com.google.api.gax.core.CredentialsProvider
    credentials()
    Return CredentialsProvider to use.
    default String
    metricTypePrefix()
    Return metric type prefix.
    default String
    prefix()
     
    default String
    projectId()
     
    default Map<String,String>
    resourceLabels()
    Return resource labels.
    default String
    resourceType()
     
    default boolean
    useSemanticMetricTypes()
    Whether to use semantically correct metric types.
    default io.micrometer.core.instrument.config.validate.Validated<?>
    validate()
     

    Methods inherited from interface io.micrometer.core.instrument.config.MeterRegistryConfig

    get, requireValid

    Methods inherited from interface io.micrometer.core.instrument.push.PushRegistryConfig

    batchSize, connectTimeout, enabled, numThreads, readTimeout, step

  • Method Details

    • prefix

      default String prefix()
      Specified by:
      prefix in interface io.micrometer.core.instrument.config.MeterRegistryConfig

    • projectId

      default String projectId()

    • resourceLabels

      default Map<String,String> resourceLabels()
      Return resource labels.
      Returns:
      resource labels.
      Since:
      1.4.0

    • resourceType

      default String resourceType()

    • useSemanticMetricTypes

      default boolean useSemanticMetricTypes()
      Whether to use semantically correct metric types. This is false by default for the sake of backwards compatibility. For example, when this is false, counter metrics are published as the GAUGE MetricKind. When this is true, counter metrics are published as the CUMULATIVE MetricKind.

      If you have published metrics to Stackdriver before, switching this flag will cause metrics publishing to fail until you delete the old MetricDescriptor with the previous MetricKind so that it can be recreated with the new MetricKind next time that metric is published. For example, the projects.metricDescriptors.delete API can be used to delete an existing MetricDescriptor.

      Returns:
      a flag indicating if semantically correct metric types will be used
      Since:
      1.8.0

    • metricTypePrefix

      default String metricTypePrefix()
      Return metric type prefix.

      Available prefixes defined in Google Cloud documentation.

      Returns:
      a prefix for MetricType
      Since:
      1.10.0

    • credentials

      default com.google.api.gax.core.CredentialsProvider credentials()
      Return CredentialsProvider to use.
      Returns:
      CredentialsProvider to use
      Since:
      1.4.0

    • validate

      default io.micrometer.core.instrument.config.validate.Validated<?> validate()
      Specified by:
      validate in interface io.micrometer.core.instrument.config.MeterRegistryConfig
      Specified by:
      validate in interface io.micrometer.core.instrument.push.PushRegistryConfig