Skip to content

Commit 6ec62a1

Browse files
docs(develop-docs): Add minimal API with Close(timeout) to telemetry processor
Addresses PR feedback from #16637 where Close(timeout) was missing from the minimal API definition. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 146dd00 commit 6ec62a1

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

  • develop-docs/sdk/foundations/processing/telemetry-processor

develop-docs/sdk/foundations/processing/telemetry-processor/index.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ flowchart LR
2020
TelemetryProcessor -- sendEnvelope --> Transport
2121
```
2222

23+
The telemetry processor **SHOULD** expose the following minimal API:
24+
25+
- `Add(item)` — Adds a telemetry item to the processor.
26+
- `Flush(timeout)` — Flushes all buffered data to the transport within the given timeout.
27+
- `Close(timeout)` — Flushes all buffered data and closes the processor within the given timeout.
28+
29+
The telemetry processor **MUST** work with existing transport implementations.
30+
2331
SDKs **SHOULD** only add the telemetry processor for high-volume data (spans, logs, metrics). SDKs without these features **MAY** omit it. Once added, SDK clients **SHOULD** forward all data to the processor, not the transport. During migration, SDKs **MAY** temporarily send only some telemetry data through the processor.
2432

2533
The telemetry processor consists of two major components:

0 commit comments

Comments
 (0)