Monitoring Setup

Last updated 2 min read
Report issue

Overview#

This document provides a comprehensive guide for monitoring a GritivaCore deployment. It covers the supported monitoring tools, setup instructions, and troubleshooting steps to ensure effective monitoring of your system.

Supported Monitoring Tools#

GritivaCore supports various monitoring tools, including:

  • Prometheus
  • Uptime Robot
  • Pingdom

These tools can be used to monitor system performance and uptime effectively.

Setup Instructions#

Follow these steps to set up monitoring for your GritivaCore deployment:

Prerequisites#

  • Ensure you have the necessary user permissions to perform the setup.
  • Access to the GritivaCore deployment and its configuration files.

Installation Steps#

  1. Install the monitoring tool of your choice (e.g., Prometheus).
  2. Configure the tool to scrape metrics from the GritivaCore agent.

Configuration#

To enable the agent metrics endpoint, add the following to the systemd service:

BASH
sudo systemctl edit gritiva-agent

Then add:

INI
[Service]
Environment="GRITIVA_METRICS_PORT=9101"

This will expose the metrics at http://<vm-ip>:9101/metrics.

What to Alert On#

Set up alerts for the following high-signal conditions:

  • NRestarts > 3/hour
  • Mesh peer in CONNECTING state for more than 5 minutes
  • Scope OOM (Out of Memory) occurrences exceeding once per day
  • Disk usage over 80%
  • Cloudflare API errors exceeding 10 per hour

Uptime Kuma Setup#

For monitoring uptime, GritivaCore recommends using Uptime Kuma. Detailed setup instructions can be found in the Uptime Kuma documentation.

External Monitoring Recommendations#

Consider using Uptime Robot or Pingdom to monitor your public domains for uptime and performance.

Log Shipping#

By default, agent logs are sent to journalctl. To ship logs to Loki or ELK, mount the journal into a sidecar scope. Example compose snippet will be provided in future updates.

Troubleshooting#

Common issues may arise during setup or configuration. Ensure that:

  • The monitoring tool is correctly configured to scrape metrics.
  • The GritivaCore agent is running and accessible.
  • Alerts are set up correctly to notify you of critical issues.

FAQs#

For frequently asked questions regarding GritivaCore monitoring, refer to the relevant sections in the documentation or reach out to support.

Open Questions

Open Questions
Please clarify the following: - What specific user permissions are required for setup? - Are there any additional monitoring tools that should be included?