Skip to content

Commit 232f1cd

Browse files
Add plugin system
1 parent 167b945 commit 232f1cd

21 files changed

Lines changed: 2221 additions & 59 deletions

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,12 @@ ember status
9797

9898
Ember polls the Caddy admin API and Prometheus metrics endpoint at a regular interval (default: 1s), computes deltas and derived metrics (RPS, percentiles, error rates), and renders them through one of several output modes: an interactive [Bubble Tea](https://github.com/charmbracelet/bubbletea) TUI (default), streaming JSONL, a headless daemon with Prometheus export, or a one-shot `status` command.
9999

100+
## Plugins
101+
102+
Ember supports a plugin system that lets third-party developers add custom tabs for visualizing metrics from additional Caddy modules (e.g., rate limiters, WAF modules, custom middleware). Plugins are compiled into the binary using Go's blank import pattern, the same approach used by Caddy itself.
103+
104+
See the [Plugin Development Guide](docs/plugins.md) for details on building and integrating plugins.
105+
100106
## Documentation
101107

102108
Full documentation is available in the [docs/](docs/index.md) directory:
@@ -109,6 +115,7 @@ Full documentation is available in the [docs/](docs/index.md) directory:
109115
- [JSON Output](docs/json-output.md): Streaming JSONL for scripting
110116
- [Prometheus Export](docs/prometheus-export.md): Metrics, health checks, daemon mode
111117
- [Docker](docs/docker.md): Container usage
118+
- [Plugins](docs/plugins.md): Building custom plugins for Ember
112119
- [Troubleshooting](docs/troubleshooting.md): Common issues and solutions
113120

114121
## Contributing

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Ember is a real-time monitoring tool for [Caddy](https://caddyserver.com/) and [
1111
- [CLI Reference](cli-reference.md): Flags, subcommands, keybindings, and shell completions
1212
- [JSON Output](json-output.md): Streaming JSONL mode for scripting
1313
- [Prometheus Export](prometheus-export.md): Metrics endpoint, health checks, and daemon mode
14+
- [Plugins](plugins.md): Building custom plugins for Ember
1415
- [Docker](docker.md): Running Ember in a container
1516
- [Troubleshooting](troubleshooting.md): Common issues and how to resolve them
1617

0 commit comments

Comments
 (0)