https://github.com/connorlindsey/otel-grafana-demo

Demo application showing how to instrument a Node application with OpenTelemetry, Prometheus, Jaeger, Loki, and Grafana. Built with Next.js, Fastify, and Postgres.
https://github.com/connorlindsey/otel-grafana-demo

grafana observability open-telemetry prometheus

Last synced: 3 months ago
JSON representation

Demo application showing how to instrument a Node application with OpenTelemetry, Prometheus, Jaeger, Loki, and Grafana. Built with Next.js, Fastify, and Postgres.

• Host: GitHub
• URL: https://github.com/connorlindsey/otel-grafana-demo
• Owner: connorlindsey
• Created: 2021-08-03T21:26:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-07T16:37:14.000Z (about 3 years ago)
• Last Synced: 2024-09-27T07:02:16.292Z (3 months ago)
• Topics: grafana, observability, open-telemetry, prometheus
• Language: TypeScript
• Homepage:
• Size: 449 KB
• Stars: 35
• Watchers: 2
• Forks: 15
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# OpenTelemetry - Grafana Demo

Author: Connor Lindsey

This demo application demonstrates how to monitor a JavaScript application using open source observability software. The following projects are used:

- [OpenTelemetry](https://opentelemetry.io/) - Instrument the application and send observability data to each backend.

- [Jaeger](https://www.jaegertracing.io/) - Distributed tracing backend.

- [Prometheus](https://prometheus.io/) - Metrics and alerting backend.

- [Loki](https://grafana.com/oss/loki/) - Logs aggregation system.

- [Grafana](https://grafana.com/) - Visualize all of our observability data.

## Project Structure

![App architecture](./docs/assets/app_architecture.png)

- api/ - Fastify API. Instrumented with OpenTelemetry

- app/ - Simple Next.js app.

- db/  - Stores copy of Postgres data for persistence.

- config/ - Standard configuration for Prometheus, Promtail, Loki, etc.

- data/ - Stores server logs

## Running the app

1. Run with `npm run dev`. Requires [Docker](https://www.docker.com/) and docker-compose.

1. Optionally, run `npm install` in `/api` and `/app`.

1. Open the app at http://localhost

1. View traces, logs, and metrics in Grafana at http://localhost:3000

## Additional Resources

- [Grafana Demo](https://play.grafana.org/d/000000012/grafana-play-home?orgId=1)

- [Grafana Cloud](https://grafana.com/products/cloud/) - Actually useful free tier

- [OpenTelemetry Key Terms](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md)

- [OpenTelemetry JS](https://github.com/open-telemetry/opentelemetry-js)

- [OpenTelemetry JS Contrib](https://github.com/open-telemetry/opentelemetry-js-contrib)

- [OpenTelemetry Status](https://opentelemetry.io/status/)

- [UtahJS Slides](https://bit.ly/3oBobaQ)