Search in docs

Results ..

No results for ''
Search by Algolia

Agent Installation

Requirements

System Requirements

Bleemeo solution uses an agent running on your system. Even if the agent uses standard tools as much as possible, not all systems meet our requirements.

Supported systems are:

SystemVersion RequiredInstallation Doc
Ubuntu20.04 (Focal Fossa), 18.04 (Bionic Beaver), 16.04 (Xenial Xerus), 14.04 LTS (Trusty Tahr)Bleemeo Agent Installation
Debian10 (Buster), 9 (Stretch), 8 (Jessie)Bleemeo Agent Installation
CentOS7, 8Bleemeo Agent Installation
Red Hat Enterprise Linux7, 8Bleemeo Agent Installation
Fedora28, 29, 30, 31, 32Bleemeo Agent Installation
DockerAny platform with Docker version above 1.9.0Install Agent Using Docker
LinuxAny Linux with Kernel >= 3.2Manual Installation
Windows7, 8, 10, Server 2008, 2012, 2016Install Agent on Windows

Resource Requirements

ResourceUsage
Architecturex86/i386, amd64 or arm
Disk spaceabout 50 MB
Memory70-80 MB
CPU usage~3% on modern amd64, ~5% on Raspberry Pi 2

Network Access Requirements

Bleemeo agent communicates with Bleemeo cloud using HTTPS and MQTT-SSL. Only the agent initiates the connections. Your firewall needs to allow the agent to open connections for both protocols :

  • HTTPS use the TCP port 443 on api.bleemeo.com
  • MQTT-SSL use the TCP port 8883 on mqtt.bleemeo.com

api.bleemeo.com and mqtt.bleemeo.com are not changing very often, but we won't warranty those IP won't change in the future.

Standard Installation

Before installing Bleemeo agent, please check that you meet the system requirements.

This method only works on Linux, see below for Windows.

To install Bleemeo agent with our official install script:

  • Login to your Bleemeo account and go to home page.
  • Run the wget -qO- "https://get.bleemeo.com?accountId=<YOUR_ACCOUNT_ID>&registrationKey=<YOUR_REGISTRATION_KEY>" | sh command on your server. When administrator privileges are required, you will be asked to enter su ou sudo password.
  • Agent is installed and configured for your Bleemeo account. You could check it on Agent list.

We recommend to use our shell script that handle the installation for you:

wget -qO- "https://get.bleemeo.com?accountId=<YOUR_ACCOUNT_ID>&registrationKey=<YOUR_REGISTRATION_KEY>" | sh

This command will:

  • add a Bleemeo package repositories
  • install required packages (telegraf and bleemeo-agent by default)
  • create configuration file for your account.

If you want to execute those step manually or integrate them into your configuration management tools (Puppet, Salt, Ansible...), look at

Installation on Windows

Before installing Bleemeo agent, please check that you meet the system requirements.

Bleemeo agent can be installed on Windows with a classical installer. An unattended installation is also available.

Bleemeo also provides official images on Docker Hub.

Running Installer

Download the installer on Bleemeo.

Run the installer, a wizard will ask you to enter your account ID and your registration key as shown above:

windows step 1windows step 2

Unattended Installation

Installer can be run with option to hide wizard (useful if you are deploying on several servers):

bleemeo-agent_latest.exe /ACCOUNT=ABC-ADF /REGKEY=ABC-DEF /S

You need to replace your account ID and your registration key in the command live above.

Installation Using Docker

We recommend installing agent using standard method or following those instructions if you use Docker. But if those methods don't fit your needs, see manual method which explains how to install the Bleemeo agent with standard tools.

Before installing Bleemeo agent, please check that you meet the system requirements.

Bleemeo provides official images on Docker Hub and on Docker Store.

Bleemeo Agent is a Docker Certified Container. The Docker Certification program is a framework for partners to integrate and certify their technology to the Docker Enterprise Edition (EE) commercial platform.

Bleemeo Agent is a Docker Certified Container

To deploy your agent, you may use docker-compose or docker run command.

Using Docker Compose

You need to get the Docker compose file.

Edit the docker-compose file, and set value for GLOUTON_BLEEMEO_ACCOUNT_ID and GLOUTON_BLEEMEO_REGISTRATION_KEY, e.g. something like

