docs: add observableGauge to the prometheus experimental example #4267
Conversation
Signed-off-by: Francois LP <francois.le.pape@gmail.com>
Signed-off-by: Francois LP <francois.le.pape@gmail.com>
…xperimental-example
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #4267 +/- ##
==========================================
- Coverage 92.22% 91.79% -0.43%
==========================================
Files 336 214 -122
Lines 9521 6547 -2974
Branches 2017 1465 -552
==========================================
- Hits 8781 6010 -2771
+ Misses 740 537 -203 |
…xperimental-example
There was a problem hiding this comment.
Thank you for opening this PR.
I'm wondering if it wouldn't be better to just link to the documentation on metrics instrumentation from the readme. The observable gauge is not really prometheus specific and its behvaior does not vary depending on which exporter is used. 🤔
from @pichlermarc Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com>
I did the PR in the first place because I was trying to move away from |
…xperimental-example
|
@pichlermarc any update? 👀 |
| observableGauge.addCallback(async observableResult => { | ||
| const value = await randomMetricPromise(); | ||
| observableResult.observe(value, attributes); | ||
| }); |
There was a problem hiding this comment.
hmm, why not observe the value synchronously here? 🤔
There was a problem hiding this comment.
hmm, why not observe the value synchronously here? 🤔
Often, when I had to observe a value at querying time, it was from an async process, so I just replicated what I often deal with :)
There was a problem hiding this comment.
I agree that the ability to collect gauge asynchronously can be a good point to present in the example.
| observableGauge.addCallback(async observableResult => { | ||
| const value = await randomMetricPromise(); | ||
| observableResult.observe(value, attributes); | ||
| }); |
There was a problem hiding this comment.
I agree that the ability to collect gauge asynchronously can be a good point to present in the example.
…xperimental-example
|
Hey @pichlermarc , should we merge the PR now it is approved? :) |
…xperimental-example
…xperimental-example
…xperimental-example
…n-telemetry#4267) * docs: add observableGauge to the prometheus experimental example Signed-off-by: Francois LP <francois.le.pape@gmail.com> * docs: add gauge image to README Signed-off-by: Francois LP <francois.le.pape@gmail.com> * refactor: change comment wording from @pichlermarc Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com> --------- Signed-off-by: Francois LP <francois.le.pape@gmail.com> Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com> Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>
Which problem is this PR solving?
Lack of documentation for async functions and gauge observable regarding the prometheus experimental example.
Short description of the changes
createObservableGauge()function.Type of change
improve documentation
How Has This Been Tested?
Checklist: