始める（Get started）

行動分析を始める

Kibana UI で分析を管理できます。検索 > 行動分析に移動して始めてください。

行動分析を使用するには、3つのステップがあります：

• 1. コレクションを作成します。コレクションは、分析イベントの論理的なグループです。
• 2. UI統合を設定します。
• 3. 収集したデータを分析します。

コレクション

このガイドは、Kibana の行動分析 UI を使用してコレクションを作成および管理することに焦点を当てています。また、行動分析 APIを使用して、コレクションを作成、リスト、削除し、コレクションにイベントを投稿することもできます。

コレクションは、分析イベントのセットです。

行動分析を設定する最初のステップは、コレクションを作成することです。Kibana UI でこれを行うには：

• 1. 検索 > 行動分析に移動します。
• 2. コレクションを作成を選択します。
• 3. コレクションの名前を慎重に付けてください。後で変更することはできません。
• 4. 作成を選択します。

コレクションを作成すると、自動的にコレクション用のdata viewが作成されます。これにより、Kibana は Elasticsearch に保存された分析データにアクセスできます。

つまり、アプリケーションやウェブサイトに分析を統合すると、すぐにDiscoverを使用してイベントを表示し、フィルターを設定し、Lensを使用して視覚化を作成できます。

コレクションを作成したら、UI 統合を完了する必要があります。

UI 統合

詳細な統合手順は、Kibana UI に提供されています。これらは、統合タブの検索 > 行動分析 > の下にあります。

次の統合オプションのいずれかを選択してください：

• オプション 1: ブラウザトラッカー
• オプション 2: JavaScript トラッカー

埋め込むと、Search UI JavaScript ライブラリのユーザーは、イベントの送信を簡素化するために次の統合を使用できます：

• Search UI 統合

オプション 1: ブラウザトラッカー

ウェブサイトやアプリケーションのソースファイルにJavaScriptスニペットを追加します。ブラウザトラッカーを使用します。

このアプローチは、ウェブブラウザに最適です。Node アプリや Search UI ユーザーはこのオプションを選択しないでください。

始めるための手順は、Kibana UI にあります。

次の手順に従ってください：

• 1. トラッキングしたいウェブサイトやアプリケーションのすべてのページに行動分析の JavaScript スニペットを埋め込みます。

Js

<script src="https://cdn.jsdelivr.net/npm/@elastic/behavioral-analytics-browser-tracker@2"></script>

• 2. イベントのトラッキングを開始するためにクライアントを初期化します。例えば：

Js

<script type="text/javascript">
  window.elasticAnalytics.createTracker({
   endpoint: "https://77561m8ivn1olhs5fczpls0xa85bueqt.us-west2.gcp.elastic-cloud.com:443",
   collectionName: "my-collection",
   apiKey: "########",
   // Optional: sampling rate percentage: 0-1, 0 = no events, 1 = all events
   // sampling: 1,
  });
  </script>

• 3. trackSearch または trackSearchClick メソッドを使用して、結果のクリックや検索などの検索イベントをトラッキングします。

オプション 2: JavaScript トラッカー

JavaScript クライアントは、NPM パッケージとして利用可能です。アプリケーションが NPM パッケージから JavaScript をバンドルする場合は、このアプローチをお勧めします。これは、Node アプリ（サーバーサイドアプリ）にとって良いオプションです。分析はアプリにバンドルされます。

これにより、ブラウザは JavaScript のダウンロードを最適化できます。

始めるための手順も、Kibana UI にあります。

次の手順に従って始めてください：

• 1. NPM から行動分析の JavaScript トラッカー クライアントをダウンロードします：
  npm install @elastic/behavioral-analytics-javascript-tracker
• 2. クライアントをアプリケーションにインポートします：

Js

import {
   createTracker,
   trackPageView,
   trackSearch,
   trackSearchClick
  } from "@elastic/behavioral-analytics-javascript-tracker";

• 3. イベントのトラッキングを開始するためにクライアントを初期化します：
  createTracker メソッドを使用して、設定でトラッカーを初期化します。その後、トラッカーを使用して行動分析にイベントを送信できます。
  初期化の例：

Js

createTracker({
   endpoint: "https://77561m8ivn1olhs5fczpls0xa85bueqt.us-west2.gcp.elastic-cloud.com:443",
   collectionName: "my-collection",
   apiKey: "<api-key>"
  });

• 4. ページビューと検索行動イベントを送信します。createTrackerを呼び出した後、trackPageViewなどのトラッカーメソッドを使用して、行動分析にイベントを送信できます。

統合が完了すると、Explorerタブ内でページビューイベントを確認できるはずです。

セッションベースのサンプリング

すべてのセッションを Elastic クラスターに送信したいわけではありません。createTracker メソッドにサンプリングパラメータを追加することで、セッションベースのサンプリングを導入できます。

サンプリングが 1（デフォルト）に設定されている場合、すべてのセッションがイベントを送信します。サンプリングが 0 に設定されている場合、セッションはイベントを送信しません。

以下は例です：

Js

createTracker({
  // ... tracker settings
  sampling: 0.3, // 30% of sessions will send events to the server
});

Search UI 統合

Search UIは、検索体験を構築するための JavaScript ライブラリです。Search UI 分析プラグインを NPM から使用して、行動分析を Search UI に統合します。

この統合により、Search UI から行動分析クライアントにイベントを送信できます。この統合の利点は、カスタムイベントを設定する必要がないことです。Search UI によって発火されたイベントは自動的に送信されます。

この統合を使用するには、次の手順に従ってください：

• 1. オプション 1: ブラウザトラッカー または オプション 2: JavaScript トラッカーを使用して、行動分析をサイトに埋め込みます。
• 2. アプリに@elastic/search-ui-analytics-pluginをインポートしてインストールします。
• 3. プラグインを Search UI 設定に追加します。

詳細については、Search UI 分析プラグインのドキュメントを参照してください。

次のステップ

• 分析 API リファレンスを参照してください。