# Telemetry Generator

### Supported Platforms

| Platform | Metrics | Logs | Traces |
| -------- | ------- | ---- | ------ |
| Linux    | ✓       | ✓    | ✓      |
| Windows  | ✓       | ✓    | ✓      |
| macOS    | ✓       | ✓    | ✓      |

### Description

The Telemetry Generator is a source that generates random telemetry data for testing purposes. This source is useful for testing the load and pipeline configurations.

### Minimum Collector Versions

* Introduced: [v1.46.0](https://github.com/observIQ/bindplane-otel-collector/releases/tag/v1.46.0)
* Updated to include Host Metrics & Windows Events: [v1.47.0](https://github.com/observIQ/bindplane-otel-collector/releases/tag/v1.47.0)

### Supported Pipelines

* Logs
* Metrics
* Traces

### Configuration for all generators

<table><thead><tr><th width="183.6015625">Field</th><th width="85.890625">Default</th><th width="88.8125">Required</th><th>Description</th></tr></thead><tbody><tr><td>Payloads per second</td><td><code>1</code></td><td><code>true</code></td><td>The number of payloads this receiver will generate per second.</td></tr></tbody></table>

#### Logs Generator Configuration

<table><thead><tr><th width="180.6796875">Field</th><th>Description</th></tr></thead><tbody><tr><td>Resource Attributes</td><td>A map of resource attributes to be included in the generated telemetry. Values can be <code>any</code>.</td></tr><tr><td>Attributes</td><td>A map of attributes to be included in the generated telemetry. Values can be <code>any</code>.</td></tr><tr><td>body</td><td>The body of the log</td></tr><tr><td>severity</td><td>The severity of the log message</td></tr></tbody></table>

#### OTLP Replay Generator

The OTLP Replay Generator replays JSON-formatted telemetry. It adjusts the timestamps of the telemetry relative the current time, with the most recent record moved to the current time, and the previous records the same relative duration in the past. The text in the `OTLP JSON` box should be valid [JSON-formatted OTLP](https://github.com/open-telemetry/opentelemetry-proto#otlpjson), such as the JSON created by `plog.JSONMarshaler`,`ptrace.JSONMarshaler`, or `pmetric.JSONMarshaler`.

<table><thead><tr><th width="115.8203125">Field</th><th>Description</th></tr></thead><tbody><tr><td>Type</td><td>The type of telemetry to replay: <code>logs</code>, <code>metrics</code>, or <code>traces</code>.</td></tr><tr><td>OTLP JSON</td><td>A string of JSON encoded OTLP telemetry</td></tr></tbody></table>

#### Host Metrics Generator

The host metrics generator creates synthetic host metrics, from a list of pre-defined metrics. The metrics resource attributes can be set in the `Resource Attributes` section of the configuration.

#### Windows Events Generator

The Windows Events Generator replays a sample of recorded Windows Event Log data. It has no additional configuration.