Rename Ping collector -> Ping bot

Author: Anze

.gitlab-ci.yml

@@ -33,6 +33,6 @@ deploy_to_docker_hub:
     - docker build -t "$CI_REGISTRY_IMAGE:$CI_COMMIT_TAG" -t "$CI_REGISTRY_IMAGE:latest" --build-arg VERSION=$CI_COMMIT_TAG --build-arg VCS_REF=$CI_COMMIT_SHA --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') .
     - docker push "$CI_REGISTRY_IMAGE:$CI_COMMIT_TAG"
     - docker push "$CI_REGISTRY_IMAGE:latest"
-    - docker rmi grafolean/grafolean-collector-ping:$CI_COMMIT_TAG
-    - docker rmi grafolean/grafolean-collector-ping:latest
+    - docker rmi grafolean/grafolean-ping-bot:$CI_COMMIT_TAG
+    - docker rmi grafolean/grafolean-ping-bot:latest
 

Dockerfile

@@ -1,13 +1,13 @@
 FROM python:3.6-slim-stretch as python-requirements
-COPY ./Pipfile ./Pipfile.lock /pingcollector/
-WORKDIR /pingcollector
+COPY ./Pipfile ./Pipfile.lock /pingbot/
+WORKDIR /pingbot
 RUN \
     pip install pipenv && \
     pipenv lock -r > /requirements.txt
 
 FROM python:3.6-slim-stretch as build-backend
-COPY ./ /pingcollector/
-WORKDIR /pingcollector
+COPY ./ /pingbot/
+WORKDIR /pingbot
 RUN \
     find ./ ! -name '*.py' -type f -exec rm '{}' ';' && \
     rm -rf tests/ .vscode/ .pytest_cache/ __pycache__/ && \
@@ -21,16 +21,16 @@ ARG VCS_REF
 ARG BUILD_DATE
 LABEL org.label-schema.vendor="Grafolean" \
       org.label-schema.url="https://grafolean.com/" \
-      org.label-schema.name="Grafolean Ping Collector" \
-      org.label-schema.description="Ping collector for Grafolean" \
+      org.label-schema.name="Grafolean Ping bot" \
+      org.label-schema.description="ICMP Ping bot for Grafolean" \
       org.label-schema.version=$VERSION \
-      org.label-schema.vcs-url="https://gitlab.com/grafolean/grafolean-collector-ping/" \
+      org.label-schema.vcs-url="https://github.com/grafolean/grafolean-ping-bot/" \
       org.label-schema.vcs-ref=$VCS_REF \
       org.label-schema.build-date=$BUILD_DATE \
       org.label-schema.docker.schema-version="1.0"
 COPY --from=python-requirements /requirements.txt /requirements.txt
 RUN pip install --no-cache-dir -r /requirements.txt
-COPY --from=build-backend /pingcollector/ /pingcollector/
-WORKDIR /pingcollector
+COPY --from=build-backend /pingbot/ /pingbot/
+WORKDIR /pingbot
 USER root
-CMD ["python", "-m", "pingcollector"]
+CMD ["python", "-m", "pingbot"]

README.md

@@ -1,33 +1,33 @@
-# About Grafolean Ping Collector
+# About Grafolean Ping bot
 
-This package is a Ping Collector for Grafolean, an easy to use generic monitoring system.
+This package is an ICMP Ping bot for Grafolean, an easy to use generic monitoring system.
 
 Once installed, all the configuration of Ping sensors is done through Grafolean's web-based user interface. Depending on permissions,
-a single Ping Collector instance can be fetching data for multiple accounts and entities. The fetching intervals can be specified with
+a single Ping bot instance can be fetching data for multiple accounts and entities. The fetching intervals can be specified with
 up to a second precision.
 
 Requirements:
-- the devices will be pinged *from the container* (make sure Ping Collector is installed in the correct network and that there are no firewalls in between)
+- the devices will be pinged *from the container* (make sure Ping bot is installed in the correct network and that there are no firewalls in between)
 - Grafolean must be accessible via HTTP(S)
 
 # License
 
 License is Commons Clause license (on top of Apache 2.0) - source is available, you can use it for free (commercially too), modify and
-share, but you can't sell it to third parties. See [LICENSE.md](https://gitlab.com/grafolean/grafolean-collector-ping/blob/master/LICENSE.md) for details.
+share, but you can't sell it to third parties. See [LICENSE.md](https://github.com/grafolean/grafolean-ping-bot/blob/master/LICENSE.md) for details.
 
-If in doubt, please [open an issue](https://gitlab.com/grafolean/grafolean-collector-ping/issues) to get further clarification.
+If in doubt, please [open an issue](https://github.com/grafolean/grafolean-ping-bot/issues) to get further clarification.
 
 # Install (docker / docker-compose)
 
 Docker is the easiest and currently the only officially supported way. Note that while instructions might (with possibly some modifications) work on other operating systems, Linux is assumed.
 
 1) log in to Grafolean service (either https://grafolean.com/ or self-hosted), select an appropriate `Account` and create a new `Bot`. Make sure that selected protocol is `Ping`. Copy the bot token.
 
-2) save [docker-compose.yml](https://gitlab.com/grafolean/grafolean-collector-ping/raw/master/docker-compose.yml) to a local file:
+2) save [docker-compose.yml](https://github.com/grafolean/grafolean-ping-bot/raw/master/docker-compose.yml) to a local file:
     ```
-    $ mkdir ~/pingcollector
-    $ cd ~/pingcollector
-    $ wget https://gitlab.com/grafolean/grafolean-collector-ping/raw/master/docker-compose.yml
+    $ mkdir ~/pingbot
+    $ cd ~/pingbot
+    $ wget https://github.com/grafolean/grafolean-ping-bot/raw/master/docker-compose.yml
     ```
 
 3) These settings must be set:
@@ -38,13 +38,13 @@ Docker is the easiest and currently the only officially supported way. Note that
 
    The easiest way to set them is to download example `.env` and edit it:
     ```
-    $ wget https://gitlab.com/grafolean/grafolean-collector-ping/raw/master/.env.example -O .env
+    $ wget https://github.com/grafolean/grafolean-ping-bot/raw/master/.env.example -O .env
     $ nano .env
     ```
 
 4) run: `docker-compose up -d`
 
