feat(api): dynamically change logging level via API (#825)

* feat(api): add authenticated endpoint to dynamically manage logging level

- Add ADMIN_API_KEY environment variable for secure access
- Add functionality to modify logging level at runtime
- Implement tRPC endpoints for getting and setting log level
- Enhance logger module to track all logger instances
- Add proper OpenAPI documentation with system tag

* fix: remove unused import

* env var ADMIN_API_KEY

* refactor(api): move logging router procedures into separate files

* fix(api): remove unnecessary success field from logging procedure responses

* refactor(api): organize api keys by type

* test(api): add UT to check invalid log level updates

* chore: add changeset

---------

Co-authored-by: PJColombo <[email protected]>

Author: PabloCastellano

.changeset/calm-experts-draw.md

@@ -0,0 +1,5 @@
+---
+"@blobscan/api": minor
+---
+
+Added procedures to retrieve and update the logger's level

.env.example

@@ -12,6 +12,7 @@ DIRECT_URL=postgresql://blobscan:s3cr3t@localhost:5432/blobscan_dev?schema=publi
 BLOBSCAN_WEB_TAG=next
 BLOBSCAN_API_TAG=next
 INDEXER_TAG=master
+ADMIN_API_KEY=secretkey
 
 ### blobscan website
 

.env.test

@@ -32,6 +32,8 @@ S3_STORAGE_ENABLED=true
 S3_STORAGE_ENDPOINT=http://localhost:9090
 S3_STORAGE_FORCE_PATH_STYLE=true
 
+ADMIN_API_KEY=secretkey
+
 BEE_ENDPOINT=http://localhost:1633
 SWARM_BATCH_ID=f89e63edf757f06e89933761d6d46592d03026efb9871f9d244f34da86b6c242
 

apps/docs/src/app/docs/environment/page.md

@@ -32,6 +32,7 @@ nextjs:
 
 | Variable                                               | Description                                                                                               | Required                        | Default value                                |
 | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ------------------------------- | -------------------------------------------- |
+| `ADMIN_API_KEY`                                        | API key used to authenticate requests to admin endpoints (e.g., logging level management)                 | No                              | (empty)                                      |
 | `BLOB_DATA_API_ENABLED`                                | Controls whether the blob data API endpoint is enabled                                                    | No                              | `true`                                       |
 | `BLOB_DATA_API_KEY`                                    | API key used to authenticate requests to retrieve blob data from the blobscan API                         | No                              | (empty)                                      |
 | `CHAIN_ID`                                             | EVM chain id                                                                                              | Yes                             | `1`                                          |

apps/rest-api-server/src/index.ts

@@ -66,10 +66,14 @@ async function main() {
         enableTracing: env.TRACES_ENABLED,
         prisma,
         scope: "rest-api",
-        serviceApiKeys: {
-          blobDataReadKey: env.BLOB_DATA_API_KEY,
-          indexerServiceSecret: env.SECRET_KEY,
-          loadNetworkServiceKey: env.WEAVEVM_API_KEY,
+        apiKeys: {
+          accesses: {
+            blobDataRead: env.BLOB_DATA_API_KEY,
+          },
+          services: {
+            indexer: env.SECRET_KEY,
+            loadNetwork: env.WEAVEVM_API_KEY,
+          },
         },
       }),
       onError({ error }) {

apps/web/src/pages/api/trpc/[...trpc].ts

@@ -23,8 +23,10 @@ export default createNextApiHandler({
     chainId: env.CHAIN_ID,
     prisma,
     enableTracing: env.TRACES_ENABLED,
-    serviceApiKeys: {
-      blobDataReadKey: env.BLOB_DATA_API_KEY,
+    apiKeys: {
+      accesses: {
+        blobDataRead: env.BLOB_DATA_API_KEY,
+      },
     },
   }),
   onError({ error }) {

packages/api/src/app-router.ts

@@ -8,6 +8,7 @@ import { blockchainSyncStateRouter } from "./routers/blockchain-sync-state";
 import { ethPriceRouter } from "./routers/eth-price";
 import { healthcheck } from "./routers/healthcheck";
 import { indexerRouter } from "./routers/indexer";
+import { loggingRouter } from "./routers/logging";
 import { search } from "./routers/search";
 import { stateRouter } from "./routers/state";
 import { statsRouter } from "./routers/stats";
@@ -25,6 +26,7 @@ export function createAppRouter(config?: AppRouterConfig) {
     blob: createBlobRouter(config?.blobRouter),
     blobStoragesState: blobStoragesStateRouter,
     block: blockRouter,
+    loggingRouter,
     syncState: blockchainSyncStateRouter,
     ethPrice: ethPriceRouter,
     indexer: indexerRouter,

packages/api/src/context.ts

@@ -10,23 +10,31 @@ import type {
 import type { BlobPropagator } from "@blobscan/blob-propagator";
 import type { BlobscanPrismaClient } from "@blobscan/db";
 
-import type { ServiceClient } from "./utils";
-import { createServiceClient } from "./utils";
+import type { ApiClient } from "./utils";
+import { createApiClient } from "./utils";
 
 export type CreateContextOptions =
   | NodeHTTPCreateContextFnOptions<NodeHTTPRequest, NodeHTTPResponse>
   | CreateNextContextOptions;
 
 type CreateInnerContextOptions = Partial<CreateContextOptions> & {
-  serviceClient?: ServiceClient;
+  apiClient?: ApiClient;
   blobPropagator?: BlobPropagator;
   prisma: BlobscanPrismaClient;
 };
 
 export type ServiceApiKeys = Partial<{
-  indexerServiceSecret: string;
-  loadNetworkServiceKey: string;
-  blobDataReadKey: string;
+  indexer: string;
+  loadNetwork: string;
+}>;
+
+export type AccessKeys = Partial<{
+  blobDataRead: string;
+}>;
+
+export type ApiKeys = Partial<{
+  services: ServiceApiKeys;
+  accesses: AccessKeys;
 }>;
 
 export type CreateContextParams = {
@@ -35,20 +43,20 @@ export type CreateContextParams = {
   prisma: BlobscanPrismaClient;
   enableTracing?: boolean;
   scope: ContextScope;
-  serviceApiKeys?: ServiceApiKeys;
+  apiKeys?: ApiKeys;
 };
 
 export type TRPCInnerContext = {
   prisma: BlobscanPrismaClient;
   blobPropagator?: BlobPropagator;
-  apiClient?: ServiceClient;
+  apiClient?: ApiClient;
 };
 
 export function createTRPCInnerContext(opts: CreateInnerContextOptions) {
   return {
     prisma: opts.prisma,
     blobPropagator: opts.blobPropagator,
-    apiClient: opts.serviceClient,
+    apiClient: opts.apiClient,
   };
 }
 
@@ -60,17 +68,17 @@ export function createTRPCContext({
   chainId,
   enableTracing,
   scope,
-  serviceApiKeys,
+  apiKeys,
 }: CreateContextParams) {
   return async (opts: CreateContextOptions) => {
     try {
-      const serviceClient = serviceApiKeys
-        ? createServiceClient(serviceApiKeys, opts.req)
+      const apiClient = apiKeys
+        ? createApiClient(apiKeys, opts.req)
         : undefined;
 
       const innerContext = createTRPCInnerContext({
         prisma,
-        serviceClient,
+        apiClient,
         blobPropagator,
       });
 

packages/api/src/routers/logging/getLevel.ts

@@ -0,0 +1,26 @@
+import type { LoggerLevel } from "@blobscan/logger";
+import { logger, logLevelEnum } from "@blobscan/logger";
+import { z } from "@blobscan/zod";
+
+import { createAuthedProcedure } from "../../procedures";
+
+export const getLevel = createAuthedProcedure("admin")
+  .meta({
+    openapi: {
+      method: "GET",
+      path: "/logging/level",
+      summary: "Get the current logging level",
+      tags: ["system"],
+    },
+  })
+  .input(z.void())
+  .output(
+    z.object({
+      level: logLevelEnum,
+    })
+  )
+  .query(() => {
+    return {
+      level: logger.level as LoggerLevel,
+    };
+  });

packages/api/src/routers/logging/index.ts

@@ -0,0 +1,8 @@
+import { t } from "../../trpc-client";
+import { getLevel } from "./getLevel";
+import { updateLevel } from "./updateLevel";
+
+export const loggingRouter = t.router({
+  getLevel,
+  updateLevel,
+});