README
¶
Getting Started • Getting Involved • Getting In Touch
Vision • Design • Monitoring • Performance • Security • Roadmap • Package
OpenTelemetry Collector
The OpenTelemetry Collector offers a vendor-agnostic implementation on how to receive, process and export telemetry data. In addition, it removes the need to run, operate and maintain multiple agents/collectors in order to support open-source telemetry data formats (e.g. Jaeger, Prometheus, etc.) sending to multiple open-source or commercial back-ends.
Objectives:
- Usable: Reasonable default configuration, supports popular protocols, runs and collects out of the box.
- Performant: Highly stable and performant under varying loads and configurations.
- Observable: An exemplar of an observable service.
- Extensible: Customizable without touching the core code.
- Unified: Single codebase, deployable as an agent or collector with support for traces, metrics and logs.
Contributing
See CONTRIBUTING.md.
Triagers (@open-telemetry/collector-triagers):
- Alolita Sharma, AWS
- Punya Biswal, Google
- Steve Flanders, Splunk
Approvers (@open-telemetry/collector-approvers):
- Anthony Mirabella, AWS
- Dmitrii Anoshin, Splunk
- Jay Camp, Splunk
- Juraci Paixão Kröhling, Red Hat
- Owais Lone, Splunk
Maintainers (@open-telemetry/collector-maintainers):
- Bogdan Drutu, Splunk
- Tigran Najaryan, Splunk
Learn more about roles in the community repository.
Thanks to all the people who already contributed!
Directories
¶
| Path | Synopsis |
|---|---|
|
Package client contains generic representations of clients connecting to different receivers
|
Package client contains generic representations of clients connecting to different receivers |
|
cmd
|
|
|
otelcol
Program otelcol is the OpenTelemetry Collector that collects stats and traces and exports to a configured backend.
|
Program otelcol is the OpenTelemetry Collector that collects stats and traces and exports to a configured backend. |
|
builder
Module
|
|
|
checkdoc
Module
|
|
|
issuegenerator
Module
|
|
|
mdatagen
Module
|
|
|
otelcorecol
Module
|
|
|
schemagen
Module
|
|
|
Package component outlines the components used in the collector and provides a foundation for the component’s creation and termination process.
|
Package component outlines the components used in the collector and provides a foundation for the component’s creation and termination process. |
|
componenterror
Package componenterror provides helper functions to create and process OpenTelemetry component errors.
|
Package componenterror provides helper functions to create and process OpenTelemetry component errors. |
|
componenthelper
Package componenthelper assists with the creation of a new component.Component.
|
Package componenthelper assists with the creation of a new component.Component. |
|
componenttest
Package componenttest define types and functions used to help test packages implementing the component package interfaces.
|
Package componenttest define types and functions used to help test packages implementing the component package interfaces. |
|
experimental/component
Package component under config/experimental contains types and interfaces that typically live under the "go.opentelemetry.io/collector/component" package but aren't stable yet to be published there.
|
Package component under config/experimental contains types and interfaces that typically live under the "go.opentelemetry.io/collector/component" package but aren't stable yet to be published there. |
|
componentattribute
Module
|
|
|
componentprofiles
Module
|
|
|
componentstatus
Module
|
|
|
Package config defines the data models for entities.
|
Package config defines the data models for entities. |
|
configauth
Package configauth implements the configuration settings to ensure authentication on incoming requests, and allows exporters to add authentication on outgoing requests.
|
Package configauth implements the configuration settings to ensure authentication on incoming requests, and allows exporters to add authentication on outgoing requests. |
|
configcheck
Package configcheck has checks to be applied to configuration objects implemented by factories of components used in the OpenTelemetry collector.
|
Package configcheck has checks to be applied to configuration objects implemented by factories of components used in the OpenTelemetry collector. |
|
configgrpc
Package configgrpc defines the configuration settings to create a gRPC client and server.
|
Package configgrpc defines the configuration settings to create a gRPC client and server. |
|
confighttp
Package confighttp defines the configuration settings for creating an HTTP client and server.
|
Package confighttp defines the configuration settings for creating an HTTP client and server. |
|
confignet
Package confignet implements the configuration settings for protocols to connect and transport data information.
|
Package confignet implements the configuration settings for protocols to connect and transport data information. |
|
configtelemetry
Package configtelemetry defines various telemetry level for configuration.
|
Package configtelemetry defines various telemetry level for configuration. |
|
configtest
Package configtest loads the configuration to test packages implementing the config package interfaces.
|
Package configtest loads the configuration to test packages implementing the config package interfaces. |
|
configtls
Package configtls implements the TLS settings to load and configure TLS clients and servers.
|
Package configtls implements the TLS settings to load and configure TLS clients and servers. |
|
configunmarshaler
Package configunmarshaler implements configuration unmarshalling from a config.Parser.
|
Package configunmarshaler implements configuration unmarshalling from a config.Parser. |
|
experimental/config
Package config under config/experimental contains configuration related types and interfaces that typically live under the "go.opentelemetry.io/collector/config" package but aren't stable yet to be published there.
|
Package config under config/experimental contains configuration related types and interfaces that typically live under the "go.opentelemetry.io/collector/config" package but aren't stable yet to be published there. |
|
experimental/configsource
Package configsource is an experimental package that defines the interface of "configuration sources," e.g., Vault, ZooKeeper, etcd2, and others.
|
Package configsource is an experimental package that defines the interface of "configuration sources," e.g., Vault, ZooKeeper, etcd2, and others. |
|
internal/configsource
Package configsource is an internal package that implements methods for injecting, watching, and updating data from ConfigSource into configuration.
|
Package configsource is an internal package that implements methods for injecting, watching, and updating data from ConfigSource into configuration. |
|
configcompression
Module
|
|
|
confighttp/xconfighttp
Module
|
|
|
configopaque
Module
|
|
|
configretry
Module
|
|
|
internal
Module
|
|
|
confmap
module
|
|
|
converter/expandconverter
Module
|
|
|
provider/envprovider
Module
|
|
|
provider/fileprovider
Module
|
|
|
provider/httpprovider
Module
|
|
|
provider/httpsprovider
Module
|
|
|
provider/yamlprovider
Module
|
|
|
xconfmap
Module
|
|
|
connector
module
|
|
|
connectorprofiles
Module
|
|
|
connectortest
Module
|
|
|
forwardconnector
Module
|
|
|
xconnector
Module
|
|
|
Package consumer contains interfaces that receive and process consumerdata.
|
Package consumer contains interfaces that receive and process consumerdata. |
|
consumererror
Package consumererror provides wrappers to easily classify errors.
|
Package consumererror provides wrappers to easily classify errors. |
|
consumerhelper
Package consumerhelper defines types and functions used to create consumer Logs, Metrics, and Traces.
|
Package consumerhelper defines types and functions used to create consumer Logs, Metrics, and Traces. |
|
consumertest
Package consumertest defines types and functions used to help test packages implementing the consumer package interfaces.
|
Package consumertest defines types and functions used to help test packages implementing the consumer package interfaces. |
|
consumererror/xconsumererror
Module
|
|
|
consumerprofiles
Module
|
|
|
xconsumer
Module
|
|
|
examples
|
|
|
demo/app
Module
|
|
|
demo/client
Module
|
|
|
demo/server
Module
|
|
|
Package exporter contains implementations of Exporter components.
|
Package exporter contains implementations of Exporter components. |
|
exporterhelper
Package exporterhelper provides helper functions for exporters.
|
Package exporterhelper provides helper functions for exporters. |
|
fileexporter
Package fileexporter exports data to files.
|
Package fileexporter exports data to files. |
|
jaegerexporter
Package jaegerexporter sends trace data to a Jaeger Collector gRPC endpoint.
|
Package jaegerexporter sends trace data to a Jaeger Collector gRPC endpoint. |
|
kafkaexporter
Package kafkaexporter exports trace data to Kafka.
|
Package kafkaexporter exports trace data to Kafka. |
|
loggingexporter
Package loggingexporter exports data to console as logs.
|
Package loggingexporter exports data to console as logs. |
|
opencensusexporter
Package opencensusexporter exports data to an OpenCensus agent.
|
Package opencensusexporter exports data to an OpenCensus agent. |
|
otlpexporter
Package otlpexporter exports data by using the OTLP format to a gPRC endpoint.
|
Package otlpexporter exports data by using the OTLP format to a gPRC endpoint. |
|
otlphttpexporter
Package otlphttpexporter exports data by using the OTLP format to an HTTP endpoint.
|
Package otlphttpexporter exports data by using the OTLP format to an HTTP endpoint. |
|
prometheusexporter
Package prometheusexporter exports metrics data as a Prometheus pull handler.
|
Package prometheusexporter exports metrics data as a Prometheus pull handler. |
|
prometheusremotewriteexporter
Package prometheusremotewriteexporter sends metrics data to Prometheus Remote Write (PRW) endpoints.
|
Package prometheusremotewriteexporter sends metrics data to Prometheus Remote Write (PRW) endpoints. |
|
zipkinexporter
Package zipkinexporter exports trace data to Zipkin.
|
Package zipkinexporter exports trace data to Zipkin. |
|
debugexporter
Module
|
|
|
exporterprofiles
Module
|
|
|
exportertest
Module
|
|
|
nopexporter
Module
|
|
|
xexporter
Module
|
|
|
extension
module
|
|
|
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. |
|
pprofextension
Package pprofextension implements an extension that exposes the golang net/http/pprof (Performance Profiler) in a HTTP endpoint.
|
Package pprofextension implements an extension that exposes the golang net/http/pprof (Performance Profiler) in a HTTP endpoint. |
|
storage
Package stanzareceiver implements a receiver that can be used by the Opentelemetry collector to receive logs using the stanza log agent
|
Package stanzareceiver implements a receiver that can be used by the Opentelemetry collector to receive logs using the stanza log agent |
|
zpagesextension
Package zpagesextension implements an extension that exposes zPages of properly instrumented components.
|
Package zpagesextension implements an extension that exposes zPages of properly instrumented components. |
|
auth
Module
|
|
|
auth/authtest
Module
|
|
|
experimental/storage
Module
|
|
|
extensionauth
Module
|
|
|
extensioncapabilities
Module
|
|
|
extensiontest
Module
|
|
|
memorylimiterextension
Module
|
|
|
xextension
Module
|
|
|
featuregate
module
|
|
|
filter
module
|
|
|
internal
|
|
|
cgroups
Package cgroups provides utilities to access Linux control group (CGroups) parameters (total memory, for example) for a given process.
|
Package cgroups provides utilities to access Linux control group (CGroups) parameters (total memory, for example) for a given process. |
|
collector/telemetry
Package telemetry controls the telemetry settings to be used in the collector.
|
Package telemetry controls the telemetry settings to be used in the collector. |
|
idutils
Package idutils provides a set of helper functions to convert ids.
|
Package idutils provides a set of helper functions to convert ids. |
|
obsreportconfig/obsmetrics
Package obsmetrics defines the obsreport metrics for each components all the metrics is in OpenCensus format which will be replaced with OTEL Metrics in the future
|
Package obsmetrics defines the obsreport metrics for each components all the metrics is in OpenCensus format which will be replaced with OTEL Metrics in the future |
|
processor/filtermetric
Package filtermetric is a helper package for processing metrics.
|
Package filtermetric is a helper package for processing metrics. |
|
processor/filterset
Package filterset provides an interface for matching strings against a set of string filters.
|
Package filterset provides an interface for matching strings against a set of string filters. |
|
processor/filterset/regexp
Package regexp provides an implementation to match strings against a set of regexp string filters.
|
Package regexp provides an implementation to match strings against a set of regexp string filters. |
|
processor/filterset/strict
Package strict provides an implementation to match strings against a set of exact match string filters.
|
Package strict provides an implementation to match strings against a set of exact match string filters. |
|
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. |
|
fanoutconsumer
Module
|
|
|
featuregates
Module
|
|
|
globalgates
Module
|
|
|
globalsignal
Module
|
|
|
memorylimiter
Module
|
|
|
telemetry
Module
|
|
|
tools
Module
|
|
|
model
module
|
|
|
Package obsreport provides unified and consistent observability signals ( metrics, tracing, etc) for components of the OpenTelemetry collector.
|
Package obsreport provides unified and consistent observability signals ( metrics, tracing, etc) for components of the OpenTelemetry collector. |
|
otelcol
module
|
|
|
otelcoltest
Module
|
|
|
pdata
module
|
|
|
pprofile
Module
|
|
|
pipeline
module
|
|
|
pipelineprofiles
Module
|
|
|
xpipeline
Module
|
|
|
processor
module
|
|
|
attributesprocessor
Package attributesprocessor contains the logic to modify attributes of a span.
|
Package attributesprocessor contains the logic to modify attributes of a span. |
|
filterprocessor
Package filterprocessor implements a processor for filtering (dropping) metrics and/or spans by various properties.
|
Package filterprocessor implements a processor for filtering (dropping) metrics and/or spans by various properties. |
|
memorylimiter
Package memorylimiter provides a processor for OpenTelemetry Service pipeline that drops data on the pipeline according to the current state of memory usage.
|
Package memorylimiter provides a processor for OpenTelemetry Service pipeline that drops data on the pipeline according to the current state of memory usage. |
|
resourceprocessor
Package resourceprocessor implements a processor for specifying resource labels to be added to OpenCensus trace data and metrics data.
|
Package resourceprocessor implements a processor for specifying resource labels to be added to OpenCensus trace data and metrics data. |
|
spanprocessor
Package spanprocessor contains logic to modify top level settings of a span, such as its name.
|
Package spanprocessor contains logic to modify top level settings of a span, such as its name. |
|
memorylimiterprocessor
Module
|
|
|
processorprofiles
Module
|
|
|
processortest
Module
|
|
|
xprocessor
Module
|
|
|
Package receiver contains implementations of Receiver components.
|
Package receiver contains implementations of Receiver components. |
|
hostmetricsreceiver
Package hostmetricsreceiver reads metrics like CPU usage, disk usage, and network usage from the host.
|
Package hostmetricsreceiver reads metrics like CPU usage, disk usage, and network usage from the host. |
|
hostmetricsreceiver/internal/perfcounters
Package perfcounters is a thin wrapper around https://godoc.org/github.com/leoluk/perflib_exporter/perflib that provides functions to scrape raw performance counter data, without calculating rates or formatting them, from the registry.
|
Package perfcounters is a thin wrapper around https://godoc.org/github.com/leoluk/perflib_exporter/perflib that provides functions to scrape raw performance counter data, without calculating rates or formatting them, from the registry. |
|
jaegerreceiver
Package jaegerreceiver receives Jaeger traces.
|
Package jaegerreceiver receives Jaeger traces. |
|
kafkareceiver
Package kafkareceiver receives traces from Kafka.
|
Package kafkareceiver receives traces from Kafka. |
|
opencensusreceiver
Package opencensusreceiver receives OpenCensus traces.
|
Package opencensusreceiver receives OpenCensus traces. |
|
opencensusreceiver/internal/ocmetrics
Package ocmetrics is the logic for receiving OpenCensus metrics proto from already instrumented applications and then passing them onto a metricsink instance.
|
Package ocmetrics is the logic for receiving OpenCensus metrics proto from already instrumented applications and then passing them onto a metricsink instance. |
|
opencensusreceiver/internal/octrace
Package octrace is the logic for receiving OpenCensus trace protobuf defined spans from already instrumented applications and then passing them onto a TracesReceiverSink instance.
|
Package octrace is the logic for receiving OpenCensus trace protobuf defined spans from already instrumented applications and then passing them onto a TracesReceiverSink instance. |
|
otlpreceiver
Package otlpreceiver receives data in OTLP format.
|
Package otlpreceiver receives data in OTLP format. |
|
prometheusreceiver
Package prometheusreceiver autodiscovers and scrapes Prometheus metrics handlers, often served at /metrics.
|
Package prometheusreceiver autodiscovers and scrapes Prometheus metrics handlers, often served at /metrics. |
|
receiverhelper
Package receiverhelper contains utilities for receivers.
|
Package receiverhelper contains utilities for receivers. |
|
scrapererror
Package scraperror provides custom error types for scrapers.
|
Package scraperror provides custom error types for scrapers. |
|
scraperhelper
Package scraperhelper provides utilities for scrapers.
|
Package scraperhelper provides utilities for scrapers. |
|
zipkinreceiver
Package zipkinreceiver receives Zipkin traces.
|
Package zipkinreceiver receives Zipkin traces. |
|
nopreceiver
Module
|
|
|
receiverprofiles
Module
|
|
|
receivertest
Module
|
|
|
xreceiver
Module
|
|
|
scraper
module
|
|
|
scraperhelper
Module
|
|
|
scrapertest
Module
|
|
|
semconv
module
|
|
|
Package service handles the command-line, configuration, and runs the OpenTelemetry Collector.
|
Package service handles the command-line, configuration, and runs the OpenTelemetry Collector. |
|
defaultcomponents
Package defaultcomponents composes the default set of components used by the otel service
|
Package defaultcomponents composes the default set of components used by the otel service |
|
internal/builder
Package builder handles the options to build the OpenTelemetry collector pipeline.
|
Package builder handles the options to build the OpenTelemetry collector pipeline. |
|
internal/fanoutconsumer
Package fanoutconsumer contains implementations of Traces/Metrics/Logs consumers that fan out the data to multiple other consumers.
|
Package fanoutconsumer contains implementations of Traces/Metrics/Logs consumers that fan out the data to multiple other consumers. |
|
hostcapabilities
Module
|
|
|
Package testbed allows to easily set up a test that requires running the agent and a load generator, measure and define resource consumption expectations for the agent, fail tests automatically when expectations are exceeded.
|
Package testbed allows to easily set up a test that requires running the agent and a load generator, measure and define resource consumption expectations for the agent, fail tests automatically when expectations are exceeded. |
|
correctness/metrics
Package metrics contains functionality for testing an otelcol pipeline end to end for metric correctness.
|
Package metrics contains functionality for testing an otelcol pipeline end to end for metric correctness. |
|
translator
|
|
Click to show internal directories.
Click to hide internal directories.