otel_resource (opentelemetry v1.6.0)

View Source

A Resource is attributes representing the entity producing telemetry. For example, by default the language (Erlang), name of this library (opentelemetry), and version of this library are included in the Resource.

This module provides the functional interface for working with the resource record.

The opentelemetry library supports resource detectors to detect attributes to include in the Resource. See otel_resource_detector for the behaviour to detect resources, and the otel_resource_app_env and otel_resource_env_var modules for built-in implementations.

See the OpenTelemetry Resource documentation for more information on Resources.

Summary

Types

key/0

values allowed in attributes of a resource are limited

schema_url/0

A schema URL for the resource.

t/0

The type that represents a resource.

value/0

A resource value.

Functions

attributes(Resource)

Returns the attributes of the given Resource.

create(Attributes)

Equivalent to create(Attributes, undefined).

create(Map, SchemaUrl)

Creates a new resources from the given map or list of Attributes and with the given SchemaUrl.

is_key(K, Resource)

Returns true if Key is valid and part of the given resource.

merge(Resource, CurrentResource)

Merges the two given resources.

schema_url(Resource)

Returns the schema URL of the resource.

Types

key/0

-type key() :: unicode:latin1_binary() | atom().

values allowed in attributes of a resource are limited

schema_url/0

-type schema_url() :: uri_string:uri_string().

A schema URL for the resource.

t/0

-type t() ::
          #resource{schema_url :: schema_url() | undefined, attributes :: otel_attributes:t()} |
          undefined.

The type that represents a resource.

value/0

-type value() :: unicode:latin1_binary() | integer() | float() | boolean().

A resource value.

Functions

attributes(Resource)

-spec attributes(t()) -> otel_attributes:t() | undefined.

Returns the attributes of the given Resource.

This function returns undefined only in case Resource is an invalid argument (not a resource record).

create(Attributes)

-spec create(#{key() => value()} | [{key(), value()}]) -> t().

Equivalent to create(Attributes, undefined).

create(Map, SchemaUrl)

-spec create(#{key() => value()} | [{key(), value()}], schema_url() | undefined) -> t().

Creates a new resources from the given map or list of Attributes and with the given SchemaUrl.

This function verifies each key and value, and drops any that don't pass verification.

is_key(K, Resource)

-spec is_key(key(), t()) -> boolean().

Returns true if Key is valid and part of the given resource.

merge(Resource, CurrentResource)

-spec merge(t(), t()) -> t().

Merges the two given resources.

In case of collision, the first argument (Resource) takes precedence.

schema_url(Resource)

-spec schema_url(t()) -> schema_url() | undefined.

Returns the schema URL of the resource.