@opentelemetry/resource-detector-instana

OpenTelemetry Resource Detector for Instana

This resource detector will detect the Instana agent to register the Opentelemetry as a Node.js process. The created resource will be automatically merged with the existing resources and contains the real PID, which is returned from the Instana agent. This mechanism is needed to connect the Node.js Otel process with the incoming Opentelemetry spans.

Installation

npm install --save @opentelemetry/resource-detector-instana

Environment variables

• INSTANA_AGENT_HOST: The Instana agent hostname.
• INSTANA_AGENT_PORT: The Instana agent port.
• INSTANA_RETRY_TIMEOUT_MS: The resource detector does three retries to connect to the Instana agent. This is the timeout between the retries.
• INSTANA_AGENT_TIMEOUT_MS: The client timeout when connecting the Instana agent.

Usage

import {
  Resource,
  processDetector,
  envDetector,
} from "@opentelemetry/resources";
import { SEMRESATTRS_SERVICE_NAME } from "@opentelemetry/semantic-conventions";
import { NodeSDK } from "@opentelemetry/sdk-node";
import { instanaAgentDetector } from "@opentelemetry/resource-detector-instana";

const globalResource = new Resource({
   [SEMRESATTRS_SERVICE_NAME]: "TestService",
});

const sdk = new NodeSDK({
   resourceDetectors: [envDetector, processDetector, instanaAgentDetector],
   resource: globalResource,
});

sdk.start()

Available detectors

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

Instana Agent Detector

Resource Attribute	Description
process.pid	The ID of the process. Value of parameter pid from the response to a request to /com.instana.plugin.nodejs.discovery
service.instance.id	The agent UUID. Value of parameter agentUuid from the response to a request to /com.instana.plugin.nodejs.discovery

Useful links

• For more information about Instana Agent, visit: https://www.ibm.com/docs/en/instana-observability/current?topic=instana-host-agent
• 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.