You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: develop-docs/sdk/telemetry/spans/implementation.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ sidebar_order: 10
13
13
This document uses key words such as "MUST", "SHOULD", and "MAY" as defined in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt) to indicate requirement levels.
14
14
</Alert>
15
15
16
-
This document provides guidelines for implementing Span-First in SDKs. This is purposefully NOT a full specification. For exact specifications, refer to the other pages under [Spans](./../index).
16
+
This document provides guidelines for implementing Span-First in SDKs. This is purposefully NOT a full specification. For exact specifications, refer to the other pages under [Spans](..).
17
17
18
18
## How To Approach Span-First in SDKs
19
19
@@ -33,9 +33,9 @@ If you're implementing Span-First (as a PoC) in your SDK, take an iterative appr
33
33
- TBD: Some SDKs already have `startSpan` or similar APIs. The migration path is still TBD but a decision can be made at a later stage.
34
34
5. Implement the `captureSpan`[single-span processing pipeline](#single-span-processing-pipeline)
35
35
- Either reuse existing heuristics (e.g. flush when segment span ends) or build a simple span buffer to flush spans (e.g. similar to the existing buffers for logs or metrics).
36
-
- Implementing the more complex [Telemetry Buffer](./../telemetry-buffer/index) can happen at a later stage.
36
+
- Implementing the more complex [Telemetry Buffer](./../../telemetry-buffer) can happen at a later stage.
37
37
6. Achieve data parity with the existing transaction events.
38
-
- Ensure that the data added by integrations, event processors, etc to transaction events is also added to the spans (See [Event Processors](#event-processors)).
38
+
- Ensure that the data added by integrations, event processors, etc to transaction events is also added to the spans (See [Event Processors](#tbd-event-processors)).
39
39
- Most additional data MUST only be added to the segment span. See [Common Attributes](../span-protocol/#common-attribute-keys) for attributes that MUST be added to every span.
40
40
- Mental model: All data our SDKs _automatically_ add to a transaction, MUST also be added to the segment span.
41
41
7. Implement the span telemetry buffer for proper, weighted span flushing. See [Span Buffer](#span-buffer) for more details.
@@ -109,7 +109,7 @@ SDK authors working on Span-First are encouraged to evaluate both options, try t
109
109
110
110
## Span Buffer
111
111
112
-
This section is intentionally short because all buffering specification is being added to the [Telemetry Buffer](../../telemetry-buffer)page.
112
+
This section is intentionally short because all buffering specification is being added to the [Telemetry Buffer](../../telemetry-buffer)page.
113
113
114
114
Some rough pointers:
115
115
- Given that SDKs SHOULD materialize and freeze the DSC as late as possible, the span buffer SHOULD enqueue span instances and at _flush time_ serialize them to JSON.
0 commit comments