Skip to content

Commit ef79e3c

Browse files
committed
Clarity updates in instrumentation docs
1 parent 21f6c03 commit ef79e3c

File tree

2 files changed

+1
-5
lines changed

2 files changed

+1
-5
lines changed

docs/platforms/javascript/common/tracing/instrumentation/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ In places where you are not able to execute your code in a callback (for example
3636

3737
## Span Hierarchy in the Browser
3838

39-
In browser environments, spans are by default collected in a flat hierarchy where every span is the direct child of the root span. You can opt into a more fine-grained hierarchy but there are trade-offs.
39+
In browser environments, spans are by default collected in a flat hierarchy where every span is the direct child of the root span (the initial operation that kicks off the entire trace.). You can opt into a more fine-grained hierarchy but there are trade-offs.
4040

4141
The key reason for keeping a flat hierarchy is because in browsers it's impossible to reliably keep track of the active span across asynchronous boundaries. This means that if multiple asynchronous operations are started in parallel, it is not possible to determine which span is the parent of which child span. Imagine the following example:
4242

docs/platforms/javascript/common/tracing/span-metrics/index.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,6 @@ Sentry.init({
102102
- Use clear, consistent naming patterns
103103
- Include the metric category (examples: `db`, `cache`, `http`)
104104
- Use snake_case for metric names
105-
- Avoid high-cardinality values in metric names
106105

107106
2. **Data Types**
108107
- Use appropriate numeric types for measurements
@@ -111,14 +110,11 @@ Sentry.init({
111110
- Use arrays when grouping related values
112111

113112
3. **Performance Considerations**
114-
- Avoid adding too many metrics to a single span
115113
- Consider the overhead of metric collection
116114
- Use sampling when collecting high-frequency metrics
117115
- Balance metric granularity with system performance
118116

119117
4. **Debugging and Monitoring**
120-
- Include relevant error and status information
121-
- Add timestamps for important events
122118
- Include correlation IDs for related operations
123119
- Add context that helps with troubleshooting
124120

0 commit comments

Comments
 (0)