-
-
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
base: master
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| --- | ||
| 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. | ||
cleptric marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Duration Units | ||
|
|
||
| Defaults to `millisecond`. | ||
cleptric marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - `nanosecond` | ||
| - `microsecond` | ||
| - `millisecond` | ||
| - `second` | ||
| - `minute` | ||
| - `hour` | ||
| - `day` | ||
| - `week` | ||
|
|
||
| ### Information Units | ||
|
|
||
| Defaults to `byte`. | ||
|
|
||
| - `bit` | ||
| - `byte` | ||
| - `kilobyte` | ||
| - `kibibyte` | ||
| - `megabyte` | ||
| - `mebibyte` | ||
| - `gigabyte` | ||
| - `gibibyte` | ||
| - `terabyte` | ||
| - `tebibyte` | ||
| - `petabyte` | ||
| - `pebibyte` | ||
| - `exabyte` | ||
| - `exbibyte` | ||
|
|
||
| ### Fraction Units | ||
|
|
||
| Defaults to `ratio`. | ||
|
|
||
| - `ratio` | ||
| - `percent` | ||
|
||
|
|
||
| ## Semantic Conventions | ||
|
|
||
| See [Sentry Conventions](https://github.com/getsentry/sentry-conventions/) for a full list of supported attributes. | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.