search

kyma-project / opentelemetry-collector-components

Contains Otel Collector components that are not pushed to upstream (yet) or components that are Kyma specific
Apache License 2.0
2 stars 8 forks source link

readme

OpenTelemetry Collector Components

Status

REUSE status

GitHub tag checks state

Overview

Contains a custom distribution of the OTel Collector Contrib bundle with additional OTel Collector components used by the Kyma Telemetry module. The additional components are either general and planned to be contributed to the upstream contrib repo, or Kyma-specific.

For actual distribution configuration, see OTel Collector Docker Image.

The additional components are located in the receiver folder.

Prerequisites

TBD: List the requirements to run the project or example.

Installation

TBD: Explain the steps to install your project. If there are multiple installation options, mention the recommended one and include others in a separate document. Create an ordered list for each installation task.

Usage

TBD: Explain how to use the project. You can create multiple subsections (H3). Include the instructions or provide links to the related documentation.

Development

Running the Receiver Locally

  1. Update the builder-config.yaml with the desired receiver.
  2. Run make target make genotelkymacol.
  3. Create a valid config.yaml for the receiver and place it as ./local/config.yaml.
  4. To run the receiver, call make target make run.

Contributing

See the Contributing Rules.

Code of Conduct

See the Code of Conduct document.

Licensing

See the license file.