Skip to content
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.

Sign up for GitHub

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

docs: Update readme's to include new errors attributes #393

Merged
merged 2 commits into from
Nov 19, 2024
Merged

docs: Update readme's to include new errors attributes #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
688d85c
Update readme's to include new errors attributes
jairo-mendoza Nov 19, 2024
f20c037
Forgot last bar for table
jairo-mendoza Nov 19, 2024
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,19 @@ Static fields are added to the [Resource](https://opentelemetry.io/docs/concepts

Fields that can change during the lifetime of the page are instead added to each span in a [SpanProcessor](https://opentelemetry.io/docs/specs/otel/trace/sdk/#span-processor).

#### GlobalErrorsInstrumentationConfig
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wasn't 100% sure where the attributes would fit in the doc, but I think this makes the most sense. I'm open to moving it though!


You can expect the following attributes to be emitted from the global errors instrumentation, unless you have it disabled in your SDK configuration:
| name | status | static? | description | example |
|----------------------------------------------|-----------------|----------|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `exception.stacktrace` | stable | per-span | The entire stacktrace as a string. | ReferenceError: VAR is not defined<br>&nbsp;&nbsp;&nbsp;&nbsp;at main(/index.js:37:18)<br>&nbsp;&nbsp;&nbsp;&nbsp;at <anonymous>(/index.js:68:6)<br>&nbsp;&nbsp;&nbsp;&nbsp;at <anonymous>(/index.js:68:6) |
| `exception.message` | stable | per-span | The exception's message. | VAR is not defined |
| `exception.type` | stable | per-span | The type of exception. | ReferenceError |
| `exception.structured_stacktrace.columns` | custom | per-span | Array of columns extracted from `exception.stacktrace`. | [18, 6, 6] |
| `exception.structured_stacktrace.lines` | custom | per-span | Array of lines extracted from `exception.stacktrace`. | [37, 68, 68] |
| `exception.structured_stacktrace.functions` | custom | per-span | Array of function names extracted from `exception.stacktrace`. | [main, \<anonymous\>, \<anonymous\>] |
| `exception.structured_stacktrace.urls` | custom | per-span | Array of urls or directories extracted from `exception.stacktrace`. | [/index.js, /index.js, /index.js] |

## Migration Practices

This wrapper can change faster than OpenTelemetry, and yet be more stable. This section describes how we do that.
Expand Down
13 changes: 13 additions & 0 deletions packages/honeycomb-opentelemetry-web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,19 @@ Static fields are added to the [Resource](https://opentelemetry.io/docs/concepts

Fields that can change during the lifetime of the page are instead added to each span in a [SpanProcessor](https://opentelemetry.io/docs/specs/otel/trace/sdk/#span-processor).

#### GlobalErrorsInstrumentationConfig
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Seems like we have 2 README's that are the same, adding in the new info here too


You can expect the following attributes to be emitted from the global errors instrumentation, unless you have it disabled in your SDK configuration:
| name | status | static? | description | example |
|----------------------------------------------|-----------------|----------|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `exception.stacktrace` | stable | per-span | The entire stacktrace as a string. | ReferenceError: VAR is not defined<br>&nbsp;&nbsp;&nbsp;&nbsp;at main(/index.js:37:18)<br>&nbsp;&nbsp;&nbsp;&nbsp;at <anonymous>(/index.js:68:6)<br>&nbsp;&nbsp;&nbsp;&nbsp;at <anonymous>(/index.js:68:6) |
| `exception.message` | stable | per-span | The exception's message. | VAR is not defined |
| `exception.type` | stable | per-span | The type of exception. | ReferenceError |
| `exception.structured_stacktrace.columns` | custom | per-span | Array of columns extracted from `exception.stacktrace`. | [18, 6, 6] |
| `exception.structured_stacktrace.lines` | custom | per-span | Array of lines extracted from `exception.stacktrace`. | [37, 68, 68] |
| `exception.structured_stacktrace.functions` | custom | per-span | Array of function names extracted from `exception.stacktrace`. | [main, \<anonymous\>, \<anonymous\>] |
| `exception.structured_stacktrace.urls` | custom | per-span | Array of urls or directories extracted from `exception.stacktrace`. | [/index.js, /index.js, /index.js] |

## Migration Practices

This wrapper can change faster than OpenTelemetry, and yet be more stable. This section describes how we do that.
Expand Down