151 lines
5.1 KiB
ReStructuredText
151 lines
5.1 KiB
ReStructuredText
===========
|
|
NSCA Client
|
|
===========
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:04a3c96ea4630fd8abd0b531436b95c8eb4ab07c3c8efcee9a5f5343c2477d36
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
|
:target: https://odoo-community.org/page/development-status
|
|
:alt: Beta
|
|
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
|
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
|
:alt: License: AGPL-3
|
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/server-tools/tree/16.0/nsca_client
|
|
:alt: OCA/server-tools
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-nsca_client
|
|
:alt: Translate me on Weblate
|
|
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
|
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=16.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
This is a technical module to send passive alerts to your favorite NSCA daemon
|
|
(Nagios, Shinken...).
|
|
This module is based on the Odoo cron system and requires a NSCA client
|
|
installed on the system to satisfy the ``/usr/sbin/send_nsca`` command.
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Installation
|
|
============
|
|
|
|
To use this module, you need to install a NSCA client.
|
|
|
|
On Debian/Ubuntu::
|
|
|
|
$ sudo apt-get install nsca-client
|
|
|
|
Configuration
|
|
=============
|
|
|
|
To configure this module, you need to:
|
|
|
|
* Configure your server and a passive service in your monitoring tool
|
|
(e.g service ``Odoo Mail Queue`` on host ``MY-SERVER``).
|
|
|
|
* Declare your NSCA server in the menu Configuration / Technical / NSCA Client / Servers
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/nsca_client/nsca_client/static/description/server.png
|
|
:width: 400 px
|
|
|
|
* Create NSCA checks in the menu Configuration / Technical / NSCA Client / Checks
|
|
|
|
.. image:: https://raw.githubusercontent.com/OCA/server-tools/16.0/nsca_client/nsca_client/static/description/check.png
|
|
:width: 400 px
|
|
|
|
* Code the methods which will be called by the NSCA checks.
|
|
|
|
Such methods must return a tuple ``(RC, MESSAGE, PERFORMANCE_DATA)`` where ``RC`` is an integer,
|
|
``MESSAGE`` a unicode string AND ``PERFOMANCE_DATA`` is a dictionary.
|
|
``RC`` values and the corresponding status are:
|
|
|
|
- 0: OK
|
|
- 1: WARNING
|
|
- 2: CRITICAL
|
|
- 3: UNKNOWN
|
|
|
|
``PERFORMANCE_DATA`` is not mandatory, so it could be possible to send
|
|
``(RC, MESSAGE)``.
|
|
Each element of ``PERFORMANCE_DATA`` will be a dictionary that could contain:
|
|
|
|
- value: value of the data (required)
|
|
- max: Max value on the chart
|
|
- min: Minimum value on the chart
|
|
- warn: Warning value on the chart
|
|
- crit: Critical value on the chart
|
|
- uom: Unit of Measure on the chart (s - Seconds, % - Percentage, B - Bytes, c - Continuous)
|
|
|
|
The key of the dictionary will be used as the performance_data label.
|
|
|
|
E.g:
|
|
|
|
.. code-block:: python
|
|
|
|
class MailMail(models.Model):
|
|
_inherit = 'mail.mail'
|
|
|
|
@api.model
|
|
def nsca_check_mails(self):
|
|
mails = self.search([('state', '=', 'exception')])
|
|
if mails:
|
|
return (1, u"%s mails not sent" % len(mails), {
|
|
'exceptions': {'value': len(mails)}})
|
|
return (0, u"OK", {'exceptions': {'value': len(mails)}})
|
|
|
|
On the example, the performance data will use the label ``exceptions`` and the
|
|
value will be the number of exception of mails.
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
|
|
In case of trouble, please check there if your issue has already been reported.
|
|
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
|
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20nsca_client%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
|
|
|
Do not contact contributors directly about support or help with technical issues.
|
|
|
|
Credits
|
|
=======
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
* ABF OSIELL
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Sébastien Alix <sebastien.alix@osiell.com>
|
|
* Enric Tobella <etobella@creublanca.es>
|
|
* Jaime Arroyo <jaime.arroyo@creublanca.es>
|
|
|
|
Maintainers
|
|
~~~~~~~~~~~
|
|
|
|
This module is maintained by the OCA.
|
|
|
|
.. image:: https://odoo-community.org/logo.png
|
|
:alt: Odoo Community Association
|
|
:target: https://odoo-community.org
|
|
|
|
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
|
mission is to support the collaborative development of Odoo features and
|
|
promote its widespread use.
|
|
|
|
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/nsca_client>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|