OpenTelemetry Resources Util

This package provides support for working with OpenTelemetry Resource objects, e.g. `resourceFromAttributes(), and includes a number of resource detectors which gather resource attributes from the environment. (Other resource detectors, e.g. for cloud providers, are available in "resource-detector-*" packages in the opentelemetry-js-contrib.git repository.

This document defines standard attributes for resources which are accessible via @opentelemetry/semantic-conventions.

Installation

npm install --save @opentelemetry/resources
Copy

Usage

import { ATTR_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
import { resourceFromAttributes } from '@opentelemetry/resources';

const resource = resourceFromAttributes({
    [ATTR_SERVICE_NAME]: 'api-service',
});

const anotherResource = resourceFromAttributes({
    'service.version': '2.0.0',
    'service.group': 'instrumentation-group'
});
const mergedResource = resource.merge(anotherResource);
Copy

Resource detectors

import { detectResources, processDetector, hostDetector } from '@opentelemetry/resources';

const resource = detectResources({
  detectors: [ processDetector, hostDetector ],
});
Copy

Included resource detectors:

• hostDetector: Detect host.* attributes per https://opentelemetry.io/docs/specs/semconv/resource/host/.
• osDetector: Detect os.* attributes per https://opentelemetry.io/docs/specs/semconv/resource/os/.
• processDetector: Detect process.* attributes per https://opentelemetry.io/docs/specs/semconv/resource/process/.
• resourceAttributesEnvDetector: Detect attributes from the OTEL_RESOURCE_ATTRIBUTES environment variable per https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration.
• serviceInstanceIdDetector: Detect service.instance.id per https://opentelemetry.io/docs/specs/semconv/resource/service/#service-instance.
• serviceNameEnvDetector: Detect service.name from the OTEL_SERVICE_NAME environment variable per https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.