oneuptime/docker-compose.yml
Nawaz Dhandala f49b1995df
feat(telemetry): add new Telemetry service (OTel, Syslog, Fluent, Metrics, Traces) and unified ingestion pipeline
- Add Telemetry service entrypoint
  - Telemetry/Index.ts: app bootstrap, routes mounting, infrastructure init and Telemetry SDK init.

- Unified queue + worker
  - Telemetry/Jobs/TelemetryIngest/ProcessTelemetry.ts: single worker that dispatches queued jobs to specific processors (logs, traces, metrics, syslog, fluent logs).
  - Telemetry/Services/Queue/TelemetryQueueService.ts: central queue API and job payload types.
  - Per-type Queue wrappers (LogsQueueService, MetricsQueueService, TracesQueueService, FluentLogsQueueService, SyslogQueueService).

- OpenTelemetry ingestion middleware and proto support
  - Telemetry/Middleware/OtelRequestMiddleware.ts: detect OTLP endpoint (logs/traces/metrics), decode protobuf bodies using protobufjs and set product type.
  - Telemetry/ProtoFiles/OTel/v1/*.proto: include common.proto, logs.proto, metrics.proto, resource.proto, traces.proto for OTLP v1 messages.

- Ingest services
  - Telemetry/Services/OtelLogsIngestService.ts: parse incoming OTLP logs, map attributes, convert timestamps, batch insert logs.
  - Telemetry/Services/OtelTracesIngestService.ts: parse OTLP traces, build span rows, extract exceptions, batch insert spans and exceptions, save telemetry exception summary.
  - Telemetry/Services/OtelMetricsIngestService.ts: parse OTLP metrics, normalize datapoints, batch insert metrics and index metric name -> service map.
  - Telemetry/Services/SyslogIngestService.ts: syslog ingestion endpoints, parser integration, map syslog fields to attributes and logs.
  - Telemetry/Services/FluentLogsIngestService.ts: ingest Fluentd style logs, normalize entries and insert into log backend.
  - Telemetry/Services/OtelIngestBaseService.ts: helpers to resolve service name from attributes/headers.

- Syslog parser and utilities
  - Telemetry/Utils/SyslogParser.ts: robust RFC5424 and RFC3164 parser, structured data extraction and sanitization.
  - Telemetry/Tests/Utils/SyslogParser.test.ts: unit tests for parser behavior.

- Telemetry exception utilities
  - Telemetry/Utils/Exception.ts: generate exception fingerprint and upsert telemetry exception status (saveOrUpdateTelemetryException).

- Queue & job integration
  - New integration with Common/Server/Infrastructure/Queue and QueueWorker, job id generation and telemetry job types.
  - Telemetry services add ingestion jobs instead of processing synchronously.

- Config, build and dev tooling
  - Add Telemetry/package.json, package-lock.json, tsconfig.json, nodemon.json, jest config.
  - New script configs and dependencies (protobufjs, ts-node, jest, nodemon, etc).

- Docker / environment updates
  - docker-compose.base.yml, docker-compose.dev.yml, docker-compose.yml: rename service from open-telemetry-ingest -> telemetry and wire TELEMETRY_* envs.
  - config.example.env: rename and consolidate environment variables (OPEN_TELEMETRY_* -> TELEMETRY_*, update hostnames and ports).
  - Tests/Scripts/status-check.sh: update ready-check target to telemetry/status/ready.

- Other
  - Telemetry/Services/Queue/*: export helpers and legacy-compatible job interface shims.
  - Memory cleanup and batching safeguards across ingest services.
  - Logging and capture spans added to key code paths.

BREAKING CHANGES / MIGRATION NOTES:
- Environment variables and docker service names changed:
  - Replace OPEN_TELEMETRY_... vars with TELEMETRY_... (PORT, HOSTNAME, CONCURRENCY, DISABLE_TELEMETRY, etc).
  - docker-compose entries moved from "open-telemetry-ingest" to "telemetry" and image name changed to oneuptime/telemetry.
  - Update any deployment automation and monitoring checks referencing the old service name or endpoints.
- Consumers: OTLP endpoints and behavior remain supported, but ingestion is now queued and processed asynchronously.

Testing / Running:
- Install deps in Telemetry/ (npm install) after syncing Common workspace.
- Run dev: npx nodemon (nodemon.json) or build & start using provided scripts.
- Run tests with jest (Telemetry test suite includes SyslogParser unit tests).

Files added/modified (high level):
- Added many files under Telemetry/: Index, Jobs, Middleware, ProtoFiles, Services, Utils, Tests, package and config artifacts.
- Modified docker-compose.* and config.example.env and status check script to use new TELEMETRY service/vars.
2025-11-07 21:36:47 +00:00

147 lines
3.9 KiB
YAML

# Images are pushed to both Docker Hub and Github Container Registry. If you're using Github Container Registry, you can change the image tag to use the Github Container Registry.
# For example, if you want to use the image from Github Container Registry, you can change the image tag from oneuptime/dashboard:latest to ghcr.io/oneuptime/dashboard:latest
services:
redis:
extends:
file: ./docker-compose.base.yml
service: redis
clickhouse:
extends:
file: ./docker-compose.base.yml
service: clickhouse
postgres:
ports:
- "5400:5432" # for access to postgres for backups. If you don't need backup, you can comment this line out to make it more secure.
extends:
file: ./docker-compose.base.yml
service: postgres
otel-collector:
image: oneuptime/otel-collector:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: otel-collector
accounts:
image: oneuptime/accounts:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: accounts
dashboard:
image: oneuptime/dashboard:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: dashboard
admin-dashboard:
image: oneuptime/admin-dashboard:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: admin-dashboard
status-page:
image: oneuptime/status-page:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: status-page
app:
image: oneuptime/app:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: app
worker:
image: oneuptime/worker:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: worker
docs:
image: oneuptime/docs:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: docs
api-reference:
image: oneuptime/api-reference:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: api-reference
workflow:
image: oneuptime/workflow:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: workflow
home:
image: oneuptime/home:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: home
probe-1:
image: oneuptime/probe:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: probe-1
probe-2:
image: oneuptime/probe:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: probe-2
probe-ingest:
image: oneuptime/probe-ingest:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: probe-ingest
server-monitor-ingest:
image: oneuptime/server-monitor-ingest:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: server-monitor-ingest
telemetry:
image: oneuptime/telemetry:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: telemetry
incoming-request-ingest:
image: oneuptime/incoming-request-ingest:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: incoming-request-ingest
isolated-vm:
image: oneuptime/isolated-vm:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: isolated-vm
ingress:
image: oneuptime/nginx:${APP_TAG}
extends:
file: ./docker-compose.base.yml
service: ingress
volumes:
postgres:
clickhouse:
networks:
oneuptime:
driver: bridge