Skip to content

Commit 36792e7

Browse files
authored
Merge pull request #176 from PureStorage-OpenConnect/175-bug---missing-envs-cause-dashboard-to-na
Update troubleshooting docs for Prometheus labeling
2 parents 8c7a835 + 256896e commit 36792e7

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

extra/grafana/README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -190,28 +190,41 @@ Check the data is accessible to each component in the stack. If at any on these
190190
<img src="./images/prometheus_purefa_simple_query.png" width="40%" height="40%">
191191
<br>
192192

193-
3. If the query does not return results, check the status of the targets for status errors.
193+
3. Make sure that in the query results from step 1 include the required labels `instance`, `location`, `site`, `env` for all targets.
194+
195+
If the labels are not being added, in [prometheus.yml](../prometheus/prometheus.yml), check that the required labels are being applied in accordance with the [sample configuration](../prometheus/prometheus.yml).
196+
```yaml
197+
labels:
198+
# Instance should be the device name and is used to correlate metrics between different endpoints in Prometheus and Grafana. Ensure this is the same for each endpoint for the same device.
199+
instance: arrayname01
200+
# location, site and env are specific to your environment. Feel free to add more labels but maintain these three to minimize changes to Grafana which is expecting to use location, site and env as filter variables.
201+
location: uk
202+
site: London
203+
env: production
204+
```
205+
206+
4. If the query does not return results, check the status of the targets for status errors.
194207
<br>
195208
<img src="./images/prometheus_purefa_target_status.png" width="40%" height="40%">
196209
<br>
197210

198-
4. Run prometheus.yml through the yaml checker. Check the configuration is correct and restart Prometheus.
211+
5. Run prometheus.yml through the yaml checker. Check the configuration is correct and restart Prometheus.
199212
```console
200213
> promtool check config /etc/prometheus/prometheus.yml
201214
Checking prometheus.yml
202215
SUCCESS: prometheus.yml is valid prometheus config file syntax
203216
```
204217

205-
5. Check messages log for Prometheus errors.
218+
6. Check messages log for Prometheus errors.
206219

207220
### Check Grafana
208-
6. Perform a simple test for Grafana by navigating to 'Explore' and entering a simple query.
221+
7. Perform a simple test for Grafana by navigating to 'Explore' and entering a simple query.
209222
<br>
210223
<img src="./images/grafana_purefa_simple_query.png" width="40%" height="40%">
211224
<br>
212225

213226
### Check Docker container is running
214-
7. Ensure that the docker image is running, if for any reason the container is unexpectedly halting while running you may add `--restart unless-stopped` to the `docker run` command to ensure the container is restarted automatically on failure.
227+
8. Ensure that the docker image is running, if for any reason the container is unexpectedly halting while running you may add `--restart unless-stopped` to the `docker run` command to ensure the container is restarted automatically on failure.
215228
216229

217230
# Troubleshooting Specific Errors

0 commit comments

Comments
 (0)