newrelic/lib/llm-events/error-message.js

New Relic agent

/*
 * Copyright 2023 New Relic Corporation. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

'use strict'

/**
 * Represents an error object, to be tracked via `agent.errors`, that is the
 * result of some error returned from LLM operations.
 */
module.exports = class LlmErrorMessage {
  /**
   * @param {object} params Constructor parameters
   * @param {object} params.response Instance of an incoming message.
   * @param {object} params.cause An instance of the LLM error object.
   * @param {LlmChatCompletionSummary} [params.summary] Details about the
   * conversation if it was a chat completion conversation.
   * @param {LlmEmbedding} [params.embedding] Details about the conversation
   * if it was an embedding conversation.
   * @param {LlmVectorStoreSearch} [params.vectorsearch] Details about the vector
   * search if it was a vector search event.
   * @param {LlmTool} [params.tool] Details about the tool event if it was a tool event.
   * @param {boolean} [params.useNameAsCode] defaults to false, only Bedrock sets it to true so far
   */
  constructor({ response, cause, summary = {}, embedding = {}, vectorsearch = {}, tool = {}, useNameAsCode = false } = {}) {
    this['http.statusCode'] = response?.statusCode ?? response?.status ?? cause?.status
    this['error.message'] = cause?.message
    this['error.code'] = response?.code ?? cause?.error?.code
    if (useNameAsCode) {
      this['error.code'] = cause?.name
    }
    this['error.param'] = response?.param ?? cause?.error?.param
    this.completion_id = summary?.id
    this.embedding_id = embedding?.id
    this.vector_store_id = vectorsearch?.id
    this.tool_id = tool?.id

    if (embedding?.vendor === 'gemini' || summary?.vendor === 'gemini') {
      this._handleGemini(cause)
    }
  }

  get [Symbol.toStringTag]() {
    return 'LlmErrorMessage'
  }

  /**
   * For `@google/genai` only, `cause` does not have the `error` or `status` fields,
   * but it does have `message` with the info we need. So, we need to parse
   * the relevant fields from cause.message to get `status` and `error`.
   * @param {object} cause error object
   */
  _handleGemini(cause) {
    if (cause?.message) {
      try {
        const jsonStartIndex = cause.message.indexOf('{')
        const jsonString = cause.message.substring(jsonStartIndex)
        const parsedError = JSON.parse(jsonString)?.error

        this['http.statusCode'] = parsedError?.code
        this['error.code'] = parsedError?.code
      } catch { }
    }
  }
}