FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

chore: replace bunyan-middleware by Trott · Pull Request #682 · nodejs/github-bot · GitHub

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .js  (3) .json  (2) All 2 file types selected
Only manifest files
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
11 changes: 3 additions & 8 deletions app.js
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
Expand Up @@ -2,10 +2,10 @@

import express from 'express'
import bodyParser from 'body-parser'
import bunyanMiddleware from 'bunyan-middleware'
import AsyncEventEmitter from 'events-async'

import logger from './lib/logger.js'
import requestLogger from './lib/request-logger.js'
import authMiddleware from './lib/auth-middleware.js'
import githubEvents from './lib/github-events.js'
import jenkinsEvents from './lib/jenkins-events.js'
Expand All @@ -23,13 +23,8 @@ if (logsDir) {
app.use('/logs', authMiddleware, express.static(logsDir))
}

// bunyanMiddleware gives us request id's and unique loggers per incoming request,
// for safety reasons we don't want to include the webhook GitHub secret in logs
app.use(bunyanMiddleware({
logger,
level: 'trace',
obscureHeaders: ['x-hub-signature']
}))
// Give each request a unique logger and avoid logging the GitHub webhook secret.
app.use(requestLogger(logger))

githubEvents(app, events)
jenkinsEvents(app, events)
Expand Down
44 changes: 44 additions & 0 deletions lib/request-logger.js
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,44 @@
import { randomUUID } from 'node:crypto'

function obscureHeaders (headers) {
return Object.fromEntries(Object.entries(headers).map(([name, value]) => [
name,
name === 'x-hub-signature' ? null : value
]))
}

function requestSerializer (req) {
return {
method: req.method,
url: req.originalUrl || req.url,
headers: obscureHeaders(req.headers),
query: req.query,
remoteAddress: req.socket.remoteAddress,
remotePort: req.socket.remotePort
}
}

export default function requestLogger (logger) {
const parentLogger = logger.child({
serializers: {
req: requestSerializer,
res: logger.constructor.stdSerializers.res
}
})

return function logRequest (req, res, next) {
const requestId = req.reqId || req.headers['x-request-id'] || randomUUID()
const start = process.hrtime.bigint()

req.log = res.log = parentLogger.child({ req_id: requestId }, true)
req.reqId = res.reqId = requestId
res.setHeader('X-Request-Id', requestId)

res.on('finish', () => {
const duration = Number(process.hrtime.bigint() - start) / 1e6
req.log.trace({ req, res, duration }, 'request finish')
})

next()
}
}
Loading

Back | FazBrowse Home | New Git URL