mirror of https://github.com/hanzoai/o11y.git synced 2026-10-15 12:58:33 +00:00

Files

T

zeekay 18f3897514 docs(readme): cut the second README, and fix the quickstart

Below our own intro sat an entire second README — upstream SigNoz's, with
"SigNoz" replaced by "Hanzo O11y". The rename put a space inside every URL it
touched, so the links read github.com/Hanzo O11y/o11y/... and
twitter.com/Hanzo O11yHq. It also carried an issues badge for o11y/o11y (not
our repo), translated-README links to files that do not exist here, a
pre-filled tweet, four "Hanzo O11y vs Prometheus/Jaeger/Elastic/Loki"
sections, and the line "a cost-effective open-source alternative to Datadog
and New Relic".

The quickstart was wrong as well: `docker compose -f compose.yml up -d` —
there is no compose.yml in this repo — and port 3301. It is
`cd deploy/docker && docker compose up -d`, then localhost:8080, per
deploy/docker/docker-compose.yaml. Added the OTLP ports, since sending data
in is the step that was missing entirely. SigNoz lineage kept, matching
NOTICE.

2026-08-01 13:49:34 -07:00

2.3 KiB

Raw Permalink Blame History

o11y

Metrics, traces and logs for the Hanzo platform, in one place. OpenTelemetry on the wire, Hanzo Datastore — an OLAP column store — on disk.

Run it

cd deploy/docker
docker compose up -d

Open http://localhost:8080. deploy/install.sh does the same thing with a few more checks, and deploy/docker/docker-compose.ha.yaml is the multi-replica variant.

Send it data

The collector listens for OTLP on 4317 (gRPC) and 4318 (HTTP). Point any OpenTelemetry SDK or the OTel Collector at it:

export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318

Traces, metrics and logs land in Datastore and show up under APM, Logs, Traces, Metrics and Exceptions in the UI. Dashboards and alerting are built on the same queries.

What it is for

Every Hanzo service emits here. It is multi-tenant by design: queries scope by org from the X-Org-Id claim in the JWT, on every panel. It sits behind gateway like the other Hanzo subsystems, and mounts under the unified cloud binary per HIP-0106.

   instrumented app  ->  OTLP  ->  o11y collector
                                       |
                                 Hanzo Datastore
                                       |
                             APM | logs | traces | metrics
                                       |
                          queries scoped by X-Org-Id from JWT
                                       |
                          dashboards | alerting | exceptions

Docs

deploy/README.md — every deployment path in detail
docs/ — configuration, contributing notes, the OTel demo walkthrough
LLM.md — architecture and the conventions that apply in this repo
CONTRIBUTING.md

Lineage

Forked from SigNoz (MIT Expat, copyright 2020–present SigNoz Inc.), synced to upstream main at commit 3e6339019. The import history was squashed, so the root commit here is a Hanzo branding commit rather than upstream's history. See NOTICE.

License

MIT — see LICENSE.

2.3 KiB Raw Permalink Blame History Unescape Escape