OpenTelemetry Collector Cookbook
This project is not officially affiliated with the CNCF's OpenTelemetry project and was created just for fun. If you like this tool or have any suggestions/feedback, please reach out in Github. #ToDo: add repo link here :)
OpenTelemetry provides three default distributions of its collector: Core, Contrib, and Kubernetes. Each distribution serves specific use cases and offers different advantages.
Additionally, OpenTelemetry comes with the OpenTelemetry Collector Builder (OCB) tool. It allows you to build and debug custom components by creating custom collector distributions. This is super useful for extending the OpenTelemetry collector, e.g., to observe custom data or just to experiment (which can be a lot of fun when you suddenly gain observability into your data 😜). For those new to OpenTelemetry, creating a custom distribution and running it within an IDE, coupled with a debugger, provides a great way to get insight how the collector works under the hood.
Generate
Getting started with the OpenTelemetry Collector can feel overwhelming, especially given that the OpenTelemetry Collector is just one part of the larger OpenTelemetry ecosystem, next to SDKs, APIs, semantic conventions, and more.
The Generate page is designed to help you quickly build your first custom OpenTelemetry collector with an easy-to-use, guided UI. To get started, you simply need to select at least one component for your custom collector. The page will then generate the build and run instructions for you.
Refer to the official OpenTelemetry documentation for more detailed Information about building a custom collector.
Recipes
The OpenTelemetry Collector provides a lot of flexibility in how it can be configured. Sometimes, you may want to run several different collectors (each for a different use case), or you may want to fine-tune how data is processed. You can also transform your data with the OpenTelemetry Transformation Language.
To make it easier for the community to share useful, tested components and help others improve and fine-tune their collector configuration, recipes (naming inspired by this great Kubecon presentation) provide a way to easily share configurations.
If you have any collector configurations you like to use and think others could benefit from, please consider sharing them as a recipe.
To add a recipe, all you need to do is open a pull request here - Thank you in advance! :)