NVIDIA DeepStream SDK API Reference
9.2 Release
Variables
semconv::url Namespace Reference

Variables

static constexpr const char * kUrlFragment = "url.fragment"
 The URI fragment component. More...
 
static constexpr const char * kUrlFull = "url.full"
 Absolute URL describing a network resource according to RFC3986 More...
 
static constexpr const char * kUrlPath = "url.path"
 The URI path component. More...
 
static constexpr const char * kUrlQuery = "url.query"
 The URI query component. More...
 
static constexpr const char * kUrlScheme = "url.scheme"
 The URI scheme component identifying the used protocol. More...
 
static constexpr const char * kUrlDomain = "url.domain"
 Domain extracted from the. More...
 
static constexpr const char * kUrlExtension = "url.extension"
 The file extension extracted from the. More...
 
static constexpr const char * kUrlFragment = "url.fragment"
 The URI fragment component. More...
 
static constexpr const char * kUrlFull = "url.full"
 Absolute URL describing a network resource according to RFC3986 More...
 
static constexpr const char * kUrlOriginal = "url.original"
 Unmodified original URL as seen in the event source. More...
 
static constexpr const char * kUrlPath = "url.path"
 The URI path component. More...
 
static constexpr const char * kUrlPort = "url.port"
 Port extracted from the. More...
 
static constexpr const char * kUrlQuery = "url.query"
 The URI query component. More...
 
static constexpr const char * kUrlRegisteredDomain = "url.registered_domain"
 The highest registered url domain, stripped of the subdomain. More...
 
static constexpr const char * kUrlScheme = "url.scheme"
 The URI scheme component identifying the used protocol. More...
 
static constexpr const char * kUrlSubdomain = "url.subdomain"
 The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. More...
 
static constexpr const char * kUrlTemplate = "url.template"
 The low-cardinality template of an absolute path reference. More...
 
static constexpr const char * kUrlTopLevelDomain = "url.top_level_domain"
 The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. More...
 
static constexpr const char * kUrlFragment = "url.fragment"
 The URI fragment component. More...
 
static constexpr const char * kUrlFull = "url.full"
 Absolute URL describing a network resource according to RFC3986 More...
 
static constexpr const char * kUrlPath = "url.path"
 The URI path component. More...
 
static constexpr const char * kUrlQuery = "url.query"
 The URI query component. More...
 
static constexpr const char * kUrlScheme = "url.scheme"
 The URI scheme component identifying the used protocol. More...
 
static constexpr const char * kUrlDomain = "url.domain"
 Domain extracted from the. More...
 
static constexpr const char * kUrlExtension = "url.extension"
 The file extension extracted from the. More...
 
static constexpr const char * kUrlFragment = "url.fragment"
 The URI fragment component. More...
 
static constexpr const char * kUrlFull = "url.full"
 Absolute URL describing a network resource according to RFC3986 More...
 
static constexpr const char * kUrlOriginal = "url.original"
 Unmodified original URL as seen in the event source. More...
 
static constexpr const char * kUrlPath = "url.path"
 The URI path component. More...
 
static constexpr const char * kUrlPort = "url.port"
 Port extracted from the. More...
 
static constexpr const char * kUrlQuery = "url.query"
 The URI query component. More...
 
static constexpr const char * kUrlRegisteredDomain = "url.registered_domain"
 The highest registered url domain, stripped of the subdomain. More...
 
static constexpr const char * kUrlScheme = "url.scheme"
 The URI scheme component identifying the used protocol. More...
 
static constexpr const char * kUrlSubdomain = "url.subdomain"
 The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. More...
 
static constexpr const char * kUrlTemplate = "url.template"
 The low-cardinality template of an absolute path reference. More...
 
static constexpr const char * kUrlTopLevelDomain = "url.top_level_domain"
 The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. More...
 

Variable Documentation

◆ kUrlDomain [1/2]

constexpr const char* semconv::url::kUrlDomain = "url.domain"
staticconstexpr

Domain extracted from the.

url.full

, such as "opentelemetry.io".

In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the domain field. If the URL contains a literal IPv6 address enclosed by

[

and

]

, the

[

and

]

characters should also be captured in the domain field.

Definition at line 31 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlDomain [2/2]

constexpr const char* semconv::url::kUrlDomain = "url.domain"
staticconstexpr

Domain extracted from the.

url.full

, such as "opentelemetry.io".

In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the domain field. If the URL contains a literal IPv6 address enclosed by

[

and

]

, the

[

and

]

characters should also be captured in the domain field.

Definition at line 31 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlExtension [1/2]

constexpr const char* semconv::url::kUrlExtension = "url.extension"
staticconstexpr

The file extension extracted from the.

url.full

, excluding the leading dot.

