How do I integrate Wobserver with a Phoenix app?

In plug mode, forward requests in your router and add socket configuration to the endpoint. The README provides specific code snippets for Phoenix, including setting up the router and enabling websockets.

Wobserver vs Observer: which is better for Elixir?

Observer is a built-in GUI tool ideal for local development debugging, while Wobserver offers web-based access, APIs, and remote monitoring. Choose Wobserver for web interfaces and distributed systems, Observer for quick local insights.

How can I add custom metrics to Wobserver?

You can add metrics via configuration using the :metrics option or dynamically at runtime with Wobserver.register. Examples in the README show defining metrics and generators in the config file.

Is Wobserver secure for production use?

While functional, Wobserver lacks built-in authentication or authorization. You must secure it externally, such as by placing it behind a reverse proxy with access controls, especially when exposing it publicly.

What's the performance overhead of running Wobserver?

In standalone mode, it starts a Cowboy server, adding minimal overhead. In plug mode, it shares your app's server, reducing resource usage, but always monitor metrics in high-traffic environments to assess impact.

How does Wobserver handle remote node discovery?

It supports methods like DNS-based discovery or custom functions configured via :discovery and :discovery_search. This allows finding nodes in distributed setups, even with network barriers like firewalls.

Open-Awesome

wobserver

MITElixirv0.1.7

A web-based monitoring and metrics tool for Elixir applications, providing system insights and a Prometheus-compatible endpoint.

GitHub

926 stars82 forks0 contributors

What is wobserver?

Wobserver is a web-based monitoring and observer tool for Elixir applications that provides real-time insights into system performance, processes, and metrics. It solves the problem of gaining visibility into Erlang VM and application health without complex setup, offering a drop-in web interface and API for monitoring.

Target Audience

Elixir developers and DevOps engineers who need to monitor and observe their Elixir applications in production or development environments, especially those using distributed systems.

Value Proposition

Developers choose Wobserver for its ease of integration, extensibility, and comprehensive monitoring capabilities, including Prometheus metrics support and remote node discovery, all within a lightweight Elixir package.

Overview

Web based metrics, monitoring, and observer

Use Cases

Best For

Monitoring Elixir application performance and system metrics in real-time
Integrating Prometheus-compatible metrics into Elixir-based systems
Observing distributed Erlang nodes and processes across a network
Adding custom monitoring pages and metrics to existing applications
Debugging and profiling Elixir applications via a web interface
Self-hosting a lightweight monitoring solution for Elixir projects

Not Ideal For

Projects not using Elixir or the Erlang VM, as it's specifically designed for those environments
Teams requiring advanced, out-of-the-box dashboards with rich visualizations and minimal UI work
Production systems that need built-in alerting, notification, or anomaly detection features
Applications where embedding or starting a separate web server is prohibited due to strict security or resource constraints

Pros & Cons

Pros

Easy Drop-in Monitoring

Wobserver runs in standalone mode with minimal configuration, offering immediate web-based access to system metrics, processes, and applications without complex setup.

Extensible Architecture

It allows adding custom pages and metrics via configuration or runtime registration, enabling tailored monitoring for specific libraries or applications, as shown in the Library Integration section.

Prometheus Integration

The /metrics endpoint outputs data in Prometheus format by default, facilitating seamless integration with monitoring stacks like Grafana for long-term metric storage and visualization.

Distributed Node Support

With node discovery features, including DNS and custom functions, it can monitor remote Erlang nodes, making it suitable for overseeing distributed Elixir systems behind firewalls.

Cons

Outdated Web Interface

The README explicitly lists 'Overhaul web interface' as an improvement needed, indicating the UI is basic and may require customization for a modern, polished look.

Complex Plug Integration

Setting up plug mode involves additional routing and socket configuration in Phoenix or Cowboy applications, which can be error-prone and adds setup overhead compared to standalone mode.

Limited Direct GitHub Support

The project doesn't support direct inclusion from GitHub due to missing built assets, forcing developers to build manually or rely on Hex packages, adding extra steps for some workflows.

Frequently Asked Questions

Related Projects

telemetry

Dynamic dispatching library for metrics and instrumentations.

Stars912

Forks75

Last commit1 month ago

elixometer

A light Elixir wrapper around exometer.

Stars826

Forks57

Last commit2 years ago

prom_ex

An Elixir Prometheus metrics collection library built on top of Telemetry with accompanying Grafana dashboards

Stars701

Forks130

Last commit2 days ago

exometer

Basic measurement objects and probe behavior

Stars528

Forks102

Last commit7 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub