Skip to content

Commit 5347727

Browse files
Alex Botenocelotl
andauthored
[docs] updating metrics examples (#2507)
* [docs] updating metrics examples Adding different instruments to the example code. * use correct Measurement Co-authored-by: Diego Hurtado <[email protected]>
1 parent 4f8de5e commit 5347727

File tree

2 files changed

+82
-4
lines changed

2 files changed

+82
-4
lines changed

docs/examples/metrics/example.py

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
from typing import Iterable
2+
13
from opentelemetry._metrics import get_meter_provider, set_meter_provider
4+
from opentelemetry._metrics.measurement import Measurement
25
from opentelemetry.exporter.otlp.proto.grpc._metric_exporter import (
36
OTLPMetricExporter,
47
)
@@ -10,7 +13,43 @@
1013
provider = MeterProvider(metric_readers=[reader])
1114
set_meter_provider(provider)
1215

16+
17+
def observable_counter_func() -> Iterable[Measurement]:
18+
yield Measurement(1, {})
19+
20+
21+
def observable_up_down_counter_func() -> Iterable[Measurement]:
22+
yield Measurement(-10, {})
23+
24+
25+
def observable_gauge_func() -> Iterable[Measurement]:
26+
yield Measurement(9, {})
27+
28+
1329
meter = get_meter_provider().get_meter("getting-started", "0.1.2")
14-
counter = meter.create_counter("first_counter")
30+
31+
# Counter
32+
counter = meter.create_counter("counter")
1533
counter.add(1)
16-
# TODO: fill in details for additional metrics
34+
35+
# Async Counter
36+
observable_counter = meter.create_observable_counter(
37+
"observable_counter", observable_counter_func
38+
)
39+
40+
# UpDownCounter
41+
updown_counter = meter.create_up_down_counter("updown_counter")
42+
updown_counter.add(1)
43+
updown_counter.add(-5)
44+
45+
# Async UpDownCounter
46+
observable_updown_counter = meter.create_observable_up_down_counter(
47+
"observable_updown_counter", observable_up_down_counter_func
48+
)
49+
50+
# Histogram
51+
histogram = meter.create_histogram("histogram")
52+
histogram.record(99.9)
53+
54+
# Async Gauge
55+
gauge = meter.create_observable_gauge("gauge", observable_gauge_func)

docs/getting_started/metrics_example.py

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@
1515
# metrics.py
1616
# This is still work in progress as the metrics SDK is being implemented
1717

18+
from typing import Iterable
19+
1820
from opentelemetry._metrics import get_meter_provider, set_meter_provider
21+
from opentelemetry._metrics.measurement import Measurement
1922
from opentelemetry.sdk._metrics import MeterProvider
2023
from opentelemetry.sdk._metrics.export import (
2124
ConsoleMetricExporter,
@@ -27,7 +30,43 @@
2730
provider = MeterProvider(metric_readers=[reader])
2831
set_meter_provider(provider)
2932

33+
34+
def observable_counter_func() -> Iterable[Measurement]:
35+
yield Measurement(1, {})
36+
37+
38+
def observable_up_down_counter_func() -> Iterable[Measurement]:
39+
yield Measurement(-10, {})
40+
41+
42+
def observable_gauge_func() -> Iterable[Measurement]:
43+
yield Measurement(9, {})
44+
45+
3046
meter = get_meter_provider().get_meter("getting-started", "0.1.2")
31-
counter = meter.create_counter("first_counter")
47+
48+
# Counter
49+
counter = meter.create_counter("counter")
3250
counter.add(1)
33-
# TODO: fill in details for additional metrics
51+
52+
# Async Counter
53+
observable_counter = meter.create_observable_counter(
54+
"observable_counter", observable_counter_func
55+
)
56+
57+
# UpDownCounter
58+
updown_counter = meter.create_up_down_counter("updown_counter")
59+
updown_counter.add(1)
60+
updown_counter.add(-5)
61+
62+
# Async UpDownCounter
63+
observable_updown_counter = meter.create_observable_up_down_counter(
64+
"observable_updown_counter", observable_up_down_counter_func
65+
)
66+
67+
# Histogram
68+
histogram = meter.create_histogram("histogram")
69+
histogram.record(99.9)
70+
71+
# Async Gauge
72+
gauge = meter.create_observable_gauge("gauge", observable_gauge_func)

0 commit comments

Comments
 (0)