Skip to content

ezgh workflows settings observability set

Turn sending the project's runs to Observability on or off.

Updated View as Markdown
ezgh workflows settings observability set [--enabled[=false]] [--environment <env>] [flags]

Turn Workflows in Observability on (--enabled) or off (--enabled=false) for the project, or change the environment its telemetry goes to (--environment, which selects the Observability dataset). While it’s on, each run is a trace (trace ID = run ID) with spans for its invocations, steps, sleeps, callbacks and child invokes; run, step and invocation metrics are queryable with PromQL; and push requests and pulled invocations carry a W3C traceparent, so your own OpenTelemetry spans nest under the run. It’s billed as normal Observability ingest.

What’s given changes and the rest stays: without --enabled, ezgh reads the setting first and keeps whether it’s on. Turning it on, or changing the environment while it’s on, also needs obs.traces.ingest and obs.metrics.ingest on the project; turning it off needs only workflows.settings.update. The environment is trimmed and lowercased: 1 to 63 lowercase letters, digits, ‘.’, ‘_’ and ‘-’, starting with a letter or digit.

Part of ezgh workflows settings observability.

Examples

ezgh workflows settings observability set --enabled
ezgh workflows settings observability set --enabled --environment staging
ezgh workflows settings observability set --enabled=false

Flags

Flag Type Default Description
--enabled boolean send the project’s runs to Observability (--enabled=false stops it)
--environment string the Observability environment (dataset) the telemetry goes to (default: the stored one, else production)

This command also takes the global flags.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close