Skip to content

Latest commit

 

History

History
58 lines (44 loc) · 5.02 KB

exceptions.md

File metadata and controls

58 lines (44 loc) · 5.02 KB

Semantic Conventions for Exceptions

This document defines semantic conventions for recording application exceptions.

Recording an Exception

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

Attributes

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

Stacktrace Representation

The table below, adapted from Google Cloud, includes possible representations of stacktraces in various languages. The table is not meant to be a recommendation for any particular language, although SIGs are free to adopt them if they see fit.

Language Format
C# the return value of Exception.ToString()
Go the return value of runtime.Stack
Java the contents of Throwable.printStackTrace()
Javascript the return value of error.stack as returned by V8
Python the return value of traceback.format_exc()
Ruby the result of Exception.backtrace joined by "\n"

Backends can use the language specified methodology for generating a stacktrace combined with platform information from the telemetry sdk resource in order to extract more fine grained information from a stacktrace, if necessary.