Update java metric instrumentation docs #4165
Conversation
|
cc @jack-berg |
cartermp
removed
the
sig-approval-missing
|
/fix:all |
|
You triggered fix:all action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/8361878119 |
| ### Using Observable (Async) Counters | ||
|
|
||
| Observable counters can be used to measure an additive, non-negative, | ||
| monotonically increasing value. |
There was a problem hiding this comment.
Its important to note that observable counters observe cumulative values which have been aggregated elsewhere. I.e. you don't asynchronously observe the increment you would record to a sync counter - you asynchronously observe the cumulative state of a bunch of increments. Same adivce applies to async up down counter.
Also, the example of monitoring the cache size with an async counter is wrong because caches can reduce in size, violating the monotonic requirement. Not sure what example you should use instead - one that comes to mind is the cumulative number of total rolls (but this isn't great because it duplicates data present in the dice-lib.rolls histogram), or the number of classes loaded by the JVM.
There was a problem hiding this comment.
I made some changes to reflect the distinction between the observables, and I think i have more realistic examples for the metric examples now but let me know if you think they still don't match
There was a problem hiding this comment.
Noticed a couple more minor things I missed the first time around, but looks good. Thanks @jaydeluca!
Closes #4123
I tried to mirror the javascript docs as closely as possible. Let me know if anything should be revisited or changed.