Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions generated/attributes/browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- [Stable Attributes](#stable-attributes)
- [browser.name](#browsername)
- [browser.report.type](#browserreporttype)
- [browser.script.invoker](#browserscriptinvoker)
- [browser.script.invoker_type](#browserscriptinvoker_type)
- [browser.script.source_char_position](#browserscriptsource_char_position)
Expand All @@ -22,6 +23,17 @@ The name of the browser.
| Exists in OpenTelemetry | No |
| Example | `Chrome` |

### browser.report.type

A browser report sent via reporting API..

| Property | Value |
| --- | --- |
| Type | `string` |
| Has PII | false |
| Exists in OpenTelemetry | No |
| Example | `network-error` |

### browser.script.invoker

How a script was called in the browser.
Expand Down
1 change: 1 addition & 0 deletions generated/attributes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ This directory contains documentation for all available attributes.
- [`logger` Attributes](./logger.md)
- [`messaging` Attributes](./messaging.md)
- [`navigation` Attributes](./navigation.md)
- [`nel` Attributes](./nel.md)
- [`net` Attributes](./net.md)
- [`network` Attributes](./network.md)
- [`os` Attributes](./os.md)
Expand Down
68 changes: 68 additions & 0 deletions generated/attributes/nel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<!-- THIS FILE IS AUTO-GENERATED. DO NOT EDIT DIRECTLY. -->

# Nel Attributes

- [Stable Attributes](#stable-attributes)
- [nel.elapsed_time](#nelelapsed_time)
- [nel.phase](#nelphase)
- [nel.referrer](#nelreferrer)
- [nel.sampling_function](#nelsampling_function)
- [nel.type](#neltype)

## Stable Attributes

### nel.elapsed_time

The elapsed number of milliseconds between the start of the resource fetch and when it was completed or aborted by the user agent.

| Property | Value |
| --- | --- |
| Type | `integer` |
| Has PII | false |
| Exists in OpenTelemetry | No |
| Example | `100` |

### nel.phase

If request failed, the phase of its network error. If request succeeded, "application".

| Property | Value |
| --- | --- |
| Type | `string` |
| Has PII | false |
| Exists in OpenTelemetry | No |
| Example | `application` |

### nel.referrer

request's referrer, as determined by the referrer policy associated with its client.

| Property | Value |
| --- | --- |
| Type | `string` |
| Has PII | false |
| Exists in OpenTelemetry | No |
| Example | `https://example.com/foo?bar=baz` |

### nel.sampling_function

The sampling function used to determine if the request should be sampled.

| Property | Value |
| --- | --- |
| Type | `double` |
| Has PII | false |
| Exists in OpenTelemetry | No |
| Example | `0.5` |

### nel.type

If request failed, the type of its network error. If request succeeded, "ok".

| Property | Value |
| --- | --- |
| Type | `string` |
| Has PII | false |
| Exists in OpenTelemetry | No |
| Example | `dns.unreachable` |

2 changes: 1 addition & 1 deletion generated/attributes/sentry.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ The operation of a span.

### sentry.origin

The origin of a span.
The origin of the instrumentation (e.g. span, log, etc.)

| Property | Value |
| --- | --- |
Expand Down
134 changes: 133 additions & 1 deletion javascript/sentry-conventions/src/attributes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -746,6 +746,26 @@ export const BROWSER_NAME = 'browser.name';
*/
export type BROWSER_NAME_TYPE = string;

// Path: model/attributes/browser/browser__report__type.json

/**
* A browser report sent via reporting API.. `browser.report.type`
*
* Attribute Value Type: `string` {@link BROWSER_REPORT_TYPE_TYPE}
*
* Contains PII: false
*
* Attribute defined in OTEL: No
*
* @example "network-error"
*/
export const BROWSER_REPORT_TYPE = 'browser.report.type';

/**
* Type for {@link BROWSER_REPORT_TYPE} browser.report.type
*/
export type BROWSER_REPORT_TYPE_TYPE = string;

// Path: model/attributes/browser/browser__script__invoker.json

/**
Expand Down Expand Up @@ -3882,6 +3902,106 @@ export const NAVIGATION_TYPE = 'navigation.type';
*/
export type NAVIGATION_TYPE_TYPE = string;

// Path: model/attributes/nel/nel__elapsed_time.json

/**
* The elapsed number of milliseconds between the start of the resource fetch and when it was completed or aborted by the user agent. `nel.elapsed_time`
*
* Attribute Value Type: `number` {@link NEL_ELAPSED_TIME_TYPE}
*
* Contains PII: false
*
* Attribute defined in OTEL: No
*
* @example 100
*/
export const NEL_ELAPSED_TIME = 'nel.elapsed_time';

/**
* Type for {@link NEL_ELAPSED_TIME} nel.elapsed_time
*/
export type NEL_ELAPSED_TIME_TYPE = number;

// Path: model/attributes/nel/nel__phase.json

/**
* If request failed, the phase of its network error. If request succeeded, "application". `nel.phase`
*
* Attribute Value Type: `string` {@link NEL_PHASE_TYPE}
*
* Contains PII: false
*
* Attribute defined in OTEL: No
*
* @example "application"
*/
export const NEL_PHASE = 'nel.phase';

/**
* Type for {@link NEL_PHASE} nel.phase
*/
export type NEL_PHASE_TYPE = string;

// Path: model/attributes/nel/nel__referrer.json

/**
* request's referrer, as determined by the referrer policy associated with its client. `nel.referrer`
*
* Attribute Value Type: `string` {@link NEL_REFERRER_TYPE}
*
* Contains PII: false
*
* Attribute defined in OTEL: No
*
* @example "https://example.com/foo?bar=baz"
*/
export const NEL_REFERRER = 'nel.referrer';

/**
* Type for {@link NEL_REFERRER} nel.referrer
*/
export type NEL_REFERRER_TYPE = string;

// Path: model/attributes/nel/nel__sampling_function.json

/**
* The sampling function used to determine if the request should be sampled. `nel.sampling_function`
*
* Attribute Value Type: `number` {@link NEL_SAMPLING_FUNCTION_TYPE}
*
* Contains PII: false
*
* Attribute defined in OTEL: No
*
* @example 0.5
*/
export const NEL_SAMPLING_FUNCTION = 'nel.sampling_function';

/**
* Type for {@link NEL_SAMPLING_FUNCTION} nel.sampling_function
*/
export type NEL_SAMPLING_FUNCTION_TYPE = number;

// Path: model/attributes/nel/nel__type.json

/**
* If request failed, the type of its network error. If request succeeded, "ok". `nel.type`
*
* Attribute Value Type: `string` {@link NEL_TYPE_TYPE}
*
* Contains PII: false
*
* Attribute defined in OTEL: No
*
* @example "dns.unreachable"
*/
export const NEL_TYPE = 'nel.type';

/**
* Type for {@link NEL_TYPE} nel.type
*/
export type NEL_TYPE_TYPE = string;

// Path: model/attributes/net/net__host__ip.json

/**
Expand Down Expand Up @@ -5119,7 +5239,7 @@ export type SENTRY_OP_TYPE = string;
// Path: model/attributes/sentry/sentry__origin.json

/**
* The origin of a span. `sentry.origin`
* The origin of the instrumentation (e.g. span, log, etc.) `sentry.origin`
*
* Attribute Value Type: `string` {@link SENTRY_ORIGIN_TYPE}
*
Expand Down Expand Up @@ -6029,6 +6149,7 @@ export type Attributes = {
[APP_START_TYPE]?: APP_START_TYPE_TYPE;
[BLOCKED_MAIN_THREAD]?: BLOCKED_MAIN_THREAD_TYPE;
[BROWSER_NAME]?: BROWSER_NAME_TYPE;
[BROWSER_REPORT_TYPE]?: BROWSER_REPORT_TYPE_TYPE;
[BROWSER_SCRIPT_INVOKER]?: BROWSER_SCRIPT_INVOKER_TYPE;
[BROWSER_SCRIPT_INVOKER_TYPE]?: BROWSER_SCRIPT_INVOKER_TYPE_TYPE;
[BROWSER_SCRIPT_SOURCE_CHAR_POSITION]?: BROWSER_SCRIPT_SOURCE_CHAR_POSITION_TYPE;
Expand Down Expand Up @@ -6153,6 +6274,11 @@ export type Attributes = {
[MESSAGING_OPERATION_TYPE]?: MESSAGING_OPERATION_TYPE_TYPE;
[MESSAGING_SYSTEM]?: MESSAGING_SYSTEM_TYPE;
[NAVIGATION_TYPE]?: NAVIGATION_TYPE_TYPE;
[NEL_ELAPSED_TIME]?: NEL_ELAPSED_TIME_TYPE;
[NEL_PHASE]?: NEL_PHASE_TYPE;
[NEL_REFERRER]?: NEL_REFERRER_TYPE;
[NEL_SAMPLING_FUNCTION]?: NEL_SAMPLING_FUNCTION_TYPE;
[NEL_TYPE]?: NEL_TYPE_TYPE;
[NETWORK_LOCAL_ADDRESS]?: NETWORK_LOCAL_ADDRESS_TYPE;
[NETWORK_LOCAL_PORT]?: NETWORK_LOCAL_PORT_TYPE;
[NETWORK_PEER_ADDRESS]?: NETWORK_PEER_ADDRESS_TYPE;
Expand Down Expand Up @@ -6271,6 +6397,7 @@ export type FullAttributes = {
[APP_START_TYPE]?: APP_START_TYPE_TYPE;
[BLOCKED_MAIN_THREAD]?: BLOCKED_MAIN_THREAD_TYPE;
[BROWSER_NAME]?: BROWSER_NAME_TYPE;
[BROWSER_REPORT_TYPE]?: BROWSER_REPORT_TYPE_TYPE;
[BROWSER_SCRIPT_INVOKER]?: BROWSER_SCRIPT_INVOKER_TYPE;
[BROWSER_SCRIPT_INVOKER_TYPE]?: BROWSER_SCRIPT_INVOKER_TYPE_TYPE;
[BROWSER_SCRIPT_SOURCE_CHAR_POSITION]?: BROWSER_SCRIPT_SOURCE_CHAR_POSITION_TYPE;
Expand Down Expand Up @@ -6421,6 +6548,11 @@ export type FullAttributes = {
[MESSAGING_SYSTEM]?: MESSAGING_SYSTEM_TYPE;
[METHOD]?: METHOD_TYPE;
[NAVIGATION_TYPE]?: NAVIGATION_TYPE_TYPE;
[NEL_ELAPSED_TIME]?: NEL_ELAPSED_TIME_TYPE;
[NEL_PHASE]?: NEL_PHASE_TYPE;
[NEL_REFERRER]?: NEL_REFERRER_TYPE;
[NEL_SAMPLING_FUNCTION]?: NEL_SAMPLING_FUNCTION_TYPE;
[NEL_TYPE]?: NEL_TYPE_TYPE;
[NET_HOST_IP]?: NET_HOST_IP_TYPE;
[NET_HOST_NAME]?: NET_HOST_NAME_TYPE;
[NET_HOST_PORT]?: NET_HOST_PORT_TYPE;
Expand Down
10 changes: 10 additions & 0 deletions model/attributes/browser/browser__report__type.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this PR, you can experiment with the fields in here.

You can also refer to this w3c document.

"key": "browser.report.type",
"brief": "A browser report sent via reporting API..",
"type": "string",
"pii": {
"key": "false"
},
"is_in_otel": false,
"example": "network-error"
}
8 changes: 8 additions & 0 deletions model/attributes/nel/nel__elapsed_time.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"key": "nel.elapsed_time",
"brief": "The elapsed number of milliseconds between the start of the resource fetch and when it was completed or aborted by the user agent.",
"type": "integer",
"pii": { "key": "false" },
"is_in_otel": false,
"example": 100
}
8 changes: 8 additions & 0 deletions model/attributes/nel/nel__phase.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"key": "nel.phase",
"brief": "If request failed, the phase of its network error. If request succeeded, \"application\".",
"type": "string",
"pii": { "key": "false" },
"is_in_otel": false,
"example": "application"
}
8 changes: 8 additions & 0 deletions model/attributes/nel/nel__referrer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"key": "nel.referrer",
"brief": "request's referrer, as determined by the referrer policy associated with its client.",
"type": "string",
"pii": { "key": "false" },
"is_in_otel": false,
"example": "https://example.com/foo?bar=baz"
}
8 changes: 8 additions & 0 deletions model/attributes/nel/nel__sampling_function.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"key": "nel.sampling_function",
"brief": "The sampling function used to determine if the request should be sampled.",
"type": "double",
"pii": { "key": "false" },
"is_in_otel": false,
"example": 0.5
}
8 changes: 8 additions & 0 deletions model/attributes/nel/nel__type.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"key": "nel.type",
"brief": "If request failed, the type of its network error. If request succeeded, \"ok\".",
"type": "string",
"pii": { "key": "false" },
"is_in_otel": false,
"example": "dns.unreachable"
}
2 changes: 1 addition & 1 deletion model/attributes/sentry/sentry__origin.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"key": "sentry.origin",
"brief": "The origin of a span.",
"brief": "The origin of the instrumentation (e.g. span, log, etc.)",
"type": "string",
"pii": {
"key": "false"
Expand Down