@traceloop/instrumentation-openai

OpenTelemetry OpenAI instrumentation for Node.js

This module provides automatic instrumentation for OpenAI SDK module, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @traceloop/node-server-sdk bundle.

If total installation size is not constrained, it is recommended to use the @traceloop/node-server-sdk bundle for the most seamless instrumentation experience.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @traceloop/instrumentation-openai

Supported Versions

• >=4.12.1

Usage

To load a specific plugin, specify it in the registerInstrumentations's configuration:

const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
const { OpenAIInstrumentation } = require("@traceloop/instrumentation-openai");
const { registerInstrumentations } = require("@opentelemetry/instrumentation");

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [new OpenAIInstrumentation()],
});

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 on Slack

License

Apache 2.0 - See LICENSE for more information.