otel-test validate
Check the spec, fixtures and rewritten config, and show the test plan, without running tests.
Usage: otel-test validate [OPTIONS]
Options:
--collector-bin <PATH>
-f, --file <FILE> [default: otel-test.yaml]
--color <COLOR> [default: auto] [possible values: auto, always, never]
--offlinevalidate does everything test does before the first test starts:
- parses and checks the test file;
- parses and checks the Collector config;
- resolves the Collector binary (downloading it if needed, unless
--offline); - rewrites the config and prints every change;
- runs
otelcol validateon the rewritten config; - loads every fixture, resolves each test's receiver and exporter references, and prints the plan.
No Collector is started and no telemetry is sent, so it's fast and safe as a first CI step or a pre-commit check.
Output
otel-test v0.1.0
Collector: v0.164.0 (/Users/you/Library/Caches/otel-test/otelcol-contrib/0.164.0-darwin_arm64/otelcol-contrib)
Config: collector.yaml
Tests: 3
✓ test specification is valid
Configuration rewrite:
- receiver otlp replaced by otlp/otel_test.otlp on 127.0.0.1:55207 (traces, logs)
- exporter otlp_http/backend replaced by otlp_http/otel_test.otlp_http/backend (traces, logs)
- extension health_check/otel_test added on 127.0.0.1:55208 for readiness checks
✓ rewritten Collector configuration passes `otelcol validate`
• passwords are removed from spans (1 span via otlp, timeout 2000ms)
- attribute password is absent
- attribute http.route equals "/login"
- exporter otlp_http/backend receives 1 item(s)
• passwords are removed from logs (1 log record via otlp, timeout 2000ms)
- attribute password is absent
- attribute user.name matches /[0-9a-f]{64}/
• health checks are dropped (1 span via otlp, timeout 2000ms)
- telemetry is dropped
✓ all fixtures, receivers and exporter references resolveEach planned test shows its item count and signal, the receiver it is injected through, its timeout, and every assertion in words. Timing warnings appear here too.
Failures
A spec that doesn't match the config:
✓ rewritten Collector configuration passes `otelcol validate`
error: test specification bad2.yaml does not match the Collector configuration:
- test "wrong exporter".expect[0]: exporter "datadog" is not used by any pipeline (exporters: otlp_http/backend)The exit codes are the same as for test: 2 for spec problems, 3 for config problems, 4 if the Collector is
unavailable. See Exit codes.