observable-phoenix

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

observable-phoenix

★ 12 Open GitHub ↗

Template of a Phoenix application using OpenTelemetry to export logs and traces to Grafana (Loki, Tempo) and PromEx for metrics

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Observable TODO List

This project showcases an observable Phoenix application using:

- [Loki](https://grafana.com/oss/loki/) for logs
- [PromEx](https://github.com/akoutmos/prom_ex) and [Prometheus](https://prometheus.io/) for metrics
- [OpenTelemetry](https://opentelemetry.io/docs/instrumentation/erlang/) and [Tempo](https://grafana.com/oss/tempo/) for traces
- [Grafana](https://grafana.com/) for data visualization and querying
- An optional NGINX proxy for securing access to the [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/)

It aims to provide a solid start point for adding observability to an
existing/new Phoenix application.

# Table of Contents

- [Architecture](#architecture)
- [Trying it out](#trying-it-out)
  - [Up and Running](#up-and-running)
  - [Interacting with the application](#interacting-with-the-application)
  - [Checking Grafana](#checking-grafana)
    - [Dashboards](#dashboards)
    - [Exploring](#exploring)

# Architecture
![Project's architecture](https://raw.githubusercontent.com/viniciusmuller/observable-phoenix/main/.github/img/architecture.png)

# Trying it out

## Up and Running

This project uses Docker containers and docker-compose to setup its environment,
so if you want to try it, make sure you have
[Docker](https://docs.docker.com/engine/install/) and
[docker-compose](https://docs.docker.com/compose/install/) installed.

In order to see/interact with the application and the generated metrics, run the
following command:

```sh
docker-compose up
```

If everything went well, you should now have everything running locally in your
machine.

## Interacting with the application

Head to http://localhost:4001/users and do some operations: create, show, list
users, etc...

## Checking Grafana

After doing some operations, check Grafana at http://localhost:3000 (default
credentials are **admin:admin**)

### Dashboards

You will find the dashboards generated by PromEx showing metrics on different
subjects, such as the BEAM, Phoenix Endpoints or Ecto repositories:

![Grafana dashboard showing BEAM metrics](https://raw.githubusercontent.com/viniciusmuller/observable-phoenix/main/.github/img/beam-stats.png)

### Exploring

You can also go to the **Explore** tab and query for specific logs or traces:

![Trace for a specific user request](https://raw.githubusercontent.com/viniciusmuller/observable-phoenix/main/.github/img/user-operation-trace.png)

![Showing latest application logs using Grafana Loki](https://raw.githubusercontent.com/viniciusmuller/observable-phoenix/main/.github/img/application-logs.png)

observable-phoenix

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README