Interface HdrDeltaHistogramAttachment

All Superinterfaces:
HdrDeltaHistogramProvider
All Known Implementing Classes:
NBMetricHistogram, NBMetricTimer
public interface HdrDeltaHistogramAttachment extends HdrDeltaHistogramProvider

Allow a DeltaHistogram to have attached metrics that also get a copy of any input data.

Terms

  • Attaching metric - the original metric which maintains the attached metric.
  • Attached metric - the "shadow" metric which receives the same input as the original metric.

Implementing classes should reproduce their configuration, but not their content. This means that attached metrics will receive content from the time they are attached, and wil not see previous content. Attaching metrics are responsible for the creation and ownership of the attached metrics.

Implementations of the attaching metric should ensure that attached metrics all receive the same data.

The number of metrics that are allowed to be chained is implementation dependent.

Implementations should ensure that any naming fields are marked differently so that the attached metric does not have the exact same name as the attaching metric.

  • Method Details

    • attachHdrDeltaHistogram

      HdrDeltaHistogramProvider attachHdrDeltaHistogram()
      Attach a metric.
      Returns:
      the attached metric, after adding to the mirrors for the metric.