Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 3.29 KB

README.md

File metadata and controls

67 lines (42 loc) · 3.29 KB
Raw

OpenTelemetry Icon Otel Component generator

OpenTelemetry is a collection of tools, APIs, and SDKs used to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) to help analyze your software’s performance and behavior. The OpenTelemetry Collector is a constituent of opentelemetry and can collect data from OpenTelemetry SDKs and other sources. This project is a component generator for the OpenTelemetry collector. The Opentelemetry collector has various components like Extensions, Receivers, Exporters, and Processors. The aim of this project is to create a tool that generates code scaffolding that would bootstrap creating otel components for developers.

Installation

You can download the binary here. Place in your system's PATH environment variable. You can follow the tutorial here

Binary not released yet please refer to the [example usage without binary](### Example usage without binary)

Example usage:

ocg --component exporter --output example --signal trace,log --module github.com/user/sample

Example usage without binary

Note: Ensure you ahave GO installed, if not, install here

git clone github.com/Chinwendu20/otel_components_generator
cd main
go run . --component exporter --output example --signal trace,log --module github.com/user/sample

Expected Output

image

How it works

The component generator has different flags:

  • component: It is used to specify the type of component to be generated. The following are the accepted values: exporter,processor,extension,receiver. Only one can be specified at a time.

  • output: It is used to indicate the location in which the generated source code would live in. The input should be string value.

  • signal: It is used to indicate the signal(s) associated with a component. The accepted values are: trace,metric,log. More than one can be specified at a time but should be delimited with a comma and no whitespaces in between. e.g. --signal trace,metric.

  • module: It is used to indicate the name of the module to be generated

  • gopath Indicate the Go binary while executing Go commands. Default: go from the PATH"

  • skipGetModules Indicate if the generator should only generate code without calling 'go mod tidy' (default false)

How to contribute

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue and let us know how we can make this project better. Don't forget to give the project a star! Thanks again!

  • Fork the Project
  • Create your Feature Branch (git checkout -b feature/AmazingFeature)
  • Commit your Changes (git commit -m 'Add some AmazingFeature')
  • Push to the Branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

Acknowledgement.

Conceptualizing this was heavily inspired by the work done in opentelemetry collector builder

Please do not forget to give this project a star