-If you get no error, congratulations! Everything else is done from within the Grafolean UI. You can however check the status of container as usually by running `docker ps`, and investigate logs by running `docker logs -f grafolean-collector-ping`.
+If you get no error, congratulations! Everything else is done from within the Grafolean UI. You can however check the status of container as usually by running `docker ps`, and investigate logs by running `docker logs -f grafolean-ping-bot`.
 
 In case of error make sure that the user is allowed to run `docker` (that is, that it is in `docker` group) by running `docker ps`. Alternatively, container can be run using `sudo` (line 4 then reads `sudo docker-compose up -d`).
 
@@ -60,7 +60,7 @@ Upgrading should be easy:
 
 Container logs can be checked by running:
 ```
-$ docker logs --since 5m -f grafolean-collector-ping
+$ docker logs --since 5m -f grafolean-ping-bot
 ```
 
 ## Building locally
@@ -80,4 +80,4 @@ To contribute to this repository, CLA needs to be signed. Please open an issue a
 
 ## Issues
 
-If you encounter any problems installing or running the software, please let us know in the [issues](https://gitlab.com/grafolean/grafolean-collector-ping/issues). Please make an effort when describing the issue. If we can reproduce the problem, we can also fix it much faster.
+If you encounter any problems installing or running the software, please let us know in the [issues](https://github.com/grafolean/grafolean-ping-bot/issues). Please make an effort when describing the issue. If we can reproduce the problem, we can also fix it much faster.

docker-compose.dev.yml

@@ -4,9 +4,9 @@ services:
   # Build a local Docker image. Usage:
   #   $ docker-compose -f docker-compose.dev.yml build
 
-  grafolean-collector-ping:
-    image: grafolean/grafolean-collector-ping
-    container_name: grafolean-collector-ping
+  grafolean-ping-bot:
+    image: grafolean/grafolean-ping-bot
+    container_name: grafolean-ping-bot
     build:
       context: .
       dockerfile: Dockerfile

docker-compose.yml

@@ -5,18 +5,18 @@ services:
   # BACKEND_URL=...   # backend API base url (the part before "/api/...")
   # BOT_TOKEN=...     # bot token
 
-  grafolean-collector-ping:
+  grafolean-ping-bot:
     # If you wish to load an explicit version, change the next line. For example:
-    #   image: grafolean/grafolean-collector-ping:v1.0.0
-    image: grafolean/grafolean-collector-ping
-    container_name: grafolean-collector-ping
+    #   image: grafolean/grafolean-ping-bot:v1.0.0
+    image: grafolean/grafolean-ping-bot
+    container_name: grafolean-ping-bot
     environment:
       # Backend url must be set to the address of the Grafolean backend, for example this uses Grafolean hosted service:
       # - BACKEND_URL=https://grafolean.com/api
       # IMPORTANT: '127.0.0.1' and 'localhost' are _never_ correct addresses for Grafolean backend, because they translate
       # to container, not host.
       - BACKEND_URL=${BACKEND_URL}
-      # To use PING Collector, a bot with the protocol "ping" must be added via user interface, then the token needs to be copied here:
+      # To use PING bot, a bot with the protocol "ping" must be added via user interface, then the token needs to be copied here:
       - BOT_TOKEN=${BOT_TOKEN}
       # Interval between fetching information about jobs:
       - JOBS_REFRESH_INTERVAL=${JOBS_REFRESH_INTERVAL:-60}

pingcollector.py

@@ -37,14 +37,14 @@ def send_results_to_grafolean(backend_url, bot_token, account_id, values):
         log.exception("Error sending data to Grafolean")
 
 
-class PingCollector(Collector):
+class PingBot(Collector):
 
     def jobs(self):
         for entity_info in self.fetch_job_configs('ping'):
             intervals = list(set([sensor_info["interval"] for sensor_info in entity_info["sensors"]]))
             job_info = { **entity_info, "backend_url": self.backend_url, "bot_token": self.bot_token }
             job_id = str(entity_info["entity_id"])
-            yield job_id, intervals, PingCollector.do_ping, job_info
+            yield job_id, intervals, PingBot.do_ping, job_info
 
     @staticmethod
     def do_ping(*args, **job_info):
@@ -122,5 +122,5 @@ def wait_for_grafolean(backend_url):
     if not bot_token:
         raise Exception("Please specify BOT_TOKEN / BOT_TOKEN_FROM_FILE env var.")
 
-    c = PingCollector(backend_url, bot_token, jobs_refresh_interval)
+    c = PingBot(backend_url, bot_token, jobs_refresh_interval)
     c.execute()