bylonis-otel-collector

module
v0.144.5-bylonis.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2026 License: AGPL-3.0

README

ByLonis OpenTelemetry Collector

The OpenTelemetry Collector distribution that ingests traces, logs and metrics into ByLonis's ClickHouse, plus the schema migrator that creates and upgrades those databases.

Hard fork of SigNoz/signoz-otel-collector at v0.144.5, under the AGPL-3.0 (see LICENSE and NOTICE).

Build

Requires Go 1.25.

make build        # .build/<os>-<arch>/bylonis-otel-collector and bylonis-schema-migrator
make test

Run

bylonis-otel-collector migrate bootstrap   # create the databases
bylonis-otel-collector migrate sync up     # schema migrations
bylonis-otel-collector migrate async up    # background migrations
bylonis-otel-collector --config=config.yaml

Configuration

Every flag can be set with an env var named BYLONIS_OTEL_COLLECTOR_<FLAG> (--clickhouse-dsn → BYLONIS_OTEL_COLLECTOR_CLICKHOUSE_DSN).

Env var Default Meaning
BYLONIS_OTEL_COLLECTOR_CLICKHOUSE_DSN tcp://0.0.0.0:9001 ClickHouse used by migrate
BYLONIS_OTEL_COLLECTOR_CLICKHOUSE_CLUSTER cluster ClickHouse cluster name
BYLONIS_OTEL_COLLECTOR_CLICKHOUSE_REPLICATION true Replicated tables
BYLONIS_DB_PREFIX signoz Prefix of the database names: <prefix>_traces, _metrics, _logs, _meter, _metadata, _analytics

BYLONIS_DB_PREFIX must be set to the same value for the migrator and the collector. Apart from the database names, migrations, tables and queries don't change.

Compatibility with SigNoz deployments

These keep working so an existing deployment can switch images without changing anything else. They are deprecated and will be removed in a later release.

  • SIGNOZ_OTEL_COLLECTOR_* env vars are read when the BYLONIS_ one is unset, with a warning in the log.
  • Components keep their signoz* names (signozlogspipeline, signozspanmetrics, signozclickhousemetrics, signozmeter, ...). Each one is also available with bylonis in its place (bylonislogspipeline, ...).
  • The images include /signoz-otel-collector and /signoz-schema-migrator as symlinks to the new binaries.
  • With the default BYLONIS_DB_PREFIX, the databases are the upstream signoz_* ones.

Directories

Path Synopsis
cmd
config
connectors
exporter
jsontypeexporter
Package jsontypeexporter exports telemetry data to JSON files.
Package jsontypeexporter exports telemetry data to JSON files.
signozkafkaexporter
package signozkafkaexporter exports trace data to Kafka.
package signozkafkaexporter exports trace data to Kafka.
signozkafkaexporter/internal/awsmsk
Package msk implements the required IAM auth used by AWS' managed Kafka platform to be used with the Surama kafka producer.
Package msk implements the required IAM auth used by AWS' managed Kafka platform to be used with the Surama kafka producer.
extension
healthcheckextension
Package healthcheckextension implements an extension that enables an HTTP endpoint that can be used to check the overall health and status of the service.
Package healthcheckextension implements an extension that enables an HTTP endpoint that can be used to check the overall health and status of the service.
internal
kafka/awsmsk
Package msk implements the required IAM auth used by AWS' managed Kafka platform to be used with the Surama kafka producer.
Package msk implements the required IAM auth used by AWS' managed Kafka platform to be used with the Surama kafka producer.
sharedcomponent
Package sharedcomponent exposes util functionality for receivers and exporters that need to share state between different signal types instances such as net.Listener or os.File.
Package sharedcomponent exposes util functionality for receivers and exporters that need to share state between different signal types instances such as net.Listener or os.File.
pkg
dbprefix
Package dbprefix makes the prefix of the ClickHouse database names configurable.
Package dbprefix makes the prefix of the ClickHouse database names configurable.
legacynames
Package legacynames emits the metrics the collector generates under their legacy SigNoz names as well as the bylonis ones, so that dashboards, alerts and UIs that still query signoz_* keep working while they move to the new names (bylonis/bylonis#47).
Package legacynames emits the metrics the collector generates under their legacy SigNoz names as well as the bylonis ones, so that dashboards, alerts and UIs that still query signoz_* keep working while they move to the new names (bylonis/bylonis#47).
processor
signozlogspipelineprocessor
Brought in as is from logstransform processor in opentelemetry-collector-contrib
Brought in as is from logstransform processor in opentelemetry-collector-contrib
signozlogspipelineprocessor/stanza/adapter
Register copies of stanza operators dedicated to signoz logs pipelines
Register copies of stanza operators dedicated to signoz logs pipelines
signozlogspipelineprocessor/stanza/entry
brought in as-is from opentelemetry-collector-contrib with changes to Get() to enable reading fields inside JSON body directly
brought in as-is from opentelemetry-collector-contrib with changes to Get() to enable reading fields inside JSON body directly
signozlogspipelineprocessor/stanza/operator/helper
brought in as is from "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/helper" with minor changes to use signozstanzaentry.Field instead of entry.Field
brought in as is from "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/helper" with minor changes to use signozstanzaentry.Field instead of entry.Field
signozlogspipelineprocessor/stanza/operator/operators/remove
Brought in as is from opentelemetry-collector-contrib
Brought in as is from opentelemetry-collector-contrib
signozlogspipelineprocessor/stanza/operator/operatortest
Brought in as is from opentelemetry-collector-contrib with anyOpConfig implementation updated to use operator config in logspipelineprocessor
Brought in as is from opentelemetry-collector-contrib with anyOpConfig implementation updated to use operator config in logspipelineprocessor
signoztailsampler
package signoztailsampler contains the logic to execute telemetry transform based on the OpenTelemetry Transformation Language.
package signoztailsampler contains the logic to execute telemetry transform based on the OpenTelemetry Transformation Language.
signoztailsampler/internal/idbatcher
Package idbatcher defines a pipeline of fixed size in which the elements are batches of ids.
Package idbatcher defines a pipeline of fixed size in which the elements are batches of ids.
signoztailsampler/internal/sampling
Package sampling contains the interfaces and data types used to implement the various sampling policies.
Package sampling contains the interfaces and data types used to implement the various sampling policies.
signoztransformprocessor
package signoztransformprocessor contains the logic to execute telemetry transform based on the OpenTelemetry Transformation Language.
package signoztransformprocessor contains the logic to execute telemetry transform based on the OpenTelemetry Transformation Language.
receiver
signozkafkareceiver
Package kafkareceiver receives traces from Kafka.
Package kafkareceiver receives traces from Kafka.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL