Skip to content

Commit d75004a

Browse files
committed
fix: add example scenarios
1 parent 94f055c commit d75004a

File tree

1 file changed

+7
-0
lines changed
  • packages/opentelemetry-api/src/metrics

1 file changed

+7
-0
lines changed

packages/opentelemetry-api/src/metrics/Meter.ts

+7
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,13 @@ export interface Meter {
5252
* supports negative increments. It is generally useful for capturing changes
5353
* in an amount of resources used, or any quantity that rises and falls
5454
* during a request.
55+
* Example uses for UpDownCounter:
56+
* <ol>
57+
* <li> count the number of active requests. </li>
58+
* <li> count memory in use by instrumenting new and delete. </li>
59+
* <li> count queue size by instrumenting enqueue and dequeue. </li>
60+
* <li> count semaphore up and down operations. </li>
61+
* </ol>
5562
*
5663
* @param name the name of the metric.
5764
* @param [options] the metric options.

0 commit comments

Comments
 (0)