Package io.opentelemetry.extension.incubator.metrics

Interface ExtendedLongGaugeBuilder

All Superinterfaces:
io.opentelemetry.api.metrics.LongGaugeBuilder
public interface ExtendedLongGaugeBuilder extends io.opentelemetry.api.metrics.LongGaugeBuilder
Extended LongGaugeBuilder with experimental APIs.

  • Method Summary

    Modifier and Type
    Method
    Description
    LongGauge
    build()
    Builds and returns a LongGauge instrument with the configuration.
    default ExtendedLongGaugeBuilder
    setAttributesAdvice(List<io.opentelemetry.api.common.AttributeKey<?>> attributes)
    Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this gauge.

    Methods inherited from interface io.opentelemetry.api.metrics.LongGaugeBuilder

    buildObserver, buildWithCallback, setDescription, setUnit

  • Method Details

    • build

      LongGauge build()
      Builds and returns a LongGauge instrument with the configuration.

      NOTE: This produces a synchronous gauge which records gauge values as they occur. Most users will want to instead register an LongGaugeBuilder.buildWithCallback(Consumer) to asynchronously observe the value of the gauge when metrics are collected.

      Returns:
      The LongGauge instrument.

    • setAttributesAdvice

      default ExtendedLongGaugeBuilder setAttributesAdvice(List<io.opentelemetry.api.common.AttributeKey<?>> attributes)
      Specify the attribute advice, which suggests the recommended set of attribute keys to be used for this gauge.