Chronoctl is a command-line app that's a wrapper for accessing the Chronosphere API,
letting you manage resources with YAML or JSON. The app supports the create
,
read
, update
, delete
, and list
operations as subcommands for each type of resource.
chronoctl COMMAND
Command | Description |
---|---|
apply |
Apply multiple resources defined in a file |
Chronoctl provides commands to configure Chronosphere, each of which corresponds to a resource type.
buckets
classic-dashboards
(grafana-dashboards
)collections
dashboards
derived-labels
derived-metrics
drop-rules
gcp-metrics-integrations
mapping-rules
monitors
muting-rules
notification-policies
notifiers
recording-rules
resource-pools
rollup-rules
service-accounts
teams
These resource commands have subcommands to read and manipulate entities via
create
, read
, update
, delete
, and list
.
The scaffold
subcommand generates YAML with all supported fields and
comments with documentation.
For details about these resource types, see their documentation.
Chronoctl also provides commands to review state in Chronosphere:
rule-evaluations
metric-usages-by-metric-name
metric-usages-by-label-name
Command | Description |
---|---|
completion |
Generate the autocompletion script for the specified shell |
help |
Help about any command |
version |
Print the current version of chronoctl |
auth |
Authenticate the chronoctl session |
To build chronoctl, you must have Go 1.23 installed. A download link can be found at go.dev.
Run make chronoctl
to build the binary. It will be found under
./bin/chronoctl
This repository guarantees backward compatibility between binary releases. This repository is not intended for use as a library, and doesn't guarantee backward compatibility of the code packages.
For any questions, bugs, or feature requests, please file a ticket through our standard support channels.