Migration guide for 1.4.0 -> 1.5.0 Metrics

[jsuereth]

Here's a migration guide for how to convert your metric API code with the 1.5.0 release.

Sync Instruments

Histogram Migration

doubleValueRecorder

DoubleValueRecorder duration = meter
            .doubleValueRecorderBuilder("http.client.duration")
            .histogramBuilder("http.client.duration")
            .setUnit("milliseconds")
            .setDescription("The duration of the outbound HTTP request")
            .build();
            
duration.record(value, Labels.of("mylabel", "labelvalue");

DoubleHistogram duration = meter
            .histogramBuilder("http.client.duration")
            .setUnit("milliseconds")
            .setDescription("The duration of the outbound HTTP request")
            .build();

duration.record(value, Attributes.builder().put("mylabel", "labelvalue").build());

longValueRecorder

LongValueRecorder duration = meter
            .longValueRecorderBuilder("http.client.duration")
            .histogramBuilder("http.client.duration")
            .setUnit("milliseconds")
            .setDescription("The duration of the outbound HTTP request")
            .build();
            
duration.record(value, Labels.of("mylabel", "labelvalue");

LongHistogram duration = meter
            .histogramBuilder("http.client.duration")
            .ofLongs()
            .setUnit("milliseconds")
            .setDescription("The duration of the outbound HTTP request")
            .build();

duration.record(value, Attributes.builder().put("mylabel", "labelvalue").build());

Counter Migration

doubleCounter

DoubleCounter counter =
        sdkMeter
            .doubleCounterBuilder("testCounter")
            .setDescription("description")
            .setUnit("ms")
            .build();
counter.add(value, Labels.of("mylabel", "labelvalue");

DoubleCounter counter =
        sdkMeter
            .counterBuilder("testCounter")
            .ofDoubles()
            .setDescription("description")
            .setUnit("ms")
            .build();
counter.record(value, Attributes.builder().put("mylabel", "labelvalue").build());

longCounter

LongCounter counter =
        sdkMeter
            .longCounterBuilder("testCounter")
            .setDescription("description")
            .setUnit("ms")
            .build();
counter.add(value, Labels.of("mylabel", "labelvalue");

LongCounter counter =
        sdkMeter
            .counterBuilder("testCounter")
            .setDescription("description")
            .setUnit("ms")
            .build();
counter.record(value, Attributes.builder().put("mylabel", "labelvalue").build());

UpDownCounter Migration

doubleUpDownCounter

DoubleUpDownCounter counter =
        sdkMeter
            .doubleUpDownCounterBuilder("testCounter")
            .setDescription("description")
            .setUnit("ms")
            .build();
counter.add(value, Labels.of("mylabel", "labelvalue");

DoubleUpDownCounter counter =
        sdkMeter
            .upDownCounterBuilder("testCounter")
            .ofDoubles()
            .setDescription("description")
            .setUnit("ms")
            .build();
counter.record(value, Attributes.builder().put("mylabel", "labelvalue").build());

longUpDownCounter

LongUpDownCounter counter =
        sdkMeter
            .longUpDownCounterBuilder("testCounter")
            .setDescription("description")
            .setUnit("ms")
            .build();
counter.add(value, Labels.of("mylabel", "labelvalue");

LongUpDownCounter counter =
        sdkMeter
            .upDownCounterBuilder("testCounter")
            .setDescription("description")
            .setUnit("ms")
            .build();
counter.record(value, Attributes.builder().put("mylabel", "labelvalue").build());

Async Instruments

Gauge Migration

longValueObserver

meter
  .longValueObserverBuilder("runtime.java.memory")
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .setUpdater(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Labels.of(TYPE_LABEL_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Labels.of(TYPE_LABEL_KEY, "vms"));
    })
  .build();  

meter
  .gaugeBuilder("runtime.java.memory")
  .ofLongs()
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .buildWithCallback(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Attributes.of(TYPE_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Attributes.of(TYPE_KEY, "vms"));
    });

doubleValueObserver

meter
  .doubleValueObserverBuilder("runtime.java.memory")
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .setUpdater(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Labels.of(TYPE_LABEL_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Labels.of(TYPE_LABEL_KEY, "vms"));
    })
  .build();  

meter
  .gaugeBuilder("runtime.java.memory")
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .buildWithCallback(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Attributes.of(TYPE_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Attributes.of(TYPE_KEY, "vms"));
    });

UpDown Sum Migration

longUpDownSumObserver

meter
  .longUpDownSumObserverBuilder("runtime.java.memory")
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .setUpdater(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Labels.of(TYPE_LABEL_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Labels.of(TYPE_LABEL_KEY, "vms"));
    })
  .build();  

meter
  .upDownCounterBuilder("runtime.java.memory")
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .buildWithCallback(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Attributes.of(TYPE_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Attributes.of(TYPE_KEY, "vms"));
    });

doubleUpDownSumObserver

meter
  .doubleUpDownSumObserverBuilder("runtime.java.memory")
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .setUpdater(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Labels.of(TYPE_LABEL_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Labels.of(TYPE_LABEL_KEY, "vms"));
    })
  .build();  

meter
  .upDownCounterBuilder("runtime.java.memory")
  .ofDoubles()
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .buildWithCallback(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Attributes.of(TYPE_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Attributes.of(TYPE_KEY, "vms"));
    });

Sum Migration

longSumObserver

meter
  .longSumObserverBuilder("runtime.java.memory")
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .setUpdater(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Labels.of(TYPE_LABEL_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Labels.of(TYPE_LABEL_KEY, "vms"));
    })
  .build();  

meter
  .counterBuilder("runtime.java.memory")
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .buildWithCallback(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Attributes.of(TYPE_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Attributes.of(TYPE_KEY, "vms"));
    });

doubleSumObserver

meter
  .doubleSumObserverBuilder("runtime.java.memory")
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .setUpdater(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Labels.of(TYPE_LABEL_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Labels.of(TYPE_LABEL_KEY, "vms"));
    })
  .build();  

meter
  .counterBuilder("runtime.java.memory")
  .ofDoubles()
  .setDescription("Runtime Java memory")
  .setUnit("bytes")
  .buildWithCallback(
    r -> {
      processInfo.updateAttributes();
      r.observe(processInfo.getResidentSetSize(), Attributes.of(TYPE_KEY, "rss"));
      r.observe(processInfo.getVirtualSize(), Attributes.of(TYPE_KEY, "vms"));
    });