WIP

Author: marcalff

api/include/opentelemetry/semconv/attributes/client_attributes.h

@@ -1,5 +1,3 @@
-
-
 /*
  * Copyright The OpenTelemetry Authors
  * SPDX-License-Identifier: Apache-2.0
@@ -23,19 +21,20 @@ namespace client
 
 /**
  * Client address - domain name if available without reverse DNS lookup; otherwise, IP address or
- * Unix domain socket name. Note: When observed from the server side, and when communicating through
+ * Unix domain socket name. <p> When observed from the server side, and when communicating through
  * an intermediary, @code client.address @endcode SHOULD represent the client address behind any
  * intermediaries,  for example proxies, if it's available.
  */
-static const char *kClientAddress = "client.address";
+static constexpr const char *kClientAddress = "client.address";
 
 /**
  * Client port number.
- * Note: When observed from the server side, and when communicating through an intermediary, @code
+ * <p>
+ * When observed from the server side, and when communicating through an intermediary, @code
  * client.port @endcode SHOULD represent the client port behind any intermediaries,  for example
  * proxies, if it's available.
  */
-static const char *kClientPort = "client.port";
+static constexpr const char *kClientPort = "client.port";
 
 }  // namespace client
 }  // namespace semconv

api/include/opentelemetry/semconv/attributes/error_attributes.h

@@ -1,5 +1,3 @@
-
-
 /*
  * Copyright The OpenTelemetry Authors
  * SPDX-License-Identifier: Apache-2.0
@@ -23,7 +21,8 @@ namespace error
 
 /**
  * Describes a class of error the operation ended with.
- * Note: The @code error.type @endcode SHOULD be predictable, and SHOULD have low cardinality.
+ * <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.
@@ -42,34 +41,15 @@ namespace error
  * the domain-specific set or not.</li>
  * </ul>
  */
-static const char *kErrorType = "error.type";
+static constexpr const char *kErrorType = "error.type";
 
-// DEBUG: {"brief": "Describes a class of error the operation ended with.\n", "examples":
-// ["timeout", "java.net.UnknownHostException", "server_certificate_invalid", "500"], "name":
-// "error.type", "note": "The `error.type` SHOULD be predictable, and SHOULD have low
-// cardinality.\n\nWhen `error.type` is set to a type (e.g., an exception type), its\ncanonical
-// class name identifying the type within the artifact SHOULD be used.\n\nInstrumentations SHOULD
-// document the list of errors they report.\n\nThe cardinality of `error.type` within one
-// instrumentation library SHOULD be low.\nTelemetry consumers that aggregate data from multiple
-// instrumentation libraries and applications\nshould be prepared for `error.type` to have high
-// cardinality at query time when no\nadditional filters are applied.\n\nIf the operation has
-// completed successfully, instrumentations SHOULD NOT set `error.type`.\n\nIf a specific domain
-// defines its own set of error identifiers (such as HTTP or gRPC status codes),\nit's RECOMMENDED
-// to:\n\n* Use a domain-specific attribute\n* Set `error.type` to capture all errors, regardless of
-// whether they are defined within the domain-specific set or not.\n", "requirement_level":
-// "recommended", "root_namespace": "error", "stability": "stable", "type": {"allow_custom_values":
-// true, "members": [{"brief": "A fallback error value to be used when the instrumentation doesn't
-// define a custom value.\n", "deprecated": none, "id": "other", "note": none, "stability":
-// "stable", "value": "_OTHER"}]}}
 namespace ErrorTypeValues
 {
 /**
  * A fallback error value to be used when the instrumentation doesn't define a custom value.
  */
-// DEBUG: {"brief": "A fallback error value to be used when the instrumentation doesn't define a
-// custom value.\n", "deprecated": none, "id": "other", "note": none, "stability": "stable",
-// "value": "_OTHER"}
 static constexpr const char *kOther = "_OTHER";
+
 }  // namespace ErrorTypeValues
 
 }  // namespace error

api/include/opentelemetry/semconv/attributes/exception_attributes.h

@@ -1,5 +1,3 @@
-
-
 /*
  * Copyright The OpenTelemetry Authors
  * SPDX-License-Identifier: Apache-2.0
@@ -23,7 +21,7 @@ namespace exception
 
 /**
  * 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. Note: An exception is considered to have escaped (or
+ * exception is escaping the scope of the span. <p> 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 @code __exit__ @endcode method in Python) but will usually be caught at the
@@ -37,24 +35,24 @@ namespace exception
  * since the event might have been recorded at a time where it was not
  * clear whether the exception will escape.
  */
-static const char *kExceptionEscaped = "exception.escaped";
+static constexpr const char *kExceptionEscaped = "exception.escaped";
 
 /**
  * The exception message.
  */
-static const char *kExceptionMessage = "exception.message";
+static constexpr const char *kExceptionMessage = "exception.message";
 
 /**
  * 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.
  */
-static const char *kExceptionStacktrace = "exception.stacktrace";
+static constexpr const char *kExceptionStacktrace = "exception.stacktrace";
 
 /**
  * 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.
  */
