New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« 搜索分析 为行为分析设置 CORS »
Elastic 文档 ›Elasticsearch 指南 [8.17] ›搜索您的数据 ›搜索分析

开始使用行为分析

编辑

开始使用行为分析

编辑

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

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

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

集合

编辑

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

集合是一组分析事件。

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

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

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

这意味着，一旦您将分析集成到您的应用程序或网站中，您就可以立即使用 Discover 来查看事件、设置过滤器，并使用 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. 通过使用 trackSearch 或 trackSearchClick 方法来跟踪搜索事件，如结果点击和搜索。

选项 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 库。使用 NPM 上提供的 Search UI 分析插件将行为分析与 Search UI 集成。

此集成使您可以将事件从 Search UI 分发到行为分析客户端。此集成的优点是您不需要设置自定义事件。Search UI 触发的事件会自动分发。

要使用此集成，请按照以下步骤操作

  1. 使用 选项 1：浏览器跟踪器 或 选项 2：JavaScript 跟踪器，将行为分析嵌入到您的网站中。
  2. 通过将其导入到您的应用程序中来安装 @elastic/search-ui-analytics-plugin。
  3. 将插件添加到您的 Search UI 配置中。

有关详细信息，请参阅 Search UI 分析插件文档。

后续步骤

编辑
« 搜索分析 为行为分析设置 CORS »