diff --git a/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md b/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md index 45755f78a..da1221ccd 100644 --- a/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md +++ b/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md @@ -146,20 +146,6 @@ The following features are planned for future support in all {{serverless-full}} * Clone index API * Traffic filtering and VPCs -The following {{es-serverless}} project-specific features are planned for future support: - -* [Behavioral Analytics](../../../solutions/search/site-or-app/behavioral-analytics.md) -* [Search Applications](../../../solutions/search/search-applications.md) -* Managed web crawler - - You can use the [self-managed web crawler](https://github.com/elastic/crawler) in the meantime. - -* Managed Search connectors - - You can use [self-managed Search connectors](asciidocalypse://docs/elasticsearch/docs/reference/ingestion-tools/search-connectors/self-managed-connectors.md) in the meantime. - - - ### Unplanned features [elasticsearch-differences-serverless-feature-unavailable] The following features are not available in {{es-serverless}} and are not planned for future support: @@ -167,3 +153,5 @@ The following features are not available in {{es-serverless}} and are not planne * [Custom plugins and bundles](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md) * [{{es}} for Apache Hadoop](asciidocalypse://docs/elasticsearch-hadoop/docs/reference/ingestion-tools/elasticsearch-hadoop/elasticsearch-for-apache-hadoop.md) * [Scripted metric aggregations](asciidocalypse://docs/elasticsearch/docs/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) +* Managed web crawler: You can use the [self-managed web crawler](https://github.com/elastic/crawler) instead. +* Managed Search connectors: You can use [self-managed Search connectors](asciidocalypse://docs/elasticsearch/docs/reference/ingestion-tools/search-connectors/self-managed-connectors.md) instead. \ No newline at end of file diff --git a/raw-migrated-files/docs-content/serverless/elasticsearch-differences.md b/raw-migrated-files/docs-content/serverless/elasticsearch-differences.md index 0c980451e..20480732c 100644 --- a/raw-migrated-files/docs-content/serverless/elasticsearch-differences.md +++ b/raw-migrated-files/docs-content/serverless/elasticsearch-differences.md @@ -142,20 +142,6 @@ The following features are planned for future support in all {{serverless-full}} * Clone index API * Traffic filtering and VPCs -The following {{es-serverless}} project-specific features are planned for future support: - -* [Behavioral Analytics](../../../solutions/search/site-or-app/behavioral-analytics.md) -* [Search Applications](../../../solutions/search/search-applications.md) -* Managed web crawler - - You can use the [self-managed web crawler](https://github.com/elastic/crawler) in the meantime. - -* Managed Search connectors - - You can use [self-managed Search connectors](asciidocalypse://docs/elasticsearch/docs/reference/ingestion-tools/search-connectors/self-managed-connectors.md) in the meantime. - - - ### Unplanned features [elasticsearch-differences-serverless-feature-unavailable] The following features are not available in {{es-serverless}} and are not planned for future support: @@ -163,3 +149,5 @@ The following features are not available in {{es-serverless}} and are not planne * [Custom plugins and bundles](/deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md) * [{{es}} for Apache Hadoop](asciidocalypse://docs/elasticsearch-hadoop/docs/reference/ingestion-tools/elasticsearch-hadoop/elasticsearch-for-apache-hadoop.md) * [Scripted metric aggregations](asciidocalypse://docs/elasticsearch/docs/reference/data-analysis/aggregations/search-aggregations-metrics-scripted-metric-aggregation.md) +* Managed web crawler: You can use the [self-managed web crawler](https://github.com/elastic/crawler) instead. +* Managed Search connectors: You can use [self-managed Search connectors](asciidocalypse://docs/elasticsearch/docs/reference/ingestion-tools/search-connectors/self-managed-connectors.md) instead. diff --git a/solutions/search/site-or-app.md b/solutions/search/site-or-app.md index 243cce8e7..4f6140fdd 100644 --- a/solutions/search/site-or-app.md +++ b/solutions/search/site-or-app.md @@ -11,5 +11,4 @@ The following tools are available to help you add search to your site or app: - Clients: Use programming language clients to integrate {{es}} with your application. - [Search UI](site-or-app/search-ui.md): Use the Search UI library to build a user interface for your search application. -- [Behavioral analytics](site-or-app/behavioral-analytics.md): Use Behavioral Analytics to track user behavior and improve search relevance. - [Search Applications](search-applications.md): Use Search Applications to simplify the process of building search experiences, by leveraging [search templates](search-templates.md). \ No newline at end of file diff --git a/solutions/search/site-or-app/behavioral-analytics-api.md b/solutions/search/site-or-app/behavioral-analytics-api.md deleted file mode 100644 index b19b11cff..000000000 --- a/solutions/search/site-or-app/behavioral-analytics-api.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -navigation_title: "API overview" -mapped_pages: - - https://www.elastic.co/guide/en/elasticsearch/reference/current/behavioral-analytics-api.html -applies_to: - stack: ---- - - - -# API overview [behavioral-analytics-api] - - -This page outlines all the APIs available for behavioral analytics and links to their documentation. - - -## Behavioral Analytics REST APIs [behavioral-analytics-api-es-rest] - -Behavioral Analytics relies on a number of {{es}} APIs to manage analytics collections. Refer to the [API documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-analytics) for the details. - - -## Behavioral Analytics Clients [behavioral-analytics-api-clients] - -Behavioral Analytics integrates onto your website using one of our JavaScript clients: - -* **Browser tracker** - integrated into your website using a ` - ``` - -2. Initialize the client to start tracking events. For example: - - ```js - - ``` - -3. Track search events, like result clicks and searches, by using the `trackSearch` or `trackSearchClick` methods. - - -### Option 2: JavaScript tracker [behavioral-analytics-start-ui-integration-js-client] - -The JavaScript client is available as an [NPM package](https://www.npmjs.com/package/@elastic/behavioral-analytics-javascript-tracker). We recommend this approach if your application bundles JavaScript from NPM packages. This is a good option for Node apps (server-side apps). Analytics will be bundled with your app. - -This allows the browser to optimize the JavaScript download. - -Instructions for getting started are also available in the {{kib}} UI. - -**Follow these steps** to get started: - -1. **Download** the behavioral analytics JavaScript tracker client from NPM: - - `npm install @elastic/behavioral-analytics-javascript-tracker` - -2. **Import** the client into your application: - - ```js - import { - createTracker, - trackPageView, - trackSearch, - trackSearchClick - } from "@elastic/behavioral-analytics-javascript-tracker"; - ``` - -3. **Initialize** the client to start tracking events: - - Use the `createTracker` method to initialize the tracker with your configuration. You can then use the tracker to send events to Behavioral Analytics. - - Example initialization: - - ```js - createTracker({ - endpoint: "https://77561m8ivn1olhs5fczpls0xa85bueqt.us-west2.gcp.elastic-cloud.com:443", - collectionName: "my-collection", - apiKey: "" - }); - ``` - -4. **Dispatch** Pageview and search behavior events. - - Once you have called `createTracker`, you can use the tracker methods such as `trackPageView` to send events to Behavioral Analytics. - - -Once integrated, you should be able to see page view events within the **Explorer** tab. - -::::{tip} -**Session-based sampling** - -You don’t always want all sessions to be sent to your Elastic cluster. You can introduce session-based sampling by adding a sampling parameter to the `createTracker` method. - -If sampling is set to 1 (default), all sessions will send events. If sampling is set to 0, no sessions will send events. - -Here’s an example: - -```js -createTracker({ - // ... tracker settings - sampling: 0.3, // 30% of sessions will send events to the server -}); -``` - -:::: - - - -## Search UI integration [behavioral-analytics-start-ui-integration-search-ui] - -[Search UI](https://docs.elastic.co/search-ui) is a JavaScript library for building search experiences. Use the [Search UI analytics plugin](https://www.npmjs.com/package/@elastic/search-ui-analytics-plugin) available on NPM to integrate behavioral analytics with Search UI. - -This integration enables you to dispatch events from Search UI to the behavioral analytics client. The advantage of this integration is that you don’t need to set up custom events. Events fired by Search UI are dispatched automatically. - -To use this integration, follow these steps: - -1. Embed Behavioral Analytics into your site using [Option 1: Browser tracker](#behavioral-analytics-start-ui-integration-js-embed) **or** the [Option 2: JavaScript tracker](#behavioral-analytics-start-ui-integration-js-client). -2. Install the [`@elastic/search-ui-analytics-plugin`](https://www.npmjs.com/package/@elastic/search-ui-analytics-plugin) by importing it into your app. -3. Add the plugin to your Search UI configuration. - -See the [Search UI analytics plugin documentation](https://docs.elastic.co/search-ui/api/core/plugins/analytics-plugin) for details. - - -## Next steps [behavioral-analytics-start-next-steps] - -* Refer to the [analytics API reference](behavioral-analytics-api.md). - diff --git a/solutions/search/site-or-app/behavioral-analytics.md b/solutions/search/site-or-app/behavioral-analytics.md deleted file mode 100644 index a84d39ea4..000000000 --- a/solutions/search/site-or-app/behavioral-analytics.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/elasticsearch/reference/current/behavioral-analytics-overview.html -applies_to: - stack: ---- - -# Behavioral analytics [behavioral-analytics-overview] - -Behavioral Analytics is an analytics event collection platform. Use these tools to analyze your users' searching and clicking behavior. Leverage this information to improve the relevance of your search results and identify gaps in your content. - -[Get started](behavioral-analytics-start.md) by embedding one of our JavaScript clients on your website or application and instrumenting the user actions you want to track. For example, you can track when a user searches, when they click on a search result, or when a user visits a particular page on your website. - -Data and analytics are stored in {{es}} indices, for advanced analysis and visualization. - -Even if you don’t use Elastic for search, you can use these tools to collect analytics from your application/website. - - -## Availability and prerequisites [behavioral-analytics-overview-prerequisites] - -::::{note} -Behavioral Analytics is a **beta feature**. Beta features are subject to change and are not covered by the support SLA of general release (GA) features. Elastic plans to promote this feature to GA in a future release. - -:::: - - -::::{dropdown} Expand to learn about version history -* Behavioral Analytics was introduced in Elastic **8.7.0** to the Enterprise Search service. -* There was a breaking schema change in **8.8.0**. (See [Migrating from 8.7 to 8.8](https://www.elastic.co/guide/en/enterprise-search/current/analytics-migration.html) in the Search documentation if you’re upgrading from 8.7 to 8.8.) -* The feature was moved to Elasticsearch in **8.10**, meaning the Enterprise Search service is no longer required as of 8.10. -:::: - - -Analytics are available to all Elastic Cloud users. - -Analytics are also available to **self-managed** deployments that satisfy subscription requirements. View the requirements for this feature under the **Elastic Search** section of the [Elastic Stack subscriptions](https://www.elastic.co/subscriptions) page. - -Your Elastic deployment must include the {{es}} and {{kib}}services. - - -## Documentation [behavioral-analytics-overview-docs] - -The following documentation is available in the {{es}} docs: - -* [Get started](behavioral-analytics-start.md) -* [API overview](behavioral-analytics-api.md) -* [Set up CORs](behavioral-analytics-cors.md) -* [View events](behavioral-analytics-event.md) -* [Events reference](behavioral-analytics-event-reference.md) - -Additional documentation is available in the following places: - -* The [Behavioral Analytics Tracker Mono Repo](https://github.com/elastic/behavioral-analytics-tracker/tree/main#readme) contains the source code for the Behavioral Analytics Tracker, which can be embedded using either the JavaScript or Browser trackers: - - * Read the [JavaScript tracker README](https://github.com/elastic/behavioral-analytics-tracker/blob/main/packages/javascript-tracker/README.md). - * Read the [Browser tracker README](https://github.com/elastic/behavioral-analytics-tracker/blob/main/packages/browser-tracker/README.md). - -* The Search UI documentation contains information about the [Search UI Analytics Plugin](https://docs.elastic.co/search-ui/api/core/plugins/analytics-plugin). -* Behavioral Analytics uses a number of [APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-analytics) to manage analytics collections. - -::::{admonition} GDPR compliance -:class: note - -Users may be concerned about the privacy implications of analytics data collection. Behavioral Analytics is fully GDPR compliant, because no personal data are collected. - -To integrate the behavioral analytics client, session data are stored in two tokens: - -* **User Token**. A unique identifier for the user. Stored under `EA_UID` cookie. Default time length is 24 hours from the first time the user visits the site. -* **Session Token**. A unique identifier for the session. Stored under `EA_SID` cookie. Time length is 30 minutes from the last time the user visits the site. - -These tokens enable the client to identify a user across sessions. They do not collect sensitive information, such as IP addresses or location data, or any other personal data. - -:::: - - - - - - - diff --git a/solutions/toc.yml b/solutions/toc.yml index b377e5dba..6b921f5a4 100644 --- a/solutions/toc.yml +++ b/solutions/toc.yml @@ -660,13 +660,6 @@ toc: children: - file: search/site-or-app/clients.md - file: search/site-or-app/search-ui.md - - file: search/site-or-app/behavioral-analytics.md - children: - - file: search/site-or-app/behavioral-analytics-start.md - - file: search/site-or-app/behavioral-analytics-cors.md - - file: search/site-or-app/behavioral-analytics-event.md - - file: search/site-or-app/behavioral-analytics-event-reference.md - - file: search/site-or-app/behavioral-analytics-api.md - file: search/search-applications.md children: - file: search/search-applications/search-application-api.md