开始使用行为分析编辑

您可以在 Kibana UI 中管理您的分析。转到 搜索 > 行为分析 开始使用。

使用行为分析是一个三步过程

  1. 创建 集合。集合是您的分析事件的逻辑分组。
  2. 设置 UI 集成
  3. 分析 收集的数据。

集合编辑

本指南重点介绍使用 Kibana 中的行为分析 UI 来创建和管理集合。您还可以使用 行为分析 API 来创建、列出和删除集合,以及将事件发布到集合。

集合是一组分析事件。

设置行为分析的第一步是创建一个集合。要在 Kibana UI 中执行此操作

  1. 转到 搜索 > 行为分析
  2. 选择 创建集合
  3. 仔细命名您的集合,因为您以后无法更改它。
  4. 选择 创建

当您创建集合时,我们会自动为该集合创建一个 数据视图。这允许 Kibana 访问存储在 Elasticsearch 中的分析数据。

这意味着,一旦您将分析集成到您的应用程序或网站中,您就可以立即使用 发现 来查看事件、设置过滤器以及使用 Lens 创建可视化。

创建集合后,您需要完成 UI 集成。

UI 集成编辑

Kibana UI 中提供了详细的集成说明。在 搜索 > 行为分析 > <您的集合> 下的 集成 选项卡中找到这些说明。

选择以下集成选项之一

嵌入后,Search UI JavaScript 库的用户可以使用以下集成来简化事件发送

选项 1:浏览器跟踪器编辑

使用 浏览器跟踪器,将 JavaScript 代码段添加到您的网站或应用程序源文件。

这种方法最适合 Web 浏览器。Node 应用程序和 Search UI 用户不应选择此选项。

Kibana UI 中提供了入门说明。

按照以下步骤操作:

  1. 将行为分析 JavaScript 代码段嵌入到您要跟踪的网站或应用程序的每个页面。

    <script src="https://cdn.jsdelivr.net.cn/npm/@elastic/behavioral-analytics-browser-tracker@2"></script>
  2. 初始化客户端以开始跟踪事件。例如

    <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. 使用 trackSearchtrackSearchClick 方法跟踪搜索事件,例如结果点击和搜索。
选项 2:JavaScript 跟踪器编辑

JavaScript 客户端作为 NPM 包 提供。如果您的应用程序从 NPM 包捆绑 JavaScript,我们建议您使用这种方法。这是 Node 应用程序(服务器端应用程序)的不错选择。分析将与您的应用程序捆绑在一起。

这允许浏览器优化 JavaScript 下载。

Kibana UI 中也提供了入门说明。

按照以下步骤操作 开始使用

  1. 下载 从 NPM 下载行为分析 JavaScript 跟踪器客户端

    npm install @elastic/behavioral-analytics-javascript-tracker

  2. 导入 将客户端导入您的应用程序

    import {
      createTracker,
      trackPageView,
      trackSearch,
      trackSearchClick
    } from "@elastic/behavioral-analytics-javascript-tracker";
  3. 初始化 初始化客户端以开始跟踪事件

    使用 createTracker 方法使用您的配置初始化跟踪器。然后,您可以使用跟踪器将事件发送到行为分析。

    示例初始化

    createTracker({
      endpoint: "https://77561m8ivn1olhs5fczpls0xa85bueqt.us-west2.gcp.elastic-cloud.com:443",
      collectionName: "my-collection",
      apiKey: "<api-key>"
    });
  4. 分派 页面浏览和搜索行为事件。

    调用 createTracker 后,您可以使用跟踪器方法(例如 trackPageView)将事件发送到行为分析。

集成后,您应该能够在 资源管理器 选项卡中看到页面浏览事件。

基于会话的抽样

您并不总是希望将所有会话都发送到您的 Elastic 集群。您可以通过在 createTracker 方法中添加抽样参数来引入基于会话的抽样。

如果抽样设置为 1(默认值),则所有会话都会发送事件。如果抽样设置为 0,则没有会话会发送事件。

以下是一个示例

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 分析插件文档

后续步骤编辑