From ecf601124b40d9754182acff280f559416e7ad4d Mon Sep 17 00:00:00 2001 From: Daniel Pawlik Date: Thu, 16 Dec 2021 10:00:15 +0100 Subject: [PATCH] Improve doc; change default loggearman port to 4730 Some improvements that were done: - add the loggearman documentation - add documtation for loggearman ansible - changed title in loggearman ansible doc - changed default port from 4731 to 4730 Change-Id: I6488bef19c1041e4a3a6e5a46251946ce6b8e8b4 --- ansible/roles/loggearman/README.rst | 4 ++-- ansible/roles/logscraper/README.rst | 4 ++-- doc/source/index.rst | 4 ++++ doc/source/loggearman-role.rst | 1 + doc/source/loggearman.rst | 22 ++++++++++++++++++++++ logscraper/logscraper.py | 4 ++-- 6 files changed, 33 insertions(+), 6 deletions(-) create mode 120000 doc/source/loggearman-role.rst create mode 100644 doc/source/loggearman.rst diff --git a/ansible/roles/loggearman/README.rst b/ansible/roles/loggearman/README.rst index c9c3f91..1dafecb 100644 --- a/ansible/roles/loggearman/README.rst +++ b/ansible/roles/loggearman/README.rst @@ -1,5 +1,5 @@ -Openstack Log Processor Tools -============================= +Loggearman ansible role +======================= The goal of this role is to setup and configure service related to `log-gearman-client` and `log-gearman-worker` scripts, that diff --git a/ansible/roles/logscraper/README.rst b/ansible/roles/logscraper/README.rst index 23009fd..821facc 100644 --- a/ansible/roles/logscraper/README.rst +++ b/ansible/roles/logscraper/README.rst @@ -1,5 +1,5 @@ -Logscraper -========== +Logscraper ansible role +======================= The goal of this role is to setup and configure service related to logscraper script which is responsible to to push recent diff --git a/doc/source/index.rst b/doc/source/index.rst index 4cb7f02..23a0a5b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,12 +17,16 @@ Contents: * :doc:`logscraper` * :doc:`ansible-role` + * :doc:`loggearman` + * :doc:`loggearman-role` .. toctree:: :maxdepth: 2 logscraper ansible-role + loggearman + loggearman-role Indices and tables ================== diff --git a/doc/source/loggearman-role.rst b/doc/source/loggearman-role.rst new file mode 120000 index 0000000..14ecda8 --- /dev/null +++ b/doc/source/loggearman-role.rst @@ -0,0 +1 @@ +../../ansible/roles/loggearman/README.rst \ No newline at end of file diff --git a/doc/source/loggearman.rst b/doc/source/loggearman.rst new file mode 100644 index 0000000..91f6dd0 --- /dev/null +++ b/doc/source/loggearman.rst @@ -0,0 +1,22 @@ +Loggearman +========== + +The Loggearman tools are responsible for listening events, +parse them, get logs from log server and push them to +the Logstash service. + + +Loggearman Client +----------------- + +The Loggearman Client is responsible for listening events that +comes on port 4730 (by default), parse them and redirect them to +German server, that later will be processed by loggearman worker. + + +Loggearman Worker +----------------- + +The Loggearman Worker is responsible to get log files from the +log server, parse them and send line by line to the Logstash service +with necessary fields like: build_uuid, build_name, etc. diff --git a/logscraper/logscraper.py b/logscraper/logscraper.py index 3dbf660..6497837 100755 --- a/logscraper/logscraper.py +++ b/logscraper/logscraper.py @@ -167,8 +167,8 @@ def get_arguments(): parser.add_argument("--gearman-server", help="Gearman host addresss", required=True) parser.add_argument("--gearman-port", help="Gearman listen port. " - "Defaults to 4731.", - default=4731) + "Defaults to 4730.", + default=4730) parser.add_argument("--follow", help="Keep polling zuul builds", action="store_true") parser.add_argument("--insecure", help="Skip validating SSL cert",