Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drbrain/nu_plugin_prometheus
A nushell plugin for querying prometheus
https://github.com/drbrain/nu_plugin_prometheus
nushell prometheus
Last synced: about 2 months ago
JSON representation
A nushell plugin for querying prometheus
- Host: GitHub
- URL: https://github.com/drbrain/nu_plugin_prometheus
- Owner: drbrain
- License: mit
- Created: 2024-06-02T04:20:50.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-06-27T06:08:58.000Z (3 months ago)
- Last Synced: 2024-06-28T06:33:57.474Z (3 months ago)
- Topics: nushell, prometheus
- Language: Rust
- Homepage:
- Size: 286 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-nu - nu_plugin_prometheus
README
# nu_plugin_prometheus
A nushell plugin for querying prometheus
Supports:
* nushell 0.95.0
* Prometheus API
* Instant queries
* Range queryies
* Target status
* Series
* Label names
* Label values
* Saved sources for convenience or mutual TLS authentication
## Usage
### Sources
A prometheus plugin can be queried directly with `--url`:
```nushell
"up" | prometheus query --source https://test.prometheus.example/
```
Nushell plugin configuration can be used to save configure prometheus sources
including mTLS.
```nushell
$env.config.plugins.prometheus = {
sources: {
prod: {
url: "https://prod.prometheus.example/"
cert: ( $env.HOME | path join ".config/nu_plugin_prometheus/user.crt" )
key: ( $env.HOME | path join ".config/nu_plugin_prometheus/user.pk8.key" )
cacert: ( $env.HOME | path join ".config/nu_plugin_prometheus/ca.crt" )
}
}
}
```
The key must be in PKCS#8 format. You can convert a PEM key with:
```nushell
openssl pkcs8 -topk8 -inform PEM -outform DER -in user.key -out user.pk8.key
```
Use `--source` or `-s` to use a configured source:
```nushell
"up" | prometheus query --source prod
```
### Queries
#### Instant
Pipe a prometheus query to `prometheus query` for an instant query:
```nushell
"up" | prometheus query --url https://prometheus.example:9090/
```
This will output a table:
|name|labels|value|timestamp|
|-|-|-|-|
|up|{job: prometheus, instance: prometheus.example:9090}|1|1435781451|
|up|{job: node, instance: prometheus.example:9100}|0|1435781451|
#### Range
A range query requires `--start`, `--end` and `--step` arguments:
```nushell
"up" | prometheus query range --url https://prometheus.example:9090/ --start ((date now) - 30sec) --end (date now) --step 15sec
```
|name|labels|values|
|-|-|-|
|up|{job: prometheus, instance: prometheus.example:9090}|[{value: 1, timestamp: 1435781430}, {value: 1, timestamp: 1435781445} {value: 1, timestamp: 1435781460}]|
|up|{job: node, instance: prometheus.example:9100}|[{value: 0, timestamp: 1435781430}, {value: 0, timestamp: 1435781445} {value: 1, timestamp: 1435781460}]|
#### Flattening labels
Adding `--flatten` will flatten labels into each row.
```nushell
"up" | prometheus query --url https://prometheus.example:9090/ --flatten
```
Outputs:
|name|instance|job|value|timestamp|
|-|-|-|-|-|
|up|prometheus.example:9090|prometheus|1|1435781451|
|up|prometheus.example:9100|job|0|1435781451|
If a metric uses "name" as a label it will overwrite the "name" column.
For a range query the values are not flattened.
### Label names
Retrieve labels names with:
```nushell
prometheus label names --url https://prometheus.example:9090/
```
Label names can be filtered by selector as input, and by time with `--start`
and `--end`.
To query "up" label names:
```nushell
"up" | prometheus label names --url https://prometheus.example:9090/
```
### Label values
Retrieve labels values with:
```nushell
"version" | prometheus label values --url https://prometheus.example:9090/
```
Label values can be filtered by name as input, by time with `--start` and
`--end`, and by selector as extra arguments.
To query "version" label values for the "postgres" job:
```nushell
"version" | prometheus label values --url https://prometheus.example:9090/ 'job="postgres"'
```
### Metric metadata
Retrieve metric metadata with:
```nushell
prometheus metric metadata --url https://prometheus.example:9090/
```
This may take some time, so supply a metric name as input or supply `--limit`
to reduce the number of records retrieved. Use `--limit-per-metric` to reduce
the number of metadata items retrieved per metric.
## Series
Retrieve series matching the given label set with:
```nushell
[up process_start_time_seconds{job="prometheus"}] |
prometheus series -s home
```
Series are retrieved using a selector given as input. Series retrived may be
filtered by time with `--start` and `--end`.
## Targets
Retreive prometheus target discovery with:
```nushell
prometheus targets --url https://prometheus.example:9090/
```
This retrives targets in either the active or dropped states. The `any`
argument alse retrieves both states.
Use `active`, or `dropped` to directly filter active or dropped targets. This
will output only the selected state.