Observable TODO List

This project showcases an observable Phoenix application using:

• Loki for logs
• PromEx and Prometheus for metrics
• OpenTelemetry and Tempo for traces
• Grafana for data visualization and querying
• An optional NGINX proxy for securing access to the OpenTelemetry Collector

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

Table of Contents

• Architecture
• Trying it out
  • Up and Running
  • Interacting with the application
  • Checking Grafana
    • Dashboards
    • Exploring

Architecture

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 and docker-compose installed.

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

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:

Exploring

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