-static const char *kExceptionType = "exception.type";
+static constexpr const char *kExceptionType = "exception.type";
 
 }  // namespace exception
 }  // namespace semconv

api/include/opentelemetry/semconv/attributes/http_attributes.h

@@ -1,5 +1,3 @@
-
-
 /*
  * Copyright The OpenTelemetry Authors
  * SPDX-License-Identifier: Apache-2.0
@@ -23,7 +21,7 @@ namespace http
 
 /**
  * HTTP request headers, @code <key> @endcode being the normalized HTTP Header name (lowercase), the
- * value being the header values. Note: Instrumentations SHOULD require an explicit configuration of
+ * value being the header values. <p> Instrumentations SHOULD require an explicit configuration of
  * which headers are to be captured. Including all request headers can be a security risk - explicit
  * configuration helps avoid leaking sensitive information. The @code User-Agent @endcode header is
  * already captured in the @code user_agent.original @endcode attribute. Users MAY explicitly
@@ -32,11 +30,12 @@ namespace http
  * containing a possibly comma-concatenated string, depending on the way the HTTP library provides
  * access to headers.
  */
-static const char *kHttpRequestHeader = "http.request.header";
+static constexpr const char *kHttpRequestHeader = "http.request.header";
 
 /**
  * HTTP request method.
- * Note: HTTP request method value SHOULD be "known" to the instrumentation.
+ * <p>
+ * HTTP request method value SHOULD be "known" to the instrumentation.
  * By default, this convention defines "known" methods as the ones listed in <a
  * href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110</a> and the PATCH method
  * defined in <a href="https://www.rfc-editor.org/rfc/rfc5789.html">RFC5789</a>. <p> If the HTTP
@@ -53,140 +52,100 @@ static const char *kHttpRequestHeader = "http.request.header";
  * instrumentations that do so, MUST also set @code http.request.method_original @endcode to the
  * original value.
  */
-static const char *kHttpRequestMethod = "http.request.method";
+static constexpr const char *kHttpRequestMethod = "http.request.method";
 
 /**
  * Original HTTP method sent by the client in the request line.
  */
-static const char *kHttpRequestMethodOriginal = "http.request.method_original";
+static constexpr const char *kHttpRequestMethodOriginal = "http.request.method_original";
 
 /**
  * The ordinal number of request resending attempt (for any reason, including redirects).
- * Note: The resend count SHOULD be updated each time an HTTP request gets resent by the client,
+ * <p>
+ * The resend count SHOULD be updated each time an HTTP request gets resent by the client,
  * regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503
  * Server Unavailable, network issues, or any other).
  */
-static const char *kHttpRequestResendCount = "http.request.resend_count";
+static constexpr const char *kHttpRequestResendCount = "http.request.resend_count";
 
 /**
  * HTTP response headers, @code <key> @endcode being the normalized HTTP Header name (lowercase),
- * the value being the header values. Note: Instrumentations SHOULD require an explicit
- * configuration of which headers are to be captured. Including all response headers can be a
- * security risk - explicit configuration helps avoid leaking sensitive information. Users MAY
- * explicitly configure instrumentations to capture them even though it is not recommended. The
- * attribute value MUST consist of either multiple header values as an array of strings or a
- * single-item array containing a possibly comma-concatenated string, depending on the way the HTTP
- * library provides access to headers.
- */
-static const char *kHttpResponseHeader = "http.response.header";
+ * the value being the header values. <p> Instrumentations SHOULD require an explicit configuration
+ * of which headers are to be captured. Including all response headers can be a security risk -
+ * explicit configuration helps avoid leaking sensitive information. Users MAY explicitly configure
+ * instrumentations to capture them even though it is not recommended. The attribute value MUST
+ * consist of either multiple header values as an array of strings or a single-item array containing
+ * a possibly comma-concatenated string, depending on the way the HTTP library provides access to
+ * headers.
+ */
+static constexpr const char *kHttpResponseHeader = "http.response.header";
 
 /**
  * <a href="https://tools.ietf.org/html/rfc7231#section-6">HTTP response status code</a>.
  */
-static const char *kHttpResponseStatusCode = "http.response.status_code";
+static constexpr const char *kHttpResponseStatusCode = "http.response.status_code";
 
 /**
  * The matched route, that is, the path template in the format used by the respective server
- * framework. Note: MUST NOT be populated when this is not supported by the HTTP server framework as
+ * framework. <p> MUST NOT be populated when this is not supported by the HTTP server framework as
  * the route attribute should have low-cardinality and the URI path can NOT substitute it. SHOULD
  * include the <a href="/docs/http/http-spans.md#http-server-definitions">application root</a> if
  * there is one.
  */
