Module: OpenTelemetry::SemConv::Incubating::TLS

Defined in:

lib/opentelemetry/semconv/incubating/tls/attributes.rb

Attribute Names

TLS_CIPHER =

Note:

Stability Level: development

String indicating the cipher used during the current connection.

The values allowed for tls.cipher MUST be one of the Descriptions of the registered TLS Cipher Suits.

Examples:

Sample Values

TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

'tls.cipher'

TLS_CLIENT_CERTIFICATE =

Note:

Stability Level: development

PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of client.certificate_chain since this value also exists in that list.

Examples:

Sample Values

MII...

'tls.client.certificate'

TLS_CLIENT_CERTIFICATE_CHAIN =

Note:

Stability Level: development

Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of client.certificate since that value should be the first certificate in the chain.

Examples:

Sample Values

["MII...", "MI..."]

'tls.client.certificate_chain'

TLS_CLIENT_HASH_MD5 =

Note:

Stability Level: development

Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.

Examples:

Sample Values

0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC

'tls.client.hash.md5'

TLS_CLIENT_HASH_SHA1 =

Note:

Stability Level: development

Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.

Examples:

Sample Values

9E393D93138888D288266C2D915214D1D1CCEB2A

'tls.client.hash.sha1'

TLS_CLIENT_HASH_SHA256 =

Note:

Stability Level: development

Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash.

Examples:

Sample Values

0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0

'tls.client.hash.sha256'

TLS_CLIENT_ISSUER =

Note:

Stability Level: development

Distinguished name of subject of the issuer of the x.509 certificate presented by the client.

Examples:

Sample Values

CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com

'tls.client.issuer'

TLS_CLIENT_JA3 =

Note:

Stability Level: development

A hash that identifies clients based on how they perform an SSL/TLS handshake.

Examples:

Sample Values

d4e5b18d6b55c71272893221c96ba240

'tls.client.ja3'

TLS_CLIENT_NOT_AFTER =

Note:

Stability Level: development

Date/Time indicating when client certificate is no longer considered valid.

Examples:

Sample Values

2021-01-01T00:00:00.000Z

'tls.client.not_after'

TLS_CLIENT_NOT_BEFORE =

Note:

Stability Level: development

Date/Time indicating when client certificate is first considered valid.

Examples:

Sample Values

1970-01-01T00:00:00.000Z

'tls.client.not_before'

TLS_CLIENT_SERVER_NAME =

Deprecated.

“Replaced by server.address.”, “reason”: “renamed”, “renamed_to”: “server.address”

Note:

Stability Level: development

Deprecated, use server.address instead.

Examples:

Sample Values

opentelemetry.io

'tls.client.server_name'

TLS_CLIENT_SUBJECT =

Note:

Stability Level: development

Distinguished name of subject of the x.509 certificate presented by the client.

Examples:

Sample Values

CN=myclient, OU=Documentation Team, DC=example, DC=com

'tls.client.subject'

TLS_CLIENT_SUPPORTED_CIPHERS =

Note:

Stability Level: development

Array of ciphers offered by the client during the client hello.

Examples:

Sample Values

["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"]

'tls.client.supported_ciphers'

TLS_CURVE =

Note:

Stability Level: development

String indicating the curve used for the given cipher, when applicable

Examples:

Sample Values

secp256r1

'tls.curve'

TLS_ESTABLISHED =

Note:

Stability Level: development

Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel.

Examples:

Sample Values

true

'tls.established'

TLS_NEXT_PROTOCOL =

Note:

Stability Level: development

String indicating the protocol being tunneled. Per the values in the IANA registry, this string should be lower case.

Examples:

Sample Values

http/1.1

'tls.next_protocol'

TLS_PROTOCOL_NAME =

Note:

Stability Level: development

Normalized lowercase protocol name parsed from original string of the negotiated SSL/TLS protocol version

'tls.protocol.name'

TLS_PROTOCOL_VERSION =

Note:

Stability Level: development

Numeric part of the version parsed from the original string of the negotiated SSL/TLS protocol version

Examples:

Sample Values

1.2
3

'tls.protocol.version'

TLS_RESUMED =

Note:

Stability Level: development

Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation.

Examples:

Sample Values

true

'tls.resumed'

TLS_SERVER_CERTIFICATE =

Note:

Stability Level: development

PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of server.certificate_chain since this value also exists in that list.

Examples:

Sample Values

MII...

'tls.server.certificate'

TLS_SERVER_CERTIFICATE_CHAIN =

Note:

Stability Level: development

Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of server.certificate since that value should be the first certificate in the chain.

Examples:

Sample Values

["MII...", "MI..."]

'tls.server.certificate_chain'

TLS_SERVER_HASH_MD5 =

Note:

Stability Level: development

Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.

Examples:

Sample Values

0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC

'tls.server.hash.md5'

TLS_SERVER_HASH_SHA1 =

Note:

Stability Level: development

Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.

Examples:

Sample Values

9E393D93138888D288266C2D915214D1D1CCEB2A

'tls.server.hash.sha1'

TLS_SERVER_HASH_SHA256 =

Note:

Stability Level: development

Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash.

Examples:

Sample Values

0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0

'tls.server.hash.sha256'

TLS_SERVER_ISSUER =

Note:

Stability Level: development

Distinguished name of subject of the issuer of the x.509 certificate presented by the client.

Examples:

Sample Values

CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com

'tls.server.issuer'

TLS_SERVER_JA3S =

Note:

Stability Level: development

A hash that identifies servers based on how they perform an SSL/TLS handshake.

Examples:

Sample Values

d4e5b18d6b55c71272893221c96ba240

'tls.server.ja3s'

TLS_SERVER_NOT_AFTER =

Note:

Stability Level: development

Date/Time indicating when server certificate is no longer considered valid.

Examples:

Sample Values

2021-01-01T00:00:00.000Z

'tls.server.not_after'

TLS_SERVER_NOT_BEFORE =

Note:

Stability Level: development

Date/Time indicating when server certificate is first considered valid.

Examples:

Sample Values

1970-01-01T00:00:00.000Z

'tls.server.not_before'

TLS_SERVER_SUBJECT =

Note:

Stability Level: development

Distinguished name of subject of the x.509 certificate presented by the server.

Examples:

Sample Values

CN=myserver, OU=Documentation Team, DC=example, DC=com

'tls.server.subject'