New component: cmd/golden

[atoulme]

The purpose and use-cases of the new component

This new component is a command line utility that can listen for traffic over OTLP and OTLPHTTP, and compare it with fixture files. It uses pkg/golden under the hood. It allows to set rules to ignore and rename elements of the fixture file to allow fuzzy matches to the incoming data.

Example configuration for the component

golden --listen-grpc http://localhost:4317 --expected file/foo_expected.yaml --ignore-start-timestamps --ignore-timestamps --ignore-metrics-order --wait 5m

If comparison is successful, the program exits as soon as the condition is matched with an exit code 0.

If the comparison fails, the program eventually exits with error code 1, with the output of the error provided by pkg/golden comparison.

Telemetry data types supported

metrics, traces, logs - start with metrics.

Code Owner(s)

@atoulme

Sponsor (optional)

@atoulme

Additional context

No response

[atoulme]

Given that @djaglowski is the original author of pkg/golden, which this CLI tool is wrapping, I have asked him to review, and possibly sponsor this submission.

[djaglowski]

I think this sounds like a useful addition. I wish I could sponsor it but don't have the capacity.

[atoulme]

I have sponsored this component for myself. If anyone wants to help own this code, please feel free to comment here.