Merge pull request #480 from plotwist-app/chore/add-opentelemetry

eulixir · web-flow · commit 9a64662a7d05 · 2026-02-23T02:01:31.000-03:00
chore: add opentelemetry
diff --git a/apps/backend/.env.example b/apps/backend/.env.example
@@ -47,3 +47,11 @@ ENABLE_CRON_JOBS=false
 
 # OpenAI
 OPENAI_API_KEY=
+
+# Monitors
+ENABLE_MONITORS=true
+MONITOR_CRON_TIME="*/30 * * * *"
+
+# Telemetry
+OTEL_EXPORTER_OTLP_ENDPOINT=localhost
+OTEL_EXPORTER_OTLP_HEADERS=
diff --git a/apps/backend/docker-compose.yml b/apps/backend/docker-compose.yml
@@ -56,6 +56,16 @@ services:
       - localstack_data:/var/lib/localstack
     networks:
       - plotwist_network
+      
+  grafana:
+    image: grafana/otel-lgtm
+    container_name: plotwist_grafana
+    ports:
+      - 12345:3000
+      - 4317:4317
+      - 4318:4318
+    networks:
+      - plotwist_network
 
 volumes:
   redis-data:
diff --git a/apps/backend/package.json b/apps/backend/package.json
@@ -32,10 +32,21 @@
     "@fastify/cors": "^11.2.0",
     "@fastify/jwt": "^10.0.0",
     "@fastify/multipart": "^9.3.0",
+    "@fastify/otel": "^0.16.0",
     "@fastify/rate-limit": "^10.3.0",
     "@fastify/redis": "^7.1.0",
     "@fastify/swagger": "^9.6.1",
     "@fastify/swagger-ui": "^5.2.4",
+    "@kubiks/otel-drizzle": "^2.1.0",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/exporter-metrics-otlp-proto": "^0.211.0",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.211.0",
+    "@opentelemetry/host-metrics": "^0.38.2",
+    "@opentelemetry/instrumentation-http": "^0.212.0",
+    "@opentelemetry/resources": "^2.5.0",
+    "@opentelemetry/sdk-metrics": "^2.5.0",
+    "@opentelemetry/sdk-node": "^0.211.0",
+    "@opentelemetry/semantic-conventions": "^1.39.0",
     "@plotwist_app/tmdb": "^0.2.5",
     "@react-email/components": "^1.0.3",
     "@swc/core": "^1.15.8",
@@ -57,9 +68,9 @@
     "fastify-type-provider-zod": "^6.1.0",
     "google-auth-library": "^9.14.0",
     "https": "^1.0.0",
+    "ioredis": "^5.8.2",
     "jsonwebtoken": "^9.0.2",
     "jwks-rsa": "^3.1.0",
-    "ioredis": "^5.8.2",
     "node-cron": "^4.2.1",
     "openai": "^6.15.0",
     "pino": "^10.1.0",