[...]
environment:
- GLOUTON_BLEEMEO_ACCOUNT_ID=91bd2bba-ad84-40eb-9eff-07e5a961285a
- GLOUTON_BLEEMEO_REGISTRATION_KEY=199390d7-8fc7-4a06-b3eb-53e574f5c7a0
[...]

Then run Docker compose:

$ docker-compose pull
$ docker-compose up -d

Using Docker Run Command

Bleemeo agent require some special options needed to monitor your Docker host and other Docker containers:

$ export GLOUTON_BLEEMEO_ACCOUNT_ID=<YOUR-ACCOUNT-ID>
$ export GLOUTON_BLEEMEO_REGISTRATION_KEY=<YOUR-REGISTRATION-KEY>
$ docker pull bleemeo/bleemeo-agent
$ docker run -d --name="bleemeo-agent" \
-v /var/lib/glouton:/var/lib/glouton -v /var/run/docker.sock:/var/run/docker.sock -v /:/hostroot:ro \
-e GLOUTON_BLEEMEO_ACCOUNT_ID -e GLOUTON_BLEEMEO_REGISTRATION_KEY \
--pid=host --net=host --cap-add CAP_SYS_PTRACE bleemeo/bleemeo-agent

Installation on Debian/Ubuntu with native packages

Before installing Bleemeo agent, please check that you meet the system requirements.

We recommend installing agent using standard method or Docker method. But if those methods don't fit your needs, this article explains how to install the Bleemeo agent with standard tools.

The agent works with your native packaging tools. For Debian/Ubuntu the agent uses APT and deb package.

Our agent will need your credentials, get them from Bleemeo Panel, click on "Connect your first server to Bleemeo platform" and add them to /etc/glouton/conf.d/30-install.conf:

$ sudo mkdir -p /etc/glouton/conf.d
$ sudo tee /etc/glouton/conf.d/30-install.conf << EOF
bleemeo:
account_id: YOUR_ACCOUNT_ID
registration_key: YOUR_REGISTRATION_KEY
EOF
$ sudo chmod 640 /etc/glouton/conf.d/30-install.conf

Our package repository is signed with the following GPG key:

pub 4096R/FC23F27E 2015-11-25
Key fingerprint = 9B8B DA4B E10E 9F23 28D4 0077 E848 FD17 FC23 F27E
uid Bleemeo Packaging Team <packaging-team@bleemeo.com>

Import this key in APT keyring:

$ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 9B8BDA4BE10E9F2328D40077E848FD17FC23F27E

Our repository are available over HTTPS, make sure APT is configured to support it:

$ sudo apt-get install apt-transport-https

Add our repository for your distribution. For example on focal:

$ dist_version=focal
$ echo deb https://packages.bleemeo.com/bleemeo-agent/ ${dist_version} main | sudo tee /etc/apt/sources.list.d/bleemeo-agent.list
$ echo deb https://packages.bleemeo.com/bleemeo-jmxtrans/ ${dist_version} main | sudo tee /etc/apt/sources.list.d/bleemeo-jmxtrans.list

Don't forget to update dist_version=focal to match your current distribution. You may use lsb_release to find the correct value:

$ lsb_release -c
Codename: focal

Finally install Bleemeo agent package:

$ sudo apt-get update
$ sudo apt-get install bleemeo-agent

Installation on CentOS with native packages

Before installing Bleemeo agent, please check that you meet the system requirements.

We recommend installing agent using standard method or Docker method. But if those methods don't fit your needs, this article explains how to install the Bleemeo agent with standard tools.

This section covers installation on CentOS, see Install Agent on Red Hat Enterprise Linux with Packages for RHEL.

The agent works with your native packaging tools. For CentOS the agent uses rpm packages.

Our agent will need your credentials, get them from Bleemeo Panel, click on "Connect your first server to Bleemeo platform" and add them to /etc/glouton/conf.d/30-install.conf:

$ sudo mkdir -p /etc/glouton/conf.d
$ sudo tee /etc/glouton/conf.d/30-install.conf << EOF
bleemeo:
account_id: YOUR_ACCOUNT_ID
registration_key: YOUR_REGISTRATION_KEY
EOF
$ sudo chmod 640 /etc/glouton/conf.d/30-install.conf

