NVIDIA DeepStream SDK API Reference

9.2 Release
semconv::error Namespace Reference

Namespaces

 ErrorTypeValues
 

Variables

static constexpr const char * kErrorType = "error.type"
 Describes a class of error the operation ended with. More...
 
static constexpr const char * kErrorMessage = "error.message"
 A message providing more detail about an error in human-readable form. More...
 
static constexpr const char * kErrorType = "error.type"
 Describes a class of error the operation ended with. More...
 
static constexpr const char * kErrorType = "error.type"
 Describes a class of error the operation ended with. More...
 
static constexpr const char * kErrorMessage = "error.message"
 A message providing more detail about an error in human-readable form. More...
 
static constexpr const char * kErrorType = "error.type"
 Describes a class of error the operation ended with. More...
 

Variable Documentation

◆ kErrorMessage [1/2]

constexpr const char* semconv::error::kErrorMessage = "error.message"
staticconstexpr

A message providing more detail about an error in human-readable form.

error.message

should provide additional context and detail about an error. It is NOT RECOMMENDED to duplicate the value of

error.type

in

error.message

. It is also NOT RECOMMENDED to duplicate the value of

exception.message

in

error.message

.

error.message

is NOT RECOMMENDED for metrics or spans due to its unbounded cardinality and overlap with span status.

Definition at line 32 of file includes/opentelemetry/semconv/incubating/error_attributes.h.

◆ kErrorMessage [2/2]

constexpr const char* semconv::error::kErrorMessage = "error.message"
staticconstexpr

A message providing more detail about an error in human-readable form.

error.message

should provide additional context and detail about an error. It is NOT RECOMMENDED to duplicate the value of

error.type

in

error.message

. It is also NOT RECOMMENDED to duplicate the value of

exception.message

in

error.message

.

error.message

is NOT RECOMMENDED for metrics or spans due to its unbounded cardinality and overlap with span status.

Definition at line 32 of file 9.2/includes/opentelemetry/semconv/incubating/error_attributes.h.

◆ kErrorType [1/4]

constexpr const char* semconv::error::kErrorType = "error.type"
staticconstexpr

Describes a class of error the operation ended with.

The

error.type

SHOULD be predictable, and SHOULD have low cardinality.

When

error.type

is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used.

Instrumentations SHOULD document the list of errors they report.

The cardinality of

error.type

within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for

error.type

to have high cardinality at query time when no additional filters are applied.

If the operation has completed successfully, instrumentations SHOULD NOT set

error.type

.

If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), it's RECOMMENDED to:

  • Use a domain-specific attribute
  • Set
    error.type
    to capture all errors, regardless of whether they are defined within the domain-specific set or not.

Definition at line 44 of file includes/opentelemetry/semconv/error_attributes.h.

◆ kErrorType [2/4]

constexpr const char* semconv::error::kErrorType = "error.type"
staticconstexpr

Describes a class of error the operation ended with.

The

error.type

SHOULD be predictable, and SHOULD have low cardinality.

When

error.type

is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used.

Instrumentations SHOULD document the list of errors they report.

The cardinality of

error.type

within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for

error.type

to have high cardinality at query time when no additional filters are applied.

If the operation has completed successfully, instrumentations SHOULD NOT set

error.type

.

If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), it's RECOMMENDED to:

  • Use a domain-specific attribute
  • Set
    error.type
    to capture all errors, regardless of whether they are defined within the domain-specific set or not.

Definition at line 44 of file 9.2/includes/opentelemetry/semconv/error_attributes.h.

◆ kErrorType [3/4]

constexpr const char* semconv::error::kErrorType = "error.type"
staticconstexpr

Describes a class of error the operation ended with.

The

error.type

SHOULD be predictable, and SHOULD have low cardinality.

When

error.type

is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used.

Instrumentations SHOULD document the list of errors they report.

The cardinality of

error.type

within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for

error.type

to have high cardinality at query time when no additional filters are applied.

If the operation has completed successfully, instrumentations SHOULD NOT set

error.type

.

If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), it's RECOMMENDED to:

  • Use a domain-specific attribute
  • Set
    error.type
    to capture all errors, regardless of whether they are defined within the domain-specific set or not.

Definition at line 56 of file includes/opentelemetry/semconv/incubating/error_attributes.h.

◆ kErrorType [4/4]

constexpr const char* semconv::error::kErrorType = "error.type"
staticconstexpr

Describes a class of error the operation ended with.

The

error.type

SHOULD be predictable, and SHOULD have low cardinality.

When

error.type

is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used.

Instrumentations SHOULD document the list of errors they report.

The cardinality of

error.type

within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for

error.type

to have high cardinality at query time when no additional filters are applied.

If the operation has completed successfully, instrumentations SHOULD NOT set

error.type

.

If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), it's RECOMMENDED to:

  • Use a domain-specific attribute
  • Set
    error.type
    to capture all errors, regardless of whether they are defined within the domain-specific set or not.

Definition at line 56 of file 9.2/includes/opentelemetry/semconv/incubating/error_attributes.h.