Skip to content

Commit c00c56c

Browse files
authored
Update the organization of internal telemetry page (#5245)
1 parent 1de4548 commit c00c56c

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

content/en/docs/collector/internal-telemetry.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -282,34 +282,48 @@ libraries. {{% /alert %}}
282282
| `rpc_server_response_size` | Measures the size of RPC response messages (uncompressed). | Histogram |
283283
| `rpc_server_responses_per_rpc` | Measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs. | Histogram |
284284

285-
### Telemetry maturity levels
285+
### Events observable with internal logs
286+
287+
The Collector logs the following internal events:
288+
289+
- A Collector instance starts or stops.
290+
- Data dropping begins due to throttling for a specified reason, such as local
291+
saturation, downstream saturation, downstream unavailable, etc.
292+
- Data dropping due to throttling stops.
293+
- Data dropping begins due to invalid data. A sample of the invalid data is
294+
included.
295+
- Data dropping due to invalid data stops.
296+
- A crash is detected, differentiated from a clean stop. Crash data is included
297+
if available.
298+
299+
## Telemetry maturity levels
286300

287-
#### Traces
301+
### Traces
288302

289303
Tracing instrumentation is still under active development, and changes might be
290304
made to span names, attached attributes, instrumented endpoints, or other
291305
aspects of the telemetry. Until this feature graduates to stable, there are no
292306
guarantees of backwards compatibility for tracing instrumentation.
293307

294-
#### Metrics
308+
### Metrics
295309

296310
The Collector's metrics follow a four-stage lifecycle:
297311

298312
> Alpha metric → Stable metric → Deprecated metric → Deleted metric
299313

300-
##### Alpha
314+
#### Alpha
301315

302316
Alpha metrics have no stability guarantees. These metrics can be modified or
303317
deleted at any time.
304318

305-
##### Stable
319+
#### Stable
306320

307321
Stable metrics are guaranteed to not change. This means:
308322

309323
- A stable metric without a deprecated signature will not be deleted or renamed.
310324
- A stable metric's type and attributes will not be modified.
311325

312-
##### Deprecated
326+
#### Deprecated
313327

314328
Deprecated metrics are slated for deletion but are still available for use. The
315329
description of these metrics include an annotation about the version in which
@@ -331,29 +345,15 @@ After deprecation:
331345
otelcol_exporter_queue_size 0
332346
```
333347

334-
##### Deleted
348+
#### Deleted
335349

336350
Deleted metrics are no longer published and cannot be used.
337351

338-
#### Logs
352+
### Logs
339353

340354
Individual log entries and their formatting might change from one release to the
341355
next. There are no stability guarantees at this time.
342356

343-
### Events observable with internal logs
344-
345-
The Collector logs the following internal events:
346-
347-
- A Collector instance starts or stops.
348-
- Data dropping begins due to throttling for a specified reason, such as local
349-
saturation, downstream saturation, downstream unavailable, etc.
350-
- Data dropping due to throttling stops.
351-
- Data dropping begins due to invalid data. A sample of the invalid data is
352-
included.
353-
- Data dropping due to invalid data stops.
354-
- A crash is detected, differentiated from a clean stop. Crash data is included
355-
if available.
356-
357357
## Use internal telemetry to monitor the Collector
358358

359359
This section recommends best practices for monitoring the Collector using its

0 commit comments

Comments
 (0)