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 儲存變異，並將其附加到 LogRocket 會議。

此功能預設為啟用，並且可以透過將 enablePinia 選項設定為 false 來停用。

import { defineNuxtConfig } from 'nuxt'

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

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