Skip to content

Commit

Permalink
rename exceptions.md -> exception-reporting.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@mwear
mwear committed Jul 9, 2020
1 parent c642d00 commit 4a1fbe8
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions specification/trace/exceptions.md → specification/trace/exception-reporting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ The name of the event MUST be `"exception"`.
The table below indicates which attributes should be added to the `Event` and
their types.

| Attribute name | Type | Notes and examples | Required? |
| :---------------- | :----- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------- |
| exception.type | String | The type of the exception (its fully-qualified class name, if applicable). 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 |
| stacktrace | String | A stack trace 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 |
| Attribute name | Type | Notes and examples | Required? |
| :---------------- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------- |
| exception.type | String | The type of the exception (its fully-qualified class name, if applicable). 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 |
| 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 |

### Stacktrace Representation

Expand All @@ -35,7 +35,7 @@ to adopt them if they see fit.
| C# | the return value of [Exception.ToString()][csharp-stacktrace] |
| Go | the return value of [runtime.Stack][go-stacktrace] |

Backends can use the language selected methodology for generating a stacktrace
Backends can use the language specified methodology for generating a stacktrace
combined with platform information from the
[telemetry sdk resource][telemetry-sdk-resource] in order to extract more fine
grained information from a stacktrace, if necessary.
Expand All @@ -45,7 +45,7 @@ grained information from a stacktrace, if necessary.
To facilitate recording an exception languages SHOULD provide a
`Span.RecordException` convenience method. The signature of the method is to be
determined by each language and can be overloaded as appropriate. The method
MUST record an exception as an event with the conventions outlined in this
MUST record an exception as an `Event` with the conventions outlined in this
document.

**Examples:**
Expand Down

0 comments on commit 4a1fbe8

Please sign in to comment.