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
This commit is contained in:
@@ -1,5 +1,5 @@
|
|||||||
Openstack Log Processor Tools
|
Loggearman ansible role
|
||||||
=============================
|
=======================
|
||||||
|
|
||||||
The goal of this role is to setup and configure service related
|
The goal of this role is to setup and configure service related
|
||||||
to `log-gearman-client` and `log-gearman-worker` scripts, that
|
to `log-gearman-client` and `log-gearman-worker` scripts, that
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
Logscraper
|
Logscraper ansible role
|
||||||
==========
|
=======================
|
||||||
|
|
||||||
The goal of this role is to setup and configure service related
|
The goal of this role is to setup and configure service related
|
||||||
to logscraper script which is responsible to to push recent
|
to logscraper script which is responsible to to push recent
|
||||||
|
@@ -17,12 +17,16 @@ Contents:
|
|||||||
|
|
||||||
* :doc:`logscraper`
|
* :doc:`logscraper`
|
||||||
* :doc:`ansible-role`
|
* :doc:`ansible-role`
|
||||||
|
* :doc:`loggearman`
|
||||||
|
* :doc:`loggearman-role`
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
logscraper
|
logscraper
|
||||||
ansible-role
|
ansible-role
|
||||||
|
loggearman
|
||||||
|
loggearman-role
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
1
doc/source/loggearman-role.rst
Symbolic link
1
doc/source/loggearman-role.rst
Symbolic link
@@ -0,0 +1 @@
|
|||||||
|
../../ansible/roles/loggearman/README.rst
|
22
doc/source/loggearman.rst
Normal file
22
doc/source/loggearman.rst
Normal file
@@ -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.
|
@@ -167,8 +167,8 @@ def get_arguments():
|
|||||||
parser.add_argument("--gearman-server", help="Gearman host addresss",
|
parser.add_argument("--gearman-server", help="Gearman host addresss",
|
||||||
required=True)
|
required=True)
|
||||||
parser.add_argument("--gearman-port", help="Gearman listen port. "
|
parser.add_argument("--gearman-port", help="Gearman listen port. "
|
||||||
"Defaults to 4731.",
|
"Defaults to 4730.",
|
||||||
default=4731)
|
default=4730)
|
||||||
parser.add_argument("--follow", help="Keep polling zuul builds",
|
parser.add_argument("--follow", help="Keep polling zuul builds",
|
||||||
action="store_true")
|
action="store_true")
|
||||||
parser.add_argument("--insecure", help="Skip validating SSL cert",
|
parser.add_argument("--insecure", help="Skip validating SSL cert",
|
||||||
|
Reference in New Issue
Block a user