refactor LangGraph LlmAgent event, remove old base

Author: amychisholm03

lib/llm-events/error-message.js

@@ -43,7 +43,7 @@ module.exports = class LlmErrorMessage {
     this.agent_id = aiAgent?.id
 
     if (embedding?.vendor === 'gemini' || summary?.vendor === 'gemini') {
-      this._handleGemini(cause)
+      this.#handleGemini(cause)
     }
   }
 
@@ -57,7 +57,7 @@ module.exports = class LlmErrorMessage {
    * the relevant fields from cause.message to get `status` and `error`.
    * @param {object} cause error object
    */
-  _handleGemini(cause) {
+  #handleGemini(cause) {
     if (cause?.message) {
       try {
         const jsonStartIndex = cause.message.indexOf('{')

lib/llm-events/event.js

@@ -3,39 +3,23 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-const BaseLlmEvent = require('../event')
-const { makeId } = require('../../util/hashes')
+const LlmEvent = require('../event-base')
 
 /**
- * @typedef {object} LangGraphAgentEventParams
- * @property {Agent} agent The New Relic agent instance.
- * @property {string} name The name of the LangGraph agent, defaults to 'agent'.
- * @property {object} segment The associated NR segment.
- * @property {object} transaction The associated NR transaction.
- * @property {boolean} error A boolean flag to indicate if an error occurred.
+ * Encapsulates a `@langchain/langgraph` LlmAgent event.
  */
-
-module.exports = class LangGraphAgentEvent extends BaseLlmEvent {
-  id = makeId(36)
-  span_id
-  trace_id
-  ingest_source = 'Node'
-  vendor = 'langgraph'
-
+module.exports = class LangGraphLlmAgent extends LlmEvent {
   /**
-   * @param {LangGraphAgentEventParams} params should contain all necessary and optional LangGraph data
+   *
+   * @param {object} params constructor parameters
+   * @param {Agent} params.agent New Relic agent instance
+   * @param {object} params.segment Current segment
+   * @param {object} params.transaction Current and active transaction
+   * @param {string} params.aiAgentName Name of the AI agent which can typically be captured through framework context
+   * @param {boolean} [params.error] Set to `true` if an error occurred during creation call, omitted if no error occurred
    */
-  constructor(params) {
-    super(params)
-    const { agent, segment, transaction, error = false, name = 'agent' } = params
-
-    this.name = name
-    this.span_id = segment.id
-    this.trace_id = transaction.traceId
-    this.error = error
-
-    // Setting `metadata` as the NR agent instance will allow `BaseLlmEvent`
-    // to extract the relevant `llm.<user_defined_metadata>`.
-    this.metadata = agent
+  constructor({ agent, segment, transaction, aiAgentName, error }) {
+    super({ agent, segment, transaction, vendor: 'langgraph', error })
+    this.name = aiAgentName ?? 'agent'
   }
 }

lib/llm-events/langgraph/agent.js

@@ -5,7 +5,7 @@
 
 const AiMonitoringSubscriber = require('../ai-monitoring/base')
 const LlmErrorMessage = require('#agentlib/llm-events/error-message.js')
-const LangGraphAgentEvent = require('#agentlib/llm-events/langgraph/agent.js')
+const LlmAgent = require('#agentlib/llm-events/langgraph/agent.js')
 const { AI: { LANGGRAPH, STREAMING_DISABLED } } = require('#agentlib/metrics/names.js')
 
 class LangGraphStreamSubscriber extends AiMonitoringSubscriber {
@@ -104,9 +104,9 @@ class LangGraphStreamSubscriber extends AiMonitoringSubscriber {
   recordAiAgentEvent({ aiAgentName, transaction, segment, error }) {
     const { agent } = this
     segment.end()
-    const agentEvent = new LangGraphAgentEvent({
+    const agentEvent = new LlmAgent({
       agent,
-      name: aiAgentName,
+      aiAgentName,
       transaction,
       segment,
       error: !!error

lib/subscribers/langgraph/graph-stream.js

@@ -7,7 +7,7 @@
 
 const test = require('node:test')
 const assert = require('node:assert')
-const LangGraphAgentEvent = require('../../../../lib/llm-events/langgraph/agent')
+const LlmAgent = require('#agentlib/llm-events/langgraph/agent.js')
 
 test.beforeEach((ctx) => {
   ctx.nr = {}
@@ -43,29 +43,28 @@ test.beforeEach((ctx) => {
     id: 'segment-1'
   }
 
-  ctx.nr.name = 'test-agent'
+  ctx.nr.aiAgentName = 'test-agent'
 })
 
 test('constructs default instance', async (t) => {
-  const event = new LangGraphAgentEvent(t.nr)
+  const event = new LlmAgent(t.nr)
   assert.equal(event.name, 'test-agent')
-  assert.match(event.id, /[a-z0-9-]{36}/)
+  assert.match(event.id, /[a-z0-9-]{32}/)
   assert.equal(event.span_id, 'segment-1')
   assert.equal(event.trace_id, 'trace-1')
   assert.equal(event['llm.foo'], 'bar')
   assert.equal(event.ingest_source, 'Node')
   assert.equal(event.vendor, 'langgraph')
-  assert.equal(event.error, false)
 })
 
 test('constructs instance with error', async (t) => {
   t.nr.error = true
-  const event = new LangGraphAgentEvent(t.nr)
+  const event = new LlmAgent(t.nr)
   assert.equal(event.error, true)
 })
 
 test('uses default name when not provided', async (t) => {
-  delete t.nr.name
-  const event = new LangGraphAgentEvent(t.nr)
+  delete t.nr.aiAgentName
+  const event = new LlmAgent(t.nr)
   assert.equal(event.name, 'agent')
 })

test/unit/llm-events/langgraph/agent.test.js

@@ -115,7 +115,7 @@ test('should create LlmAgent event for CompiledStateGraph.invoke', async (t) =>
     const [segment] = tx.trace.getChildren(tx.trace.root.id)
 
     match(agentEvent, {
-      id: /[a-f0-9]{36}/,
+      id: /[a-f0-9]{32}/,
       name: 'LangGraphReactAgent',
       span_id: segment.id,
       trace_id: tx.traceId,

test/versioned/langgraph/graph-invoke.test.js

@@ -162,7 +162,7 @@ test('should create LlmAgent event for CompiledStateGraph.stream', async (t) =>
     const [segment] = tx.trace.getChildren(tx.trace.root.id)
 
     match(agentEvent, {
-      id: /[a-f0-9]{36}/,
+      id: /[a-f0-9]{32}/,
       name: 'LangGraphReactAgent',
       span_id: segment.id,
       trace_id: tx.traceId,
@@ -239,7 +239,7 @@ test('should have LlmChatCompletion events from LangChain and OpenAI instrumenta
   })
 })
 
-test('should have LlmTool events from LangChain instrumentation', async (t) => {
+test('should have LlmTool event from LangChain instrumentation', async (t) => {
   const { agent, langgraphAgentWithTools } = t.nr
 
   await helper.runInTransaction(agent, async (tx) => {
@@ -260,6 +260,8 @@ test('should have LlmTool events from LangChain instrumentation', async (t) => {
     assert.equal(toolEvent.name, 'calculator', 'tool name should be calculator')
     assert.equal(toolEvent.vendor, 'langchain', 'vendor should be langchain')
     assert.equal(toolEvent.output, '4', 'tool output should be 4')
+    assert.equal(toolEvent.run_id, 'call_calc123')
+    assert.equal(toolEvent.agent_name, 'LangGraphReactAgent')
 
     // Should have 2 LlmChatCompletionMessages with role='tool'
     const chatEvents = events.filter((e) => e[0].type === 'LlmChatCompletionMessage' && e[1].role === 'tool')