
Product
Introducing Scala and Kotlin Support in Socket
Socket now supports Scala and Kotlin, bringing AI-powered threat detection to JVM projects with easy manifest generation and fast, accurate scans.
gcp-structured-logger
Advanced tools
Outputs structured logs that are formatted in GCP logging.
Most basic usage it to create a Logging
object and use the logger
property.
const { Logging, LogSeverity } = require('gcp-structured-logger')
const logging = new Logging({
projectId: '<project-id>',
logName: '<label for logName>', // Useful for filtering in Log viewer
serviceContext: {
service: '<service name>', // Name that appears in Error Reporter
version: '<version>', // Optional version
},
extraLabels: { // Optional extra labels useful for more filtering
},
requestUserExtractor: () => {} // See below
})
logging.logger.info('Some log message', {
extra: 'data'
}, ['Array'])
To report errors to GCP Error Reporting the reportError
method on a logger can be used.
An optional severity
can also be passed in, or it is picked up from the provided error. If no severity
is passed in ERROR
is used.
const err = new Error('An error occurred')
logging.logger.reportError(err)
// With severity
logging.logger.reportError(err, LogSeverity.ALERT)
These get logged out to GCP Error reporting.
// Listen out for uncaughtException (uses uncaughtExceptionMonitor in v12.17+) and unhandled Promise rejections
logging.attachToProcess(logging.logger)
// To remove from the process
const detachLogger = logging.attachToProcess(logging.logger)
detachLogger()
Can be use with express
as a logging middleware and error handler.
If the err
has a statusCode
or status
property that is greater or equal to 500, then the severity of the err is set to WARNING
.
const express = require('express')
const app = express()
// App setup - set port, trust proxy, etc
// Add ability to use req.log in later middleware
app.use(logger.makeLoggingMiddleware())
app.use((req, res, next) => {
req.log.debug('Incoming request')
next()
})
// Add routes
// And a final error handler if needed
app.use((req, res, next) => next({ status: 404, message: 'Not found' }))
// Report next(err)
app.use(logger.makeErrorMiddleware())
Can be use Next.js in the middleware file, it should be added as the first middleware (to allow you to use req.log
in future middlewares).
This then adds the .log
property onto all requests.
import { NextResponse } from 'next/server'
import type { NextRequest } from 'next/server'
export function middleware(request: NextRequest) {
logger.nextJSMiddleware(request);
// Continue or do usual middleware handling
return NextResponse.next();
}
You can also pass in a requestUserExtractor
function when creating a Logging
instance for setting the user of the error.
This is useful if you've attached the logged in user, etc. to the request or the headers contains some user info.
If requestUserExtractor
returns no value (or is not provided), no user will be set on the reported error.
const logging = new Logging({
projectId: '<project-id>',
logName: '<label for logName>',
serviceContext: {
service: '<service name>',
},
requestUserExtractor: req => {
// Parameter is the request that log.reportError was called on
return req.get('user-id')
},
})
FAQs
Structured logger for GCP logging
The npm package gcp-structured-logger receives a total of 89 weekly downloads. As such, gcp-structured-logger popularity was classified as not popular.
We found that gcp-structured-logger demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports Scala and Kotlin, bringing AI-powered threat detection to JVM projects with easy manifest generation and fast, accurate scans.
Application Security
/Security News
Socket CEO Feross Aboukhadijeh and a16z partner Joel de la Garza discuss vibe coding, AI-driven software development, and how the rise of LLMs, despite their risks, still points toward a more secure and innovative future.
Research
/Security News
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.