n2n/n2n-monitor

Monitor used for slow query alerts and frontend exceptions handler

Maintainers

Package info

github.com/n2n/n2n-monitor

Homepage

Type:n2n-module

pkg:composer/n2n/n2n-monitor

Statistics

Installs: 3 525

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v7.4.0 2024-12-04 10:35 UTC

This package is auto-updated.

Last update: 2026-06-05 15:33:30 UTC


README

Monitor module for n2n applications.

monitor.js is a clientside js error reporter for n2n.

PHP Setup

use n2n\monitor\ui\MonitorHtmlBuilder;

$monitorHtmlBuilder = new MonitorHtmlBuilder($view);
$monitorHtmlBuilder->meta()->setup();

This emits:

  • meta[name="monitor-url"]
  • the n2n-monitor/monitor.js script

Load monitor.js before other JavaScript code.

JavaScript

Plain JavaScript projects do not need extra setup beyond $monitorHtmlBuilder->meta()->setup().

The script installs:

  • window.n2nMonitor.report(error)
  • window._n2nMonitorErrorHandler(error)

Angular projects should forward caught Angular errors to window.n2nMonitor.report(error).

Payload

Reports are POSTed as JSON to the URL from meta[name="monitor-url"].

Payload fields:

  • discriminator
  • severity
  • name
  • message
  • stackTrace
  • url