-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(dev-docs): Add metrics telemetry specs #15178
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
chargome
wants to merge
9
commits into
master
Choose a base branch
from
cg-dev-docs-metrics
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3957c4f
add metrics docs
chargome 3cd9dc2
update resources
chargome 4ca5e7b
Update develop-docs/sdk/telemetry/metrics.mdx
chargome 8058f51
.
chargome 4eb6bc8
use count
chargome 80f1227
update docs for flag
chargome da457fc
add note on sendDefaultPii
chargome 7b06da1
user agent parsing
chargome af220b6
one more increment leftover
chargome File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -457,6 +457,48 @@ _None_ | |||||
|
||||||
_None_ | ||||||
|
||||||
### Trace Metric | ||||||
|
||||||
Item type `"trace_metric"` contains an array of metric payloads encoded as JSON. This allows for multiple metric payloads to be sent in a single envelope item. | ||||||
|
||||||
Only a single trace_metric container is allowed per envelope. The `item_count` field in the envelope item header must match the amount of metrics sent, it's not optional. A `content_type` field in the envelope item header must be set to `application/vnd.sentry.items.trace_metric+json`. | ||||||
|
||||||
It's okay to mix metrics from different traces into the same trace_metric envelope item, but if you do, you MUST not attach a DSC (dynamic sampling context) to the envelope header. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
See the <Link to="/sdk/telemetry/metrics">Metrics</Link> documentation for the payload | ||||||
details. For an example `trace_metric` envelope, see [Appendix A of the Metrics documentation](/sdk/telemetry/metrics#appendix-a-example-trace_metric-envelope). | ||||||
|
||||||
Example: | ||||||
|
||||||
```json | ||||||
{ | ||||||
"type": "trace_metric", | ||||||
"item_count": 5, | ||||||
"content_type": "application/vnd.sentry.items.trace_metric+json" | ||||||
} | ||||||
{ | ||||||
"items": [{..metric..}, {..metric..}, {..metric..}, {..metric..}, {..metric..}] | ||||||
} | ||||||
``` | ||||||
|
||||||
**Constraints:** | ||||||
|
||||||
_None_ | ||||||
|
||||||
**Envelope Headers:** | ||||||
|
||||||
_None_ | ||||||
|
||||||
**Additional Item Headers:** | ||||||
|
||||||
`item_count` | ||||||
|
||||||
: **integer, required.** The number of metric entries in the envelope. | ||||||
|
||||||
`content_type` | ||||||
|
||||||
: **string, required.** The content type of the metric entries. Must be `application/vnd.sentry.items.trace_metric+json`. | ||||||
|
||||||
### Reserved Types | ||||||
|
||||||
Reserved types may not be written by any implementation. They are reserved for | ||||||
|
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.