Star us on GitHub
Star
Menu

Native OpenTelemetry Logging

Learn how to export logs to highlight.io via one of the OpenTelemetry SDKs.
1
Export your logs to the highlight.io collector.

We host an OpenTelemetry collector endpoint at https://otel.highlight.io:4318/v1/traces and https://otel.highlight.io:4318/v1/logs. Configure your OpenTelemetry SDK to send logs via OTLP HTTPS to this endpoint. Your Highlight Project ID should be included as an attribute with the highlight.project_id key. This configuration will depend on which SDK you use in your app.

import { NodeSDK } from '@opentelemetry/sdk-node' import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'; import { Resource } from '@opentelemetry/resources' import type { Attributes } from '@opentelemetry/api' const attributes: Attributes = { 'highlight.project_id': '<YOUR_PROJECT_ID>' } const sdk = new NodeSDK({ resource: new Resource(attributes), traceExporter: new OTLPTraceExporter({ // NB: this is the url for trace exports. if you are using a language which supports // the opentelemetry logs format, use 'https://otel.highlight.io:4318/v1/logs' url: 'https://otel.highlight.io:4318/v1/traces' }) }); const tracer = trace.getTracer('my-service'); sdk.start(); const log = (level: string, message: string) => { const span = tracer.startSpan('main') span.setAttributes({ ['highlight.session_id']: 'abc123', ['highlight.trace_id']: 'def456', customer: 'vadim', customer_id: 1234 }) span.addEvent('log', { ['log.severity']: level, ['log.message']: message }, new Date()) span.end() }; log('info', 'hello, world!')
Copy
2
Verify your backend logs are being recorded.

Visit the highlight logs portal and check that backend logs are coming in.