Nuxt Rollbar module

Nuxt Rollbar

Nuxt 3 モジュールでRollbarと連携します。

セットアップ

# pnpm
pnpm add -D nuxt-rollbar

# npm
npm i -D nuxt-rollbar

# yarn
yarn add -D nuxt-rollbar

基本的な使用方法

Nuxt設定のmodulesセクションにnuxt-rollbarを追加し、Rollbarサーバーおよび/またはクライアントアクセストークンを指定します。

// `nuxt.config.ts`
export default defineNuxtConfig({
  modules: ['nuxt-rollbar'],

  rollbar: {
    serverAccessToken: 'SERVER_ACCESS_TOKEN',
    clientAccessToken: 'CLIENT_ACCESS_TOKEN',
  },
});

完了！Rollbarがアプリケーションで実行されます。

設定

クライアントのみ

ℹ️ useRollbarコンポーザブルは、サーバーではundefinedを返します。

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

  rollbar: {
    clientAccessToken: 'CLIENT_ACCESS_TOKEN',
    mode: 'client',
    config: {
      // Rollbar configuration
    },
  },
});

サーバーのみ

ℹ️ useRollbarコンポーザブルは、クライアントではundefinedを返します。

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

  rollbar: {
    serverAccessToken: 'SERVER_ACCESS_TOKEN',
    mode: 'server',
    config: {
      // Rollbar configuration
    },
  },
});

サーバーとクライアントの両方

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

  rollbar: {
    serverAccessToken: 'SERVER_ACCESS_TOKEN',
    clientAccessToken: 'CLIENT_ACCESS_TOKEN',
    config: {
      // Rollbar configuration
    },
  },
});

モジュールオプション

オプション	タイプ	デフォルト	説明
`clientAccessToken`	`文字列`	`''`	Rollbarクライアントアクセストークン。
`serverAccessToken`	`文字列`	`''`	Rollbarサーバーアクセストークン。
`mode`	`文字列`	`'all'`	Rollbarインスタンスが実行される環境モード。
`config`	`Rollbar.Configuration`	`null`	Rollbar設定。

コンポーザブル

Nuxt 3エコシステムの他のコンポーザブルと同様に、自動的にインポートされ、アプリケーションのコンポーネントで使用できます。

ℹ️ Rollbarインスタンスはクライアントとサーバーの両方の環境で使用できるため、どちらのコンテキストでも使用できます。

`useRollbar`

利用可能で環境（クライアントまたはサーバー）用に設定されている場合、Rollbarインスタンスを返します。それ以外の場合はundefinedを返します。

型定義

function useRollbar(): Rollbar;

例

const rollbar = useRollbar();

rollbar.log('Hello, world!');

このコンポーザブルは、～の単純なエイリアスです。

useNuxtApp().$rollbar;

💻 開発

このリポジトリをクローンします。
corepack enableを使用してCorepackを有効にします。
pnpm installを使用して依存関係をインストールします。
pnpm run dev:prepareを実行します。
pnpm run devを使用して開発サーバーを起動します。

謝辞

特に感謝したいのは

nuxt-plausible
nuxt-rollbar-module

インスピレーションと基盤となる作業に感謝します。