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

Add semantic conventions for logs and errors #432

Closed
wants to merge 3 commits into from
+43 −0
Closed

Add semantic conventions for logs and errors #432

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a96847
Add semantic conventions for errors
mwear Jan 25, 2020
b90e199
Update error.type description
mwear Jan 29, 2020
448ec1d
Extend to support logs
vmihailenco Jan 31, 2020
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
43 changes: 43 additions & 0 deletions specification/data-error-semantic-conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Semantic conventions for logs and errors

This document defines semantic conventions for recording logs and errors.

## Recording a Log

A log SHOULD be recorded as an `Event` on the span during which it occurred.
The name of the event MUST be `"log"`.

## Attributes

The table below indicates which attributes should be added to the `Event` and
their types.

| Attribute name | Type | Notes and examples | Required? |
| :------------- | :--------- | :----------------------------------------------------------- | :-------- |
| log.type | String | The source of the log message such as `syslog`, `log4j`, or `log` if the source is unknown | Yes |
| log.severity | String | One of `debug`, `info`, `warn`, `error`, `fatal`, and `panic` | Yes |
| log.message | String | The log message. E.g. `"User not found"` or `"json.Marshal failed"`. | Yes |
| frame.file | String | Filename where the log occurred, e.g. `main.go` | No |
| frame.line | uint32 | Line number where the log occurred, e.g. `10` | No |
| frame.func | String | Function name where the log occurred, e.g. `method1` | No |
| frame.stack | String | An array of stackframes formatted as JSON. The stackframe at which the log occurred should be the first entry. E.g. `[{"func": "method1", "file": "main.go", "line": 10}, {"func": "main", "file": "main.go", "line": 5}]` | No |

## Recording an Error

An error SHOULD be recorded as an `Event` on the span during which it occurred.
The name of the event MUST be `"error"`.

## Attributes

The table below indicates which attributes should be added to the `Event` and
their types.

| Attribute name | Type | Notes and examples | Required? |
| :------------- | :--------- | :----------------------------------------------------------- | :-------- |
| log.type | String | The type of the error (its fully-qualified class name, if applicable). E.g. "java.net.ConnectException", "OSError" | Yes |
| log.severity | String | One of `error`, `fatal`, and `panic` | Yes |
| log.message | String | The error message. E.g. `"Division by zero"`, `"Can't convert 'int' object to str implicitly"` | Yes |
| frame.file | String | Filename where the error occurred, e.g. `main.go` | No |
| frame.line | uint32 | Line number where the error occurred, e.g. `10` | No |
| frame.func | String | Function name where the error occurred, e.g. `method1` | No |
| frame.stack | String | An array of stackframes formatted as JSON. The stackframe at which error log occurred should be the first entry. E.g. `[{"func": "method1", "file": "main.go", "line": 10}, {"func": "main", "file": "main.go", "line": 5}]` | No |