Add our repository for your distribution:

$ sudo tee /etc/yum.repos.d/bleemeo.repo << "EOF"
[bleemeo-agent-repo]
name=Bleemeo Agent Repository
baseurl=https://packages.bleemeo.com/bleemeo-agent/centos/$releasever/$basearch/
enabled=1
gpgcheck=1
gpgkey=https://packages.bleemeo.com/bleemeo-agent/centos/gpg
[bleemeo-jmxtrans-repo]
name=Bleemeo jmxtrans Repository
baseurl=https://packages.bleemeo.com/jmxtrans/centos/$releasever/$basearch/
enabled=1
gpgcheck=1
gpgkey=https://packages.bleemeo.com/jmxtrans/centos/gpg
EOF

Finally install Bleemeo agent package:

$ sudo yum -y install bleemeo-agent

Installation on Fedora with native packages

Before installing Bleemeo agent, please check that you meet the system requirements.

We recommend installing agent using standard method or Docker method. But if those methods don't fit your needs, this article explains how to install the Bleemeo agent with standard tools.

The agent works with your native packaging tools. For Fedora the agent uses rpm packages.

Our agent will need your credentials, get them from Bleemeo Panel, click on "Connect your first server to Bleemeo platform" and add them to /etc/glouton/conf.d/30-install.conf:

$ sudo mkdir -p /etc/glouton/conf.d
$ sudo tee /etc/glouton/conf.d/30-install.conf << EOF
bleemeo:
account_id: YOUR_ACCOUNT_ID
registration_key: YOUR_REGISTRATION_KEY
EOF
$ sudo chmod 640 /etc/glouton/conf.d/30-install.conf

Add our repository for your distribution:

$ sudo tee /etc/yum.repos.d/bleemeo.repo << "EOF"
[bleemeo-agent-repo]
name=Bleemeo Agent Repository
baseurl=https://packages.bleemeo.com/bleemeo-agent/fedora/$releasever/$basearch/
enabled=1
gpgcheck=1
gpgkey=https://packages.bleemeo.com/bleemeo-agent/fedora/gpg
[bleemeo-jmxtrans-repo]
name=Bleemeo jmxtrans Repository
baseurl=https://packages.bleemeo.com/jmxtrans/fedora/$releasever/$basearch/
enabled=1
gpgcheck=1
gpgkey=https://packages.bleemeo.com/jmxtrans/fedora/gpg
EOF

Finally install Bleemeo agent package:

$ sudo dnf -y install bleemeo-agent

Installation on Red Hat Enterprise Linux with native packages

Before installing Bleemeo agent, please check that you meet the system requirements.

We recommend installing agent using standard method or Docker method. But if those methods don't fit your needs, this article explains how to install the Bleemeo agent with standard tools.

This section covers installation on RHEL, see Install Agent on CentOS with Packages for CentOS.

The agent works with your native packaging tools. For RHEL the agent uses rpm packages.

Our agent will need your credentials, get them from Bleemeo Panel, click on "Connect your first server to Bleemeo platform" and add them to /etc/glouton/conf.d/30-install.conf:

$ sudo mkdir -p /etc/glouton/conf.d
$ sudo tee /etc/glouton/conf.d/30-install.conf << EOF
bleemeo:
account_id: YOUR_ACCOUNT_ID
registration_key: YOUR_REGISTRATION_KEY
EOF
$ sudo chmod 640 /etc/glouton/conf.d/30-install.conf

Add our repository for your distribution:

$ sudo tee /etc/yum.repos.d/bleemeo.repo << "EOF"
[bleemeo-agent-repo]
name=Bleemeo Agent Repository
baseurl=https://packages.bleemeo.com/bleemeo-agent/centos/7/$basearch/
enabled=1
gpgcheck=1
gpgkey=https://packages.bleemeo.com/bleemeo-agent/centos/gpg
[bleemeo-jmxtrans-repo]
name=Bleemeo jmxtrans Repository
baseurl=https://packages.bleemeo.com/jmxtrans/centos/7/$basearch/
enabled=1
gpgcheck=1
gpgkey=https://packages.bleemeo.com/jmxtrans/centos/gpg
EOF

