Node.js 在Firebase函数中将自定义信息添加到Stackdriver错误日志

我正在使用Firebase函数和Stackdriver

Stackdriver与Firebase功能集成得非常好，因此我可以使用

控制台.error

命令轻松记录错误。 但是，我不仅要记录错误对象，还要记录查询参数。 如果我可以在同一个日志行中记录错误对象和查询参数，那么它们就可以很容易地分组和导出

有没有一种简单的方法可以将信息添加到Stackdriver上的错误日志中，如下所示

控制台错误（新错误（“无效查询”），请求查询） 谢谢

---编辑

我尝试了以下代码。这可以向日志条目添加查询参数，但不幸的是，Stackdriver将所有错误放在一个组中，如下面的屏幕截图所示。即使每个错误的类型不同，并且发生在不同的文件中，所有错误都被分组在一起。我希望Stackdriver错误报告能像往常一样按错误类型或堆栈跟踪对错误进行分组

index.js

const functions = require('firebase-functions')
const raiseReferenceError = require('./raiseReferenceError')
const raiseSyntaxError = require('./raiseSyntaxError')
const raiseTypeError = require('./raiseTypeError')

exports.stackdriverErrorLogging = functions.https.onRequest((req, res) => {
  try {
    switch (Math.round(Math.random() * 2)) {
      case 0:
        raiseReferenceError()
        break

      case 1:
        raiseSyntaxError()
        break

      default:
        raiseTypeError()
        break
    }
  } catch (error) {
    console.error({
      error: error,
      method: req.method,
      query: req.query
    })
  }

  res.send('Hello from Firebase!')
})

raiseReferenceError.js

module.exports = () => {
  console.log(foo)
}

raiseSyntaxError.js

module.exports = () => {
  eval(',')
}

raiseTypeError.js

module.exports = () => {
  const foo = null
  foo()
}

10次运行结果的屏幕截图：

Stackdriver错误报告错误摘要页面 Stackdriver错误报告错误详细信息页面

---

当我处理错误时，我通常使用一个对象结构来提供我需要的所有信息。大概是这样的：

const query=req.query；
const myErrorObject=新错误（“某些错误”）；
控制台错误({
方法：req.method，
查询：req.query，
错误：myErrorObject
});

---

希望这对您有所帮助

[update]-我看到您添加了更多信息，表明您正在尝试使用错误报告，而不仅仅是日志记录。您仍然可以使用记录库

我建议使用Stackdriver日志记录，它应该允许您编写结构化日志。这在Firebase中有描述。

自我回答：

我试图找到简单的方法，但没有。所以我决定摆脱我的懒惰，学习如何使用尤里·格林斯泰恩提到的@googlecloud/日志

我找到了很多例子，但没有一个足以说明这个问题。 最后，我构建了一个函数，该函数可以轻松地报告带有附加信息的错误

要点如下：

要将GCP控制台上的自定义错误日志显示为正常错误日志，它需要包括严重性、区域、执行id、跟踪id。如果缺少它们，GCP控制台不会在默认筛选器上显示它们。也不能按执行ID标记分组

应该从http请求中提取执行id和跟踪id。（我不知道如何在另一个触发器类型函数中使用它们。）

这需要时间，但最后，Stackdriver错误报告会识别并分组每个错误类型，并成功地在错误日志的JSON负载中包含自定义信息。这就是我想要的

现在我终于可以回去工作了

这是一个主代码

// https://firebase.google.com/docs/functions/reporting-errors#manually_reporting_errors
const { Logging } = require('@google-cloud/logging')

// Instantiates a client
const logging = new Logging()

module.exports = function reportError (err, context = {}, req = undefined) {
  // Use Stackdriver only on production environment.
  if (process.env.NODE_ENV !== 'production') {
    return new Promise((resolve, reject) => {
      console.error(err, context)
      return resolve()
    })
  }

  const log = logging.log('cloudfunctions.googleapis.com%2Fcloud-functions')

  // https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/MonitoredResource
  const metadata = {
    severity: 'ERROR',
    resource: {
      type: 'cloud_function',
      labels: {
        function_name: process.env.FUNCTION_NAME,
        project: process.env.GCLOUD_PROJECT,
        region: process.env.FUNCTION_REGION
      }
    }
  }

  // Extract execution_id, trace from http request
  // https://stackoverflow.com/a/55642248/7908771
  if (req) {
    const traceId = req.get('x-cloud-trace-context').split('/')[0]
    Object.assign(metadata, {
      trace: `projects/${process.env.GCLOUD_PROJECT}/traces/${traceId}`,
      labels: {
        execution_id: req.get('function-execution-id')
      }
    })
  }

  // https://cloud.google.com/error-reporting/reference/rest/v1beta1/ErrorEvent
  const errorEvent = {
    message: err.stack,
    serviceContext: {
      service: process.env.FUNCTION_NAME,
      resourceType: 'cloud_function'
    },
    context: context
  }

  // Write the error log entry
  return new Promise((resolve, reject) => {
    log.write(log.entry(metadata, errorEvent), (error) => {
      if (error) {
        return reject(error)
      }
      return resolve()
    })
  })
}

10次运行结果的屏幕截图：

Stackdriver错误报告错误摘要页面。

Stackdriver日志记录显示自定义信息错误。

---

谢谢您的建议。我试过了，但不幸的是Stackdriver没有按单个错误对日志进行分组。所有错误都归为一组。我将把我的努力添加到这个问题上。无论如何，谢谢你提供的有用信息。谢谢你告诉我官方信息。然而，理解如何使用自定义日志需要时间，所以我觉得很麻烦。因此，我正在寻找一种简单的方法。我也尝试了“”，但找不到此案例的好例子，也无法很好地使用它。这就是我问这个问题的原因。除了你的建议可能没有别的办法了。很高兴你对这个问题感兴趣。谢谢。谢谢你再次告诉我！可能没有简单的办法。我将尝试它。我遵循了这个助手函数，但仍然无法将我的自定义日志放入stackdriver。当我触发显式抛出错误的API时，会记录调试日志，但没有自定义详细信息。日志中也没有jsonPayload这样的密钥。也通过google日志文档进行了检查，但我的自定义日志仍然没有被记录