Class ExceptionIncubatingAttributes

java.lang.Object
io.opentelemetry.semconv.incubating.ExceptionIncubatingAttributes

public final class ExceptionIncubatingAttributes extends Object
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final io.opentelemetry.api.common.AttributeKey<Boolean>
    Deprecated.
    deprecated in favor of stable ExceptionAttributes.EXCEPTION_ESCAPED attribute.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Deprecated.
    deprecated in favor of stable ExceptionAttributes.EXCEPTION_MESSAGE attribute.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Deprecated.
    deprecated in favor of stable ExceptionAttributes.EXCEPTION_STACKTRACE attribute.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Deprecated.
    deprecated in favor of stable ExceptionAttributes.EXCEPTION_TYPE attribute.
  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • EXCEPTION_ESCAPED

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Boolean> EXCEPTION_ESCAPED
      Deprecated.
      deprecated in favor of stable ExceptionAttributes.EXCEPTION_ESCAPED attribute.
      SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span.

      Notes:

      An exception is considered to have escaped (or left) the scope of a span, if that span is ended while the exception is still logically "in flight". This may be actually "in flight" in some languages (e.g. if the exception is passed to a Context manager's __exit__ method in Python) but will usually be caught at the point of recording the exception in most languages.

      It is usually not possible to determine at the point where an exception is thrown whether it will escape the scope of a span. However, it is trivial to know that an exception will escape, if one checks for an active exception just before ending the span, as done in the example for recording span exceptions.

      It follows that an exception may still escape the scope of the span even if the exception.escaped attribute was not set or set to false, since the event might have been recorded at a time where it was not clear whether the exception will escape.

    • EXCEPTION_MESSAGE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> EXCEPTION_MESSAGE
      Deprecated.
      deprecated in favor of stable ExceptionAttributes.EXCEPTION_MESSAGE attribute.
      The exception message.

    • EXCEPTION_STACKTRACE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> EXCEPTION_STACKTRACE
      Deprecated.
      deprecated in favor of stable ExceptionAttributes.EXCEPTION_STACKTRACE attribute.
      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.

    • EXCEPTION_TYPE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> EXCEPTION_TYPE
      Deprecated.
      deprecated in favor of stable ExceptionAttributes.EXCEPTION_TYPE attribute.
      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.