Skip to content

Commit 5146aa6

Browse files
committed
nits
1 parent 704ed2b commit 5146aa6

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/metrics.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ from `global` and saved for re-use.
4444

4545
The fully qualified module name might be a good option for the Meter name.
4646
Optionally, one may create a meter with version, schema_url, and additional
47-
meter-level attributes as well. Both are shown in below examples.
47+
meter-level attributes as well. Both approaches are demonstrated below.
4848

4949
```rust
5050
use opentelemetry::global;
@@ -67,6 +67,10 @@ let meter = global::meter("my_company.my_product.my_library");
6767

6868
### Instruments
6969

70+
OpenTelemetry defines several types of metric instruments, each optimized for
71+
specific usage patterns. The following table maps OpenTelemetry Specification
72+
instruments to their corresponding Rust SDK types.
73+
7074
:heavy_check_mark: You should understand and pick the right instrument type.
7175

7276
> [!NOTE] Picking the right instrument type for your use case is crucial to
@@ -232,9 +236,9 @@ you create them. Follow these guidelines:
232236
* **Shutdown**: Explicitly call `shutdown` on the `MeterProvider` at the end of
233237
your application to ensure all metrics are properly flushed and exported.
234238

235-
> [!NOTE] If you did not use opentelemetry::global::set_meter_provider to set a
236-
> clone of the MeterProvider as the global provider, then you should be aware
237-
> that dropping the last instance of MeterProvider implicitly call shutdown on
239+
> [!NOTE] If you did not use `opentelemetry::global::set_meter_provider` to set a
240+
> clone of the `MeterProvider` as the global provider, then you should be aware
241+
> that dropping the last instance of `MeterProvider` implicitly calls shutdown on
238242
> the provider.
239243
240244
:heavy_check_mark: Always call `shutdown` on the `MeterProvider` at the end of
@@ -316,6 +320,9 @@ last export is exported, allowing SDK to "forget" previous state.
316320

317321
### Pre-Aggregation
318322

323+
Rather than exporting every individual measurement to the backend, OpenTelemetry
324+
Rust aggregates data locally and only exports the aggregated metrics.
325+
319326
Using the [fruit example](#example), there are six measurements reported during
320327
the time range `(T2, T3]`. Instead of exporting each individual measurement
321328
event, the SDK aggregates them and exports only the summarized results. This

0 commit comments

Comments
 (0)