|
| 1 | +/* |
| 2 | + * Copyright The OpenTelemetry Authors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +/* |
| 7 | + * DO NOT EDIT, this is an Auto-generated file from: |
| 8 | + * buildscripts/semantic-convention/templates/registry/semantic_attributes-h.j2 |
| 9 | + */ |
| 10 | + |
| 11 | +#pragma once |
| 12 | + |
| 13 | +#include "opentelemetry/common/macros.h" |
| 14 | +#include "opentelemetry/version.h" |
| 15 | + |
| 16 | +OPENTELEMETRY_BEGIN_NAMESPACE |
| 17 | +namespace semconv |
| 18 | +{ |
| 19 | +namespace code |
| 20 | +{ |
| 21 | + |
| 22 | +/** |
| 23 | + * The column number in @code code.file.path @endcode best representing the operation. It SHOULD |
| 24 | + * point within the code unit named in @code code.function.name @endcode. This attribute MUST NOT be |
| 25 | + * used on the Profile signal since the data is already captured in 'message Line'. This constraint |
| 26 | + * is imposed to prevent redundancy and maintain data integrity. |
| 27 | + */ |
| 28 | +static constexpr const char *kCodeColumnNumber = "code.column.number"; |
| 29 | + |
| 30 | +/** |
| 31 | + * The source code file name that identifies the code unit as uniquely as possible (preferably an |
| 32 | + * absolute file path). This attribute MUST NOT be used on the Profile signal since the data is |
| 33 | + * already captured in 'message Function'. This constraint is imposed to prevent redundancy and |
| 34 | + * maintain data integrity. |
| 35 | + */ |
| 36 | +static constexpr const char *kCodeFilePath = "code.file.path"; |
| 37 | + |
| 38 | +/** |
| 39 | + * The method or function fully-qualified name without arguments. The value should fit the natural |
| 40 | + * representation of the language runtime, which is also likely the same used within @code |
| 41 | + * code.stacktrace @endcode attribute value. This attribute MUST NOT be used on the Profile signal |
| 42 | + * since the data is already captured in 'message Function'. This constraint is imposed to prevent |
| 43 | + * redundancy and maintain data integrity. <p> Values and format depends on each language runtime, |
| 44 | + * thus it is impossible to provide an exhaustive list of examples. The values are usually the same |
| 45 | + * (or prefixes of) the ones found in native stack trace representation stored in |
| 46 | + * @code code.stacktrace @endcode without information on arguments. |
| 47 | + * <p> |
| 48 | + * Examples: |
| 49 | + * <ul> |
| 50 | + * <li>Java method: @code com.example.MyHttpService.serveRequest @endcode</li> |
| 51 | + * <li>Java anonymous class method: @code com.mycompany.Main$1.myMethod @endcode</li> |
| 52 | + * <li>Java lambda method: @code com.mycompany.Main$$Lambda/0x0000748ae4149c00.myMethod |
| 53 | + * @endcode</li> <li>PHP function: @code GuzzleHttp\Client::transfer @endcode</li> <li>Go function: |
| 54 | + * @code github.com/my/repo/pkg.foo.func5 @endcode</li> <li>Elixir: @code OpenTelemetry.Ctx.new |
| 55 | + * @endcode</li> <li>Erlang: @code opentelemetry_ctx:new @endcode</li> <li>Rust: @code |
| 56 | + * playground::my_module::my_cool_func @endcode</li> <li>C function: @code fopen @endcode</li> |
| 57 | + * </ul> |
| 58 | + */ |
| 59 | +static constexpr const char *kCodeFunctionName = "code.function.name"; |
| 60 | + |
| 61 | +/** |
| 62 | + * The line number in @code code.file.path @endcode best representing the operation. It SHOULD point |
| 63 | + * within the code unit named in @code code.function.name @endcode. This attribute MUST NOT be used |
| 64 | + * on the Profile signal since the data is already captured in 'message Line'. This constraint is |
| 65 | + * imposed to prevent redundancy and maintain data integrity. |
| 66 | + */ |
| 67 | +static constexpr const char *kCodeLineNumber = "code.line.number"; |
| 68 | + |
| 69 | +/** |
| 70 | + * A stacktrace as a string in the natural representation for the language runtime. The |
| 71 | + * representation is identical to <a |
| 72 | + * href="/docs/exceptions/exceptions-spans.md#stacktrace-representation">@code exception.stacktrace |
| 73 | + * @endcode</a>. This attribute MUST NOT be used on the Profile signal since the data is already |
| 74 | + * captured in 'message Location'. This constraint is imposed to prevent redundancy and maintain |
| 75 | + * data integrity. |
| 76 | + */ |
| 77 | +static constexpr const char *kCodeStacktrace = "code.stacktrace"; |
| 78 | + |
| 79 | +} // namespace code |
| 80 | +} // namespace semconv |
| 81 | +OPENTELEMETRY_END_NAMESPACE |
0 commit comments