Interface MetricMetadata.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MetricMetadata.Builder,MetricMetadata>, SdkBuilder<MetricMetadata.Builder,MetricMetadata>, SdkPojo
Enclosing class:
MetricMetadata
@Mutable @NotThreadSafe public static interface MetricMetadata.Builder extends SdkPojo, CopyableBuilder<MetricMetadata.Builder,MetricMetadata>

  • Method Details

    • name

      MetricMetadata.Builder name(String name)

      The metric name as emitted, such as "Duration".

      Parameters:
      name - The metric name as emitted, such as "Duration".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • namespace

      @Deprecated MetricMetadata.Builder namespace(String namespace)
      Deprecated.
      Use attributes['service.namespace']; retained for backward compatibility.

      DEPRECATED: read attributes["service.namespace"] instead. Retained (deprecated) for backward compatibility with existing consumers; will be removed once they migrate. The logical service grouping the metric belongs to.

      Parameters:
      namespace - DEPRECATED: read attributes["service.namespace"] instead. Retained (deprecated) for backward compatibility with existing consumers; will be removed once they migrate. The logical service grouping the metric belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredStat

      MetricMetadata.Builder preferredStat(String preferredStat)

      The statistic to chart or alarm on, such as "p99" or "Sum". Free-form and frequently absent.

      Parameters:
      preferredStat - The statistic to chart or alarm on, such as "p99" or "Sum". Free-form and frequently absent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricType

      MetricMetadata.Builder metricType(String metricType)

      OTel metric kind: "gauge", "sum", "histogram", "exponential_histogram", or "summary" (CloudWatch-vended metrics carry the same kinds). Absent when the producer did not report one.

      Parameters:
      metricType - OTel metric kind: "gauge", "sum", "histogram", "exponential_histogram", or "summary" (CloudWatch-vended metrics carry the same kinds). Absent when the producer did not report one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      MetricMetadata.Builder attributes(Map<String,String> attributes)

      Per-metric qualifying attributes the console uses to query this metric's telemetry. These are the RAW, store-matching values keyed by their OTel names ("service.name", "service.namespace", "cloud.provider", "cloud.account.id", "cloud.region", "instrumentation_scope") — deliberately NOT the node's normalized/merged identity, so the query selectors match the emitted series. A merged node can carry different values per metric, which is why they live here rather than on the node.

      Parameters:
      attributes - Per-metric qualifying attributes the console uses to query this metric's telemetry. These are the RAW, store-matching values keyed by their OTel names ("service.name", "service.namespace", "cloud.provider", "cloud.account.id", "cloud.region", "instrumentation_scope") — deliberately NOT the node's normalized/merged identity, so the query selectors match the emitted series. A merged node can carry different values per metric, which is why they live here rather than on the node.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • semantics

      MetricMetadata.Builder semantics(MetricSemantics semantics)

      What the metric means and the unit it is reported in.

      Parameters:
      semantics - What the metric means and the unit it is reported in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • semantics

      default MetricMetadata.Builder semantics(Consumer<MetricSemantics.Builder> semantics)

      What the metric means and the unit it is reported in.

      This is a convenience method that creates an instance of the MetricSemantics.Builder avoiding the need to create one manually via MetricSemantics.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to semantics(MetricSemantics).

      Parameters:
      semantics - a consumer that will call methods on MetricSemantics.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: