https://github.com/go-faster/oteldb

OpenTelemetry signal storage
https://github.com/go-faster/oteldb

clickhouse clickhouse-server grafana loki monitoring observability open-telemetry opentelemetry otel prometheus tempo

Last synced: 27 days ago
JSON representation

OpenTelemetry signal storage

• Host: GitHub
• URL: https://github.com/go-faster/oteldb
• Owner: go-faster
• License: apache-2.0
• Created: 2023-05-19T09:04:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-12T20:35:26.000Z (7 months ago)
• Last Synced: 2024-04-14T05:10:22.356Z (7 months ago)
• Topics: clickhouse, clickhouse-server, grafana, loki, monitoring, observability, open-telemetry, opentelemetry, otel, prometheus, tempo
• Language: Go
• Homepage:
• Size: 4.73 MB
• Stars: 30
• Watchers: 4
• Forks: 3
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff
  • Codeowners: CODEOWNERS
  • Security: .github/SECURITY.md
  • Support: .github/SUPPORT.md
  • Roadmap: ROADMAP.md

Awesome Lists containing this project

README

        






# oteldb [![codecov](https://img.shields.io/codecov/c/github/go-faster/oteldb?label=cover)](https://codecov.io/gh/go-faster/oteldb) [![experimental](https://img.shields.io/badge/-experimental-blueviolet)](https://go-faster.org/docs/projects/status#experimental)

The next generation, [OpenTelemetry-first][otel] aggregation system for metrics, traces and logs.

Compatible with [PromQL][promql], [TraceQL][traceql] and [LogQL][logql].

Based on [ClickHouse][clickhouse], fastest open-source (Apache 2.0) column-oriented database.

[clickhouse]: https://clickhouse.com/

[otel]: https://opentelemetry.io/

> [!WARNING]

> Work in progress. Not ready for production use.

Supported query languages:

- [PromQL][promql] ([Prometheus][prometheus]) for metrics, [>99% compatibility][compliance]

- [TraceQL][traceql] ([Grafana Tempo][tempo]) for traces

- [LogQL][logql] ([Grafana Loki][loki]) for logs

[traceql]: https://grafana.com/docs/tempo/latest/traceql/

[logql]: https://grafana.com/docs/loki/latest/query/

[promql]: https://prometheus.io/docs/prometheus/latest/querying/basics/

[prometheus]: https://prometheus.io/

[loki]: https://grafana.com/oss/loki/

[tempo]: https://grafana.com/oss/tempo/

Supported ingestion protocols:

- Prometheus remote write, including [exemplars][exemplars]

- OpenTelemetry protocol (gRPC) for metrics, traces and logs

Ingestion is possible with [OpenTelemetry collector][otelcol], supporting [over 90 protocols][otelcol-contrib].

[otelcol]: https://opentelemetry.io/docs/collector/

[otelcol-contrib]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver

[exemplars]: https://grafana.com/docs/grafana/latest/fundamentals/exemplars/

## Prometheus Compatibility

See [ch-compliance][compliance] for Prometheus compatibility tests.

```console

$ promql-compliance-tester -config-file promql-test-queries.yml -config-file test.oteldb.yml

Total: 547 / 548 (99.82%) passed, 0 unsupported

```

[compliance]: ./dev/local/ch-compliance

## Quick Start

Setup oteldb, ClickHouse, Grafana, and telemetry generators:

```shell

docker compose -f dev/local/ch/docker-compose.yml up -d

```

You can open Grafana dashboard at http://localhost:3000/d/oteldb/oteldb

## License

Apache License 2.0, see [LICENSE](./LICENSE).