feat: add API performance observability reporting

This commit is contained in:
dahyeon committed 2026-06-28 00:40:05 -07:00
1 parent 871a5fe78a
commit 88de2148ae
14 files changed
+2082 -1

No files matched your search

@@ -0,0 +1,218 @@
import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises';
import os from 'node:os';
import path from 'node:path';
import {
buildEndpointReportFromLocalEvents,
buildNewRelicCustomEventNrql,
buildNewRelicTransactionNrql,
discoverApiRoutes,
formatMarkdownReport,
mergeRowsWithManifest,
} from './api-performance-report';
import type { ApiPerformanceEvent } from '../modules/global/observability/performance-observer';
describe('api performance route discovery', () => {
let rootDir: string;
beforeEach(async () => {
rootDir = await mkdtemp(path.join(os.tmpdir(), 'api-performance-routes-'));
await mkdir(path.join(rootDir, 'modules', 'match'), { recursive: true });
});
afterEach(async () => {
await rm(rootDir, { recursive: true, force: true });
});
it('discovers controller routes including multiline decorators', async () => {
await writeFile(
path.join(rootDir, 'modules', 'match', 'match.controller.ts'),
`
import { Controller, Get, Post } from '@nestjs/common';
@Controller('communities/:communityId/matches')
export class MatchController {
@Get()
list() {}
@Post(
':matchId/participants'
)
join() {}
}
`,
);
await writeFile(
path.join(rootDir, 'app.controller.ts'),
`
import { Controller, Get } from '@nestjs/common';
@Controller()
export class AppController {
@Get()
root() {}
}
`,
);
await expect(discoverApiRoutes(rootDir)).resolves.toEqual([
{
method: 'GET',
route: '/',
controllerFile: 'app.controller.ts',
},
{
method: 'GET',
route: '/communities/:communityId/matches',
controllerFile: 'modules/match/match.controller.ts',
},
{
method: 'POST',
route: '/communities/:communityId/matches/:matchId/participants',
controllerFile: 'modules/match/match.controller.ts',
},
]);
});
});
describe('api performance report generation', () => {
it('reports every manifest route, including routes with no samples', () => {
const routes = [
{
method: 'GET',
route: '/communities/:communityId/matches',
controllerFile: 'match.controller.ts',
},
{
method: 'POST',
route: '/communities/:communityId/matches',
controllerFile: 'match.controller.ts',
},
{
method: 'GET',
route: '/communities/:communityId/internal-stats/matches',
controllerFile: 'community-stats.controller.ts',
},
];
const events: ApiPerformanceEvent[] = [
{
type: 'api-request',
timestamp: '2026-06-28T00:00:00.000Z',
requestId: 'request-1',
method: 'GET',
route: '/communities/:communityId/matches',
path: '/communities/abc/matches',
statusCode: 200,
durationMs: 100,
isError: false,
queryCount: 2,
mongooseDurationMs: 40,
docsReturned: 50,
hydratedDocsReturned: 50,
leanQueryCount: 0,
},
];
const rows = buildEndpointReportFromLocalEvents({
routes,
events,
p95BudgetMs: 300,
docsReturnedP95Budget: 500,
hydratedDocsReturnedP95Budget: 0,
});
expect(rows).toHaveLength(3);
expect(
rows.find(
(row) => row.route === '/communities/:communityId/matches',
)?.status,
).toBe('document-heavy');
expect(rows.filter((row) => row.status === 'no-samples')).toHaveLength(2);
});
it('keeps observed-only New Relic rows while adding no-sample manifest routes', () => {
const rows = mergeRowsWithManifest({
routes: [
{
method: 'GET',
route: '/known',
controllerFile: 'known.controller.ts',
},
],
measuredRows: [
{
method: 'GET',
route: '/observed-only',
source: 'newrelic-transaction',
samples: 10,
avgMs: 40,
p50Ms: 35,
p95Ms: 80,
p99Ms: 120,
maxMs: 130,
errorRatePercentage: 0,
queryCountP95: null,
mongooseDurationP95Ms: null,
docsReturnedP95: null,
hydratedDocsReturnedP95: null,
status: 'ok',
},
],
fallbackSource: 'newrelic-transaction',
p95BudgetMs: 300,
docsReturnedP95Budget: 500,
hydratedDocsReturnedP95Budget: 0,
});
expect(rows.map((row) => `${row.method} ${row.route}`)).toEqual([
'GET /known',
'GET /observed-only',
]);
expect(rows[0].status).toBe('no-samples');
expect(rows[1].samples).toBe(10);
});
it('formats all rows instead of truncating to a top list', () => {
const rows = Array.from({ length: 12 }, (_, index) => ({
method: 'GET',
route: `/route-${index}`,
source: 'local' as const,
samples: 1,
avgMs: 10,
p50Ms: 10,
p95Ms: 10,
p99Ms: 10,
maxMs: 10,
errorRatePercentage: 0,
queryCountP95: 1,
mongooseDurationP95Ms: 1,
docsReturnedP95: 1,
hydratedDocsReturnedP95: 0,
status: 'ok' as const,
}));
const report = formatMarkdownReport({
rows,
source: 'local',
since: 'fixture',
});
expect(report).toContain('/route-0');
expect(report).toContain('/route-11');
});
it('builds New Relic queries for custom events and transaction duration data', () => {
expect(buildNewRelicCustomEventNrql('lolympus-api', '1 day ago')).toContain(
'FROM ApiRequestPerformance',
);
expect(buildNewRelicCustomEventNrql('lolympus-api', '1 day ago')).toContain(
'FACET method, route',
);
expect(
buildNewRelicTransactionNrql('lolympus-api', '1 day ago'),
).toContain('FROM Transaction');
expect(
buildNewRelicTransactionNrql('lolympus-api', '1 day ago'),
).toContain('FACET name');
});
});