@grafana-ps/tools
v0.11.2
Published
Grafana Cloud tools provided by the Grafana PS team.
Readme
@grafana-ps/tools
Grafana Cloud tools provided by the Grafana PS team.
Usage
$ npm install -g @grafana-ps/tools
$ grot COMMAND
running command...
$ grot (--version)
@grafana-ps/tools/0.11.2 linux-x64 node-v22.18.0
$ grot --help [COMMAND]
USAGE
$ grot COMMAND
...Commands
grot check cloud promql SLUG FILETOKEN FILEQUERYgrot check cloud token read SLUG FILEgrot check k8s-monitoring values FILEgrot check k8s-monitoring values alloy-logs FILEgrot check k8s-monitoring values alloy-metrics FILEgrot check k8s-monitoring values alloy-receiver FILEgrot check k8s-monitoring values alloy-singleton FILEgrot check k8s-monitoring values annotationAutodiscovery FILEgrot check k8s-monitoring values cluster FILEgrot check k8s-monitoring values clusterEvents FILEgrot check k8s-monitoring values clusterMetrics FILEgrot check k8s-monitoring values destinations FILEgrot check k8s-monitoring values nodeLogs FILEgrot check k8s-monitoring values podLogs FILEgrot check lgtm values FILEgrot check lgtm values api FILEgrot check lgtm values authenticator FILEgrot check lgtm values loadGenerator FILEgrot check lgtm values opentelemetry FILEgrot generate k8s-monitoring values SLUG WRITETOKENFILE FILEgrot help [COMMAND]grot pluginsgrot plugins add PLUGINgrot plugins:inspect PLUGIN...grot plugins install PLUGINgrot plugins link PATHgrot plugins remove [PLUGIN]grot plugins resetgrot plugins uninstall [PLUGIN]grot plugins unlink [PLUGIN]grot plugins update
grot check cloud promql SLUG FILETOKEN FILEQUERY
validate token read access
USAGE
$ grot check cloud promql SLUG FILETOKEN FILEQUERY --names <value>... [--aggregations <value>...] [--functions
<value>...] [--labels <value>...] [--stackToken <value>] [--strict]
ARGUMENTS
SLUG stack slug to use
FILETOKEN token file to read
FILEQUERY query file to check
FLAGS
--aggregations=<value>... [default: ] aggregations to check
--functions=<value>... [default: ] functions to check
--labels=<value>... [default: ] labels to check
--names=<value>... (required) [default: ] metric names to check
--stackToken=<value> token with stack access
--strict strict label check
DESCRIPTION
validate token read accessSee code: src/commands/check/cloud/promql.ts
grot check cloud token read SLUG FILE
validate token read access
USAGE
$ grot check cloud token read SLUG FILE [--stackToken <value>]
ARGUMENTS
SLUG stack slug to use
FILE file to read
FLAGS
--stackToken=<value> token with stack access
DESCRIPTION
validate token read accessSee code: src/commands/check/cloud/token/read.ts
grot check k8s-monitoring values FILE
full validation of values.yaml
USAGE
$ grot check k8s-monitoring values FILE [-t prometheus|loki|otlp...]
ARGUMENTS
FILE values file to validate
FLAGS
-t, --types=<option>... [default: prometheus,loki,otlp] types of destinations to validate
<options: prometheus|loki|otlp>
DESCRIPTION
full validation of values.yamlSee code: src/commands/check/k8s-monitoring/values.ts
grot check k8s-monitoring values alloy-logs FILE
validate .alloy-logs
USAGE
$ grot check k8s-monitoring values alloy-logs FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .alloy-logsSee code: src/commands/check/k8s-monitoring/values/alloy-logs.ts
grot check k8s-monitoring values alloy-metrics FILE
validate .alloy-metrics
USAGE
$ grot check k8s-monitoring values alloy-metrics FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .alloy-metricsSee code: src/commands/check/k8s-monitoring/values/alloy-metrics.ts
grot check k8s-monitoring values alloy-receiver FILE
validate .alloy-receiver
USAGE
$ grot check k8s-monitoring values alloy-receiver FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .alloy-receiverSee code: src/commands/check/k8s-monitoring/values/alloy-receiver.ts
grot check k8s-monitoring values alloy-singleton FILE
validate .alloy-singleton
USAGE
$ grot check k8s-monitoring values alloy-singleton FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .alloy-singletonSee code: src/commands/check/k8s-monitoring/values/alloy-singleton.ts
grot check k8s-monitoring values annotationAutodiscovery FILE
validate .annotationAutodiscovery
USAGE
$ grot check k8s-monitoring values annotationAutodiscovery FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .annotationAutodiscoverySee code: src/commands/check/k8s-monitoring/values/annotationAutodiscovery.ts
grot check k8s-monitoring values cluster FILE
validate .cluster
USAGE
$ grot check k8s-monitoring values cluster FILE
ARGUMENTS
FILE values file to validate
DESCRIPTION
validate .clusterSee code: src/commands/check/k8s-monitoring/values/cluster.ts
grot check k8s-monitoring values clusterEvents FILE
validate .clusterEvents
USAGE
$ grot check k8s-monitoring values clusterEvents FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .clusterEventsSee code: src/commands/check/k8s-monitoring/values/clusterEvents.ts
grot check k8s-monitoring values clusterMetrics FILE
validate .clusterMetrics
USAGE
$ grot check k8s-monitoring values clusterMetrics FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .clusterMetricsSee code: src/commands/check/k8s-monitoring/values/clusterMetrics.ts
grot check k8s-monitoring values destinations FILE
validate .destinations
USAGE
$ grot check k8s-monitoring values destinations FILE [-t prometheus|loki|otlp...]
ARGUMENTS
FILE values file to validate
FLAGS
-t, --types=<option>... [default: prometheus,loki,otlp] types of destinations to validate
<options: prometheus|loki|otlp>
DESCRIPTION
validate .destinationsSee code: src/commands/check/k8s-monitoring/values/destinations.ts
grot check k8s-monitoring values nodeLogs FILE
validate .nodeLogs
USAGE
$ grot check k8s-monitoring values nodeLogs FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .nodeLogsSee code: src/commands/check/k8s-monitoring/values/nodeLogs.ts
grot check k8s-monitoring values podLogs FILE
validate .podLogs
USAGE
$ grot check k8s-monitoring values podLogs FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .podLogsSee code: src/commands/check/k8s-monitoring/values/podLogs.ts
grot check lgtm values FILE
full validation of values.yaml
USAGE
$ grot check lgtm values FILE [-t prometheus|otlp...]
ARGUMENTS
FILE values file to validate
FLAGS
-t, --telemetry=<option>... [default: prometheus,otlp] types of telmetry to validate
<options: prometheus|otlp>
DESCRIPTION
full validation of values.yamlSee code: src/commands/check/lgtm/values.ts
grot check lgtm values api FILE
validate .api
USAGE
$ grot check lgtm values api FILE [-t prometheus|otlp...]
ARGUMENTS
FILE file to read
FLAGS
-t, --telemetry=<option>... [default: prometheus,otlp] types of telmetry to validate
<options: prometheus|otlp>
DESCRIPTION
validate .apiSee code: src/commands/check/lgtm/values/api.ts
grot check lgtm values authenticator FILE
validate .authenticator
USAGE
$ grot check lgtm values authenticator FILE [-t prometheus|otlp...]
ARGUMENTS
FILE file to read
FLAGS
-t, --telemetry=<option>... [default: prometheus,otlp] types of telmetry to validate
<options: prometheus|otlp>
DESCRIPTION
validate .authenticatorSee code: src/commands/check/lgtm/values/authenticator.ts
grot check lgtm values loadGenerator FILE
validate .loadGenerator
USAGE
$ grot check lgtm values loadGenerator FILE [-t prometheus|otlp...]
ARGUMENTS
FILE file to read
FLAGS
-t, --telemetry=<option>... [default: prometheus,otlp] types of telmetry to validate
<options: prometheus|otlp>
DESCRIPTION
validate .loadGeneratorSee code: src/commands/check/lgtm/values/loadGenerator.ts
grot check lgtm values opentelemetry FILE
validate .opentelemetry
USAGE
$ grot check lgtm values opentelemetry FILE
ARGUMENTS
FILE file to read
DESCRIPTION
validate .opentelemetrySee code: src/commands/check/lgtm/values/opentelemetry.ts
grot generate k8s-monitoring values SLUG WRITETOKENFILE FILE
full generation of values.yaml
USAGE
$ grot generate k8s-monitoring values SLUG WRITETOKENFILE FILE --stackToken <value>
ARGUMENTS
SLUG stack slug to use
WRITETOKENFILE write token file destination
FILE write destination
FLAGS
--stackToken=<value> (required) token with stack access
DESCRIPTION
full generation of values.yamlSee code: src/commands/generate/k8s-monitoring/values.ts
grot help [COMMAND]
Display help for grot.
USAGE
$ grot help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for grot.See code: @oclif/plugin-help
grot plugins
List installed plugins.
USAGE
$ grot plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ grot pluginsSee code: @oclif/plugin-plugins
grot plugins add PLUGIN
Installs a plugin into grot.
USAGE
$ grot plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into grot.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the GROT_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the GROT_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ grot plugins add
EXAMPLES
Install a plugin from npm registry.
$ grot plugins add myplugin
Install a plugin from a github url.
$ grot plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ grot plugins add someuser/someplugingrot plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ grot plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ grot plugins inspect mypluginSee code: @oclif/plugin-plugins
grot plugins install PLUGIN
Installs a plugin into grot.
USAGE
$ grot plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into grot.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the GROT_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the GROT_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ grot plugins add
EXAMPLES
Install a plugin from npm registry.
$ grot plugins install myplugin
Install a plugin from a github url.
$ grot plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ grot plugins install someuser/somepluginSee code: @oclif/plugin-plugins
grot plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ grot plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ grot plugins link mypluginSee code: @oclif/plugin-plugins
grot plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ grot plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ grot plugins unlink
$ grot plugins remove
EXAMPLES
$ grot plugins remove myplugingrot plugins reset
Remove all user-installed and linked plugins.
USAGE
$ grot plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
grot plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ grot plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ grot plugins unlink
$ grot plugins remove
EXAMPLES
$ grot plugins uninstall mypluginSee code: @oclif/plugin-plugins
grot plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ grot plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ grot plugins unlink
$ grot plugins remove
EXAMPLES
$ grot plugins unlink myplugingrot plugins update
Update installed plugins.
USAGE
$ grot plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
