Execution connectors designed to improve execution of Centreon-Engine checks
C++ CMake Python Makefile Perl
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
perl
ssh
test/centreon-benchmark/connector
README.md

README.md

Centreon Connectors

Centreon Connectors are extremely fast open-source monitoring check execution daemons designed to work with Centreon Engine. It is a low-level component of the Centreon software suite.

Centreon Connectors are released under the Apache Software License version 2 and is endorsed by the Centreon company.

There are currently two open-source connectors :

  • Centreon Connector Perl : persistent Perl interpreter that executes Perl plugins very fast
  • Centreon Connector SSH : maintain SSH connexions opened to reduce overhead of plugin execution over SSH

Documentation

The full Centreon Connector Perl documentation is available online here. The full Centreon Connector SSH documentation is also available online here. The two documentation sets are generated from ReST files located in the ./perl/doc/ and ./ssh/doc/ directories (respectively) of Centreon Connectors sources.

Documentation extensively covers all aspects of Centreon Connectors such as installation, compilation, configuration, use and more. It is the reference guide of the software. This README is only provided as a quick introduction.

Installing from binaries

Warning: Centreon Connectors are low-level components of the Centreon software suite. If this is your first installation you would probably want to install it entirely.

Centreon (the company behind the Centreon software suite) provides binary packages for RedHat / CentOS. They are available either as part of the Centreon Entreprise Server distribution or as individual packages on our RPM repository.

Once the repository installed a simple command will be needed to install a connector.

$# yum install centreon-connector-perl
$# yum install centreon-connector-ssh

Fetching sources

The reference repository is hosted at GitHub. Beware that the repository hosts in-developement sources and that it might not work at all.

Stable releases are available as gziped tarballs on Centreon's download site.

Compilation (quickstart)

Warning: Centreon Connectors are low-level components of the Centreon software suite. If this is your first installation you would probably want to install it entirely.

This paragraph is only a quickstart guide for the compilation of Centreon Connectors. For a more in-depth guide with build options you should refer to the online documentation of Centreon Connector Perl or Centreon Connector SSH.

Centreon Connectors need Centreon Clib to be build. You should install it first.

Once the sources of Centreon Connectors extracted you should build each project independently by going to its build/ directory and launching the CMake command. This will look for required dependencies and print a summary of the compilation parameters if everything went fine. The example below is for Centreon Connector Perl but works all the same for any other Connector.

$> cd centreon-connector/perl/build
$> cmake .
...

Now launch the compilation using the make command and then install the software by running make install as priviledged user.

$> make -j 4
...
$# make install

You're done !

Bug reports / Feature requests

The best way to report a bug or to request a feature is to open an issue in GitHub's issue tracker.

Please note that Centreon Connectors follows the same workflow as Centreon to process issues.

For a quick resolution of a bug your message should contain :

  • the problem description
  • precise steps on how to reproduce the issue (if you're using Centreon web UI tell us where you click)
  • the expected behavior
  • the Centreon products versions
  • the operating system you're using (name and version)
  • if possible configuration, log and debug files

Contributing

Contributions are much welcome ! If possible provide them as pull-requests on GitHub. If not, patches will do but describe against which vesion/commit they apply.

For any question or remark feel free to send a mail to the project maintainer : Matthieu Kermagoret (mkermagoret@centreon.com).