feat(ip): log ip and session id

Author: djMax

.trunk/trunk.yaml

@@ -1,23 +1,23 @@
 version: 0.1
 cli:
-  version: 1.17.1
+  version: 1.17.2
 plugins:
   sources:
     - id: trunk
-      ref: v1.2.6
+      ref: v1.3.0
       uri: https://github.com/trunk-io/plugins
 lint:
   enabled:
     - actionlint@1.6.26
-    - checkov@3.0.22
-    - eslint@8.53.0
+    - checkov@3.1.9
+    - eslint@8.54.0
     - git-diff-check
     - markdownlint@0.37.0
     - osv-scanner@1.4.3
-    - prettier@3.0.3
+    - prettier@3.1.0
     - trivy@0.47.0
-    - trufflehog@3.62.1
-    - yamllint@1.32.0
+    - trufflehog@3.63.2-rc0
+    - yamllint@1.33.0
   ignore:
     - linters: [ALL]
       paths:

package.json

@@ -92,7 +92,8 @@
     "minimist": "^1.2.8",
     "opentelemetry-instrumentation-fetch-node": "^1.1.2",
     "pino": "^8.16.2",
-    "read-pkg-up": "^7.0.1"
+    "read-pkg-up": "^7.0.1",
+    "request-ip": "^3.3.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^18.4.2",
@@ -109,6 +110,7 @@
     "@types/lodash": "^4.14.201",
     "@types/minimist": "^1.2.5",
     "@types/node": "^20.9.1",
+    "@types/request-ip": "^0.0.41",
     "@types/supertest": "^2.0.16",
     "@typescript-eslint/eslint-plugin": "^6.11.0",
     "@typescript-eslint/parser": "^6.11.0",

src/telemetry/requestLogger.ts

@@ -1,4 +1,5 @@
 import type { RequestHandler, Request, Response, ErrorRequestHandler } from 'express';
+import requestip from 'request-ip';
 import { Histogram } from '@opentelemetry/api';
 
 import { ServiceError } from '../error';
@@ -34,9 +35,15 @@ function getBasicInfo(req: Request) {
 
   const preInfo: Record<string, string> = {
     url,
+    ip: requestip.getClientIp(req) || '',
     m: req.method,
   };
 
+  const sessionReq = req as WithIdentifiedSession;
+  if (sessionReq.session?.id) {
+    preInfo.sid = sessionReq.session.id;
+  }
+
   return preInfo;
 }
 

yarn.lock

@@ -649,6 +649,7 @@ __metadata:
     "@types/lodash": ^4.14.201
     "@types/minimist": ^1.2.5
     "@types/node": ^20.9.1
+    "@types/request-ip": ^0.0.41
     "@types/supertest": ^2.0.16
     "@typescript-eslint/eslint-plugin": ^6.11.0
     "@typescript-eslint/parser": ^6.11.0
@@ -669,6 +670,7 @@ __metadata:
     pino-pretty: ^10.2.3
     pinst: ^3.0.0
     read-pkg-up: ^7.0.1
+    request-ip: ^3.3.0
     supertest: ^6.3.3
     ts-node: ^10.9.1
     tsconfig-paths: ^4.2.0
@@ -1692,6 +1694,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/request-ip@npm:^0.0.41":
+  version: 0.0.41
+  resolution: "@types/request-ip@npm:0.0.41"
+  dependencies:
+    "@types/node": "*"
+  checksum: d8579b7c9b739bd417eadc83d01fce52b10014733ab0f17f9e922c19013ebe5c745c9b267dc2adf48b26738dfb1a9c6b09184cb8b3e85fc490933966b005748c
+  languageName: node
+  linkType: hard
+
 "@types/semver@npm:^7.5.0":
   version: 7.5.1
   resolution: "@types/semver@npm:7.5.1"
@@ -6460,6 +6471,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"request-ip@npm:^3.3.0":
+  version: 3.3.0
+  resolution: "request-ip@npm:3.3.0"
+  checksum: 9ca26f814201da19cb6f1a18da4f036803b770665ec0e7c556ea975ba553321922a5f04909f6dfc2371f695ca8aaa3c66f02c00a5e902c76435029804cdc4964
+  languageName: node
+  linkType: hard
+
 "require-directory@npm:^2.1.1":
   version: 2.1.1
   resolution: "require-directory@npm:2.1.1"