@forinda/kickjs-otel
v1.3.2
Published
OpenTelemetry adapter for KickJS — automatic tracing, metrics, and export to any OTel backend
Maintainers
Keywords
Readme
@forinda/kickjs-otel
OpenTelemetry adapter for KickJS — automatic tracing, metrics, and export to any OTel backend.
Install
# Using the KickJS CLI (recommended — auto-installs peer dependencies)
kick add otel
# Manual install
pnpm add @forinda/kickjs-otel @opentelemetry/api @opentelemetry/semantic-conventions
# Optional SDK packages
pnpm add @opentelemetry/sdk-node @opentelemetry/sdk-trace-base @opentelemetry/sdk-metricsFeatures
OtelAdapter— lifecycle adapter that instruments requests with spans and metrics- Works with any OpenTelemetry-compatible backend (Jaeger, Grafana Tempo, Datadog, etc.)
- Zero-config console exporter for development
Quick Example
import { OtelAdapter } from '@forinda/kickjs-otel'
bootstrap({
modules,
adapters: [
new OtelAdapter({
serviceName: 'my-api',
enabled: true,
}),
],
})For production, initialize the OTel SDK before bootstrap:
import { NodeSDK } from '@opentelemetry/sdk-node'
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'
const sdk = new NodeSDK({
traceExporter: new OTLPTraceExporter({
url: 'http://localhost:4318/v1/traces',
}),
})
sdk.start()Documentation
License
MIT
