Skip to content
This repository has been archived by the owner on Sep 2, 2023. It is now read-only.

Commit

Permalink
Merge pull request #16 from sbueringer/pr-fixup
Browse files Browse the repository at this point in the history
0.2.1: add screenshots, fix dependencies
  • Loading branch information
sbueringer committed Nov 19, 2020
2 parents f25c1ac + ca731fc commit f4af861
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 6 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@

# v0.2.1 - 2020-11-18

* add screenshots
* fix dependencies in plugin.json

# v0.2.0 - 2020-11-11

Highlights:
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

This datasource lets you integrate key value data from Consul in Grafana dashboards.

![Overview](https://github.com/sbueringer/grafana-consul-datasource/raw/master/docs/overview.png)
![Overview](https://github.com/sbueringer/grafana-consul-datasource/raw/master/src/images/overview.png)

# Usage

Expand All @@ -32,18 +32,18 @@ The data can be used in **table** and **single-stat** panels. The following expl

### Variables

![Variables](https://github.com/sbueringer/grafana-consul-datasource/raw/master/docs/keys.png)
![Variables](https://github.com/sbueringer/grafana-consul-datasource/raw/master/src/images/keys.png)

This example shows how keys can be queried to use them as variables. This query retrieves all direct subkeys of `registry/apiregistration.k8s.io/apiservices/`. The subkeys are then matched via the regex and can then be used as variable values.

### Singlestat Panel

![Tags](https://github.com/sbueringer/grafana-consul-datasource/raw/master/docs/tags.png)
![Tags](https://github.com/sbueringer/grafana-consul-datasource/raw/master/src/images/tags.png)

This example shows how subkeys can be retrieved as tags. These tags can then be displayed in the Single Stat panel by defining a legend format. *Note*: This only works if `Value / Stat` in the `Option` tab is set to `Name`.

### Table Panel

![Table](https://github.com/sbueringer/grafana-consul-datasource/raw/master/docs/table.png)
![Table](https://github.com/sbueringer/grafana-consul-datasource/raw/master/src/images/table.png)

The final examples shows how key/value pairs can be displayed in tables. Every matching key of the query results in one row. Columns can then be retrieved relative from this key.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
9 changes: 7 additions & 2 deletions src/plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,17 @@
{"name": "GitHub", "url": "https://github.com/sbueringer/grafana-consul-datasource"},
{"name": "Apache License 2.0", "url": "https://github.com/sbueringer/grafana-consul-datasource/blob/master/LICENSE"}
],
"screenshots": [],
"screenshots": [
{"name": "Variables", "path": "images/keys.png"},
{"name": "Overview", "path": "images/overview.png"},
{"name": "Table", "path": "images/table.png"},
{"name": "Tags", "path": "images/tags.png"}
],
"version": "%VERSION%",
"updated": "%TODAY%"
},
"dependencies": {
"grafanaVersion": "7.3.x",
"grafanaDependency": "7.3.x",
"plugins": []
}
}

0 comments on commit f4af861

Please sign in to comment.