feat: API monitoring #43
+200
−3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,11 @@ | |
| RawReplyDefaultExpression, | ||
| RawRequestDefaultExpression, | ||
| RawServerDefault, | ||
| FastifyReply, | ||
| FastifyRequest, | ||
| RouteOptions, | ||
| } from "fastify"; | ||
| import fastifyMetrics from "fastify-metrics"; | ||
| import * as path from "path"; | ||
| import { fileURLToPath } from "url"; | ||
|
|
||
|
|
@@ -21,6 +25,8 @@ | |
| // Place your custom options for app below here. | ||
| // MongoDB URI (Optional) | ||
| // mongoUri: string; | ||
| lokiHost?: string; | ||
| prometheusKey?: string; | ||
|
There was a problem hiding this comment. The variable name "prometheusKey" is misleading as it's actually used as an authentication secret/token. Consider renaming to "prometheusAuthToken" or "prometheusSecret" to better reflect its purpose and security implications. |
||
| } & FastifyServerOptions & | ||
| Partial<AutoloadPluginOptions> & | ||
| AuthPluginOptions; | ||
|
|
@@ -49,6 +55,8 @@ | |
| // mongoUri: getOption("MONGO_URI")!, | ||
| authDiscoveryURL: getOption("AUTH_DISCOVERY_URL")!, | ||
| authClientID: getOption("AUTH_CLIENT_ID")!, | ||
| lokiHost: getOption("LOKI_HOST", false), | ||
| prometheusKey: getOption("PROMETHEUS_KEY", false), | ||
| authSkip: (() => { | ||
| const opt = getOption("AUTH_SKIP", false); | ||
| if (opt !== undefined) { | ||
|
|
@@ -59,6 +67,43 @@ | |
| })(), | ||
| }; | ||
|
|
||
| if (options.lokiHost) { | ||
| const lokiTransport = { | ||
| target: "pino-loki", | ||
| options: { | ||
| batching: true, | ||
| interval: 5, // Logs are sent every 5 seconds, default. | ||
| host: options.lokiHost, | ||
| labels: { application: packageJson.name }, | ||
| }, | ||
| }; | ||
|
|
||
| const existingLogger = options.logger; | ||
|
|
||
| if (existingLogger && typeof existingLogger === "object") { | ||
| const existingTransport = (existingLogger as any).transport; | ||
|
Check failure on line 84 in src/app.ts
|
||
|
|
||
| let mergedTransport: any; | ||
|
Check failure on line 86 in src/app.ts
|
||
| if (Array.isArray(existingTransport)) { | ||
| mergedTransport = [...existingTransport, lokiTransport]; | ||
| } else if (existingTransport) { | ||
| mergedTransport = [existingTransport, lokiTransport]; | ||
| } else { | ||
| mergedTransport = lokiTransport; | ||
| } | ||
|
|
||
| options.logger = { | ||
| ...(existingLogger as any), | ||
|
Check failure on line 96 in src/app.ts
|
||
| transport: mergedTransport, | ||
| } as any; | ||
|
Check failure on line 98 in src/app.ts
|
||
| } else { | ||
| options.logger = { | ||
| level: "info", | ||
| transport: lokiTransport, | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| // Support Typebox | ||
| export type FastifyTypebox = FastifyInstance< | ||
| RawServerDefault, | ||
|
|
@@ -83,6 +128,29 @@ | |
| origin: "*", | ||
| }); | ||
|
|
||
| // Register Metrics | ||
| const metricsEndpoint: RouteOptions | string | null = opts.prometheusKey | ||
| ? { | ||
| url: "/metrics", | ||
| method: "GET", | ||
| handler: async () => {}, // Overridden by fastify-metrics | ||
| onRequest: async (request: FastifyRequest, reply: FastifyReply) => { | ||
| if ( | ||
| request.headers.authorization !== `Bearer ${opts.prometheusKey}` | ||
| ) { | ||
|
Comment on lines
+138
to
+140
There was a problem hiding this comment. The authentication check is vulnerable to timing attacks. Consider using a constant-time comparison function to compare the authorization header with the expected value to prevent attackers from determining the correct key through timing analysis.
Member
There was a problem hiding this comment. This is okay... I guess. |
||
| reply.code(401).send({ status: "error", message: "Unauthorized" }); | ||
| return; | ||
| } | ||
| }, | ||
| } | ||
| : "/metrics"; | ||
|
|
||
| await fastify.register(fastifyMetrics.default, { | ||
| endpoint: metricsEndpoint, | ||
| defaultMetrics: { enabled: true }, | ||
| clearRegisterOnInit: true, | ||
| }); | ||
|
|
||
| // Register Swagger & Swagger UI & Scalar | ||
| await fastify.register(import("@fastify/swagger"), { | ||
| openapi: { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| import { build } from "../helper.js"; | ||
| import * as assert from "node:assert"; | ||
| import { test } from "node:test"; | ||
|
|
||
| test("metrics route without key", async (t) => { | ||
| const app = await build(t); | ||
|
|
||
| const response = await app.inject({ | ||
| url: "/metrics", | ||
| }); | ||
|
|
||
| assert.equal(response.statusCode, 200); | ||
| }); | ||
wylited marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| test("metrics route with key", async (t) => { | ||
| const app = await build(t, { prometheusKey: "secret" }); | ||
|
|
||
| // Without auth header | ||
| const response = await app.inject({ | ||
| url: "/metrics", | ||
| }); | ||
| assert.equal(response.statusCode, 401); | ||
|
|
||
| // With correct auth header | ||
| const responseAuth = await app.inject({ | ||
| url: "/metrics", | ||
| headers: { | ||
| authorization: "Bearer secret", | ||
| }, | ||
| }); | ||
| assert.equal(responseAuth.statusCode, 200); | ||
wylited marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // With incorrect auth header | ||
| const responseBadAuth = await app.inject({ | ||
| url: "/metrics", | ||
| headers: { | ||
| authorization: "Bearer wrong", | ||
| }, | ||
| }); | ||
| assert.equal(responseBadAuth.statusCode, 401); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.