diff --git a/apps/backend/src/config.ts b/apps/backend/src/config.ts
@@ -12,6 +12,8 @@ export const config = {
   myAnimeList: loadMALEnvs(),
   openai: loadOpenAIEnvs(),
   google: loadGoogleEnvs(),
+  monitors: loadMonitorsEnvs(),
+  telemetry: loadTelemetryEnvs(),
 }
 
 function loadRedisEnvs() {
@@ -121,3 +123,20 @@ function loadGoogleEnvs() {
 
   return schema.parse(process.env)
 }
+
+function loadMonitorsEnvs() {
+  const schema = z.object({
+    ENABLE_MONITORS: z.string().default('false'),
+    MONITOR_CRON_TIME: z.string().default('0 0 * * *'),
+  })
+
+  return schema.parse(process.env)
+}
+
+function loadTelemetryEnvs() {
+  const schema = z.object({
+    OTEL_EXPORTER_OTLP_ENDPOINT: z.string().optional(),
+    OTEL_EXPORTER_OTLP_HEADERS: z.string().optional(),
+  })
+  return schema.parse(process.env)
+}
diff --git a/apps/backend/src/domain/services/tmdb/get-tmdb-data.ts b/apps/backend/src/domain/services/tmdb/get-tmdb-data.ts
@@ -1,4 +1,5 @@
 import type { FastifyRedis } from '@fastify/redis'
+
 import type { Language } from '@plotwist_app/tmdb'
 import { tmdb } from '@/infra/adapters/tmdb'
 
diff --git a/apps/backend/src/domain/services/users/update-user.ts b/apps/backend/src/domain/services/users/update-user.ts
@@ -1,3 +1,4 @@
+import type { z } from 'zod'
 import { NoValidFieldsError } from '@/domain/errors/no-valid-fields'
 import { UserNotFoundError } from '@/domain/errors/user-not-found'
 import { UsernameAlreadyRegisteredError } from '@/domain/errors/username-already-registered'
@@ -8,7 +9,7 @@ import {
 import { isUniqueViolation } from '@/infra/db/utils/postgres-errors'
 import type { updateUserBodySchema } from '@/infra/http/schemas/users'
 
-export type UpdateUserInput = typeof updateUserBodySchema._type
+export type UpdateUserInput = z.infer<typeof updateUserBodySchema>
 
 export async function updateUserService({
   userId,
diff --git a/apps/backend/src/infra/adapters/r2-storage.ts b/apps/backend/src/infra/adapters/r2-storage.ts
@@ -76,7 +76,7 @@ async function uploadImage({
 
 const R2Storage: CloudStorage = {
   deleteOldImages: prefix => deleteOldImages(prefix),
-  uploadImage: uploadImageInput => uploadImage(uploadImageInput),
+  uploadImage: input => uploadImage(input),
 }
 
 export { R2Storage }
diff --git a/apps/backend/src/infra/db/index.ts b/apps/backend/src/infra/db/index.ts
@@ -1,3 +1,4 @@
+import { instrumentDrizzleClient } from '@kubiks/otel-drizzle'
 import { drizzle } from 'drizzle-orm/postgres-js'
 import postgres from 'postgres'
 import { config } from '@/config'
@@ -6,3 +7,5 @@ import * as schema from './schema'
 
 export const client = postgres(config.db.DATABASE_URL)
 export const db = drizzle(client, { schema })
+
+instrumentDrizzleClient(db, { dbSystem: 'postgresql' })
diff --git a/apps/backend/src/infra/db/repositories/reviews-repository.ts b/apps/backend/src/infra/db/repositories/reviews-repository.ts
@@ -118,7 +118,7 @@ export async function selectReviews({
     )
     .leftJoin(schema.users, eq(schema.reviews.userId, schema.users.id))
     .orderBy(...orderCriteria)
-    .limit(limit + 1) // Fetch one extra to check if there are more
+    .limit(limit + 1)
     .offset(offset)
 }
 
diff --git a/apps/backend/src/infra/db/repositories/user-item-repository.ts b/apps/backend/src/infra/db/repositories/user-item-repository.ts
@@ -180,7 +180,6 @@ export async function reorderUserItems(
   _status: string,
   orderedIds: string[]
 ) {
-  // Update position for each item based on array order
   const updates = orderedIds.map((id, index) =>
     db
       .update(schema.userItems)
diff --git a/apps/backend/src/infra/db/repositories/user-stats.ts b/apps/backend/src/infra/db/repositories/user-stats.ts
@@ -3,8 +3,6 @@ import { db } from '..'
 import { schema } from '../schema'
 
 export async function selectUserStats(userId: string) {
-  // Run all independent queries in parallel instead of sequential transaction
-  // This improves performance as these are all read-only operations
   const [
     [{ count: followersCount }],
     [{ count: followingCount }],
diff --git a/apps/backend/src/infra/http/routes/follow.ts b/apps/backend/src/infra/http/routes/follow.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   createFollowController,
   deleteFollowController,
diff --git a/apps/backend/src/infra/http/routes/images.ts b/apps/backend/src/infra/http/routes/images.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import { createImageController } from '../controllers/images-controller'
 import { verifyJwt } from '../middlewares/verify-jwt'
 import {
diff --git a/apps/backend/src/infra/http/routes/import.ts b/apps/backend/src/infra/http/routes/import.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   createImportController,
   getDetailedImportController,
diff --git a/apps/backend/src/infra/http/routes/likes.ts b/apps/backend/src/infra/http/routes/likes.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   createLikeController,
   deleteLikeController,
diff --git a/apps/backend/src/infra/http/routes/list-item.ts b/apps/backend/src/infra/http/routes/list-item.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   createListItemController,
   deleteListItemController,
diff --git a/apps/backend/src/infra/http/routes/lists.ts b/apps/backend/src/infra/http/routes/lists.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   createListController,
   deleteListController,
diff --git a/apps/backend/src/infra/http/routes/login.ts b/apps/backend/src/infra/http/routes/login.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import { loginController } from '../controllers/login-controller'
 import { loginBodySchema, loginResponseSchema } from '../schemas/login'
 
diff --git a/apps/backend/src/infra/http/routes/social-auth.ts b/apps/backend/src/infra/http/routes/social-auth.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   appleAuthController,
   googleAuthController,
diff --git a/apps/backend/src/infra/http/routes/social-links.ts b/apps/backend/src/infra/http/routes/social-links.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   getSocialLinksController,
   upsertSocialLinksController,
diff --git a/apps/backend/src/infra/http/routes/subscriptions.ts b/apps/backend/src/infra/http/routes/subscriptions.ts
@@ -1,4 +1,5 @@
 import type { FastifyInstance } from 'fastify'
+
 import { deleteSubscriptionController } from '../controllers/subscriptions-controller'
 import { verifyJwt } from '../middlewares/verify-jwt'
 import {
diff --git a/apps/backend/src/infra/http/routes/tmdb-proxy.ts b/apps/backend/src/infra/http/routes/tmdb-proxy.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import https from 'https'
+
 import { config } from '@/config'
 
 const TMDB_BASE_URL = 'https://api.themoviedb.org/3'
diff --git a/apps/backend/src/infra/http/routes/user-activities.ts b/apps/backend/src/infra/http/routes/user-activities.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   deleteUserActivityController,
   getUserActivitiesController,
diff --git a/apps/backend/src/infra/http/routes/user-episodes.ts b/apps/backend/src/infra/http/routes/user-episodes.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   createUserEpisodesController,
   deleteUserEpisodesController,
diff --git a/apps/backend/src/infra/http/routes/user-items.ts b/apps/backend/src/infra/http/routes/user-items.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   deleteUserItemController,
   getAllUserItemsController,
diff --git a/apps/backend/src/infra/http/routes/user-stats.ts b/apps/backend/src/infra/http/routes/user-stats.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   getUserBestReviewsController,
   getUserItemsStatusController,
diff --git a/apps/backend/src/infra/http/routes/users.ts b/apps/backend/src/infra/http/routes/users.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   createUserController,
   deleteUserController,
diff --git a/apps/backend/src/infra/http/routes/watch-entries.ts b/apps/backend/src/infra/http/routes/watch-entries.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import {
   createWatchEntryController,
   deleteWatchEntryController,
diff --git a/apps/backend/src/infra/http/routes/webhook.ts b/apps/backend/src/infra/http/routes/webhook.ts
@@ -1,5 +1,6 @@
 import type { FastifyInstance } from 'fastify'
 import type { ZodTypeProvider } from 'fastify-type-provider-zod'
+
 import { stripeWebhookController } from '../controllers/stripe-webhook-controller'
 
 export async function webhookRoutes(app: FastifyInstance) {
diff --git a/apps/backend/src/infra/http/server.ts b/apps/backend/src/infra/http/server.ts
@@ -6,15 +6,19 @@ import {
   validatorCompiler,
 } from 'fastify-type-provider-zod'
 import { ZodError } from 'zod'
+import { config } from '@/config'
 import { DomainError } from '@/domain/errors/domain-error'
 import { logger } from '@/infra/adapters/logger'
-import { config } from '../../config'
+import { registerHttpRequestMetrics } from '@/infra/telemetry/http-request-metrics'
+import { fastifyOtel } from '@/infra/telemetry/otel'
 import { routes } from './routes'
 import { transformSwaggerSchema } from './transform-schema'
 
 const app: FastifyInstance = fastify()
 
-export function startServer() {
+export async function startServer() {
+  await app.register(fastifyOtel.plugin())
+
   app.setValidatorCompiler(validatorCompiler)
   app.setSerializerCompiler(serializerCompiler)
 
@@ -85,16 +89,15 @@ export function startServer() {
     return reply.status(500).send({ message: 'Internal server error.' })
   })
 
+  registerHttpRequestMetrics(app)
+
   // TODO: Uncomment this when we have a client guard
   // registerClientGuard(app)
   routes(app)
 
-  app
-    .listen({
-      port: config.app.PORT,
-      host: '0.0.0.0',
-    })
-    .then(() => {
-      logger.info(`HTTP server running at ${config.app.BASE_URL}`)
-    })
+  await app.listen({
+    port: config.app.PORT,
+    host: '0.0.0.0',
+  })
+  logger.info(`HTTP server running at ${config.app.BASE_URL}`)
 }
diff --git a/apps/backend/src/infra/http/transform-schema.ts b/apps/backend/src/infra/http/transform-schema.ts
@@ -5,7 +5,7 @@ export function transformSwaggerSchema(
 ): ReturnType<typeof jsonSchemaTransform> {
   const { schema, url } = jsonSchemaTransform(data)
 
-  if (schema.consumes?.includes('multipart/form-data')) {
+  if (schema?.consumes?.includes('multipart/form-data')) {
     if (schema.body === undefined) {
       schema.body = {
         type: 'object',
diff --git a/apps/backend/src/infra/telemetry/dash.json b/apps/backend/src/infra/telemetry/dash.json
diff --git a/apps/backend/src/infra/telemetry/http-request-metrics.ts b/apps/backend/src/infra/telemetry/http-request-metrics.ts
diff --git a/apps/backend/src/infra/telemetry/monitor-metrics.ts b/apps/backend/src/infra/telemetry/monitor-metrics.ts
diff --git a/apps/backend/src/infra/telemetry/otel.ts b/apps/backend/src/infra/telemetry/otel.ts
diff --git a/apps/backend/src/main.ts b/apps/backend/src/main.ts
diff --git a/apps/backend/src/monitors/monitor.ts b/apps/backend/src/monitors/monitor.ts
diff --git a/apps/backend/src/monitors/new-users.ts b/apps/backend/src/monitors/new-users.ts
diff --git a/apps/backend/src/monitors/today-new-subscriptions.ts b/apps/backend/src/monitors/today-new-subscriptions.ts
diff --git a/apps/backend/src/monitors/total-items-added.ts b/apps/backend/src/monitors/total-items-added.ts
diff --git a/apps/backend/src/monitors/total-subscriptions.ts b/apps/backend/src/monitors/total-subscriptions.ts
diff --git a/apps/backend/src/monitors/total-users.ts b/apps/backend/src/monitors/total-users.ts
diff --git a/apps/backend/src/workers/worker.ts b/apps/backend/src/workers/worker.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import type { FastifyRedis } from '@fastify/redis'`
	`2`	`+`
`2`	`3`	`import type { Language } from '@plotwist_app/tmdb'`
`3`	`4`	`import { tmdb } from '@/infra/adapters/tmdb'`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ async function uploadImage({`
`76`	`76`
`77`	`77`	`const R2Storage: CloudStorage = {`
`78`	`78`	`deleteOldImages: prefix => deleteOldImages(prefix),`
`79`		`- uploadImage: uploadImageInput => uploadImage(uploadImageInput),`
	`79`	`+ uploadImage: input => uploadImage(input),`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`export { R2Storage }`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ export async function selectReviews({`
`118`	`118`	`)`
`119`	`119`	`.leftJoin(schema.users, eq(schema.reviews.userId, schema.users.id))`
`120`	`120`	`.orderBy(...orderCriteria)`
`121`		`- .limit(limit + 1) // Fetch one extra to check if there are more`
	`121`	`+ .limit(limit + 1)`
`122`	`122`	`.offset(offset)`
`123`	`123`	`}`
`124`	`124`