chore(semantic-conventions): whitespace-only fixes in comments from weaver 0.12.0 (#5427)

This commit is contained in:
Trent Mick 2025-02-06 09:36:32 -08:00 committed by GitHub
parent 4001f626d9
commit a6bb7a321d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 1729 additions and 1729 deletions

View File

@ -9,7 +9,7 @@ ROOT_DIR="${SCRIPT_DIR}/../../"
# ... in git@github.com:open-telemetry/semantic-conventions.git # ... in git@github.com:open-telemetry/semantic-conventions.git
SPEC_VERSION=v1.29.0 SPEC_VERSION=v1.29.0
# ... in git@github.com:open-telemetry/weaver.git # ... in git@github.com:open-telemetry/weaver.git
GENERATOR_VERSION=v0.10.0 GENERATOR_VERSION=v0.12.0
# When running on windows and you are getting references to ";C" (like Telemetry;C) # When running on windows and you are getting references to ";C" (like Telemetry;C)
# then this is an issue with the bash shell, so first run the following in your shell: # then this is an issue with the bash shell, so first run the following in your shell:

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -20,7 +20,7 @@
/** /**
* ASP.NET Core exception middleware handling result * ASP.NET Core exception middleware handling result
* *
* @example handled * @example handled
* @example unhandled * @example unhandled
*/ */
@ -48,14 +48,14 @@ export const ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT_VALUE_UNHANDLED = "unhandle
/** /**
* Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception. * Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception.
* *
* @example Contoso.MyHandler * @example Contoso.MyHandler
*/ */
export const ATTR_ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' as const; export const ATTR_ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' as const;
/** /**
* Rate limiting policy name. * Rate limiting policy name.
* *
* @example fixed * @example fixed
* @example sliding * @example sliding
* @example token * @example token
@ -64,7 +64,7 @@ export const ATTR_ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.po
/** /**
* Rate-limiting result, shows whether the lease was acquired or contains a rejection reason * Rate-limiting result, shows whether the lease was acquired or contains a rejection reason
* *
* @example acquired * @example acquired
* @example request_canceled * @example request_canceled
*/ */
@ -92,21 +92,21 @@ export const ASPNETCORE_RATE_LIMITING_RESULT_VALUE_REQUEST_CANCELED = "request_c
/** /**
* Flag indicating if request was handled by the application pipeline. * Flag indicating if request was handled by the application pipeline.
* *
* @example true * @example true
*/ */
export const ATTR_ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' as const; export const ATTR_ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' as const;
/** /**
* A value that indicates whether the matched route is a fallback route. * A value that indicates whether the matched route is a fallback route.
* *
* @example true * @example true
*/ */
export const ATTR_ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' as const; export const ATTR_ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' as const;
/** /**
* Match result - success or failure * Match result - success or failure
* *
* @example success * @example success
* @example failure * @example failure
*/ */
@ -124,49 +124,49 @@ export const ASPNETCORE_ROUTING_MATCH_STATUS_VALUE_SUCCESS = "success" as const;
/** /**
* Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. * Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
* *
* @example client.example.com * @example client.example.com
* @example 10.1.2.80 * @example 10.1.2.80
* @example /tmp/my.sock * @example /tmp/my.sock
* *
* @note When observed from the server side, and when communicating through an intermediary, `client.address` **SHOULD** represent the client address behind any intermediaries, for example proxies, if it's available. * @note When observed from the server side, and when communicating through an intermediary, `client.address` **SHOULD** represent the client address behind any intermediaries, for example proxies, if it's available.
*/ */
export const ATTR_CLIENT_ADDRESS = 'client.address' as const; export const ATTR_CLIENT_ADDRESS = 'client.address' as const;
/** /**
* Client port number. * Client port number.
* *
* @example 65123 * @example 65123
* *
* @note When observed from the server side, and when communicating through an intermediary, `client.port` **SHOULD** represent the client port behind any intermediaries, for example proxies, if it's available. * @note When observed from the server side, and when communicating through an intermediary, `client.port` **SHOULD** represent the client port behind any intermediaries, for example proxies, if it's available.
*/ */
export const ATTR_CLIENT_PORT = 'client.port' as const; export const ATTR_CLIENT_PORT = 'client.port' as const;
/** /**
* Describes a class of error the operation ended with. * Describes a class of error the operation ended with.
* *
* @example timeout * @example timeout
* @example java.net.UnknownHostException * @example java.net.UnknownHostException
* @example server_certificate_invalid * @example server_certificate_invalid
* @example 500 * @example 500
* *
* @note The `error.type` **SHOULD** be predictable, and **SHOULD** have low cardinality. * @note 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 * 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. * canonical class name identifying the type within the artifact **SHOULD** be used.
* *
* Instrumentations **SHOULD** document the list of errors they report. * Instrumentations **SHOULD** document the list of errors they report.
* *
* The cardinality of `error.type` within one instrumentation library **SHOULD** be low. * The cardinality of `error.type` within one instrumentation library **SHOULD** be low.
* Telemetry consumers that aggregate data from multiple instrumentation libraries and applications * 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 * should be prepared for `error.type` to have high cardinality at query time when no
* additional filters are applied. * additional filters are applied.
* *
* If the operation has completed successfully, instrumentations **SHOULD NOT** set `error.type`. * 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), * If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
* it's **RECOMMENDED** to: * it's **RECOMMENDED** to:
* *
* - Use a domain-specific attribute * - 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. * - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not.
*/ */
@ -179,19 +179,19 @@ export const ERROR_TYPE_VALUE_OTHER = "_OTHER" as const;
/** /**
* **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. * **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 left) the scope of a span, * @note 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". * 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 * 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 * 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. * 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 * It is usually not possible to determine at the point where an exception is thrown
* whether it will escape the scope of a span. * whether it will escape the scope of a span.
* However, it is trivial to know that an exception * However, it is trivial to know that an exception
* will escape, if one checks for an active exception just before ending the span, * will escape, if one checks for an active exception just before ending the span,
* as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception). * as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception).
* *
* It follows that an exception may still escape the scope of the span * 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, * 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 * since the event might have been recorded at a time where it was not
@ -201,7 +201,7 @@ export const ATTR_EXCEPTION_ESCAPED = 'exception.escaped' as const;
/** /**
* The exception message. * The exception message.
* *
* @example Division by zero * @example Division by zero
* @example Can't convert 'int' object to str implicitly * @example Can't convert 'int' object to str implicitly
*/ */
@ -209,14 +209,14 @@ export const ATTR_EXCEPTION_MESSAGE = 'exception.message' as const;
/** /**
* 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. * 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.
* *
* @example "Exception in thread "main" java.lang.RuntimeException: Test exception\\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\\n at com.example.GenerateTrace.main(GenerateTrace.java:5)\\n" * @example "Exception in thread "main" java.lang.RuntimeException: Test exception\\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\\n at com.example.GenerateTrace.main(GenerateTrace.java:5)\\n"
*/ */
export const ATTR_EXCEPTION_STACKTRACE = 'exception.stacktrace' as const; export const ATTR_EXCEPTION_STACKTRACE = 'exception.stacktrace' as const;
/** /**
* 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. * 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.
* *
* @example java.net.ConnectException * @example java.net.ConnectException
* @example OSError * @example OSError
*/ */
@ -224,10 +224,10 @@ export const ATTR_EXCEPTION_TYPE = 'exception.type' as const;
/** /**
* HTTP request headers, `<key>` being the normalized HTTP Header name (lowercase), the value being the header values. * HTTP request headers, `<key>` being the normalized HTTP Header name (lowercase), the value being the header values.
* *
* @example http.request.header.content-type=["application/json"] * @example http.request.header.content-type=["application/json"]
* @example http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"] * @example http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"]
* *
* @note 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. * @note 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 `User-Agent` header is already captured in the `user_agent.original` attribute. Users **MAY** explicitly configure instrumentations to capture them even though it is not recommended. * The `User-Agent` header is already captured in the `user_agent.original` attribute. 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. * 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.
@ -236,22 +236,22 @@ export const ATTR_HTTP_REQUEST_HEADER = (key: string) => `http.request.header.${
/** /**
* HTTP request method. * HTTP request method.
* *
* @example GET * @example GET
* @example POST * @example POST
* @example HEAD * @example HEAD
* *
* @note HTTP request method value **SHOULD** be "known" to the instrumentation. * @note HTTP request method value **SHOULD** be "known" to the instrumentation.
* By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods) * By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
* and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html). * and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
* *
* If the HTTP request method is not known to instrumentation, it **MUST** set the `http.request.method` attribute to `_OTHER`. * If the HTTP request method is not known to instrumentation, it **MUST** set the `http.request.method` attribute to `_OTHER`.
* *
* If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it **MUST** provide a way to override * If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it **MUST** provide a way to override
* the list of known HTTP methods. If this override is done via environment variable, then the environment variable **MUST** be named * the list of known HTTP methods. If this override is done via environment variable, then the environment variable **MUST** be named
* OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods * OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods
* (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). * (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).
* *
* HTTP method names are case-sensitive and `http.request.method` attribute value **MUST** match a known HTTP method name exactly. * HTTP method names are case-sensitive and `http.request.method` attribute value **MUST** match a known HTTP method name exactly.
* Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, **SHOULD** populate a canonical equivalent. * Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, **SHOULD** populate a canonical equivalent.
* Tracing instrumentations that do so, **MUST** also set `http.request.method_original` to the original value. * Tracing instrumentations that do so, **MUST** also set `http.request.method_original` to the original value.
@ -310,7 +310,7 @@ export const HTTP_REQUEST_METHOD_VALUE_TRACE = "TRACE" as const;
/** /**
* Original HTTP method sent by the client in the request line. * Original HTTP method sent by the client in the request line.
* *
* @example GeT * @example GeT
* @example ACL * @example ACL
* @example foo * @example foo
@ -319,19 +319,19 @@ export const ATTR_HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original'
/** /**
* The ordinal number of request resending attempt (for any reason, including redirects). * The ordinal number of request resending attempt (for any reason, including redirects).
* *
* @example 3 * @example 3
* *
* @note 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). * @note 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).
*/ */
export const ATTR_HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' as const; export const ATTR_HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' as const;
/** /**
* HTTP response headers, `<key>` being the normalized HTTP Header name (lowercase), the value being the header values. * HTTP response headers, `<key>` being the normalized HTTP Header name (lowercase), the value being the header values.
* *
* @example http.response.header.content-type=["application/json"] * @example http.response.header.content-type=["application/json"]
* @example http.response.header.my-custom-header=["abc", "def"] * @example http.response.header.my-custom-header=["abc", "def"]
* *
* @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. * @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. * 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. * 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.
@ -340,17 +340,17 @@ export const ATTR_HTTP_RESPONSE_HEADER = (key: string) => `http.response.header.
/** /**
* [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). * [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6).
* *
* @example 200 * @example 200
*/ */
export const ATTR_HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' as const; export const ATTR_HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' as const;
/** /**
* The matched route, that is, the path template in the format used by the respective server framework. * The matched route, that is, the path template in the format used by the respective server framework.
* *
* @example /users/:userID? * @example /users/:userID?
* @example {controller}/{action}/{id?} * @example {controller}/{action}/{id?}
* *
* @note **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. * @note **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 [application root](/docs/http/http-spans.md#http-server-definitions) if there is one. * **SHOULD** include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one.
*/ */
@ -358,38 +358,38 @@ export const ATTR_HTTP_ROUTE = 'http.route' as const;
/** /**
* Name of the garbage collector action. * Name of the garbage collector action.
* *
* @example end of minor GC * @example end of minor GC
* @example end of major GC * @example end of major GC
* *
* @note Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()). * @note Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()).
*/ */
export const ATTR_JVM_GC_ACTION = 'jvm.gc.action' as const; export const ATTR_JVM_GC_ACTION = 'jvm.gc.action' as const;
/** /**
* Name of the garbage collector. * Name of the garbage collector.
* *
* @example G1 Young Generation * @example G1 Young Generation
* @example G1 Old Generation * @example G1 Old Generation
* *
* @note Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()). * @note Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()).
*/ */
export const ATTR_JVM_GC_NAME = 'jvm.gc.name' as const; export const ATTR_JVM_GC_NAME = 'jvm.gc.name' as const;
/** /**
* Name of the memory pool. * Name of the memory pool.
* *
* @example G1 Old Gen * @example G1 Old Gen
* @example G1 Eden space * @example G1 Eden space
* @example G1 Survivor Space * @example G1 Survivor Space
* *
* @note Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). * @note Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()).
*/ */
export const ATTR_JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' as const; export const ATTR_JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' as const;
/** /**
* The type of memory. * The type of memory.
* *
* @example heap * @example heap
* @example non_heap * @example non_heap
*/ */
@ -412,7 +412,7 @@ export const ATTR_JVM_THREAD_DAEMON = 'jvm.thread.daemon' as const;
/** /**
* State of the thread. * State of the thread.
* *
* @example runnable * @example runnable
* @example blocked * @example blocked
*/ */
@ -450,7 +450,7 @@ export const JVM_THREAD_STATE_VALUE_WAITING = "waiting" as const;
/** /**
* Local address of the network connection - IP address or Unix domain socket name. * Local address of the network connection - IP address or Unix domain socket name.
* *
* @example 10.1.2.80 * @example 10.1.2.80
* @example /tmp/my.sock * @example /tmp/my.sock
*/ */
@ -458,14 +458,14 @@ export const ATTR_NETWORK_LOCAL_ADDRESS = 'network.local.address' as const;
/** /**
* Local port number of the network connection. * Local port number of the network connection.
* *
* @example 65123 * @example 65123
*/ */
export const ATTR_NETWORK_LOCAL_PORT = 'network.local.port' as const; export const ATTR_NETWORK_LOCAL_PORT = 'network.local.port' as const;
/** /**
* Peer address of the network connection - IP address or Unix domain socket name. * Peer address of the network connection - IP address or Unix domain socket name.
* *
* @example 10.1.2.80 * @example 10.1.2.80
* @example /tmp/my.sock * @example /tmp/my.sock
*/ */
@ -473,40 +473,40 @@ export const ATTR_NETWORK_PEER_ADDRESS = 'network.peer.address' as const;
/** /**
* Peer port number of the network connection. * Peer port number of the network connection.
* *
* @example 65123 * @example 65123
*/ */
export const ATTR_NETWORK_PEER_PORT = 'network.peer.port' as const; export const ATTR_NETWORK_PEER_PORT = 'network.peer.port' as const;
/** /**
* [OSI application layer](https://wikipedia.org/wiki/Application_layer) or non-OSI equivalent. * [OSI application layer](https://wikipedia.org/wiki/Application_layer) or non-OSI equivalent.
* *
* @example amqp * @example amqp
* @example http * @example http
* @example mqtt * @example mqtt
* *
* @note The value **SHOULD** be normalized to lowercase. * @note The value **SHOULD** be normalized to lowercase.
*/ */
export const ATTR_NETWORK_PROTOCOL_NAME = 'network.protocol.name' as const; export const ATTR_NETWORK_PROTOCOL_NAME = 'network.protocol.name' as const;
/** /**
* The actual version of the protocol used for network communication. * The actual version of the protocol used for network communication.
* *
* @example 1.1 * @example 1.1
* @example 2 * @example 2
* *
* @note If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute **SHOULD** be set to the negotiated version. If the actual protocol version is not known, this attribute **SHOULD NOT** be set. * @note If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute **SHOULD** be set to the negotiated version. If the actual protocol version is not known, this attribute **SHOULD NOT** be set.
*/ */
export const ATTR_NETWORK_PROTOCOL_VERSION = 'network.protocol.version' as const; export const ATTR_NETWORK_PROTOCOL_VERSION = 'network.protocol.version' as const;
/** /**
* [OSI transport layer](https://wikipedia.org/wiki/Transport_layer) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). * [OSI transport layer](https://wikipedia.org/wiki/Transport_layer) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication).
* *
* @example tcp * @example tcp
* @example udp * @example udp
* *
* @note The value **SHOULD** be normalized to lowercase. * @note The value **SHOULD** be normalized to lowercase.
* *
* Consider always setting the transport when setting a port number, since * Consider always setting the transport when setting a port number, since
* a port number is ambiguous without knowing the transport. For example * a port number is ambiguous without knowing the transport. For example
* different processes could be listening on TCP port 12345 and UDP port 12345. * different processes could be listening on TCP port 12345 and UDP port 12345.
@ -540,10 +540,10 @@ export const NETWORK_TRANSPORT_VALUE_UNIX = "unix" as const;
/** /**
* [OSI network layer](https://wikipedia.org/wiki/Network_layer) or non-OSI equivalent. * [OSI network layer](https://wikipedia.org/wiki/Network_layer) or non-OSI equivalent.
* *
* @example ipv4 * @example ipv4
* @example ipv6 * @example ipv6
* *
* @note The value **SHOULD** be normalized to lowercase. * @note The value **SHOULD** be normalized to lowercase.
*/ */
export const ATTR_NETWORK_TYPE = 'network.type' as const; export const ATTR_NETWORK_TYPE = 'network.type' as const;
@ -560,14 +560,14 @@ export const NETWORK_TYPE_VALUE_IPV6 = "ipv6" as const;
/** /**
* The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). * The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP).
* *
* @example io.opentelemetry.contrib.mongodb * @example io.opentelemetry.contrib.mongodb
*/ */
export const ATTR_OTEL_SCOPE_NAME = 'otel.scope.name' as const; export const ATTR_OTEL_SCOPE_NAME = 'otel.scope.name' as const;
/** /**
* The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). * The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP).
* *
* @example 1.0.0 * @example 1.0.0
*/ */
export const ATTR_OTEL_SCOPE_VERSION = 'otel.scope.version' as const; export const ATTR_OTEL_SCOPE_VERSION = 'otel.scope.version' as const;
@ -589,45 +589,45 @@ export const OTEL_STATUS_CODE_VALUE_OK = "OK" as const;
/** /**
* Description of the Status if it has a value, otherwise not set. * Description of the Status if it has a value, otherwise not set.
* *
* @example resource not found * @example resource not found
*/ */
export const ATTR_OTEL_STATUS_DESCRIPTION = 'otel.status_description' as const; export const ATTR_OTEL_STATUS_DESCRIPTION = 'otel.status_description' as const;
/** /**
* Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. * Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
* *
* @example example.com * @example example.com
* @example 10.1.2.80 * @example 10.1.2.80
* @example /tmp/my.sock * @example /tmp/my.sock
* *
* @note When observed from the client side, and when communicating through an intermediary, `server.address` **SHOULD** represent the server address behind any intermediaries, for example proxies, if it's available. * @note When observed from the client side, and when communicating through an intermediary, `server.address` **SHOULD** represent the server address behind any intermediaries, for example proxies, if it's available.
*/ */
export const ATTR_SERVER_ADDRESS = 'server.address' as const; export const ATTR_SERVER_ADDRESS = 'server.address' as const;
/** /**
* Server port number. * Server port number.
* *
* @example 80 * @example 80
* @example 8080 * @example 8080
* @example 443 * @example 443
* *
* @note When observed from the client side, and when communicating through an intermediary, `server.port` **SHOULD** represent the server port behind any intermediaries, for example proxies, if it's available. * @note When observed from the client side, and when communicating through an intermediary, `server.port` **SHOULD** represent the server port behind any intermediaries, for example proxies, if it's available.
*/ */
export const ATTR_SERVER_PORT = 'server.port' as const; export const ATTR_SERVER_PORT = 'server.port' as const;
/** /**
* Logical name of the service. * Logical name of the service.
* *
* @example shoppingcart * @example shoppingcart
* *
* @note **MUST** be the same for all instances of horizontally scaled services. If the value was not specified, SDKs **MUST** fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value **MUST** be set to `unknown_service`. * @note **MUST** be the same for all instances of horizontally scaled services. If the value was not specified, SDKs **MUST** fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value **MUST** be set to `unknown_service`.
*/ */
export const ATTR_SERVICE_NAME = 'service.name' as const; export const ATTR_SERVICE_NAME = 'service.name' as const;
/** /**
* The version string of the service API or implementation. The format is not defined by these conventions. * The version string of the service API or implementation. The format is not defined by these conventions.
* *
* @example 2.0.0 * @example 2.0.0
* @example a01dbef8a * @example a01dbef8a
*/ */
@ -635,7 +635,7 @@ export const ATTR_SERVICE_VERSION = 'service.version' as const;
/** /**
* SignalR HTTP connection closure status. * SignalR HTTP connection closure status.
* *
* @example app_shutdown * @example app_shutdown
* @example timeout * @example timeout
*/ */
@ -658,7 +658,7 @@ export const SIGNALR_CONNECTION_STATUS_VALUE_TIMEOUT = "timeout" as const;
/** /**
* [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) * [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md)
* *
* @example web_sockets * @example web_sockets
* @example long_polling * @example long_polling
*/ */
@ -746,9 +746,9 @@ export const TELEMETRY_SDK_LANGUAGE_VALUE_WEBJS = "webjs" as const;
/** /**
* The name of the telemetry SDK as defined above. * The name of the telemetry SDK as defined above.
* *
* @example opentelemetry * @example opentelemetry
* *
* @note The OpenTelemetry SDK **MUST** set the `telemetry.sdk.name` attribute to `opentelemetry`. * @note The OpenTelemetry SDK **MUST** set the `telemetry.sdk.name` attribute to `opentelemetry`.
* If another SDK, like a fork or a vendor-provided implementation, is used, this SDK **MUST** set the * If another SDK, like a fork or a vendor-provided implementation, is used, this SDK **MUST** set the
* `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point * `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point
@ -760,45 +760,45 @@ export const ATTR_TELEMETRY_SDK_NAME = 'telemetry.sdk.name' as const;
/** /**
* The version string of the telemetry SDK. * The version string of the telemetry SDK.
* *
* @example 1.2.3 * @example 1.2.3
*/ */
export const ATTR_TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' as const; export const ATTR_TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' as const;
/** /**
* The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component * The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component
* *
* @example SemConv * @example SemConv
*/ */
export const ATTR_URL_FRAGMENT = 'url.fragment' as const; export const ATTR_URL_FRAGMENT = 'url.fragment' as const;
/** /**
* Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) * Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986)
* *
* @example https://www.foo.bar/search?q=OpenTelemetry#SemConv * @example https://www.foo.bar/search?q=OpenTelemetry#SemConv
* @example //localhost * @example //localhost
* *
* @note For network calls, URL usually has `scheme://host[:port][path][?query][#fragment]` format, where the fragment * @note For network calls, URL usually has `scheme://host[:port][path][?query][#fragment]` format, where the fragment
* is not transmitted over HTTP, but if it is known, it **SHOULD** be included nevertheless. * is not transmitted over HTTP, but if it is known, it **SHOULD** be included nevertheless.
* *
* `url.full` **MUST NOT** contain credentials passed via URL in form of `https://username:password@www.example.com/`. * `url.full` **MUST NOT** contain credentials passed via URL in form of `https://username:password@www.example.com/`.
* In such case username and password **SHOULD** be redacted and attribute's value **SHOULD** be `https://REDACTED:REDACTED@www.example.com/`. * In such case username and password **SHOULD** be redacted and attribute's value **SHOULD** be `https://REDACTED:REDACTED@www.example.com/`.
* *
* `url.full` **SHOULD** capture the absolute URL when it is available (or can be reconstructed). * `url.full` **SHOULD** capture the absolute URL when it is available (or can be reconstructed).
* *
* Sensitive content provided in `url.full` **SHOULD** be scrubbed when instrumentations can identify it. * Sensitive content provided in `url.full` **SHOULD** be scrubbed when instrumentations can identify it.
* *
* *
* Query string values for the following keys **SHOULD** be redacted by default and replaced by the * Query string values for the following keys **SHOULD** be redacted by default and replaced by the
* value `REDACTED`: * value `REDACTED`:
* *
* - [`AWSAccessKeyId`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth) * - [`AWSAccessKeyId`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
* - [`Signature`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth) * - [`Signature`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
* - [`sig`](https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token) * - [`sig`](https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token)
* - [`X-Goog-Signature`](https://cloud.google.com/storage/docs/access-control/signed-urls) * - [`X-Goog-Signature`](https://cloud.google.com/storage/docs/access-control/signed-urls)
* *
* This list is subject to change over time. * This list is subject to change over time.
* *
* When a query string value is redacted, the query string key **SHOULD** still be preserved, e.g. * When a query string value is redacted, the query string key **SHOULD** still be preserved, e.g.
* `https://www.example.com/path?color=blue&sig=REDACTED`. * `https://www.example.com/path?color=blue&sig=REDACTED`.
*/ */
@ -806,30 +806,30 @@ export const ATTR_URL_FULL = 'url.full' as const;
/** /**
* The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component * The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component
* *
* @example /search * @example /search
* *
* @note Sensitive content provided in `url.path` **SHOULD** be scrubbed when instrumentations can identify it. * @note Sensitive content provided in `url.path` **SHOULD** be scrubbed when instrumentations can identify it.
*/ */
export const ATTR_URL_PATH = 'url.path' as const; export const ATTR_URL_PATH = 'url.path' as const;
/** /**
* The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component * The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component
* *
* @example q=OpenTelemetry * @example q=OpenTelemetry
* *
* @note Sensitive content provided in `url.query` **SHOULD** be scrubbed when instrumentations can identify it. * @note Sensitive content provided in `url.query` **SHOULD** be scrubbed when instrumentations can identify it.
* *
* *
* Query string values for the following keys **SHOULD** be redacted by default and replaced by the value `REDACTED`: * Query string values for the following keys **SHOULD** be redacted by default and replaced by the value `REDACTED`:
* *
* - [`AWSAccessKeyId`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth) * - [`AWSAccessKeyId`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
* - [`Signature`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth) * - [`Signature`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
* - [`sig`](https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token) * - [`sig`](https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token)
* - [`X-Goog-Signature`](https://cloud.google.com/storage/docs/access-control/signed-urls) * - [`X-Goog-Signature`](https://cloud.google.com/storage/docs/access-control/signed-urls)
* *
* This list is subject to change over time. * This list is subject to change over time.
* *
* When a query string value is redacted, the query string key **SHOULD** still be preserved, e.g. * When a query string value is redacted, the query string key **SHOULD** still be preserved, e.g.
* `q=OpenTelemetry&sig=REDACTED`. * `q=OpenTelemetry&sig=REDACTED`.
*/ */
@ -837,7 +837,7 @@ export const ATTR_URL_QUERY = 'url.query' as const;
/** /**
* The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. * The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol.
* *
* @example https * @example https
* @example ftp * @example ftp
* @example telnet * @example telnet
@ -846,7 +846,7 @@ export const ATTR_URL_SCHEME = 'url.scheme' as const;
/** /**
* Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. * Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client.
* *
* @example CERN-LineMode/2.15 libwww/2.17b3 * @example CERN-LineMode/2.15 libwww/2.17b3
* @example Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1 * @example Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1
* @example YourApp/1.0.0 grpc-java-okhttp/1.27.2 * @example YourApp/1.0.0 grpc-java-okhttp/1.27.2

View File

@ -20,54 +20,54 @@
/** /**
* Number of exceptions caught by exception handling middleware. * Number of exceptions caught by exception handling middleware.
* *
* @note Meter name: `Microsoft.AspNetCore.Diagnostics`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Diagnostics`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_ASPNETCORE_DIAGNOSTICS_EXCEPTIONS = 'aspnetcore.diagnostics.exceptions' as const; export const METRIC_ASPNETCORE_DIAGNOSTICS_EXCEPTIONS = 'aspnetcore.diagnostics.exceptions' as const;
/** /**
* Number of requests that are currently active on the server that hold a rate limiting lease. * Number of requests that are currently active on the server that hold a rate limiting lease.
* *
* @note Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_ASPNETCORE_RATE_LIMITING_ACTIVE_REQUEST_LEASES = 'aspnetcore.rate_limiting.active_request_leases' as const; export const METRIC_ASPNETCORE_RATE_LIMITING_ACTIVE_REQUEST_LEASES = 'aspnetcore.rate_limiting.active_request_leases' as const;
/** /**
* Number of requests that are currently queued, waiting to acquire a rate limiting lease. * Number of requests that are currently queued, waiting to acquire a rate limiting lease.
* *
* @note Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_ASPNETCORE_RATE_LIMITING_QUEUED_REQUESTS = 'aspnetcore.rate_limiting.queued_requests' as const; export const METRIC_ASPNETCORE_RATE_LIMITING_QUEUED_REQUESTS = 'aspnetcore.rate_limiting.queued_requests' as const;
/** /**
* The time the request spent in a queue waiting to acquire a rate limiting lease. * The time the request spent in a queue waiting to acquire a rate limiting lease.
* *
* @note Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_ASPNETCORE_RATE_LIMITING_REQUEST_TIME_IN_QUEUE = 'aspnetcore.rate_limiting.request.time_in_queue' as const; export const METRIC_ASPNETCORE_RATE_LIMITING_REQUEST_TIME_IN_QUEUE = 'aspnetcore.rate_limiting.request.time_in_queue' as const;
/** /**
* The duration of rate limiting lease held by requests on the server. * The duration of rate limiting lease held by requests on the server.
* *
* @note Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_ASPNETCORE_RATE_LIMITING_REQUEST_LEASE_DURATION = 'aspnetcore.rate_limiting.request_lease.duration' as const; export const METRIC_ASPNETCORE_RATE_LIMITING_REQUEST_LEASE_DURATION = 'aspnetcore.rate_limiting.request_lease.duration' as const;
/** /**
* Number of requests that tried to acquire a rate limiting lease. * Number of requests that tried to acquire a rate limiting lease.
* *
* @note Requests could be: * @note Requests could be:
* *
* - Rejected by global or endpoint rate limiting policies * - Rejected by global or endpoint rate limiting policies
* - Canceled while waiting for the lease. * - Canceled while waiting for the lease.
* *
* Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 * Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_ASPNETCORE_RATE_LIMITING_REQUESTS = 'aspnetcore.rate_limiting.requests' as const; export const METRIC_ASPNETCORE_RATE_LIMITING_REQUESTS = 'aspnetcore.rate_limiting.requests' as const;
/** /**
* Number of requests that were attempted to be matched to an endpoint. * Number of requests that were attempted to be matched to an endpoint.
* *
* @note Meter name: `Microsoft.AspNetCore.Routing`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Routing`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_ASPNETCORE_ROUTING_MATCH_ATTEMPTS = 'aspnetcore.routing.match_attempts' as const; export const METRIC_ASPNETCORE_ROUTING_MATCH_ATTEMPTS = 'aspnetcore.routing.match_attempts' as const;
@ -104,7 +104,7 @@ export const METRIC_JVM_CPU_COUNT = 'jvm.cpu.count' as const;
/** /**
* Recent CPU utilization for the process as reported by the JVM. * Recent CPU utilization for the process as reported by the JVM.
* *
* @note The value range is [0.0,1.0]. This utilization is not defined as being for the specific interval since last measurement (unlike `system.cpu.utilization`). [Reference](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getProcessCpuLoad()). * @note The value range is [0.0,1.0]. This utilization is not defined as being for the specific interval since last measurement (unlike `system.cpu.utilization`). [Reference](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getProcessCpuLoad()).
*/ */
export const METRIC_JVM_CPU_RECENT_UTILIZATION = 'jvm.cpu.recent_utilization' as const; export const METRIC_JVM_CPU_RECENT_UTILIZATION = 'jvm.cpu.recent_utilization' as const;
@ -146,42 +146,42 @@ export const METRIC_JVM_THREAD_COUNT = 'jvm.thread.count' as const;
/** /**
* Number of connections that are currently active on the server. * Number of connections that are currently active on the server.
* *
* @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_KESTREL_ACTIVE_CONNECTIONS = 'kestrel.active_connections' as const; export const METRIC_KESTREL_ACTIVE_CONNECTIONS = 'kestrel.active_connections' as const;
/** /**
* Number of TLS handshakes that are currently in progress on the server. * Number of TLS handshakes that are currently in progress on the server.
* *
* @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_KESTREL_ACTIVE_TLS_HANDSHAKES = 'kestrel.active_tls_handshakes' as const; export const METRIC_KESTREL_ACTIVE_TLS_HANDSHAKES = 'kestrel.active_tls_handshakes' as const;
/** /**
* The duration of connections on the server. * The duration of connections on the server.
* *
* @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_KESTREL_CONNECTION_DURATION = 'kestrel.connection.duration' as const; export const METRIC_KESTREL_CONNECTION_DURATION = 'kestrel.connection.duration' as const;
/** /**
* Number of connections that are currently queued and are waiting to start. * Number of connections that are currently queued and are waiting to start.
* *
* @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_KESTREL_QUEUED_CONNECTIONS = 'kestrel.queued_connections' as const; export const METRIC_KESTREL_QUEUED_CONNECTIONS = 'kestrel.queued_connections' as const;
/** /**
* Number of HTTP requests on multiplexed connections (HTTP/2 and HTTP/3) that are currently queued and are waiting to start. * Number of HTTP requests on multiplexed connections (HTTP/2 and HTTP/3) that are currently queued and are waiting to start.
* *
* @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_KESTREL_QUEUED_REQUESTS = 'kestrel.queued_requests' as const; export const METRIC_KESTREL_QUEUED_REQUESTS = 'kestrel.queued_requests' as const;
/** /**
* Number of connections rejected by the server. * Number of connections rejected by the server.
* *
* @note Connections are rejected when the currently active count exceeds the value configured with `MaxConcurrentConnections`. * @note Connections are rejected when the currently active count exceeds the value configured with `MaxConcurrentConnections`.
* Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 * Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0
*/ */
@ -189,30 +189,30 @@ export const METRIC_KESTREL_REJECTED_CONNECTIONS = 'kestrel.rejected_connections
/** /**
* The duration of TLS handshakes on the server. * The duration of TLS handshakes on the server.
* *
* @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_KESTREL_TLS_HANDSHAKE_DURATION = 'kestrel.tls_handshake.duration' as const; export const METRIC_KESTREL_TLS_HANDSHAKE_DURATION = 'kestrel.tls_handshake.duration' as const;
/** /**
* Number of connections that are currently upgraded (WebSockets). . * Number of connections that are currently upgraded (WebSockets). .
* *
* @note The counter only tracks HTTP/1.1 connections. * @note The counter only tracks HTTP/1.1 connections.
* *
* Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 * Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_KESTREL_UPGRADED_CONNECTIONS = 'kestrel.upgraded_connections' as const; export const METRIC_KESTREL_UPGRADED_CONNECTIONS = 'kestrel.upgraded_connections' as const;
/** /**
* Number of connections that are currently active on the server. * Number of connections that are currently active on the server.
* *
* @note Meter name: `Microsoft.AspNetCore.Http.Connections`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Http.Connections`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_SIGNALR_SERVER_ACTIVE_CONNECTIONS = 'signalr.server.active_connections' as const; export const METRIC_SIGNALR_SERVER_ACTIVE_CONNECTIONS = 'signalr.server.active_connections' as const;
/** /**
* The duration of connections on the server. * The duration of connections on the server.
* *
* @note Meter name: `Microsoft.AspNetCore.Http.Connections`; Added in: ASP.NET Core 8.0 * @note Meter name: `Microsoft.AspNetCore.Http.Connections`; Added in: ASP.NET Core 8.0
*/ */
export const METRIC_SIGNALR_SERVER_CONNECTION_DURATION = 'signalr.server.connection.duration' as const; export const METRIC_SIGNALR_SERVER_CONNECTION_DURATION = 'signalr.server.connection.duration' as const;