Skip to content

Commit

Permalink
docs: Update readme's to include new errors attributes (#393)
Browse files Browse the repository at this point in the history 
<!--
Thank you for contributing to the project! 💜
Please see our [OSS process
document](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md#)
to get an idea of how we operate.
-->

## Short description of the changes
We have added new attributes to `GlobalErrorsInstrumentation`, updated
READMEs to reflect that.

## How to verify that this has the expected result
Check READMEs.
  • Loading branch information
@jairo-mendoza
jairo-mendoza authored Nov 19, 2024
1 parent 58d7048 commit fb00fb1
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
View file
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

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
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

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

0 comments on commit fb00fb1

Please sign in to comment.