Logrocket · Nuxt 模块

nuxt-logrocket

用于 Nuxt.js 的 LogRocket 模块

特性

Nuxt 3 & Nuxt Bridge
支持 Pinia 集成
能够在开发模式下运行

安装

使用 yarn 或 npm 将 nuxt-logrocket 依赖项添加到你的项目中

yarn add nuxt-logrocket

或者

npm install nuxt-logrocket --save

将 nuxt-logrocket 添加到你的 nuxt.config.ts 文件的 modules 部分

import { defineNuxtConfig } from 'nuxt'

export default defineNuxtConfig({
  modules: ['nuxt-logrocket'],

  logRocket: {
    id: '',
    dev: false,
    config: {
      //
    }
  }
})

选项

可以使用运行时配置或 nuxt.config.ts 中的 logRocket 部分传递选项。在大多数情况下，为必需的 id 选项设置值就足够了。

以下是完整的选项列表

选项	类型	默认值	必需
id	`字符串`	`''`	是
dev	`布尔值`	`true`	否
enablePinia	`布尔值`	`true`	否
release	`字符串`	`null`	否
consoleEnabled	`布尔值`	`true`	否
networkEnabled	`布尔值`	`true`	否
networkRequestSanitizer	`函数`	-	否
networkResponseSanitizer	`函数`	-	否
domEnabled	`布尔值`	`true`	否
inputSanitizer	`布尔值`	`false`	否
textSanitizer	`布尔值`	`false`	否
baseHref	`字符串`	`null`	否
shouldCaptureIP	`布尔值`	`true`	否
rootHostname	`字符串`	`null`	否
shouldDebugLog	`布尔值`	`true`	否
mergeIframes	`布尔值`	`false`	否

这是一个包含选项默认值的示例

{
  id: '',
  dev: true,
  enablePinia: true,
  config: {
    release: null,
    console: {
      isEnabled: true
    },
    network: {
      isEnabled: true,
      networkRequestSanitizer: () => {},
      networkResponseSanitizer: () => {}
    },
    dom: {
      isEnabled: true,
      inputSanitizer: false,
      textSanitizer: false,
      baseHref: null
    },
    shouldCaptureIP: true,
    rootHostname: null,
    shouldDebugLog: true,
    mergeIframes: false
  }
}

用法

正确设置后，LogRocket 会自动注入到你的应用程序中。默认情况下，此模块仅在 production 和客户端事件中起作用。

为了在你的应用程序中使用 LogRocket 的注入功能，你可以使用

const { $logRocket } = useNuxtApp()

访问 LogRocket 的网站以获取完整的功能列表：文档

Pinia

此模块会自动检测 Pinia 存储 mutation，并将它们附加到 LogRocket 会话。

此功能默认情况下处于启用状态，可以通过将 enablePinia 选项设置为 false 来禁用。

import { defineNuxtConfig } from 'nuxt'

export default defineNuxtConfig({
  modules: ['nuxt-logrocket'],

  logRocket: {
    id: '',
    enablePinia: false
  }
})