feat(health): add Sentry status check to health endpoint

- Integrated Sentry status check functionality in the health controller.
- Updated tests to validate Sentry active/disabled states.
- Improved Sentry initialization with enhanced logging and error handling.
This commit is contained in:
Mathis HERRIOT
2026-02-09 12:57:31 +01:00
parent 8a146a2e1d
commit 3a4f6624fc
3 changed files with 63 additions and 16 deletions

View File

@@ -1,8 +1,13 @@
import { CACHE_MANAGER } from "@nestjs/cache-manager"; import { CACHE_MANAGER } from "@nestjs/cache-manager";
import { Test, TestingModule } from "@nestjs/testing"; import { Test, TestingModule } from "@nestjs/testing";
import * as Sentry from "@sentry/nestjs";
import { DatabaseService } from "./database/database.service"; import { DatabaseService } from "./database/database.service";
import { HealthController } from "./health.controller"; import { HealthController } from "./health.controller";
jest.mock("@sentry/nestjs", () => ({
getClient: jest.fn(),
}));
describe("HealthController", () => { describe("HealthController", () => {
let controller: HealthController; let controller: HealthController;
@@ -37,10 +42,15 @@ describe("HealthController", () => {
it("should return ok if database and redis are connected", async () => { it("should return ok if database and redis are connected", async () => {
mockDb.execute.mockResolvedValue([]); mockDb.execute.mockResolvedValue([]);
mockCacheManager.set.mockResolvedValue(undefined); mockCacheManager.set.mockResolvedValue(undefined);
(Sentry.getClient as jest.Mock).mockReturnValue({
getOptions: () => ({ dsn: "http://dsn" }),
});
const result = await controller.check(); const result = await controller.check();
expect(result.status).toBe("ok"); expect(result.status).toBe("ok");
expect(result.database).toBe("connected"); expect(result.database).toBe("connected");
expect(result.redis).toBe("connected"); expect(result.redis).toBe("connected");
expect(result.sentry).toBe("active");
}); });
it("should return error if database is disconnected", async () => { it("should return error if database is disconnected", async () => {
@@ -62,4 +72,19 @@ describe("HealthController", () => {
expect(result.redis).toBe("disconnected"); expect(result.redis).toBe("disconnected");
expect(result.redisError).toBe("Redis Error"); expect(result.redisError).toBe("Redis Error");
}); });
it("should return sentry disabled if client or dsn is missing", async () => {
mockDb.execute.mockResolvedValue([]);
mockCacheManager.set.mockResolvedValue(undefined);
(Sentry.getClient as jest.Mock).mockReturnValue(undefined);
const result = await controller.check();
expect(result.sentry).toBe("disabled");
(Sentry.getClient as jest.Mock).mockReturnValue({
getOptions: () => ({ dsn: undefined }),
});
const result2 = await controller.check();
expect(result2.sentry).toBe("disabled");
});
}); });

View File

@@ -1,5 +1,6 @@
import { CACHE_MANAGER } from "@nestjs/cache-manager"; import { CACHE_MANAGER } from "@nestjs/cache-manager";
import { Controller, Get, Inject } from "@nestjs/common"; import { Controller, Get, Inject } from "@nestjs/common";
import * as Sentry from "@sentry/nestjs";
import type { Cache } from "cache-manager"; import type { Cache } from "cache-manager";
import { sql } from "drizzle-orm"; import { sql } from "drizzle-orm";
import { DatabaseService } from "./database/database.service"; import { DatabaseService } from "./database/database.service";
@@ -39,6 +40,14 @@ export class HealthController {
health.redisError = error.message; health.redisError = error.message;
} }
// Check Sentry status
const sentryClient = Sentry.getClient();
if (sentryClient?.getOptions().dsn) {
health.sentry = "active";
} else {
health.sentry = "disabled";
}
return health; return health;
} }
} }

View File

@@ -19,9 +19,10 @@ async function bootstrap() {
const sentryDsn = configService.get<string>("SENTRY_DSN"); const sentryDsn = configService.get<string>("SENTRY_DSN");
if (sentryDsn) { if (sentryDsn) {
try {
Sentry.init({ Sentry.init({
dsn: sentryDsn, dsn: sentryDsn,
integrations: [nodeProfilingIntegration()], integrations: [Sentry.nestIntegration(), nodeProfilingIntegration()],
tracesSampleRate: 1.0, tracesSampleRate: 1.0,
profilesSampleRate: 1.0, profilesSampleRate: 1.0,
sendDefaultPii: false, // RGPD sendDefaultPii: false, // RGPD
@@ -35,6 +36,18 @@ async function bootstrap() {
return event; return event;
}, },
}); });
const client = Sentry.getClient();
if (client?.getOptions().dsn) {
logger.log("Sentry is initialized and connection is active");
} else {
logger.warn("Sentry initialized but DSN is missing");
}
} catch (error) {
logger.error(`Failed to initialize Sentry: ${error.message}`);
}
} else {
logger.warn("Sentry is disabled (SENTRY_DSN not configured)");
} }
// Sécurité // Sécurité