The file extension is only set if it exists, as not every url has a file extension. When the file name has multiple extensions

example.tar.gz

, only the last one should be captured

gz

, not

tar.gz

.

Definition at line 40 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlExtension [2/2]

constexpr const char* semconv::url::kUrlExtension = "url.extension"
staticconstexpr

The file extension extracted from the.

url.full

, excluding the leading dot.

The file extension is only set if it exists, as not every url has a file extension. When the file name has multiple extensions

example.tar.gz

, only the last one should be captured

gz

, not

tar.gz

.

Definition at line 40 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlFragment [1/4]

constexpr const char* semconv::url::kUrlFragment = "url.fragment"
staticconstexpr

The URI fragment component.

Definition at line 25 of file 9.2/includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlFragment [2/4]

constexpr const char* semconv::url::kUrlFragment = "url.fragment"
staticconstexpr

The URI fragment component.

Definition at line 25 of file includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlFragment [3/4]

constexpr const char* semconv::url::kUrlFragment = "url.fragment"
staticconstexpr

The URI fragment component.

Definition at line 45 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlFragment [4/4]

constexpr const char* semconv::url::kUrlFragment = "url.fragment"
staticconstexpr

The URI fragment component.

Definition at line 45 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlFull [1/4]

constexpr const char* semconv::url::kUrlFull = "url.full"
staticconstexpr

Absolute URL describing a network resource according to RFC3986

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.

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/

.

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.

Query string values for the following keys SHOULD be redacted by default and replaced by the value

REDACTED

:

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.

https://www.example.com/path?color=blue&sig=REDACTED

.

Definition at line 59 of file includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlFull [2/4]

constexpr const char* semconv::url::kUrlFull = "url.full"
staticconstexpr

Absolute URL describing a network resource according to RFC3986

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.

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/

.

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.

Query string values for the following keys SHOULD be redacted by default and replaced by the value

REDACTED

:

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.

https://www.example.com/path?color=blue&sig=REDACTED

.

Definition at line 59 of file 9.2/includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlFull [3/4]

constexpr const char* semconv::url::kUrlFull = "url.full"
staticconstexpr

Absolute URL describing a network resource according to RFC3986

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.

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/

.

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.

Query string values for the following keys SHOULD be redacted by default and replaced by the value

REDACTED

:

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.

https://www.example.com/path?color=blue&sig=REDACTED

.

Definition at line 79 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlFull [4/4]

constexpr const char* semconv::url::kUrlFull = "url.full"
staticconstexpr

Absolute URL describing a network resource according to RFC3986

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.

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/

.

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.

Query string values for the following keys SHOULD be redacted by default and replaced by the value

REDACTED

:

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.

https://www.example.com/path?color=blue&sig=REDACTED

.

Definition at line 79 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlOriginal [1/2]

constexpr const char* semconv::url::kUrlOriginal = "url.original"
staticconstexpr

Unmodified original URL as seen in the event source.

In network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path. This field is meant to represent the URL as it was observed, complete or not.

url.original

might contain credentials passed via URL in form of

https://username:password@www.example.com/

. In such case password and username SHOULD NOT be redacted and attribute's value SHOULD remain the same.

Definition at line 91 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlOriginal [2/2]

constexpr const char* semconv::url::kUrlOriginal = "url.original"
staticconstexpr

Unmodified original URL as seen in the event source.

In network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path. This field is meant to represent the URL as it was observed, complete or not.

url.original

might contain credentials passed via URL in form of

https://username:password@www.example.com/

. In such case password and username SHOULD NOT be redacted and attribute's value SHOULD remain the same.

Definition at line 91 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlPath [1/4]

constexpr const char* semconv::url::kUrlPath = "url.path"
staticconstexpr

The URI path component.

Sensitive content provided in

url.path

SHOULD be scrubbed when instrumentations can identify it.

Definition at line 67 of file 9.2/includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlPath [2/4]

constexpr const char* semconv::url::kUrlPath = "url.path"
staticconstexpr

The URI path component.

Sensitive content provided in

url.path

SHOULD be scrubbed when instrumentations can identify it.

Definition at line 67 of file includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlPath [3/4]

constexpr const char* semconv::url::kUrlPath = "url.path"
staticconstexpr

The URI path component.

Sensitive content provided in

url.path

SHOULD be scrubbed when instrumentations can identify it.

Definition at line 99 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlPath [4/4]

constexpr const char* semconv::url::kUrlPath = "url.path"
staticconstexpr

The URI path component.

Sensitive content provided in

url.path

SHOULD be scrubbed when instrumentations can identify it.

Definition at line 99 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlPort [1/2]

constexpr const char* semconv::url::kUrlPort = "url.port"
staticconstexpr

Port extracted from the.

url.full

