HotCodePush

telemetry-export

Set, get, update, test and delete your organization's OpenTelemetry export with hotcodepush telemetry-export, with its headers and signals.

hotcodepush telemetry-export manages the organization's telemetry export: one OTLP/HTTP base URL that receives every audit event as a log record and the update metrics every hour. There is one export per organization, so no verb names it. Its deliveries are telemetry-export-delivery.

Experimental

The telemetry export is new, and the record and metric names it sends may still change.

get

Print the organization's telemetry export with its URL, signals, header names and, while it is disabled, since when. The header values never print.

hotcodepush telemetry-export get
hotcodepush telemetry-export get --organization Acme --json

set

Set the organization's telemetry export, replacing the one before whole: the base URL, the headers the backend authenticates with, and the signals. Every header is given again, since the stored values never leave the API. The export starts enabled.

OptionTypeDescription
--header <name=value>string, repeatableA header sent with every request, such as the backend's authorization header, as name=value.
--signal <signals>stringThe signals to export, comma-separated: logs, metrics or both.
--url <url>stringThe OTLP/HTTP base URL, without the /v1/logs or /v1/metrics path.
hotcodepush telemetry-export set --url https://api.honeycomb.io --header "x-honeycomb-team=$HONEYCOMB_API_KEY" --signal logs,metrics
hotcodepush telemetry-export set --url https://otlp.example.com --header "Authorization=Bearer $OTLP_TOKEN" --signal logs --json

update

Turn the telemetry export on or off. Turning it on again after failed deliveries disabled it restarts the count.

OptionTypeDescription
--enabledbooleanWhether the export delivers. Turning it on again restarts the count of failures that disables it. Pass false to turn it off.
hotcodepush telemetry-export update --enabled
hotcodepush telemetry-export update --enabled false --organization Acme --json

delete

Delete the organization's telemetry export with its delivery log: nothing more is sent, and its headers are forgotten. Confirms once (--yes in a script).

hotcodepush telemetry-export delete
hotcodepush telemetry-export delete --organization Acme --yes --json

test

Send one record per enabled signal through the export's delivery path and print each delivery with the backend's answer. It takes the path a real record takes, so test shows whether the backend accepts what the export sends. Confirms once (--yes in a script).

hotcodepush telemetry-export test
hotcodepush telemetry-export test --organization Acme --yes --json

Last updated on

On this page