zeekayandGitHub
babbdec4b8
* debrand: signoz/SigNoz/SIGNOZ -> o11y/O11y/O11Y across the tree Rename all SigNoz *branding* to O11y in file contents, file/dir names, package names, env vars, config keys, comments, docs, SDK code, and the ClickHouse schema identifiers the querier reads. Collector dependency: - Repoint github.com/hanzoai/signoz-otel-collector -> github.com/hanzoai/otel-collector and bump v0.144.6 -> v0.144.7 (go.mod + go.sum reconciled via go mod tidy). Internal package paths also debranded upstream: signozschemamigrator -> o11yschemamigrator, signozlogspipelineprocessor -> o11ylogspipelineprocessor. - Fix: v0.144.7 dropped otelconst.DistributedFieldKeysTable from the collector's public constants; pin FieldKeysTable = "distributed_field_keys" locally in pkg/telemetrymetadata/tables.go. Package/dir renames (package decl + all importers): pkg/apiserver/signozapiserver -> o11yapiserver, plus signozalertmanager, signozauthzapi, signozglobal, signozquerier, signozruler, and pkg/signoz -> pkg/o11y. Schema (read plane): signoz_traces/metrics/logs/metadata/analytics/meter and signoz_index_v3/index_v2/error_index_v2/spans (+ distributed_*) -> o11y_*. Data-preserving cutover migration added: deploy/clickhouse/migrations/0001_rename_signoz_to_o11y.sql (metadata-only RENAME DATABASE/TABLE, no drop/recreate). Preserved (attribution / external / wire contracts): - LICENSE + NOTICE verbatim (incl. "software from SigNoz", "Copyright ... SigNoz Inc."). - Upstream github.com/SigNoz/* repo URLs + @SigNoz/* CODEOWNERS teams. - Billing resource-attribute regex "signoz.workspace.*" (external wire contract). go build ./pkg/... ./cmd/... = 0; gofmt clean; renamed+schema pkg tests pass. * o11y: bump collector to v0.144.8 (o11y_* physical schema writer) + lockstep deploy plan Collector v0.144.8's schema-migrator + exporters now CREATE/WRITE the same o11y_* physical databases/tables the querier reads and the RENAME migration (0001_rename_signoz_to_o11y.sql) targets. Cross-checked byte-identical: writer DB set == migration target DB set (6); writer prefixed-table set == migration target table set (8); o11y querier reads and cloud reads are subsets of that set. Zero table-name mismatches between writer, readers, and migration. Collector go.mod unchanged between v0.144.7 and v0.144.8 (identical go.mod hash) — pure source rename, no module-graph change. Adds deploy/clickhouse/DEPLOY_signoz_to_o11y_cutover.md: the lockstep order (collector v0.144.8 -> RENAME migration -> o11y+cloud readers) with a fresh/scratch-ClickHouse pre-flight (create via migrator, emit trace+metric, query back) and rollback. Ships together or telemetry blackholes. go build ./pkg/... ./cmd/community = 0.
2.2 KiB
Before You Begin
To configure metrics and logs collection for a Clickhouse server, you need the following.
Ensure Clickhouse server is prepared for monitoring
-
Ensure that the Clickhouse server is running a supported version
Clickhouse versions v23 and newer are supported.
You can use the following SQL statement to determine server versionSELECT version(); -
If collecting metrics, ensure that Clickhouse is configured to export prometheus metrics If needed, please configure Clickhouse to expose prometheus metrics.
-
If collecting query_log, ensure that there is a clickhouse user with required permissions To create a monitoring user for clickhouse, you can run:
CREATE USER monitoring IDENTIFIED BY 'monitoring_password'; GRANT SELECT ON system.query_log to monitoring; -- If monitoring a clustered deployment, also grant privilege for executing remote queries GRANT REMOTE ON *.* TO 'monitoring' on CLUSTER 'cluster_name';
Ensure OTEL Collector is running and has access to the Clickhouse server
-
Ensure that an OTEL collector is running in your deployment environment
If needed, please install O11y OTEL Collector
If already installed, ensure that the collector version is v0.88.0 or newer.
If collecting logs from system.query_log table, ensure that the collector version is v0.88.23 or newer.Also ensure that you can provide config files to the collector and that you can set environment variables and command line flags used for running it.
-
Ensure that the OTEL collector can access the Clickhouse server
In order to collect metrics, the collector must be able to reach clickhouse server and access the port on which prometheus metrics are being exposed.In order to collect server logs, the collector must be able to read the Clickhouse server log file.
In order to collect logs from query_log table, the collector must be able to reach the server and connect to it as a clickhouse user with required permissions.