Commands
Github Options
These options may be set via the set github
command, or reset via the reset github
command.
Parameter | Description | Default Value |
---|---|---|
jwt-token
|
JSON Web Token to authenticate to Github | - |
name
|
Github repository name | - (subject to final repo location) |
org
|
Github repository organization | - (subject to final repo location) |
password
|
Password used to authenicate to Github | - |
path
|
Path within Github repository | - (subject to final repo location) |
token
|
Token used to authenticate to Github | - |
username
|
Username used to authenticate to Github | - |
Prometheus options
These options may be set via the set prometheus
command, or reset via the reset prometheus
command.
Parameter | Description | Default Value |
---|---|---|
authentication
|
Authentication type. Possible values are none , basic , and oauth . |
none
|
client-authentication
|
Controls whether Grafana must authenticate to Prometheus. | false
|
client-certificate
|
Client certificate file, when client authentication is enabled. | - |
client-key
|
Client key file, when client authentication is enabled. | - |
cookies
|
A list of cookie names to be forwarded from Grafana to Prometheus. | Empty |
http-method
|
HTTP method used to issue queries to Prometheus (POST or GET ). |
POST
|
password
|
Password to authenticate to Prometheus when using basic authentication. |
- |
query-timeout
|
Maximum timeout in seconds for Prometheus queries to complete. | 60
|
scrape-interval
|
Advisory scrape interval in seconds. | 15
|
selfsigned-ca-certificate
|
Self-signed CA certificate when TLS communication to Prometheus is used. | - |
server-name
|
Server name to be validated when TLS communication to Prometheus is used. | - |
skip-validation
|
Skip validation of server certificate when TLS communication to Prometheus is used. | false
|
timeout
|
HTTP timeout in seconds. | 60
|
type
|
Prometheus server type. Valid values are Prometheus , Cortex , Mimir , and Thanos . |
Prometheus
|
url
|
Prometheus server URL. | - |
username
|
Username to authenticate to Prometheus when using basic authentication. |
- |
version
|
Prometheus version. The allowed values depend on the type value. |
2.50.0
|
Grafana options
These options may be set via the set grafana
command, or reset via the reset grafana
command.
Parameter | Description | Default Value |
---|---|---|
org-id
|
Organization ID | - |
password
|
Password used to authenicate to Grafana | - |
timeout
|
Grafana request timeout | 0 (no timeout) |
token
|
Grafana Service Account Token to authenticate to Grafana | - |
update-datasource
|
Controls whether the datasource is updated when dashboards are pushed to Grafana. | true
|
URL
|
Grafana URL. | - |
username
|
Username used to authenticate to Grafana | - |
verify
|
When using HTTPS, controls whether the host certificate is verified | true
|
fetch <product>
Fetch monitoring files for the named product (ems
, ftl
, kafka
, pulsar
) from Github and store them in the local storage directory.
list available
List the products available in Github.
list fetched
List the products fetched into the local storage directory.
push <product>
Push the files for the named product (ems
, ftl
, kafka
, pulsar
) from local storage into Grafana.
reset github
Reset one or more of the Github parameters to its default value.
reset grafana
Reset one or more of the Grafana parameters to its default value.
reset local-storage
Resets the local storage setting to blank.
reset prometheus
Reset one or more of the Prometheus parameters to its default value.
set autosave
Controls whether changes made to the configuration by the set grafana
, reset grafana
, set local-storage
, reset local-storage
, set prometheus
, reset prometheus
, set github
, and reset github
commands are automatically saved to the configuration file. set autosave true
enables this, while set autosave false
disables this action. The default is false
.
set github
Sets one or more of the Github parameters.
set grafana
Sets one or more of the Grafana parameters.
set local-storage <Directory>
Sets the local storage directory parameter. The directory must exist and be writeable.
set prometheus
Sets one or more of the Prometheus parameters.
show autosave
Show the current state of autosave
.
show github
Show the current Github parameter values.
show grafana
Show the currrent Grafana parameter values.
show local-storage
Show the current local storage directory.
show prometheus
Show the current Prometheus parameter values.