API Reference monitorex v#0.6.0

Copy Markdown

Modules

Monitorex provides HTTP monitoring capabilities.

GenServer that manages an append-only ETS log of fired alerts.

Threshold-based alert evaluation for Monitorex.

Response helpers and shared utilities for the Monitorex REST API.

REST API plug for programmatic access to Monitorex telemetry data.

Plug for serving Monitorex dashboard static assets (CSS and JS).

Phoenix LiveView on_mount hook for the Monitorex dashboard.

Cluster support for Monitorex — provides multi-node data aggregation across distributed Erlang nodes.

Helper that delegates to Monitorex.Cluster (multi-node) or Monitorex.Storage (local) based on the :cluster_mode config.

GenServer that owns ETS tables, attaches telemetry handlers, and runs periodic maintenance for the Monitorex monitoring system.

Reusable UI components for the Monitorex dashboard.

LiveComponent that renders the Alert Center dashboard page.

Error boundary wrapper for Monitorex LiveComponents.

Shared helper functions for LiveView components.

LiveComponent that shows detailed statistics for a specific outbound host.

LiveComponent that renders the inbound consumers dashboard.

LiveComponent that renders the inbound overview dashboard.

LiveComponent that renders a live feed of recent inbound requests.

LiveComponent that renders the outbound overview dashboard.

LiveComponent that renders a live feed of recent outbound requests.

LiveComponent that shows detailed statistics for a specific inbound route.

Timeline Split-Pane LiveComponent — revamped.

Extracts a consumer label from an inbound Plug.Conn for per-consumer dashboard breakdowns.

Root LiveView for the Monitorex dashboard.

Represents a monitored HTTP event (inbound or outbound).

Handles telemetry events from Tesla, Finch, Req, and Phoenix, transforming them into Monitorex.Event structs.

Plug that serves CSV/JSON exports of Monitorex dashboard data.

Export utilities for Monitorex — generates CSV and JSON from page data.

Redacts sensitive HTTP header values before events are stored.

Health check module for Monitorex.

Plug that serves a JSON health check endpoint for Monitorex.

LiveView layouts for the Monitorex dashboard.

Behaviour for alert notification channels.

Discord webhook notifier.

SMTP email notifier.

Slack incoming-webhook notifier.

Exports Monitorex metrics in Prometheus text format (plain text, no deps).

Behaviour for resolving the current user and their access level in the Monitorex dashboard.

Default resolver implementation that grants unrestricted access.

Router macros for embedding the Monitorex dashboard in your Phoenix application.

Read/query layer over the configured storage backend.

Behaviour for Monitorex storage backends.

ETS-backed implementation of Monitorex.Storage.Backend.

SQLite-backed implementation of Monitorex.Storage.Backend.

Redacts sensitive query parameters from URLs to prevent accidental leakage of tokens, keys, and credentials in stored/displayed outbound URLs.

Normalizes URLs to prevent high-cardinality URL explosion in the outbound dashboard.