Skip to Content
kusaw docsv1.0.0
CLI reference

kusaw telemetry

Show and control opt-in metadata telemetry

kusaw telemetry

Show and control opt-in metadata telemetry

Usage

Text
kusaw telemetry [flags]

Flags

NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for telemetry

Subcommands

kusaw telemetry off

Disable telemetry and discard unsent batches

Text
kusaw telemetry off [flags]
NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for off

Example:

Text
kusaw telemetry off

kusaw telemetry on

Enable telemetry after the endpoint and both env vars are set

Text
kusaw telemetry on [flags]
NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for on

Example:

Text
kusaw telemetry on

kusaw telemetry preview

Print the next telemetry batch with secrets redacted

Text
kusaw telemetry preview [flags]
NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for preview

Example:

Text
kusaw telemetry preview

kusaw telemetry schema

Print the factory-telemetry/1 JSON Schema

Text
kusaw telemetry schema [flags]
NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for schema

Example:

Text
kusaw telemetry schema

kusaw telemetry status

Show telemetry config and whether it is sending

Text
kusaw telemetry status [flags]
NameShortTypeDefaultDescription
--configstringPath to kusaw.yaml (overrides KUSAW_CONFIG and parent search)
--factorystringfactory name from kusaw list
--help-hboolfalsehelp for status

Example:

Text
kusaw telemetry status

Exit codes

CodeNameDescription
0okSuccess.
1errorRuntime error.
2usageUsage or validation error.
3rejectedControl request rejected; the error string is printed verbatim.
4not picked upControl request not picked up within the wait time while serve runs.

Example

Text
kusaw telemetry status

On this page