README
¶
Chronoctl
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.
Usage
chronoctl COMMAND
Commands
| Command | Description |
|---|---|
apply |
Apply multiple resources defined in a file |
Configuration
Chronoctl provides commands to configure Chronosphere, each of which corresponds to a resource type.
bucketsclassic-dashboards(grafana-dashboards)collectionsdashboardsderived-labelsderived-metricsdrop-rulesgcp-metrics-integrationsmapping-rulesmonitorsmuting-rulesnotification-policiesnotifiersrecording-rulesresource-poolsrollup-rulesservice-accountsteams
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.
State
Chronoctl also provides a command to review the state of rule evaluations in Chronosphere:
rule-evaluations
Additional commands
| 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 |
Building
To build chronoctl, you must have Go 1.22 installed. A download link can be found at go.dev.
Run make chronoctl to build the binary. It will be found under
./bin/chronoctl
Backward compatibility
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.
Support
For any questions, bugs, or feature requests, please file a ticket through our standard support channels.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package src is the root of the chronoctl source code
|
Package src is the root of the chronoctl source code |
|
cmd/chronoctl
package main
|
package main |
|
cmd/cli
Package cli provides utilities for use in the chronoctl CLI
|
Package cli provides utilities for use in the chronoctl CLI |
|
cmd/pkg/auth
Package auth provides utilities for authenticating a chronoctl session.
|
Package auth provides utilities for authenticating a chronoctl session. |
|
cmd/pkg/client
Package client implements client flags for chronoctl CLI commands and gives commands access to client objects that can be used to make API calls.
|
Package client implements client flags for chronoctl CLI commands and gives commands access to client objects that can be used to make API calls. |
|
cmd/pkg/dry
Package dry implements the dry run flag for chronoctl commands.
|
Package dry implements the dry run flag for chronoctl commands. |
|
cmd/pkg/env
Package env provides environment variable definitions for chronoctl.
|
Package env provides environment variable definitions for chronoctl. |
|
cmd/pkg/file
package file contains commands related to file operations.
|
package file contains commands related to file operations. |
|
cmd/pkg/groups
Groups is a package for shared CLI groups.
|
Groups is a package for shared CLI groups. |
|
cmd/pkg/output
Package output provides functionality to write output in different formats.
|
Package output provides functionality to write output in different formats. |
|
cmd/pkg/parsing
Package parsing contains methods for parsing strings into various types.
|
Package parsing contains methods for parsing strings into various types. |
|
cmd/pkg/ptr
Package ptr contains functions to create references from constant values, typically for representing optional values.
|
Package ptr contains functions to create references from constant values, typically for representing optional values. |
|
cmd/pkg/ruleevaluations
Package ruleevaluations contains all commands related to rule evaluations
|
Package ruleevaluations contains all commands related to rule evaluations |
|
cmd/pkg/shorthand
shorthand package contains the interfaces used by chronogen create shorthand support.
|
shorthand package contains the interfaces used by chronogen create shorthand support. |
|
cmd/pkg/sliceutil
Package sliceutil contains utility functions for working with slices.
|
Package sliceutil contains utility functions for working with slices. |
|
cmd/pkg/timesutil
Package timesutil provides utilities for parsing and validating RFC3339 timestamps
|
Package timesutil provides utilities for parsing and validating RFC3339 timestamps |
|
cmd/pkg/token
Package token provides utilities for storing and retrieving data from a local file store.
|
Package token provides utilities for storing and retrieving data from a local file store. |
|
cmd/pkg/transport
Package transport provides methods to create an HTTP transport that can communicate with the Chronosphere API.
|
Package transport provides methods to create an HTTP transport that can communicate with the Chronosphere API. |
|
cmd/pkg/unstable
Package unstable implements the unstable cobra command
|
Package unstable implements the unstable cobra command |
|
generated/cli/configunstable
Code generated by chronogen; DO NOT EDIT
|
Code generated by chronogen; DO NOT EDIT |
|
generated/cli/configv1
Code generated by chronogen; DO NOT EDIT
|
Code generated by chronogen; DO NOT EDIT |
|
generated/swagger/configunstable/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
generated/swagger/configv1/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
generated/swagger/stateunstable/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
generated/swagger/statev1/mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
thirdparty/yaml
Package yaml implements YAML support for the Go language.
|
Package yaml implements YAML support for the Go language. |
|
types
Package types contains all of the type metadata for entities output by chronoctl
|
Package types contains all of the type metadata for entities output by chronoctl |
|
x/swagger
Package swagger contains generated code from the Swagger spec.
|
Package swagger contains generated code from the Swagger spec. |
|
x/test
Package xtest contains test helpers for Chronoctl.
|
Package xtest contains test helpers for Chronoctl. |
|
tools
module
|
Click to show internal directories.
Click to hide internal directories.