Skip to content
This repository was archived by the owner on Nov 11, 2024. It is now read-only.

Latest commit

 

History

History

README.md

[BwareLabs] Monitoring solution for Moonbeam collator

alt text IMPORTANT NOTICE

The scripts were tested on Ubuntu 20.04 LTS machines which respect the hardware requirements imposed by Moonbeam as seen here.

alt text Contents of the main directory

  • .env - this contains important environment variables which are needed in order to properly deploy the monitoring solution
    • SLACK_API_URL - webhook URL for your Slack channel (this will be adapted in the future for other communication channels)
  • start_alertmanager.sh - installs Alertmanager and configures its service
  • start_blackbox_exporter.sh - installs Blackbox Exporter and configures its service
  • start_prometheus.sh - installs Prometheus and configures its service
  • start_instrumentation.sh - starts all the aforementioned tools, spinning the monitoring solution up
  • config - directory which contains .yml/.yaml files for configuring the aforementioned tools
  • setup - directory which contains helper scripts for installing the aforementioned tools

alt text Contents of config directory

  • alert-rules.yaml - rules for alerting (this will be triggered in case something wrong happens and will be sent to the Slack channel mentioned in alertmanager.yml)
  • alertmanager.yml - Alertmanager configuration which contains the slack_api_url and the receiver channels (IMPORTANT: YOU SHOULD HAVE THE CHANNELS MENTIONED HERE ALREADY CREATED IN SLACK)
  • blackbox.yml - Blackbox Exporter configuration (default settings should be enough - used for RPC calls)
  • prometheus.yml - Prometheus configuration (default settings should be enough if using standard Moonbeam installation)

alt text Contents of setup directory

  • install_alertmanager.sh - downloads & installs Alertmanager binaries
  • install_blackbox_exporter.sh - downloads & installs Blackbox Exporter binaries
  • install_prometheus.sh - downloads & installs Prometheus binaries

alt text First steps

  • Make sure you have git installed on your machine (if not sure, you can run the following command to make sure you have the package installed)
sudo apt install git -y 
  • Clone the git main git repository via HTTPS or SSH (below example is with HTTPS since it's easier, but it is not the recommended way)
git clone https://github.com/bwarelabs/moonbeam-launch.git

alt text How to deploy the monitoring solution

  • Go to moonbeam-launch/prometheus directory
cd moonbeam-launch/prometheus
  • Carefully complete .env with the appropiate values, depending on your use case
  • From the prometheus directory, run the following command in your terminal:
sudo bash start_instrumentation.sh
  • This can be run as root or any other user with sudo privileges
  • Check if everything has run correctly by accessing http://YOUR_NODE_PUBLIC_IP:9090/ - here you should be able to see the appropiate targets and alerting rules

alt text Contact

For official inquiries, you can contact us at info@bwarelabs.com.

For other details, feel free to contact us on Discord (Mateip | bwarelabs.com#1629, Silviu | bwarelabs.com#8286, Tibi | bwarelabs.com#4803).

alt text Copyright

Copyright © 2021 BwareLabs

alt text