Skip to content

Commit

Permalink
Remove exception.escaped attribute (as per SIG mtg).
Browse files Browse the repository at this point in the history
  • Loading branch information
Oberon00 committed Aug 11, 2020
1 parent 67e2c98 commit 80ea27d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
4 changes: 2 additions & 2 deletions specification/trace/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -516,8 +516,8 @@ MUST record an exception as an `Event` with the conventions outlined in the

Examples:

- `RecordException(exception: Exception, escaped: boolean? = null)`
- `RecordException(type: String, message: String, stacktrace: String, escaped: boolean?)`
- `RecordException(exception: Exception)`
- `RecordException(type: String, message: String, stacktrace: String)`

### Span lifetime

Expand Down
3 changes: 1 addition & 2 deletions specification/trace/semantic_conventions/exceptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Span span = myTracer.startSpan(/*...*/);
try {
// original code
} catch (Throwable e) {
span.recordException(e, /*escaped=*/true);
span.recordException(e); // We know that the exception is escaping here.
throw e;
} finally {
span.end();
Expand All @@ -60,7 +60,6 @@ their types.
| exception.type | String | The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it. E.g. "java.net.ConnectException", "OSError" | One of `exception.type` or `exception.message` is required |
| exception.message | String | The exception message. E.g. `"Division by zero"`, `"Can't convert 'int' object to str implicitly"` | One of `exception.type` or `exception.message` is required |
| exception.stacktrace | String | A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. E.g. `"Exception in thread \"main\" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)"`. | No |
| exception.escaped | Bool | SHOULD be set to true if the exception event is recoded at a point where it is known that the exception is escaping the scope of the span (e.g. if there is an exception active just before ending the Span). Note that an exception may still leave the scope of the span even if this was not set or set to false, if the event was recorded at an earlier time. | No |

### Stacktrace Representation

Expand Down

0 comments on commit 80ea27d

Please sign in to comment.