Grafana data source
This documentation page is a guide for Cyso customers on how to add a data source to an existing Grafana instance. We will focus on how to add a Prometheus data source using the Cyso API.
Pre-requisites
- Ensure you have an active Grafana instance running.
- Have your Cyso customer ID and API key on hand.
Steps
-
Access Grafana Dashboard: Open your Grafana instance and log in to the Grafana dashboard using your credentials.
-
Navigate to Data Sources: Click on the Grafana logo to open the side menu. From the side menu, click on the
Configuration(cogwheel icon), then selectData Sources. -
Add New Data Source: In the top right corner of the data source page, click on
Add data source. -
Select Prometheus as Data Source Type: In the
Add data sourcepage, selectPrometheusfrom the list of options. -
Input Data Source Settings:
-
URL: Enter
https://api.ams2.observe.cyso.com/{customer_id}/metrics/prometheus/into the URL field, replacing{customer_id}with your specific Cyso customer ID. -
Access: Choose
Serverto access the data source backend. -
Basic Auth: Tick the
Basic Authcheckbox. This option enables Grafana to send user credentials through HTTP headers. -
Input Basic Auth Details:
-
User: Enter your Cyso customer ID into the
Userfield. -
Password: Enter your API key provided by Cyso into the
Passwordfield. -
Save & Test: After inputting your details, click on the
Save & Testbutton at the end of the page. Grafana will attempt to connect to the URL with the given credentials. If the details are correct, you will see a success message; otherwise, an error message will be displayed.
Troubleshooting
If you encounter any issues during this process, ensure that:
- Your Grafana instance is running and accessible.
- You've entered the correct Cyso customer ID and API key.
- The URL
https://api.ams2.observe.cyso.com/{customer_id}/metrics/prometheus/is correctly entered with{customer_id}replaced by your specific Cyso customer ID.
If you continue to experience issues, contact our Cyso support team for further assistance.
Remember, each data source added will allow for enhanced monitoring capabilities, and Prometheus provides a wide range of metrics which can be invaluable to understanding your system's performance.
Conclusion
We hope this guide helps you integrate your Grafana instance with our API. At Cyso, we are committed to providing you with a seamless experience. If you need more assistance, feel free to contact us.