README.md

🔭 Node.js API - OpenTelemetry instrumentation

Projeto de exemplo para instrumentação de uma API Node.js utilizando o OpenTelemetry

Funcionalidades • Pré-requisitos • Subindo a aplicação • Subindo a stack de observabilidade • Tecnologias utilizadas

Funcionalidades

• Cadastro de tarefas
• Alteração de tarefas
• Consulta de tarefas
• Deleção de tarefas

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Docker e Docker compose

Subindo a aplicação

# Clone este repositório
$ git clone https://github.com/leogiraldimg/nodejs-otel.git

# Acesse o diretório do projeto clonado
$ cd nodejs-otel

# Suba o container do banco de dados
$ docker-compose -f docker-compose.local.yaml up -d

# Execute as migrações do banco de dados
$ npm run migration:dev

# Suba a aplicação
$ npm start

Subindo a stack de observabilidade

Para subir a stack de observabilidade, acesse o branch "otel-instrumentation".

# Acesse o diretório observability
$ cd observability

# Suba os containers da stack de observabilidade
$ docker compose up -d

Tecnologias utilizadas

As seguintes ferramentas foram usadas na construção do projeto:

• Node.js
• Docker
• Grafana
• Grafana Tempo
• Grafana Loki
• Prometheus
• OpenTelemetry