RUM-12403 Adds documentation for iOS manual keeping/dropping traces.#34163
Merged
RUM-12403 Adds documentation for iOS manual keeping/dropping traces.#34163
Conversation
Contributor
Preview links (active after the
|
arroz
force-pushed
the
miguel.arroz/ios-manually-keep-drop-traces
branch
from
65366b7 to
2130d8a
Compare
arroz
force-pushed
the
miguel.arroz/ios-manually-keep-drop-traces
branch
from
2130d8a to
07e8283
Compare
arroz
added
under_review
simaoseica-dd
approved these changes
Jan 28, 2026
arroz
removed
the
under_review
maycmlee
reviewed
Jan 28, 2026
Contributor
maycmlee
left a comment
maycmlee
left a comment
There was a problem hiding this comment.
Some suggestions and a question
| {{< /tabs >}} | ||
|
|
||
| 8. (Optional) To distribute traces between your environments, for example frontend - backend, you can either do it manually or leverage our auto instrumentation. In both cases, you can opt to inject the trace context into all requests or only into the sampled ones. A sampling of 100% is applied by default. | ||
| 8. (Optional) Override a sampling decision by forcing a trace to be kept or dropped. For example, always keep a trace of a critical transaction, or always drop unnecessary, repetitive traces. |
Contributor
There was a problem hiding this comment.
Suggested change
| 8. (Optional) Override a sampling decision by forcing a trace to be kept or dropped. For example, always keep a trace of a critical transaction, or always drop unnecessary, repetitive traces. | |
| 8. (Optional) Override a sampling decision by forcing a trace to be kept or dropped. For example, always keep a critical transaction's trace, or always drop unnecessary, repetitive traces. |
| 8. (Optional) To distribute traces between your environments, for example frontend - backend, you can either do it manually or leverage our auto instrumentation. In both cases, you can opt to inject the trace context into all requests or only into the sampled ones. A sampling of 100% is applied by default. | ||
| 8. (Optional) Override a sampling decision by forcing a trace to be kept or dropped. For example, always keep a trace of a critical transaction, or always drop unnecessary, repetitive traces. | ||
|
|
||
| Manually keep a trace: |
Contributor
There was a problem hiding this comment.
Are these commands the user runs?
Suggested change
| Manually keep a trace: | |
| To manually keep a trace: |
Contributor
Author
There was a problem hiding this comment.
They are APIs, not commands. The APIs are similar to https://docs.datadoghq.com/tracing/trace_pipeline/ingestion_mechanisms/?tab=java#force-keep-and-drop but in the context of the iOS SDK (agent-less).
| 8. (Optional) To distribute traces between your environments, for example frontend - backend, you can either do it manually or leverage our auto instrumentation. In both cases, you can opt to inject the trace context into all requests or only into the sampled ones. A sampling of 100% is applied by default. | ||
| 8. (Optional) Override a sampling decision by forcing a trace to be kept or dropped. For example, always keep a trace of a critical transaction, or always drop unnecessary, repetitive traces. | ||
|
|
||
| Manually keep a trace: |
Contributor
There was a problem hiding this comment.
Right now this section looks like it's not part of step 8. Indenting the text and tabs will fix this. Let me know if you need any help!
| {{< /tabs >}} | ||
|
|
||
| <div class="alert alert-danger"> | ||
| Always call `keepTrace()` or `dropTrace()` on a root span before child spans are created, and before any context propagation. Otherwise, the system can't ensure consistency, resulting in partial traces being ingested. |
Contributor
There was a problem hiding this comment.
Suggested change
| Always call `keepTrace()` or `dropTrace()` on a root span before child spans are created, and before any context propagation. Otherwise, the system can't ensure consistency, resulting in partial traces being ingested. | |
| Always call <code>keepTrace()</code> or <code>dropTrace()</code> on a root span before child spans are created, and before any context propagation. Otherwise, the system can't ensure consistency, resulting in partial traces being ingested. |
| Always call `keepTrace()` or `dropTrace()` on a root span before child spans are created, and before any context propagation. Otherwise, the system can't ensure consistency, resulting in partial traces being ingested. | ||
| </div> | ||
|
|
||
| 9. (Optional) To distribute traces between your environments, for example frontend - backend, you can either do it manually or leverage our auto instrumentation. In both cases, you can opt to inject the trace context into all requests or only into the sampled ones. A sampling of 100% is applied by default. |
Contributor
There was a problem hiding this comment.
Suggested change
| 9. (Optional) To distribute traces between your environments, for example frontend - backend, you can either do it manually or leverage our auto instrumentation. In both cases, you can opt to inject the trace context into all requests or only into the sampled ones. A sampling of 100% is applied by default. | |
| 9. (Optional) To distribute traces between your environments, for example from frontend to backend, you can either do it manually or use auto instrumentation. In both cases, you can opt to inject the trace context into all requests or only into the sampled ones. A sampling of 100% is applied by default. |
Contributor
Author
There was a problem hiding this comment.
I applied your suggestions. However, the indenting is now different from the rest of the page… let me know if I should fix the entire page, or revert it to make it consistent. FWIW it looks way better the way you suggested, I myself had trouble reading the previously step 8 (now, 9) and making sense of what was part of it and what wasn't.
* indent steps * fix lines
maycmlee
approved these changes
Feb 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Documenting iOS SDK APIs for manually keeping and dropping traces.
Merge readiness: