Appearance
To send OpenTelemetry metrics and traces generated by ARMS from your AI Application to Highlight.io, follow the below steps.
1. Get your Credentials
- Sign in to your Highlight.io account
- Navigate to Project Settings:
- Go to your project dashboard
- Click on Settings → Project Settings
- Get your Project ID:
- Copy your Project ID from the settings page
- This will be used in the OTLP endpoint URL
- Generate API Key (if needed):
- Navigate to API Keys section
- Generate a new API key for OpenTelemetry ingestion
- Copy the API key for authentication
2. Instrument your application
SDK
For direct integration into your Python applications:
Function Arguments
python
import elsai_arms
elsai_arms.init(
otlp_endpoint="https://otel.highlight.io:4318/v1/traces",
otlp_headers="x-highlight-project=YOUR_PROJECT_ID"
)Replace:
YOUR_PROJECT_IDwith your Highlight.io Project ID from Step 1.- Example:
x-highlight-project=1jdkoe52
- Example:
Environment Variables
python
import elsai_arms
elsai_arms.init()Set these environment variables:
shell
export OTEL_EXPORTER_OTLP_ENDPOINT="https://otel.highlight.io:4318/v1/traces"
export OTEL_EXPORTER_OTLP_HEADERS="x-highlight-project=YOUR_PROJECT_ID"Replace:
YOUR_PROJECT_IDwith your Highlight.io Project ID from Step 1.- Example:
x-highlight-project=1jdkoe52
- Example:
See the ARMS SDK configuration docs for more advanced options.
CLI
For zero-code auto-instrumentation via command line:
CLI Arguments
shell
# Using CLI arguments
elsai-arms-instrument \
--otlp-endpoint "https://otel.highlight.io:4318/v1/traces" \
--otlp-headers "x-highlight-project=YOUR_PROJECT_ID" \
--service-name "my-ai-service" \
--deployment-environment "production" \
python app.pyReplace:
YOUR_PROJECT_IDwith your Highlight.io Project ID from Step 1.- Example:
x-highlight-project=1jdkoe52
- Example:
Environment Variables
shell
# Set environment variables (takes precedence over CLI args)
export OTEL_EXPORTER_OTLP_ENDPOINT="https://otel.highlight.io:4318/v1/traces"
export OTEL_EXPORTER_OTLP_HEADERS="x-highlight-project=YOUR_PROJECT_ID"
export OTEL_SERVICE_NAME="my-ai-service"
export OTEL_DEPLOYMENT_ENVIRONMENT="production"
# Run your application
elsai-arms-instrument python app.pyReplace:
YOUR_PROJECT_IDwith your Highlight.io Project ID from Step 1.- Example:
x-highlight-project=1jdkoe52
- Example:
See the ARMS SDK configuration docs for more advanced options.
3. Visualize in Highlight.io
Once your LLM application is instrumented, you can explore the telemetry data in Highlight.io:
- Navigate to Traces: Go to your Highlight.io project dashboard and click on Traces
- Explore AI Operations: View your AI application traces including:
- LLM request traces with detailed timing
- Token usage and cost information
- Vector database operations
- Model performance analytics
- Request/response payloads (if enabled)
- Session Monitoring: Link traces to user sessions for full-stack observability
- Error Tracking: Monitor and debug AI application errors and exceptions
- Performance Analysis: Analyze latency, throughput, and resource usage
Your ARMS-instrumented AI applications will appear automatically in Highlight.io with comprehensive observability including LLM costs, token usage, model performance, and integration with your existing application monitoring.