In the above code, make sure to change "7" with your current RHEL version. You can see the version from the file /etc/redhat-release or /etc/os-release.

Finally install Bleemeo agent package:

$ sudo yum -y install bleemeo-agent

Installation for Cloud Image Creation

By default when installing Bleemeo agent, it will immediately start and register itself with Bleemeo Cloud platform. However this is not wanted when Bleemeo agent is installed while creating a cloud image (for example an AMI with AWS). In this case the agent should only start and register once the image is used to create a new machine.

To address this use case, the installation script allow to install Bleemeo agent and avoid its startup and registration while still running on same machine used to create the cloud image.

Using this method will write your Bleemeo account credentials needed for the agent to register itself on the disk. Anyone with access to the image could register a server on your Bleemeo account.

Installation

Before installing Bleemeo agent, please check that you meet the system requirements.

To install Bleemeo agent while creating a cloud image:

  • Login to your Bleemeo account and go to home page.
  • Take the wget [...] | sh command and add &cloudimageCreation=1 to the parameters.
  • Run the resulting wget -qO- "https://get.bleemeo.com?accountId=<YOUR ACCOUNT_ID>&registrationKey=<YOUR_REGISTRATION_KEY>&cloudimageCreation=1 | sh command on your server. When administrator privileges are required, you will be asked to enter su ou sudo password.
  • The Agent is installed but won't start while still running on the same machine. It will only start and register itself for each new machine created from the image.

Installation on Kubernetes

Bleemeo agent support discovering services running on Kubernetes. It will monitor all known services and gather Docker containers metrics.

To achieve this, an access to Kubernetes API is required. The easiest is to run agent in the Kubernetes cluster using DaemonSet. You should use the deployment yaml provided, you only need to change GLOUTON_BLEEMEO_ACCOUNT_ID and GLOUTON_BLEEMEO_REGISTRATION_KEY.

$ wget https://raw.githubusercontent.com/bleemeo/glouton/master/k8s.yaml
$ editor k8s.yaml
[...change GLOUTON_BLEEMEO_ACCOUNT_ID and GLOUTON_BLEEMEO_REGISTRATION_KEY]
[...]
metadata:
name: glouton-credentials
type:
stringData:
GLOUTON_BLEEMEO_ACCOUNT_ID: d48f38a0-677b-4700-a13a-f8af8935602d
GLOUTON_BLEEMEO_REGISTRATION_KEY: ddc199d4-72e0-4014-b055-d4bba73a2e7d
[...]

Then deploy Glouton in your Kubernetes:

$ kubectl apply -f k8s.yaml

This will start one Glouton on every node of your Kubernetes cluster.

Agent Manual Installation

We recommend installing agent using standard method or Docker method. But if those methods don't fit your needs, this article explains how to install the Bleemeo agent with standard tools.
  • Bleemeo agent don't need to be run as root, so it's better to create a glouton user:
$ sudo adduser --system glouton
  • Download glouton binary and install it
$ wget https://packages.bleemeo.com/bleemeo-agent/binary/glouton-linux-$(uname -m).bin
$ sudo mv glouton-$(uname -m).bin /usr/local/sbin/glouton
  • Create a configuration file in /etc/glouton/conf.d/30-install.conf with the following content:
bleemeo:
account_id: <YOUR-ACCOUNT-ID>
registration_key: <YOUR-REGISTRATION-KEY>
agent:
state_file: /var/lib/glouton/state.json
facts_file: /var/lib/glouton/facts.yaml
  • Ensure this file has limited access:
$ sudo chown glouton /etc/glouton/conf.d/30-install.conf
$ sudo chmod 0640 /etc/glouton/conf.d/30-install.conf
  • Create a folder for state file, and make sure bleemeo user could write in it:
$ sudo mkdir /var/lib/glouton
$ sudo chown glouton /var/lib/glouton
  • Then start the agent. Depending on what you prefer, you should create a init.d script, systemd service or configure supervisor to run agent.

    To run is on foreground:

$ sudo -u glouton /usr/local/sbin/glouton