Add additional Open Telemetry attributes (and adhere to canonical attribute naming) (#9700)

Co-authored-by: Daniel Cousens <[email protected]>

Author: dcousens

examples/logging-opentelemetry/keystone.ts

@@ -28,10 +28,13 @@ export default config<TypeInfo>({
 
             return {
               async willSendResponse({ operation, request }) {
-                span.setAttribute('type', operation?.operation || 'unknown')
-                span.setAttribute('name', request.operationName || 'unknown')
-                span.setAttribute('hash', request.query ? sha256(request.query) : 'empty')
-                // span.setAttribute('query', request.query?.replaceAll(/\s+/g, ' ') || '') // WARNING: verbose
+                span.setAttribute('graphql.operation.name', operation?.operation || 'unknown')
+                span.setAttribute('graphql.operation.type', request.operationName || 'unknown')
+                span.setAttribute(
+                  'graphql.document.sha256',
+                  request.query ? sha256(request.query) : 'empty'
+                )
+                // span.setAttribute('graphql.document', request.query?.replaceAll(/\s+/g, ' ') || '') // WARNING: verbose
                 span.end()
               },
             }
@@ -47,9 +50,9 @@ export default config<TypeInfo>({
           'http request',
           {
             attributes: {
-              method: req.method,
-              path: req.path,
-              userAgent: req.headers['user-agent'] || '',
+              'http.request.method': req.method,
+              'http.request.path': req.path,
+              'user_agent.original': req.headers['user-agent'] || '',
             },
           },
           span => {

packages/core/src/lib/core/mutations/index.ts

@@ -79,7 +79,7 @@ async function createSingle__(
 ) {
   return await withSpan(
     `create ${list.graphql.names.outputTypeNameLower}`,
-    async () => {
+    async span => {
       // throw an accessDeniedError if not allowed
       await enforceListLevelAccessControl(context, 'create', list, inputData, undefined)
       await enforceFieldLevelAccessControl(context, 'create', list, inputData, undefined)
@@ -94,13 +94,17 @@ async function createSingle__(
       await beforeOperation()
 
       // operation
-      const item = await context.prisma[list.listKey].create({
+      const result = await context.prisma[list.listKey].create({
         data: list.isSingleton ? { ...data, id: 1 } : data,
       })
 
-      return { item, afterOperation }
+      span.setAttribute('keystone.result.id', result?.id ?? '')
+      return { item: result, afterOperation }
     },
-    { 'keystone.list': list.listKey, 'keystone.operation': 'create' }
+    {
+      'keystone.list': list.listKey,
+      'keystone.operation': 'create',
+    }
   )
 }
 
@@ -143,7 +147,7 @@ async function updateSingle__(
 ) {
   return await withSpan(
     `update ${list.graphql.names.outputTypeNameLower}`,
-    async () => {
+    async span => {
       // validate and resolve the input filter
       const uniqueWhere = await resolveUniqueWhereInput(where, list, context)
 
@@ -164,15 +168,16 @@ async function updateSingle__(
       await beforeOperation()
 
       // operation
-      const updatedItem = await context.prisma[list.listKey].update({
+      const result = await context.prisma[list.listKey].update({
         where: { id: item.id },
         data,
       })
+      span.setAttribute('keystone.result.id', result?.id ?? '')
 
       // after operation
-      await afterOperation(updatedItem)
+      await afterOperation(result)
 
-      return updatedItem
+      return result
     },
     { 'keystone.list': list.listKey, 'keystone.operation': 'update' }
   )
@@ -186,7 +191,7 @@ async function deleteSingle__(
 ) {
   return await withSpan(
     `delete ${list.graphql.names.outputTypeNameLower}`,
-    async () => {
+    async span => {
       // validate and resolve the input filter
       const uniqueWhere = await resolveUniqueWhereInput(where, list, context)
 
@@ -214,6 +219,7 @@ async function deleteSingle__(
 
       // operation
       const result = await context.prisma[list.listKey].delete({ where: { id: item.id } })
+      span.setAttribute('keystone.result.id', result?.id ?? '')
 
       // after operation
       await runSideEffectOnlyHook(list, 'afterOperation', {
@@ -236,7 +242,7 @@ async function actionSingle__(
 ) {
   return await withSpan(
     action.otel,
-    async () => {
+    async span => {
       // no before operation hook for actions
 
       // operation
@@ -248,6 +254,7 @@ async function actionSingle__(
         },
         context
       )
+      span.setAttribute('keystone.result.id', (result?.id as string) ?? '')
 
       // no after operation hook for actions
       return result

packages/core/src/lib/utils.ts

@@ -1,13 +1,20 @@
-/**
- * Turns a passed in string into a human readable label
- * @param {String} str The string to convert.
- * @returns The new string
- */
-export function humanize(str: string, capitalize: boolean = true) {
-  str = str.replace(/[^a-zA-Z0-9]+/g, ' ').replace(/([a-z0-9])([A-Z]+)/g, '$1 $2')
+// WARNING: this is an opinionated subject, with too many ways to do this
+//   we went with a subset that we are happy with
+//   see tests2/utils.test.ts for examples
+export function humanize(s: string, capitalize: boolean = true) {
+  // drop non-alphanumeric
+  s = s.replace(/[^a-zA-Z0-9]+/g, ' ')
 
-  if (!capitalize) return str
-  return str
+  // insert spaces before camels of length > 1
+  for (let i = 0; i < 24; i++) {
+    // not unbounded, shouldnt happen
+    const next = s.replace(/([a-z0-9])([A-Z][A-Za-z0-9])/, '$1 $2')
+    if (next === s) break
+    s = next
+  }
+
+  if (!capitalize) return s
+  return s
     .split(' ')
     .map(x => x.charAt(0).toUpperCase() + x.slice(1))
     .join(' ')

tests2/utils.test.ts

@@ -11,12 +11,19 @@ describe('utils', () => {
     assert.equal(humanize('kebab-case'), 'Kebab Case')
     assert.equal(humanize('multiple words here'), 'Multiple Words Here')
     assert.equal(humanize('Multiple Words Here'), 'Multiple Words Here')
-    assert.equal(humanize('Thing42WithOther43'), 'Thing42 With Other43')
-    assert.equal(humanize('Thing42_withOther43', false), 'Thing42 with Other43')
     assert.equal(humanize('foo'), 'Foo')
     assert.equal(humanize('Foo'), 'Foo')
     assert.equal(humanize('fooBar'), 'Foo Bar')
     assert.equal(humanize('FooBar'), 'Foo Bar')
     assert.equal(humanize('Foo Bar'), 'Foo Bar')
+    assert.equal(humanize('Foo11WithBar11'), 'Foo11 With Bar11')
+    assert.equal(humanize('Foo1A_WithBar11'), 'Foo1A With Bar11')
+    assert.equal(humanize('Foo1AA_WithBar11'), 'Foo1 AA With Bar11')
+    assert.equal(humanize('Foo11_WithBar11'), 'Foo11 With Bar11')
+    assert.equal(humanize('Foo11_WithBar11A'), 'Foo11 With Bar11A')
+    assert.equal(humanize('Foo11_WithBar11AA'), 'Foo11 With Bar11 AA')
+    assert.equal(humanize('Foo11_withBar11', false), 'Foo11 with Bar11')
+    assert.equal(humanize('FOO1A_BAR11'), 'FOO1A BAR11')
+    assert.equal(humanize('FOO1A1_BAR11'), 'FOO1 A1 BAR11')
   })
 })