Iain Sproat
84cb74e8b3
* each log line is a json object * structured logging allows logs to be ingested by machines and the logs to be indexed and queried addresses #1105 * structured logging allows arbitrary properties to be appended to each log line, and ingestion of logs to remain robust * Structured logging provided by `pino` library * Add `express-pino-logger` dependency * Remove `debug`, `morgan`, and `morgan-debug` and replace with structured logging * `console.log` & `console.error` replaced with structured logging in backend * Remove `DEBUG` environment variable and replace with `LOG_LEVEL` - Note that there is a test which reads from a logged line on `stdout`. This is not robust, it would be better to use the childProcess.pid to look up the port number. * Log errors at points we explicitly send error to Sentry * Amend indentation of a couple of log messages to align indentation with others
70 lines
2.1 KiB
JavaScript
70 lines
2.1 KiB
JavaScript
/* istanbul ignore file */
|
|
// const { logger } = require('@/logging/logging')
|
|
const Sentry = require('@sentry/node')
|
|
const { ApolloError } = require('apollo-server-express')
|
|
const prometheusClient = require('prom-client')
|
|
|
|
const metricCallCount = new prometheusClient.Counter({
|
|
name: 'speckle_server_apollo_calls',
|
|
help: 'Number of calls',
|
|
labelNames: ['actionName']
|
|
})
|
|
|
|
/** @type {import('apollo-server-core').PluginDefinition} */
|
|
module.exports = {
|
|
// eslint-disable-next-line no-unused-vars
|
|
requestDidStart(ctx) {
|
|
return {
|
|
didResolveOperation(ctx) {
|
|
if (!ctx.operation) {
|
|
return
|
|
}
|
|
|
|
const transaction = Sentry.startTransaction({
|
|
op: `GQL ${ctx.operation.operation} ${ctx.operation.selectionSet.selections[0].name.value}`,
|
|
name: `GQL ${ctx.operation.selectionSet.selections[0].name.value}`
|
|
})
|
|
|
|
try {
|
|
const actionName = `${ctx.operation.operation} ${ctx.operation.selectionSet.selections[0].name.value}`
|
|
metricCallCount.labels(actionName).inc()
|
|
// logger.debug(actionName)
|
|
} catch (e) {
|
|
Sentry.captureException(e)
|
|
}
|
|
|
|
Sentry.configureScope((scope) => scope.setSpan(transaction))
|
|
ctx.request.transaction = transaction
|
|
},
|
|
didEncounterErrors(ctx) {
|
|
if (!ctx.operation) return
|
|
|
|
for (const err of ctx.errors) {
|
|
if (err instanceof ApolloError) {
|
|
continue
|
|
}
|
|
Sentry.withScope((scope) => {
|
|
scope.setTag('kind', ctx.operation.operation)
|
|
scope.setExtra('query', ctx.request.query)
|
|
scope.setExtra('variables', ctx.request.variables)
|
|
if (err.path) {
|
|
// We can also add the path as breadcrumb
|
|
scope.addBreadcrumb({
|
|
category: 'query-path',
|
|
message: err.path.join(' > '),
|
|
level: Sentry.Severity.Debug
|
|
})
|
|
}
|
|
Sentry.captureException(err)
|
|
})
|
|
}
|
|
},
|
|
willSendResponse(ctx) {
|
|
if (ctx.request.transaction) {
|
|
ctx.request.transaction.finish()
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|