Definition at line 104 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlPort [2/2]

constexpr const char* semconv::url::kUrlPort = "url.port"
staticconstexpr

Port extracted from the.

url.full

Definition at line 104 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlQuery [1/4]

constexpr const char* semconv::url::kUrlQuery = "url.query"
staticconstexpr

The URI query component.

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

:

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.

q=OpenTelemetry&sig=REDACTED

.

Definition at line 92 of file includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlQuery [2/4]

constexpr const char* semconv::url::kUrlQuery = "url.query"
staticconstexpr

The URI query component.

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

:

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.

q=OpenTelemetry&sig=REDACTED

.

Definition at line 92 of file 9.2/includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlQuery [3/4]

constexpr const char* semconv::url::kUrlQuery = "url.query"
staticconstexpr

The URI query component.

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

:

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.

q=OpenTelemetry&sig=REDACTED

.

Definition at line 129 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlQuery [4/4]

constexpr const char* semconv::url::kUrlQuery = "url.query"
staticconstexpr

The URI query component.

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

:

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.

q=OpenTelemetry&sig=REDACTED

.

Definition at line 129 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlRegisteredDomain [1/2]

constexpr const char* semconv::url::kUrlRegisteredDomain = "url.registered_domain"
staticconstexpr

The highest registered url domain, stripped of the subdomain.

This value can be determined precisely with the public suffix list. For example, the registered domain for

foo.example.com

is

example.com

. Trying to approximate this by simply taking the last two labels will not work well for TLDs such as

co.uk

.

Definition at line 139 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlRegisteredDomain [2/2]

constexpr const char* semconv::url::kUrlRegisteredDomain = "url.registered_domain"
staticconstexpr

The highest registered url domain, stripped of the subdomain.

This value can be determined precisely with the public suffix list. For example, the registered domain for

foo.example.com

is

example.com

. Trying to approximate this by simply taking the last two labels will not work well for TLDs such as

co.uk

.

Definition at line 139 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlScheme [1/4]

constexpr const char* semconv::url::kUrlScheme = "url.scheme"
staticconstexpr

The URI scheme component identifying the used protocol.

Definition at line 98 of file includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlScheme [2/4]

constexpr const char* semconv::url::kUrlScheme = "url.scheme"
staticconstexpr

The URI scheme component identifying the used protocol.

Definition at line 98 of file 9.2/includes/opentelemetry/semconv/url_attributes.h.

◆ kUrlScheme [3/4]

constexpr const char* semconv::url::kUrlScheme = "url.scheme"
staticconstexpr

The URI scheme component identifying the used protocol.

Definition at line 145 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlScheme [4/4]

constexpr const char* semconv::url::kUrlScheme = "url.scheme"
staticconstexpr

The URI scheme component identifying the used protocol.

Definition at line 145 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlSubdomain [1/2]

constexpr const char* semconv::url::kUrlSubdomain = "url.subdomain"
staticconstexpr

The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain.

In a partially qualified domain, or if the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain.

The subdomain portion of

www.east.mydomain.co.uk

is

east

. If the domain has multiple levels of subdomain, such as

sub2.sub1.example.com

, the subdomain field should contain

sub2.sub1

, with no trailing period.

Definition at line 155 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlSubdomain [2/2]

constexpr const char* semconv::url::kUrlSubdomain = "url.subdomain"
staticconstexpr

The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain.

In a partially qualified domain, or if the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain.

The subdomain portion of

www.east.mydomain.co.uk

is

east

. If the domain has multiple levels of subdomain, such as

sub2.sub1.example.com

, the subdomain field should contain

sub2.sub1

, with no trailing period.

Definition at line 155 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlTemplate [1/2]

constexpr const char* semconv::url::kUrlTemplate = "url.template"
staticconstexpr

The low-cardinality template of an absolute path reference.

Definition at line 161 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlTemplate [2/2]

constexpr const char* semconv::url::kUrlTemplate = "url.template"
staticconstexpr

The low-cardinality template of an absolute path reference.

Definition at line 161 of file includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlTopLevelDomain [1/2]

constexpr const char* semconv::url::kUrlTopLevelDomain = "url.top_level_domain"
staticconstexpr

The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name.

For example, the top level domain for example.com is

com

.

This value can be determined precisely with the public suffix list.

Definition at line 169 of file 9.2/includes/opentelemetry/semconv/incubating/url_attributes.h.

◆ kUrlTopLevelDomain [2/2]

constexpr const char* semconv::url::kUrlTopLevelDomain = "url.top_level_domain"
staticconstexpr

The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name.

For example, the top level domain for example.com is

com

.

This value can be determined precisely with the public suffix list.

Definition at line 169 of file includes/opentelemetry/semconv/incubating/url_attributes.h.