Skip to content

Commit

Permalink
Merge pull request #40 from Vonage/feature/change_annotation_concept
Browse files Browse the repository at this point in the history
* Version 1.0.3:
  • Loading branch information
YehonatanVonage authored Mar 29, 2017
2 parents 8d455d4 + 67edf51 commit 344064b
Show file tree
Hide file tree
Showing 15 changed files with 877 additions and 623 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ Lets say that you want to monitor a bunch of servers, and you want to keep track
This plugin will make it easier to do. You just add all the metrics you want to track, and choose how you want their values to be treated:
1. Component severity marker - Set the threshold for each and you get an overview that will report to you if there is anything wrong with any metrics. That means that if all the metrics are in the OK zone, the panel will be green. If evan one of the metrics is in the WARNING zone, it will be yellow, and red if any of them is CRITICAL.
2. Component disable marker - Set the exact value that represent if the component is disabled, the panel will be grey.
3. Annotation - show extra information about the component in the top left side of the panel.
3. Display as text - show extra information about the component in the panel

Severity and text values can be shown in 2 options:
1. Regular - under the panel title
2. Annotation - In the top left side of the panel

**Note:** The disable markers are prioritized over the severity ones.

Expand All @@ -29,11 +33,11 @@ You can also repeat the panel on a template if you have multiple instances that
2. Choose the name of the panel to be displayed in the `Panel Title` field.
**Note:** this field supports Grafana templates, so if you repeat the panel the correct name will show
3. Go the the Options tab, and choose the how to treat each metric.
1. For severity disply, select the `Threshold` option type under `Status Type`. Enter the `Warning` and `Critical` thresholds for each of your queries.
* If you want the result to always be displayed with it's value (regardless to the thresholds), check the box titled `Show Value`
1. For severity display, select the `Threshold` option type under `Handler Type`. Enter the `Warning` and `Critical` thresholds for each of your queries.
* If you want the result to always be displayed with it's value (regardless to the thresholds), check the box titled `Show Always`
* The plugin automatically detects if higher values are good, or lower values are good by checking which threshold is higher/lower. i.e. if in your metric higher values are better, put a lower value in the "critical" threshold than the "warning" threshold.
2. For disable display, select the `Disable Criteria` option type under "Status Type". Enter the `Disable Value` for each of your queries.
3. For annotation, select the "Annotation" option type under "Status Type". The alias + the value of the metric will be shown on the top left.
2. For disable display, select the `Disable Criteria` option type under `Handler Type`. Enter the `Disable Value` for each of your queries.
3. For display the text without any condition, select the `Text Only` option type under `Handler Type`. The alias + the value of the metric will be shown on the panel by the `Display Type` value.
4. If the query returns multiple values, choose the type of aggregation you want to be used (`None` will just use the most first result)

## Other Features
Expand All @@ -51,6 +55,10 @@ If there is not data from any of the metrics, you can show the panel as disabled
## Supported Data Sources
Currently the plugin was tested with **influxDB** and **Graphite**. Support for other data sources could be added by demand

## Release Notes
### Version 1.0.3
* Version (1.0.3) can have some conflicts with older versions.

# Screenshots
### Panel States
![ok](https://github.com/Vonage/Grafana_Status_panel/blob/develop/src/img/ok.png?raw=true)
Expand Down
18 changes: 13 additions & 5 deletions dist/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ Lets say that you want to monitor a bunch of servers, and you want to keep track
This plugin will make it easier to do. You just add all the metrics you want to track, and choose how you want their values to be treated:
1. Component severity marker - Set the threshold for each and you get an overview that will report to you if there is anything wrong with any metrics. That means that if all the metrics are in the OK zone, the panel will be green. If evan one of the metrics is in the WARNING zone, it will be yellow, and red if any of them is CRITICAL.
2. Component disable marker - Set the exact value that represent if the component is disabled, the panel will be grey.
3. Annotation - show extra information about the component in the top left side of the panel.
3. Display as text - show extra information about the component in the panel

Severity and text values can be shown in 2 options:
1. Regular - under the panel title
2. Annotation - In the top left side of the panel

**Note:** The disable markers are prioritized over the severity ones.

Expand All @@ -29,11 +33,11 @@ You can also repeat the panel on a template if you have multiple instances that
2. Choose the name of the panel to be displayed in the `Panel Title` field.
**Note:** this field supports Grafana templates, so if you repeat the panel the correct name will show
3. Go the the Options tab, and choose the how to treat each metric.
1. For severity disply, select the `Threshold` option type under `Status Type`. Enter the `Warning` and `Critical` thresholds for each of your queries.
* If you want the result to always be displayed with it's value (regardless to the thresholds), check the box titled `Show Value`
1. For severity display, select the `Threshold` option type under `Handler Type`. Enter the `Warning` and `Critical` thresholds for each of your queries.
* If you want the result to always be displayed with it's value (regardless to the thresholds), check the box titled `Show Always`
* The plugin automatically detects if higher values are good, or lower values are good by checking which threshold is higher/lower. i.e. if in your metric higher values are better, put a lower value in the "critical" threshold than the "warning" threshold.
2. For disable display, select the `Disable Criteria` option type under "Status Type". Enter the `Disable Value` for each of your queries.
3. For annotation, select the "Annotation" option type under "Status Type". The alias + the value of the metric will be shown on the top left.
2. For disable display, select the `Disable Criteria` option type under `Handler Type`. Enter the `Disable Value` for each of your queries.
3. For display the text without any condition, select the `Text Only` option type under `Handler Type`. The alias + the value of the metric will be shown on the panel by the `Display Type` value.
4. If the query returns multiple values, choose the type of aggregation you want to be used (`None` will just use the most first result)

## Other Features
Expand All @@ -51,6 +55,10 @@ If there is not data from any of the metrics, you can show the panel as disabled
## Supported Data Sources
Currently the plugin was tested with **influxDB** and **Graphite**. Support for other data sources could be added by demand

## Release Notes
### Version 1.0.3
* Version (1.0.3) can have some conflicts with older versions.

# Screenshots
### Panel States
![ok](https://github.com/Vonage/Grafana_Status_panel/blob/develop/src/img/ok.png?raw=true)
Expand Down
99 changes: 47 additions & 52 deletions dist/css/status_panel.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/css/status_panel.css.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 344064b

Please sign in to comment.