lseara/isonline repository overview

⁠Host availability monitoring with Docker

This project aims to provide a simple and easy way to monitor the availability of hosts using a Docker container. The container is based on the Alpine image and uses a shell script to perform connectivity tests for a user-defined list of hosts. The test results are saved in a log file for tracking and analysis purposes.

⁠Usage

⁠With Docker Compose

Using Docker Compose allows you to define the necessary environment parameters for container execution. To do this, create a docker-compose.yaml file with the following contents:

version: '3.3'

services:
  isonline:
    container_name: myisonline
    volumes:
      - /docker/isonline:/log
    restart: always
    environment:
      - HOSTS: "192.168.86.1 facebook.com"
      - TIME_INTERVAL: "3"
      - PACKAGES: "2"
      - SECWAIT: "1"
      - DATE_FORMAT: "+%d/%m/%Y %H=%M=%S %z"
      - TZ: "America/Sao_Paulo"
    image: lseara/isonline

This file configures a service named myisonline, which uses the lseara/isonline image and defines the necessary environment parameters for host monitoring. The volume /docker/isonline:/log allows the log file to be saved in a specific folder on the host.

To start monitoring, execute the following command in the folder where the docker-compose.yaml file is located:

docker-compose up -d

⁠With Docker run

Using Docker run allows you to define the necessary environment parameters for container execution directly in the command line. To do this, execute the following command:

docker run -d --name myisonline -v /docker/isonline:/log --restart=always -e HOSTS="192.168.86.1 facebook.com" -e TIME_INTERVAL="3" -e PACKAGES="2" -e SECWAIT="1" -e DATE_FORMAT="+%d/%m/%Y %H=%M=%S %z" -e TZ="America/Sao_Paulo" lseara/isonline

This command starts a new container with the name isonline, uses the lseara/isonline image, and defines the necessary environment parameters for host monitoring. The volume /docker/isonline:/log allows the log file to be saved in a specific folder on the host.

⁠Environment Parameters

The environment parameters below can be defined to customize host monitoring. If not defined, the container assumes the default value for each parameter.

• HOSTS: Space-separated list of hosts to monitor (default: "8.8.8.8 1.1.1.1 www.google.com⁠ www.bing.com⁠")
• TIME_INTERVAL: Time interval in seconds between each test (default: "60")
• PACKAGES: Number of test packets to send (default: "1")
• SECWAIT: Waiting time in seconds per test (default: "10")
• DATE_FORMAT: Date/time format to be used in the log file (default: "+%d/%m/%Y %H:%M:%S %z")
  

⁠Monitoramento de disponibilidade de hosts com Docker

Este projeto tem como objetivo fornecer uma maneira simples e fácil de monitorar a disponibilidade de hosts através do uso de um container Docker. O container é baseado na imagem Alpine e usa um script em shell para executar testes de conectividade para uma lista de hosts definida pelo usuário. Os resultados dos testes são salvos em um arquivo de log para fins de acompanhamento e análise.

⁠Uso

⁠Com Docker Compose

O uso do Docker Compose permite que você defina os parâmetros de ambiente necessários para a execução do container. Para isso, crie um arquivo docker-compose.yaml com o seguinte conteúdo:

version: '3.3'

services:
  isonline:
    container_name: myisonline
    volumes:
      - /docker/isonline:/log
    restart: always
    environment:
      - HOSTS: "192.168.86.1 facebook.com"
      - TIME_INTERVAL: "3"
      - PACKAGES: "2"
      - SECWAIT: "1"
      - DATE_FORMAT: "+%d/%m/%Y %H=%M=%S %z"
      - TZ: "America/Sao_Paulo"
    image: lseara/isonline

Este arquivo configura um serviço chamado myisonline, que usa a imagem lseara/isonline e define os parâmetros de ambiente necessários para o monitoramento dos hosts. O volume /docker/isonline:/log permite que o arquivo de log seja salvo em uma pasta específica do host.

Para iniciar o monitoramento, execute o seguinte comando na pasta onde o arquivo docker-compose.yaml está localizado:

docker-compose up -d

⁠Com Docker run

O uso do Docker run permite que você defina os parâmetros de ambiente necessários para a execução do container diretamente na linha de comando. Para isso, execute o seguinte comando:

docker run -d --name myisonline -v /docker/isonline:/log --restart=always -e HOSTS="192.168.86.1 facebook.com" -e TIME_INTERVAL="3" -e PACKAGES="2" -e SECWAIT="1" -e DATE_FORMAT="+%d/%m/%Y %H=%M=%S %z" -e TZ="America/Sao_Paulo" lseara/isonline

Este comando inicia um novo container com o nome isonline, usa a imagem lseara/isonline e define os parâmetros de ambiente necessários para o monitoramento dos hosts. O volume /docker/isonline:/log permite que o arquivo de log seja salvo em uma pasta específica do host.

⁠Parâmetros de ambiente

Os parâmetros de ambiente abaixo podem ser definidos para personalizar o monitoramento dos hosts. Caso não seja definido, o container assume o valor padrão de cada parâmetro.

• HOSTS: Lista de hosts separados por espaço para monitorar (padrão: "8.8.8.8 1.1.1.1 www.google.com⁠ www.bing.com⁠")
• TIME_INTERVAL: Intervalo de tempo em segundos entre cada teste (padrão: "60")
• PACKAGES: Número de pacotes de teste para enviar (padrão: "1")
• SECWAIT: Tempo de espera em segundos por teste (padrão: "10")
• DATE_FORMAT: Formato da data/hora para ser usado no arquivo de log (padrão: "+%d/%m/%Y %H:%M:%S %z")