Home

As mentioned in the README, the telemetry generator addresses the use case to test any platform that ingests OpenTelemetry data. There are two modes in which the tool can be run:

• As a library
  In this mode, you can add the JAR file from the release as a dependency in your code to perform the data generation. This mode has the benefit of flexibility for certain things like being able to implement your own way to post the generated data and if you run it in a separate thread, you can also monitor the status of the data generated in the number of payloads posted and killing the data generation via API.
• As a CLI
  This mode is for use cases where you just want to post the data to an endpoint from the command-line and not write any code for it. To do this, please use the fat-jar from the release artifacts which will have all the 3rd-party dependencies included.

Whichever mode you prefer, the tool needs to understand the schema/spec of the data you want to post, i.e. what kind of resources, metrics, logs and traces data. This is done by providing what we call definition files for each of these in the YAML format. The resource definition file must be provided while at least one of the metrics, logs or traces definition can be provided based on your requirements. Read more about these here:

• Resource model definition
• Metrics definition
• Logs definition
• Traces definition

The FAQ deals with a few questions on flexibility and more control on the execution.

Please open issues on the repo in case you'd like some more details added to this wiki.