Skip to content

feat: send otel data to otel endpoint #2970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chronark merged 2 commits into from
Mar 14, 2025
Merged

feat: send otel data to otel endpoint #2970

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17726e5
feat: send otel data to otel endpoint
chronark Mar 14, 2025
62932b0
chore: clean up
chronark Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 0 additions & 256 deletions apps/agent/pkg/gossip/membership_test.go
View file
Open in desktop

This file was deleted.

37 changes: 24 additions & 13 deletions apps/engineering/content/architecture/services/api/config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@ These options control the fundamental behavior of the API server.

**Examples:**
- `--http-port=7070` - Default port
- `--http-port=8080` - Common alternative for local development
- `--http-port=80` - Standard HTTP port (requires root privileges on Unix systems)
</Property>

<Property name="--region | UNKEY_REGION" type="string" defaultValue="unknown" required={false}>
Expand All @@ -110,9 +108,8 @@ The Unkey API requires a MySQL database for storing keys and configuration. For
For production use, ensure the database has proper backup procedures in place. Unkey is using [PlanetScale](https://planetscale.com/)

**Examples:**
- `--database-primary=mysql://root:password@localhost:3306/unkey`
- `--database-primary=mysql://user:password@mysql.example.com:3306/unkey?tls=true`
- `--database-primary=mysql://unkey:password@mysql.default.svc.cluster.local:3306/unkey`
- `--database-primary=mysql://root:password@localhost:3306/unkey?parseTime=true` - Local MySQL for development
- `--database-primary=mysql://username:pscale_pw_...@aws.connect.psdb.cloud/unkey?sslmode=require` - PlanetScale connection
</Property>

<Property name="--database-readonly-replica | UNKEY_DATABASE_READONLY_DSN" type="string" required={false}>
Expand All @@ -123,8 +120,8 @@ The Unkey API requires a MySQL database for storing keys and configuration. For
Unkey is using [PlanetScales](https://planetscale.com/) global read replica endpoint.

**Examples:**
- `--database-readonly-replica=mysql://readonly:password@replica.mysql.example.com:3306/unkey?tls=true`
- `--database-readonly-replica=mysql://readonly:password@mysql-replica.default.svc.cluster.local:3306/unkey`
- `--database-readonly-replica=mysql://root:password@localhost:3306/unkey?parseTime=true` - Local MySQL for development
- `--database-readonly-replica=mysql://username:pscale_pw_...@aws.connect.psdb.cloud/unkey?sslmode=require` - PlanetScale connection
</Property>

## Analytics & Monitoring
Expand All @@ -143,15 +140,29 @@ These options configure analytics storage and observability for the Unkey API.
- `--clickhouse-url=clickhouse://default:password@clickhouse.default.svc.cluster.local:9000/unkey?secure=true`
</Property>

<Property name="--otel-otlp-endpoint | UNKEY_OTEL_OTLP_ENDPOINT" type="string" required={false}>
OpenTelemetry collector endpoint for metrics, traces, and logs. When provided, the Unkey API will send telemetry data (metrics, traces, and logs) to this endpoint using the OTLP protocol.
<Property name="--otel | UNKEY_OTEL" type="boolean" defaultValue={false} required={false}>
Enable OpenTelemetry. The Unkey API will collect and export telemetry data (metrics, traces, and logs) using the OpenTelemetry protocol.

This should be specified as a host and optional port without scheme or path. The implementation is configured for HTTP protocol by default.
When this flag is set to true, the following standard OpenTelemetry environment variables are used to configure the exporter:

- `OTEL_EXPORTER_OTLP_ENDPOINT`: The URL of your OpenTelemetry collector
- `OTEL_EXPORTER_OTLP_PROTOCOL`: The protocol to use (http/protobuf or grpc)
- `OTEL_EXPORTER_OTLP_HEADERS`: Headers for authentication (e.g., "authorization=Bearer \<token\>")

Using these standard variables ensures compatibility with OpenTelemetry documentation and tools. For detailed configuration information, see the [official OpenTelemetry documentation](https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/).

**Examples:**
- `--otel-otlp-endpoint=localhost:4317` - Local collector
- `--otel-otlp-endpoint=otlp-gateway-prod-us-east-0.grafana.net:443` - Grafana Cloud
- `--otel-otlp-endpoint=api.honeycomb.io:443` - Honeycomb.io

```bash
# Enable OpenTelemetry
export UNKEY_OTEL=true
export OTEL_EXPORTER_OTLP_ENDPOINT="https://otlp-gateway-prod-us-east-0.grafana.net/otlp"
export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
export OTEL_EXPORTER_OTLP_HEADERS="authorization=Basic ..."

# Or as command-line flags
unkey api --otel=true"
```
</Property>

<Property name="--color | UNKEY_COLOR" type="boolean" defaultValue={false} required={false}>
Expand Down
Loading
Loading