Effective monitoring is crucial for ensuring the reliability and performance of your Keeper node within the TriggerX network. This guide provides step-by-step instructions to set up and utilize Grafana and Prometheus for real-time monitoring of your Keeper's operations.
Prerequisites
Before proceeding, ensure the following:
Core Services Running: Your Keeper and associated services should be up and running.
Environment Configuration: Verify or set the following environment variables in your .env file:
GRAFANA_PORTPort for accessing the Grafana dashboard (default: 3000).
PROMETHEUS_PORTPort for Prometheus metrics scraping.
You can leave these at their default values or modify them as per your requirements.
Starting and Stopping Monitoring Services
TriggerX provides convenient scripts to manage monitoring services:
Start Monitoring:
./triggerx.shstart-mon
This command initiates the Grafana and Prometheus services for monitoring.
Stop Monitoring:
./triggerx.shstop-mon
Accessing the Grafana Dashboard
Once monitoring services are active:
Open Grafana:
Navigate to http://<host>:<GRAFANA_PORT> in your web browser, replacing <host> with your machine's IP address and <GRAFANA_PORT> with the configured port (default: 3000).
Note: If accessing from a different machine, ensure that the specified port is open in your firewall settings.
Login Credentials:
Username: admin
Password: triggerx
Navigate to the Dashboard:
On the left sidebar, go to:
Click on Dashboard
TriggerX Keeper Dashboard
Here, you'll find visualizations and metrics related to your Keeper's performance.
Customizing Grafana Port
To change the default Grafana port:
Modify .env File:
Open your .env file and update the GRAFANA_PORT variable to your desired port number.
Restart Services:
After saving changes, restart the monitoring services:
Note: Ensure the new port is open in your firewall settings to allow external access.
