Contact Sales

Install, Upgrade, Uninstall

Quick Start

Quick start for the case that the monitoring is run as a standalone app (not as a part of Braiins Farm Proxy).

  • clone the git repository git clone https://github.com/braiins/farm-monitor.git
  • go to a new directory cd farm-monitor
  • define IP address ranges for the device discovery in the config file ./monitoring/metrics_exporter/metrics-exporter.toml
  • run command docker compose up -d
  • open URL http://localhost:3000 to see the Farm Dashboard in Grafana

Prerequisites

Braiins Farm Monitor has its own public Github repository and it is basically a stack of 3 Docker containers. You can easily install it with the Linux terminal of the hardware which will host the monitoring.

At the beginning it is required to install a couple of prerequisites:

Linux

Docker

Docker compose

RPi

Docker

Docker compose

Verify prerequisite installed

docker version
docker compose version
git --version

Installation

Description of the installation in case that Braiins Farm Monitor is run as a standalone app (not as a part of Braiins Farm Proxy).

Download Braiins Farm Monitor Repository

You can either clone the repository using git:

sudo apt update
sudo apt install git
git clone 'https://github.com/braiins/farm-monitor.git'

…or download a zip archive with all the files:

Download

Upgrade

Braiins recommends users to monitor the Braiins Farm Monitor Github repository to be notified if a new version is available.

To upgrade to a newer version just run the command git pull origin master in the Linux terminal.

git pull origin master
hint: Pulling without specifying how to reconcile divergent branches is
hint: discouraged. You can squelch this message by running one of the following
hint: commands sometime before your next pull:
hint:
hint:   git config pull.rebase false  # merge (the default strategy)
hint:   git config pull.rebase true   # rebase
hint:   git config pull.ff only       # fast-forward only
hint:
hint: You can replace "git config" with "git config --global" to set a default
hint: preference for all repositories. You can also pass --rebase, --no-rebase,
hint: or --ff-only on the command line to override the configured default per
hint: invocation.
From https://github.com/braiins/farm-monitor
 * branch            master     -> FETCH_HEAD
Already up to date.

If you made any changes in the configuration files you might want to save the modified files or stash them with command git stash before the upgrade.

git stash
Saved working directory and index state WIP on master: bbdd970 Release 22.11

If you made any changes in the docker-compose.yml file, you will need to make them again after the upgrade since the git pull pulls the docker-compose.yml from the Github repository.

Uninstallation

To completely remove farm-proxy and out-of-the-box monitoring from your system you need to perform the following steps:

  1. Stop monitoring: docker compose down
docker compose down
Stopping metrics-exporter ... done
Stopping grafana          ... done
Stopping prometheus       ... done
Removing metrics-exporter ... done
Removing grafana          ... done
Removing prometheus       ... done
  1. Remove containers: docker container prune
docker container prune
WARNING! This will remove all stopped containers.
Are you sure you want to continue? [y/N] y
Deleted Containers:
2102bed62e09d73556248597690d149f2729ad2686744745dbbfae09e314ff55

Total reclaimed space: 0B
  1. Remove images: docker image prune
docker image prune
WARNING! This will remove all dangling images.
Are you sure you want to continue? [y/N] y
Total reclaimed space: 0B
  1. Remove stored monitoring data: docker volume prune
docker volume prune
WARNING! This will remove all local volumes not used by at least one container.
Are you sure you want to continue? [y/N] y
Deleted Volumes:
metrics-exporter_prometheus_data
metrics-exporter_grafana_data
metrics-exporter_scanner_data
public_prometheus_data
public_grafana_data
public_scanner_data

Total reclaimed space: 2.264GB
  1. Remove the folder: rm -rf farm-monitor/
rm -rf farm-monitor/
Was this helpful?