tvdijen/simplesamlphp-module-monitor

A module that is able to perform various checks on the health of a SimpleSAMLphp installation

Installs: 668

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 2

Open Issues: 4

Type:simplesamlphp-module

v3.0.0 2022-01-24 17:08 UTC

README

This module provides a framework for monitoring SimpleSAMLphp.

Using TestSuites and TestCases, virtually anything can be monitored. TestSuites and TestCases for the most common usecases ship with the module, but you can easily add your own!

When you enable this module, a link to the monitoring-page will appear on the admin configuration-tab. Add ?output=xml to the url to get an XML-representation of the monitoring-page, for use with your 3rd party monitoring system like SCOM / Nagios, or even load balancers that determine a node's health. A JSON-formatted output is also possible using ?output=json in the url.

The XML-page will also set a HTTP reponse-code corresponding to the 'overall status':

  • 200 - Everything is OK
  • 417 - There is at least one warning
  • 500 - There is at least one error

Installation

  • Run composer.phar require tvdijen/simplesamlphp-module-monitor:dev-master --update-no-dev
  • Copy config-templates/module_monitor.php to the SimpleSAML config-directory
  • Enable the module by adding the 'monitor' => true entry to the module.enable setting in config.php

Build Status Scrutinizer Code Quality codecov