-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(spans): Create a dedicated attributes page #15557
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
cleptric
wants to merge
3
commits into
master
Choose a base branch
from
attributes
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
3 commits
Select commit
Hold shift + click to select a range
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 |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| --- | ||
| title: Attributes | ||
| sidebar_order: 2 | ||
| --- | ||
|
|
||
| This document defines the format used by Sentry to represent attributes across different telemetry data types (Spans, Logs, Metrics). | ||
|
|
||
| ## Attribute Object Structure | ||
|
|
||
| Attributes are stored as key-value pairs where each value is an object with type information. | ||
|
|
||
| ```json | ||
| { | ||
| "my_attribute": { | ||
| "value": "some value", | ||
| "type": "string" | ||
| }, | ||
| "response_time": { | ||
| "value": 123, | ||
| "unit": "millisecond", | ||
| "type": "integer" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Properties | ||
|
|
||
| | Property | Type | Required | Description | | ||
| |----------|------|----------|-------------| | ||
| | `type` | string | Yes | The data type of the attribute value. | | ||
| | `value` | any | Yes | The actual attribute value, must match the specified type. | | ||
| | `unit` | string | No | The unit of the attribute value. See [Units](#units) for a full list of supported units. | | ||
|
|
||
| ### Supported Types | ||
|
|
||
| The following types are supported: | ||
|
|
||
| - `string` | ||
| - `boolean` | ||
| - `integer` (64-bit signed integer) | ||
| - `double` (64-bit floating point number) | ||
| - `string[]` | ||
| - `boolean[]` | ||
| - `integer[]` | ||
| - `double[]` | ||
|
Comment on lines
+44
to
+45
Member
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. Reminder that we still have to figure out what should happen with mixed number arrays (integers and doubles). Not a blocker though. |
||
|
|
||
| **Note on Integers:** Integers should be 64-bit signed integers. For 64-bit unsigned integers, use the `string` type to avoid overflow issues until unsigned integers are natively supported. | ||
|
|
||
| ## Units | ||
|
|
||
| The following units are [supported by Relay](https://getsentry.github.io/relay/relay_metrics/enum.MetricUnit.html). | ||
|
|
||
| ### Duration Units | ||
|
|
||
| - `nanosecond` | ||
| - `microsecond` | ||
| - `millisecond` | ||
| - `second` | ||
| - `minute` | ||
| - `hour` | ||
| - `day` | ||
| - `week` | ||
|
|
||
| ### Information Units | ||
|
|
||
| - `bit` | ||
| - `byte` | ||
| - `kilobyte` | ||
| - `kibibyte` | ||
| - `megabyte` | ||
| - `mebibyte` | ||
| - `gigabyte` | ||
| - `gibibyte` | ||
| - `terabyte` | ||
| - `tebibyte` | ||
| - `petabyte` | ||
| - `pebibyte` | ||
| - `exabyte` | ||
| - `exbibyte` | ||
|
|
||
| ### Fraction Units | ||
|
|
||
| - `ratio` | ||
| - `percent` | ||
|
|
||
| ## Semantic Conventions | ||
|
|
||
| See [Sentry Conventions](https://github.com/getsentry/sentry-conventions/) for a full list of supported attributes. | ||
|
|
||
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
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
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
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.
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.
Uh oh!
There was an error while loading. Please reload this page.