File: error_attributes.h

package info (click to toggle)
opentelemetry-cpp 1.23.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,372 kB
  • sloc: cpp: 96,239; sh: 1,766; makefile: 36; python: 31
file content (57 lines) | stat: -rw-r--r-- 1,897 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

/*
 * DO NOT EDIT, this is an Auto-generated file from:
 * buildscripts/semantic-convention/templates/registry/semantic_attributes-h.j2
 */

#pragma once

#include "opentelemetry/common/macros.h"
#include "opentelemetry/version.h"

OPENTELEMETRY_BEGIN_NAMESPACE
namespace semconv
{
namespace error
{

/**
  Describes a class of error the operation ended with.
  <p>
  The @code error.type @endcode SHOULD be predictable, and SHOULD have low cardinality.
  <p>
  When @code error.type @endcode is set to a type (e.g., an exception type), its
  canonical class name identifying the type within the artifact SHOULD be used.
  <p>
  Instrumentations SHOULD document the list of errors they report.
  <p>
  The cardinality of @code error.type @endcode within one instrumentation library SHOULD be low.
  Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
  should be prepared for @code error.type @endcode to have high cardinality at query time when no
  additional filters are applied.
  <p>
  If the operation has completed successfully, instrumentations SHOULD NOT set @code error.type
  @endcode. <p> If a specific domain defines its own set of error identifiers (such as HTTP or gRPC
  status codes), it's RECOMMENDED to: <ul> <li>Use a domain-specific attribute</li> <li>Set @code
  error.type @endcode to capture all errors, regardless of whether they are defined within the
  domain-specific set or not.</li>
  </ul>
 */
static constexpr const char *kErrorType = "error.type";

namespace ErrorTypeValues
{
/**
  A fallback error value to be used when the instrumentation doesn't define a custom value.
 */
static constexpr const char *kOther = "_OTHER";

}  // namespace ErrorTypeValues

}  // namespace error
}  // namespace semconv
OPENTELEMETRY_END_NAMESPACE