mirror of
https://github.com/hyperdxio/hyperdx
synced 2026-04-21 13:37:15 +00:00
348a4044e8
Summary
Migrates the HyperDX API and related services from Winston to Pino for standardized,
faster, and more structured logging with improved OpenTelemetry integration.
Changes
Core Migration
- Replaced Winston with Pino across all logging infrastructure
- Upgraded @hyperdx/node-opentelemetry from v0.8.2 to v0.9.0 to support Pino
transport
- Removed deprecated dependencies:
- winston and express-winston
- @opentelemetry/host-metrics and @opentelemetry/sdk-metrics (consolidated into
newer OTel SDK)
- Added new dependencies:
- pino and pino-http for core logging
- pino-pretty for development console output
Logger Configuration (packages/api/src/utils/logger.ts)
Production:
- Outputs stringified JSON to stdout via pino/file transport
- Maintains HyperDX transport integration when API key is configured
- Includes full OpenTelemetry trace context (trace_id, span_id, trace_flags)
<img width="830" height="184" alt="Screenshot 2025-10-14 at 4 31 36 PM" src="https://github.com/user-attachments/assets/82e60919-5c4d-4688-a6f5-d54632aef749" />
Development:
- Uses pino-pretty for human-readable, colorized console output
- Hides verbose fields from console: pid, hostname, trace_id, span_id, trace_flags
- HTTP request/response objects excluded from logs via custom serializers
<img width="825" height="350" alt="image" src="https://github.com/user-attachments/assets/64b293d8-bc95-4715-931a-dbf73483d247" />
HTTP Logging:
- Replaced express-winston with pino-http
- Custom log levels based on HTTP status codes (warn for 4xx, error for 5xx+)
- Simplified log messages: HTTP {method} {url}
Error Logging Updates
Updated error logging patterns throughout the codebase to follow Pino's structured
logging conventions:
// Before (Winston)
logger.error('Error message:', error);
// After (Pino)
logger.error({ err: error }, 'Error message');
Ref: HDX-2588
This PR should also address issue: https://github.com/hyperdxio/hyperdx/issues/1035
97 lines
4 KiB
JSON
97 lines
4 KiB
JSON
{
|
|
"name": "@hyperdx/api",
|
|
"version": "2.6.0",
|
|
"license": "MIT",
|
|
"private": true,
|
|
"engines": {
|
|
"node": ">=22.16.0"
|
|
},
|
|
"dependencies": {
|
|
"@ai-sdk/anthropic": "^2.0.23",
|
|
"@esm2cjs/p-queue": "^7.3.0",
|
|
"@hyperdx/common-utils": "^0.7.0",
|
|
"@hyperdx/node-opentelemetry": "^0.9.0",
|
|
"@hyperdx/passport-local-mongoose": "^9.0.1",
|
|
"@opentelemetry/api": "^1.8.0",
|
|
"@opentelemetry/host-metrics": "^0.35.5",
|
|
"@opentelemetry/sdk-metrics": "^1.30.1",
|
|
"@slack/webhook": "^6.1.0",
|
|
"@types/node": "^22.15.18",
|
|
"ai": "5.0.59",
|
|
"chrono-node": "^2.9.0",
|
|
"compression": "^1.7.4",
|
|
"connect-mongo": "^4.6.0",
|
|
"cors": "^2.8.5",
|
|
"cron": "^4.3.1",
|
|
"date-fns": "^2.28.0",
|
|
"express": "^4.19.2",
|
|
"express-rate-limit": "^6.7.1",
|
|
"express-session": "^1.17.3",
|
|
"handlebars": "^4.7.8",
|
|
"http-graceful-shutdown": "^3.1.13",
|
|
"http-proxy-middleware": "^3.0.5",
|
|
"jsonwebtoken": "^9.0.0",
|
|
"lodash": "^4.17.21",
|
|
"minimist": "^1.2.7",
|
|
"mongodb": "^6.15.0",
|
|
"mongoose": "^6.13.8",
|
|
"ms": "^2.1.3",
|
|
"on-headers": "^1.1.0",
|
|
"passport": "^0.6.0",
|
|
"passport-local": "^1.0.0",
|
|
"pino": "^10.0.0",
|
|
"pino-http": "^11.0.0",
|
|
"promised-handlebars": "^2.0.1",
|
|
"protobufjs": "^7.5.2",
|
|
"semver": "^7.5.2",
|
|
"serialize-error": "^8.1.0",
|
|
"uuid": "^8.3.2",
|
|
"zod": "3.25",
|
|
"zod-express-middleware": "^1.4.0"
|
|
},
|
|
"devDependencies": {
|
|
"@types/compression": "^1.7.3",
|
|
"@types/cors": "^2.8.14",
|
|
"@types/express": "^4.17.13",
|
|
"@types/express-session": "^1.17.7",
|
|
"@types/jest": "^28.1.1",
|
|
"@types/lodash": "^4.14.198",
|
|
"@types/minimist": "^1.2.2",
|
|
"@types/ms": "^0.7.31",
|
|
"@types/passport-local": "^1.0.34",
|
|
"@types/semver": "^7.3.12",
|
|
"@types/supertest": "^2.0.12",
|
|
"@types/swagger-jsdoc": "^6",
|
|
"@types/uuid": "^8.3.4",
|
|
"esbuild": "^0.25.5",
|
|
"jest": "^28.1.3",
|
|
"migrate-mongo": "^11.0.0",
|
|
"nodemon": "^2.0.20",
|
|
"pino-pretty": "^13.1.1",
|
|
"rimraf": "^4.4.1",
|
|
"supertest": "^6.3.1",
|
|
"swagger-jsdoc": "^6.2.8",
|
|
"swagger-ui-express": "^5.0.1",
|
|
"ts-jest": "^28.0.5",
|
|
"ts-node": "^10.8.1",
|
|
"tsc-alias": "^1.8.8",
|
|
"tsconfig-paths": "^4.2.0",
|
|
"typescript": "5.9.3"
|
|
},
|
|
"scripts": {
|
|
"start": "node ./dist/index.js",
|
|
"dev": "DOTENV_CONFIG_PATH=.env.development nodemon --signal SIGTERM -e ts,json --exec 'ts-node' --transpile-only -r tsconfig-paths/register -r dotenv-expand/config -r '@hyperdx/node-opentelemetry/build/src/tracing' ./src/index.ts",
|
|
"dev-task": "DOTENV_CONFIG_PATH=.env.development nodemon --signal SIGTERM -e ts,json --exec 'ts-node' --transpile-only -r tsconfig-paths/register -r dotenv-expand/config -r '@hyperdx/node-opentelemetry/build/src/tracing' ./src/tasks/index.ts",
|
|
"build": "tsc -p ./tsconfig.build.json && tsc-alias -p ./tsconfig.build.json && esbuild ../../node_modules/@hyperdx/node-opentelemetry/build/src/tracing --bundle --minify --platform=node --outfile=dist/tracing.js && esbuild ./build/src/index.js ./build/src/tasks/index.js --bundle --minify --platform=node --target=node22 --outdir=dist --alias:@='./src' && mkdir -p dist/opamp && cp -r src/opamp/proto dist/opamp/proto && rimraf ./build",
|
|
"lint": "npx eslint --quiet . --ext .ts",
|
|
"lint:fix": "npx eslint . --ext .ts --fix",
|
|
"ci:lint": "yarn lint && yarn tsc --noEmit",
|
|
"ci:int": "DOTENV_CONFIG_PATH=.env.test jest --runInBand --ci --forceExit --coverage",
|
|
"dev:int": "DOTENV_CONFIG_PATH=.env.test jest --watchAll --runInBand --detectOpenHandles",
|
|
"dev:migrate-db-create": "ts-node node_modules/.bin/migrate-mongo create -f migrate-mongo-config.ts",
|
|
"dev:migrate-db": "ts-node node_modules/.bin/migrate-mongo up -f migrate-mongo-config.ts",
|
|
"dev:migrate-ch-create": "migrate create -ext sql -dir ./migrations/ch -seq",
|
|
"dev:migrate-ch": "migrate -database 'clickhouse://localhost:9000?database=default&x-multi-statement=true' -path ./migrations/ch up",
|
|
"docgen": "ts-node scripts/generate-api-docs.ts"
|
|
}
|
|
}
|