# monitorex v0.6.0 - Table of Contents

## Pages

- [Monitorex](readme.md)

- guides
  - [Getting Started](getting_started.md)

## Modules

- [Monitorex.Api](Monitorex.Api.md): Response helpers and shared utilities for the Monitorex REST API.
- [Monitorex.ApiPlug](Monitorex.ApiPlug.md): REST API plug for programmatic access to Monitorex telemetry data.
- [Monitorex.Components.Live.AlertsPage](Monitorex.Components.Live.AlertsPage.md): LiveComponent that renders the Alert Center dashboard page.
- [Monitorex.Components.Live.ErrorBoundary](Monitorex.Components.Live.ErrorBoundary.md): Error boundary wrapper for Monitorex LiveComponents.
- [Monitorex.Components.Live.TimelinePage](Monitorex.Components.Live.TimelinePage.md): Timeline Split-Pane LiveComponent — revamped.
- [Monitorex.ExportPlug](Monitorex.ExportPlug.md): Plug that serves CSV/JSON exports of Monitorex dashboard data.
- [Monitorex.Exports](Monitorex.Exports.md): Export utilities for Monitorex — generates CSV and JSON from page data.
- [Monitorex.HeaderRedactor](Monitorex.HeaderRedactor.md): Redacts sensitive HTTP header values before events are stored.
- [Monitorex.Health](Monitorex.Health.md): Health check module for Monitorex.
- [Monitorex.HealthPlug](Monitorex.HealthPlug.md): Plug that serves a JSON health check endpoint for Monitorex.
- [Monitorex.PrometheusExporter](Monitorex.PrometheusExporter.md): Exports Monitorex metrics in Prometheus text format (plain text, no deps).
- [Monitorex.Resolver.Default](Monitorex.Resolver.Default.md): Default resolver implementation that grants unrestricted access.

- Core
  - [Monitorex](Monitorex.md): Monitorex provides HTTP monitoring capabilities.
  - [Monitorex.Assets](Monitorex.Assets.md): Plug for serving Monitorex dashboard static assets (CSS and JS).
  - [Monitorex.Authentication](Monitorex.Authentication.md): Phoenix LiveView `on_mount` hook for the Monitorex dashboard.
  - [Monitorex.Event](Monitorex.Event.md): Represents a monitored HTTP event (inbound or outbound).
  - [Monitorex.Layouts](Monitorex.Layouts.md): LiveView layouts for the Monitorex dashboard.
  - [Monitorex.Resolver](Monitorex.Resolver.md): Behaviour for resolving the current user and their access level in the
Monitorex dashboard.
  - [Monitorex.Router](Monitorex.Router.md): Router macros for embedding the Monitorex dashboard in your Phoenix application.

- Data Pipeline
  - [Monitorex.Cluster](Monitorex.Cluster.md): Cluster support for Monitorex — provides multi-node data aggregation
across distributed Erlang nodes.
  - [Monitorex.ClusterPage](Monitorex.ClusterPage.md): Helper that delegates to `Monitorex.Cluster` (multi-node) or `Monitorex.Storage`
(local) based on the `:cluster_mode` config.
  - [Monitorex.Collector](Monitorex.Collector.md): GenServer that owns ETS tables, attaches telemetry handlers, and runs
periodic maintenance for the Monitorex monitoring system.
  - [Monitorex.EventHandler](Monitorex.EventHandler.md): Handles telemetry events from Tesla, Finch, Req, and Phoenix, transforming them
into `Monitorex.Event` structs.
  - [Monitorex.Storage](Monitorex.Storage.md): Read/query layer over the configured storage backend.
  - [Monitorex.Storage.Backend](Monitorex.Storage.Backend.md): Behaviour for Monitorex storage backends.
  - [Monitorex.Storage.ETS](Monitorex.Storage.ETS.md): ETS-backed implementation of `Monitorex.Storage.Backend`.
  - [Monitorex.Storage.SQLite](Monitorex.Storage.SQLite.md): SQLite-backed implementation of `Monitorex.Storage.Backend`.

- Alerts
  - [Monitorex.AlertHistory](Monitorex.AlertHistory.md): GenServer that manages an append-only ETS log of fired alerts.
  - [Monitorex.Alerts](Monitorex.Alerts.md): Threshold-based alert evaluation for Monitorex.
  - [Monitorex.Notifier](Monitorex.Notifier.md): Behaviour for alert notification channels.
  - [Monitorex.Notifiers.Discord](Monitorex.Notifiers.Discord.md): Discord webhook notifier.
  - [Monitorex.Notifiers.Email](Monitorex.Notifiers.Email.md): SMTP email notifier.
  - [Monitorex.Notifiers.Slack](Monitorex.Notifiers.Slack.md): Slack incoming-webhook notifier.

- UI Components
  - [Monitorex.Components.Core](Monitorex.Components.Core.md): Reusable UI components for the Monitorex dashboard.
  - [Monitorex.Components.Live.Helpers](Monitorex.Components.Live.Helpers.md): Shared helper functions for LiveView components.

  - [Monitorex.Components.Live.HostDetailPage](Monitorex.Components.Live.HostDetailPage.md): LiveComponent that shows detailed statistics for a specific outbound host.
  - [Monitorex.Components.Live.InboundConsumersPage](Monitorex.Components.Live.InboundConsumersPage.md): LiveComponent that renders the inbound consumers dashboard.
  - [Monitorex.Components.Live.InboundOverviewPage](Monitorex.Components.Live.InboundOverviewPage.md): LiveComponent that renders the inbound overview dashboard.
  - [Monitorex.Components.Live.InboundRecentPage](Monitorex.Components.Live.InboundRecentPage.md): LiveComponent that renders a live feed of recent inbound requests.
  - [Monitorex.Components.Live.OutboundOverviewPage](Monitorex.Components.Live.OutboundOverviewPage.md): LiveComponent that renders the outbound overview dashboard.
  - [Monitorex.Components.Live.OutboundRecentPage](Monitorex.Components.Live.OutboundRecentPage.md): LiveComponent that renders a live feed of recent outbound requests.
  - [Monitorex.Components.Live.RouteDetailPage](Monitorex.Components.Live.RouteDetailPage.md): LiveComponent that shows detailed statistics for a specific inbound route.
  - [Monitorex.DashboardLive](Monitorex.DashboardLive.md): Root LiveView for the Monitorex dashboard.

- Utilities
  - [Monitorex.ConsumerIdentifier](Monitorex.ConsumerIdentifier.md): Extracts a consumer label from an inbound `Plug.Conn` for per-consumer dashboard breakdowns.
  - [Monitorex.URLRedactor](Monitorex.URLRedactor.md): Redacts sensitive query parameters from URLs to prevent accidental leakage
of tokens, keys, and credentials in stored/displayed outbound URLs.
  - [Monitorex.UrlNormalizer](Monitorex.UrlNormalizer.md): Normalizes URLs to prevent high-cardinality URL explosion in the outbound dashboard.

