登录
首页 >  文章 >  前端

如何使用 New Relic 监控 App Router Nextjs 应用程序

来源:dev.to

时间:2024-07-24 11:04:12 395浏览 收藏

在文章实战开发的过程中,我们经常会遇到一些这样那样的问题,然后要卡好半天,等问题解决了才发现原来一些细节知识点还是没有掌握好。今天golang学习网就整理分享《如何使用 New Relic 监控 App Router Nextjs 应用程序》,聊聊,希望可以帮助到正在努力赚钱的你。

next.js 是一个功能强大的 javascript 框架,可为开发和运行时提供优化的速度和性能。随着 next.js 13 的发布,app router 已成为在 next.js 应用程序中处理路由的推荐方式。这款新路由器利用 react 的最新功能,例如服务器组件和流媒体,提供更现代、更高效的方法来构建 web 应用程序。

在这篇博文中,您将了解如何使用新的 app router 设置服务器端的应用程序性能监控和前端的浏览器监控,从而为您的 next.js 应用程序提供全栈可观察性。首先,您需要一个 new relic 帐户和许可证密钥,两者都是免费提供的。

安装代理和中间件

在 next.js 项目中运行以下命令来安装 new relic node.js apm 代理和 next.js 的 new relic 中间件。

npm install newrelic @newrelic/next

命令成功完成后,您将看到 package.json 文件中包含的依赖项。

 "dependencies": {
   "@newrelic/next": "^0.10.0",
   "newrelic": "^11.23.0",
   "next": "14.2.5",
   "react": "^18",
   "react-dom": "^18"
 },

@newrelic/next 包为 new relic 监控 next.js 应用程序提供官方工具。它专注于页面和服务器请求的服务器端渲染、中间件和事务命名,确保服务器端活动的全面可观察性。

此软件包单独安装,但与 new relic node.js 代理无缝集成,提供代理的所有功能,以增强 next.js 应用程序中的性能监控和错误跟踪。

虽然它不涵盖客户端操作,但您可以注入 new relic 浏览器代理以进行客户端遥测(本博客文章后面会详细介绍)。

配置

要使用 new relic 有效地检测 next.js 应用程序,您需要修改 next.config.js 文件。此配置确保 new relic 支持的模块不会被 webpack 破坏,并且它将这些模块外部化。

使用以下内容在项目根目录中创建或更新 next.config.js 文件:

'use strict'

const nrexternals = require('@newrelic/next/load-externals')

module.exports = {
  experimental: {
    servercomponentsexternalpackages: ['newrelic']
  },
  webpack: (config) => {
    nrexternals(config)
    return config
  }
}

接下来,通过修改 package.json 文件的脚本部分来修改您的开发并启动 npm 脚本。允许您的应用程序使用 node 的 -r 选项运行,这将预加载 @newrelic/next 中间件。

"scripts": {
  "dev": "node_options='-r @newrelic/next' next",
  "build": "next build",
  "start": "node_options='-r @newrelic/next' next start",
  "lint": "next lint"
}

在运行应用程序之前,请将 newrelic.js amp 代理配置文件添加到项目的根目录中。有关更多信息,请参阅 next.js 应用程序的示例配置文件。

此外,请在 .env 文件中使用 new_relic_app_name 和 new_relic_license_key,如应用程序的示例 .env 文件中所示。

在 new relic 中查看性能数据

运行您的应用程序并转到 new relic 中的 apm 页面。您将看到应用程序的服务器端数据流入 new relic。

如何使用 New Relic 监控 App Router Nextjs 应用程序

前端可观察性

要在使用 app router 时注入浏览器代理,我们将编辑 app/layout.js(.ts) 文件。

import script from 'next/script'
import link from 'next/link'
import newrelic from 'newrelic'
import './style.css'

export default async function rootlayout({ children }) {
  if (newrelic.agent.collector.isconnected() === false) {
    await new promise((resolve) => {
      newrelic.agent.on("connected", resolve)
    })
  }

  const browsertimingheader = newrelic.getbrowsertimingheader({
    hastoremovescriptwrapper: true,
    allowtransactionlessinjection: true,
  })

  return (