Skip to main content

Alignak Log MongoDB Module

Note that this module is only useful to get the Alignak monitoring logs in a Mongo DB if you do not use the Alignak backend


Alignak module for the monitoring logs

Develop branch build status Development code static analysis Development code tests coverage Most recent PyPi version License AGPL v3

Installation

The installation of this module will copy some configuration files in the Alignak default configuration directory (eg. /usr/local/etc/alignak). The copied files are located in the default sub-directory used for the modules (eg. arbiter/modules).

From PyPI

To install the module from PyPI:

sudo pip install alignak-module-mongo-logs

From source files

To install the module from the source files (for developing purpose):

git clone https://github.com/Alignak-monitoring-contrib/alignak-module-mongo-logs
cd alignak-module-mongo-logs
sudo pip install . -e

Short description

This module for Alignak collects the monitoring logs (alerts, notifications, …) to log them into a collection of a Mongo DB.

This module was back-ported from the Shinken mod-mongo-logs but it does not manage the availability for hosts and services.

Configuration

Once installed, this module has its own configuration file in the /usr/local/etc/alignak/arbiter/modules directory. The default configuration file is mod-mongo-logs.cfg. This file is commented to help configure all the parameters.

To configure Alignak broker to use this module:

  • edit your broker daemon configuration file

  • add the module_alias parameter value (logs) to the modules parameter of the daemon

To configure this module for Mongo DB:

  • edit the module configuration file to set the MongoDB parameters

Metrics

This module is able to push metrics to an external TSDB (Graphite, InfluxDB). Configure the metrics parameters in the configuration:

; --------------------------------------------------------------------
; Module internal metrics
; Export module metrics to a statsd server.
; By default at localhost:8125 (UDP) with the alignak prefix
; Default is not enabled
; --------------------------------------------------------------------
;statsd_host = localhost
; For StatsD
;statsd_port = 8125
; For Graphite
;statsd_port = 2004
; Default
;statsd_prefix=alignak
; Use this prefix to use the alignak name in the metrics hierarchy
;statsd_prefix=%(alignak_name)s.modules
; Default is disabled
;statsd_enabled = 0
;graphite_enabled = 0
; --------------------------------------------------------------------

Available metrics:

  • committed-logs counts the DB commited logs

  • monitoring-event-got.%s counts the detected events

  • monitoring-event-ignored.%s counts the ignored events (not DB commited)

  • queue-size is the module message queue size. If greater than 1, it indicates a module overload because the queue should be emptied on each loop turn

  • managed-broks-time is the broks management duration on each loop turn

Note that only the events in this list are DB commited: [‘TIMEPERIOD TRANSITION’, ‘RETENTION LOAD’, ‘RETENTION SAVE’, ‘CURRENT STATE’, ‘NOTIFICATION’, ‘ALERT’, ‘DOWNTIME’, ‘FLAPPING’, ‘ACTIVE CHECK’, ‘PASSIVE CHECK’, ‘COMMENT’, ‘ACKNOWLEDGE’, ‘DOWNTIME’]

An example Grafana dashboard:

./doc/_static/images/grafana.png

Bugs, issues and contributing

Contributions to this project are welcome and encouraged … issues in the project repository are the common way to raise an information.

Metadata

Release files for alignak-module-mongo-logs 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for alignak-module-mongo-logs 1.1.0
File Size Uploaded
alignak_module_mongo_logs-1.1.0.tar.gz 34.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for alignak-module-mongo-logs 1.1.0
File Interpreter ABI Platform
alignak_module_mongo_logs-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 66.0 kB

Release files / alignak_module_mongo_logs-1.1.0.tar.gz

Download URL alignak_module_mongo_logs-1.1.0.tar.gz
Size 34.5 kB
Tags Source
SHA-256 checksum
How to use checksums
5a01662e1fe573f5c164ae66d99523193d5bd8dd8d458425370035f8e879b81e
BLAKE2b-256 checksum
How to use checksums
d5421da57e859853d25669583c59871d94c2aef6370541dd3ee67eaa1890517a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.20.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.7

Release files / alignak_module_mongo_logs-1.1.0-py3-none-any.whl

Download URL alignak_module_mongo_logs-1.1.0-py3-none-any.whl
Size 31.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ee08fd802f7f5c26500cc4e53c6d8a7c7ca183717343bf8caff0759bf224634f
BLAKE2b-256 checksum
How to use checksums
af93db17f2027077bc629a59999cd3ae49a81997aadf72b14833c6a6b409242a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.20.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.7

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page