Netdata - Pharm-IT

Pre-configured Netdata Agent by Pharm-IT for monitoring use.
Explore the docs »
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation

About The Project

This is a pre-configured Netdata Agent by Pharm-IT for monitoring use. Despite the pre-configured example from netdata.cloud it uses a custom network netdata. This docker network will be created by the docker-compose.yml file. In the standard cloud-init script the netdata network will be allowed to communicate with the host system by the ufw firewall settings (https://askubuntu.com/a/903358).

These settings are necessary to send, for example, metrics of the Docker Engine via the metrics endpoint.

(back to top)

Built With

• netdata

(back to top)

Getting Started

Because the project is dockerized, you can run the following command to start the Netdata Agent instance.

Installation

1. Install Docker and Docker Compose
2. Clone the repo

   git clone https://github.com/pharm-it-de/netdata-pharmit.git

3. Create the .env-file

    # Name of the instance, will be display in netdata.cloud as indicator
    NETDATA_HOSTNAME=<name-of-the-instance>
   
    # login to netdata.cloud and get token from "Connect Nodes" > "Docker" > "NETDATA_CLAIM_TOKEN"
    NETDATA_CLAIM_TOKEN=<token from netdata.cloud>
    
    # login to netdata.cloud and get token from "Connect Nodes" > "Docker" > "NETDATA_CLAIM_URL"
    NETDATA_CLAIM_URL=https://app.netdata.cloud
    
    # optional: login to netdata.cloud and get token from "Connect Nodes" > "Docker" > "NETDATA_CLAIM_ROOMS"
    # NETDATA_CLAIM_ROOMS=<UUID of the room>

4. Run the docker containers

   docker-compose up -d

(back to top)

Contact

Project Link: https://github.com/pharm-it-de/netdata-pharmit

(back to top)