v 11.0 v 12.0 Third Party 30
Download for v 12.0 Deploy on Odoo.sh
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 434
Technical Name nsca_client
LicenseAGPL-3
Websitehttps://github.com/OCA/server-tools
Versions 12.0 11.0 14.0 13.0
You bought this module and need support? Click here!

NSCA Client

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runboat

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

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
https://raw.githubusercontent.com/OCA/server-tools/12.0/nsca_client/nsca_client/static/description/server.png
  • Create NSCA checks in the menu Configuration / Technical / NSCA Client / Checks
https://raw.githubusercontent.com/OCA/server-tools/12.0/nsca_client/nsca_client/static/description/check.png
  • 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:

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. 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.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • ABF OSIELL

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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 project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author, please use the developer contact information. They can usually be found in the description.
Please choose a rating from 1 to 5 for this module.