huanld/speckle-server
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

feat(server): add db metrics to GQL finished log entries (#3826)

Browse Source 
* feat(server): add db metrics to GQL finished log entries

* logging for query errored as well
This commit is contained in:
Kristaps Fabians Geikins
2025-01-15 13:40:00 +02:00
committed by GitHub
parent 04c577529b
commit cf7f2593cb
3 changed files with 59 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/server/modules/core/graph/plugins/logging.ts
+24 -7
View File
@@ -6,6 +6,7 @@ import { FieldNode, SelectionNode } from 'graphql'
import { ApolloServerPlugin } from '@apollo/server'
import { GraphQLContext } from '@/modules/shared/helpers/typeHelper'
import { shouldLogAsInfoLevel } from '@/logging/graphqlError'
import { getRequestContext } from '@/logging/requestContext'
type ApolloLoggingPluginTransaction = {
start: number
@@ -62,7 +63,9 @@ export const loggingPluginFactory: (deps: {
const auth = ctx.contextValue
const userId = auth?.userId
const actionName = `${ctx.operation.operation} ${firstSelectedField.name.value}`
const operationName = ctx.operationName || ctx.operation?.name?.value
const actionName =
operationName || `${ctx.operation.operation} ${firstSelectedField.name.value}`
const op = `GQL ${actionName}`
const name = `GQL ${firstSelectedField.name.value}`
const kind = ctx.operation.operation
@@ -73,8 +76,8 @@ export const loggingPluginFactory: (deps: {
graphql_operation_kind: kind,
graphql_query: query,
graphql_variables: redactSensitiveVariables(variables),
graphql_operation_value: op,
graphql_operation_name: name,
graphql_operation_name: actionName,
graphql_operation_title: op,
userId
})
@@ -109,6 +112,13 @@ export const loggingPluginFactory: (deps: {
const query = ctx.request.query
const variables = redactSensitiveVariables(ctx.request.variables)
const reqCtx = getRequestContext()
if (reqCtx) {
logger = logger.child({
dbMetrics: reqCtx.dbMetrics
})
}
if (err.path) {
logger = logger.child({
'query-path': err.path.join(' > '),
@@ -120,28 +130,35 @@ export const loggingPluginFactory: (deps: {
if (shouldLogAsInfoLevel(err)) {
logger.info(
{ err },
'{graphql_operation_value} failed after {apollo_query_duration_ms} ms'
'{graphql_operation_title} failed after {apollo_query_duration_ms} ms'
)
} else {
logger.error(
err,
'{graphql_operation_value} failed after {apollo_query_duration_ms} ms'
'{graphql_operation_title} failed after {apollo_query_duration_ms} ms'
)
}
}
},
willSendResponse: async (ctx) => {
const logger = ctx.contextValue.log || graphqlLogger
let logger = ctx.contextValue.log || graphqlLogger
if (ctx.request.transaction) {
ctx.request.transaction.finish()
}
const reqCtx = getRequestContext()
if (reqCtx) {
logger = logger.child({
dbMetrics: reqCtx.dbMetrics
})
}
logger.info(
{
apollo_query_duration_ms: Date.now() - apolloRequestStart
},
'{graphql_operation_value} finished after {apollo_query_duration_ms} ms'
'{graphql_operation_title} finished after {apollo_query_duration_ms} ms'
)
}
}