ibmstreams / edge-metrics-scraper Goto Github PK

Overall, it is easy to follow if you are familiar with the other tools. Therefore the documentation should state explicitly at the outset that you need Grafana and Prometheus installed and running, and that you also need a basic knowledge of how they work. Can also link to the Prometheus getting started which is a good resource.

Places where information wasn't complete:

• In " Configuring, starting and testing the Edge metrics scraper", it says

• Update the hardcoded value for port. The port is set to 3001 by default.

Where do you update the port?

• In " Configuring Prometheus to pull metrics from scraper", it says,

This is a sample of what to add.

# Sample for Edge Beta.
scrape_configs:

When I added that to my config it didn't work because the scrape_configs tag was already declared. Would be helpful to link to instructions on how to add a new config.

• Importing the dashboard into Grafana:

import the json file at /Grafana/Edge Beta - Sample dashboard-1595962166443.json
Is that the name of the file I am looking for in the grafana folder? Or a path in the Grafana UI?

• Importing the dashboard fails for me because I do not think there are instructions on how to connect Grafana to Prometheus.

• Troubleshooting section

The code does a mapping of invalid characters to _ during the scrape. If you are getting invalid conversion errors this could be the problem.
Is there a way to fix these errors if you do run into them?