-static const char *kHttpRoute = "http.route";
-
-// DEBUG: {"brief": "HTTP request method.", "examples": ["GET", "POST", "HEAD"], "name":
-// "http.request.method", "note": "HTTP request method value SHOULD be \"known\" to the
-// instrumentation.\nBy default, this convention defines \"known\" methods as the ones listed in
-// [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)\nand the PATCH method defined
-// in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).\n\nIf the HTTP request method is not
-// known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.\n\nIf the
-// HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST
-// provide a way to override\nthe list of known HTTP methods. If this override is done via
-// environment variable, then the environment variable MUST be
-// named\nOTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of
-// case-sensitive known HTTP methods\n(this list MUST be a full override of the default known
-// method, it is not a list of known methods in addition to the defaults).\n\nHTTP method names are
-// case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name
-// exactly.\nInstrumentations for specific web frameworks that consider HTTP methods to be case
-// insensitive, SHOULD populate a canonical equivalent.\nTracing instrumentations that do so, MUST
-// also set `http.request.method_original` to the original value.\n", "requirement_level":
-// "recommended", "root_namespace": "http", "stability": "stable", "type": {"allow_custom_values":
-// true, "members": [{"brief": "CONNECT method.", "deprecated": none, "id": "connect", "note": none,
-// "stability": "stable", "value": "CONNECT"}, {"brief": "DELETE method.", "deprecated": none, "id":
-// "delete", "note": none, "stability": "stable", "value": "DELETE"}, {"brief": "GET method.",
-// "deprecated": none, "id": "get", "note": none, "stability": "stable", "value": "GET"}, {"brief":
-// "HEAD method.", "deprecated": none, "id": "head", "note": none, "stability": "stable", "value":
-// "HEAD"}, {"brief": "OPTIONS method.", "deprecated": none, "id": "options", "note": none,
-// "stability": "stable", "value": "OPTIONS"}, {"brief": "PATCH method.", "deprecated": none, "id":
-// "patch", "note": none, "stability": "stable", "value": "PATCH"}, {"brief": "POST method.",
-// "deprecated": none, "id": "post", "note": none, "stability": "stable", "value": "POST"},
-// {"brief": "PUT method.", "deprecated": none, "id": "put", "note": none, "stability": "stable",
-// "value": "PUT"}, {"brief": "TRACE method.", "deprecated": none, "id": "trace", "note": none,
-// "stability": "stable", "value": "TRACE"}, {"brief": "Any HTTP method that the instrumentation has
-// no prior knowledge of.", "deprecated": none, "id": "other", "note": none, "stability": "stable",
-// "value": "_OTHER"}]}}
+static constexpr const char *kHttpRoute = "http.route";
+
 namespace HttpRequestMethodValues
 {
 /**
  * CONNECT method.
  */
-// DEBUG: {"brief": "CONNECT method.", "deprecated": none, "id": "connect", "note": none,
-// "stability": "stable", "value": "CONNECT"}
 static constexpr const char *kConnect = "CONNECT";
+
 /**
  * DELETE method.
  */
-// DEBUG: {"brief": "DELETE method.", "deprecated": none, "id": "delete", "note": none, "stability":
-// "stable", "value": "DELETE"}
 static constexpr const char *kDelete = "DELETE";
+
 /**
  * GET method.
  */
-// DEBUG: {"brief": "GET method.", "deprecated": none, "id": "get", "note": none, "stability":
-// "stable", "value": "GET"}
 static constexpr const char *kGet = "GET";
+
 /**
  * HEAD method.
  */
-// DEBUG: {"brief": "HEAD method.", "deprecated": none, "id": "head", "note": none, "stability":
-// "stable", "value": "HEAD"}
 static constexpr const char *kHead = "HEAD";
+
 /**
  * OPTIONS method.
  */
-// DEBUG: {"brief": "OPTIONS method.", "deprecated": none, "id": "options", "note": none,
-// "stability": "stable", "value": "OPTIONS"}
 static constexpr const char *kOptions = "OPTIONS";
+
 /**
  * PATCH method.
  */
-// DEBUG: {"brief": "PATCH method.", "deprecated": none, "id": "patch", "note": none, "stability":
-// "stable", "value": "PATCH"}
 static constexpr const char *kPatch = "PATCH";
+
 /**
  * POST method.
  */
-// DEBUG: {"brief": "POST method.", "deprecated": none, "id": "post", "note": none, "stability":
-// "stable", "value": "POST"}
 static constexpr const char *kPost = "POST";
+
 /**
  * PUT method.
  */
-// DEBUG: {"brief": "PUT method.", "deprecated": none, "id": "put", "note": none, "stability":
-// "stable", "value": "PUT"}
 static constexpr const char *kPut = "PUT";
+
 /**
  * TRACE method.
  */
-// DEBUG: {"brief": "TRACE method.", "deprecated": none, "id": "trace", "note": none, "stability":
-// "stable", "value": "TRACE"}
 static constexpr const char *kTrace = "TRACE";
+
 /**
  * Any HTTP method that the instrumentation has no prior knowledge of.
  */
-// DEBUG: {"brief": "Any HTTP method that the instrumentation has no prior knowledge of.",
-// "deprecated": none, "id": "other", "note": none, "stability": "stable", "value": "_OTHER"}
 static constexpr const char *kOther = "_OTHER";
+
 }  // namespace HttpRequestMethodValues
 
 }  // namespace http