Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/en/serverless/ai-assistant/ai-assistant.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ preview:[]
The AI Assistant uses generative AI to provide:

* **Chat**: Have conversations with the AI Assistant. Chat uses function calling to request, analyze, and visualize your data.
* **Contextual insights**: Open prompts throughout {observability} that explain errors and messages and suggest remediation.
* **Contextual insights**: Open prompts throughout {obs-serverless} that explain errors and messages and suggest remediation.

[role="screenshot"]
image::images/ai-assistant-overview.gif[Observability AI assistant preview]
Expand Down Expand Up @@ -77,7 +77,7 @@ To set up the AI Assistant:
** {kibana-ref}/openai-action-type.html[OpenAI]
** {kibana-ref}/bedrock-action-type.html[Amazon Bedrock]
** {kibana-ref}/gemini-action-type.html[Google Gemini]
. Authenticate communication between {observability} and the AI provider by providing the following information:
. Authenticate communication between {obs-serverless} and the AI provider by providing the following information:
+
.. In the **URL** field, enter the AI provider's API endpoint URL.
.. Under **Authentication**, enter the key or secret you created in the previous step.
Expand Down Expand Up @@ -175,7 +175,7 @@ POST _reindex
[[observability-ai-assistant-interact-with-the-ai-assistant]]
== Interact with the AI Assistant

You can chat with the AI Assistant or interact with contextual insights located throughout {observability}.
You can chat with the AI Assistant or interact with contextual insights located throughout {obs-serverless}.
See the following sections for more on interacting with the AI Assistant.

[TIP]
Expand Down Expand Up @@ -219,7 +219,7 @@ You can suggest the following functions:
| Function | Description

| `alerts`
| Get alerts for {observability}.
| Get alerts for {obs-serverless}.

| `elasticsearch`
| Call {es} APIs on your behalf.
Expand Down Expand Up @@ -262,7 +262,7 @@ Additional functions are available when your cluster has APM data:
[[observability-ai-assistant-use-contextual-prompts]]
=== Use contextual prompts

AI Assistant contextual prompts throughout {observability} provide the following information:
AI Assistant contextual prompts throughout {obs-serverless} provide the following information:

* **Alerts**: Provides possible causes and remediation suggestions for log rate changes.
* **Application performance monitoring (APM)**: Explains APM errors and provides remediation suggestions.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/serverless/aiops/aiops-analyze-spikes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ preview:[]

// <DocCallOut template="technical preview" />

{observability} provides built-in log rate analysis capabilities,
{obs-serverless} provides built-in log rate analysis capabilities,
based on advanced statistical methods,
to help you find and investigate the causes of unusual spikes or drops in log rates.

To analyze log spikes and drops:

. In your {observability} project, go to **AIOps** → **Log rate analysis**.
. In your {obs-serverless} project, go to **AIOps** → **Log rate analysis**.
. Choose a data view or saved search to access the log data you want to analyze.
. In the histogram chart, click a spike (or drop) to start the analysis.
+
Expand Down
6 changes: 3 additions & 3 deletions docs/en/serverless/aiops/aiops-detect-anomalies.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ include::../partials/roles.asciidoc[]

:goal!:

The anomaly detection feature in {observability} automatically models the normal behavior of your time series data — learning trends,
The anomaly detection feature in {obs-serverless} automatically models the normal behavior of your time series data — learning trends,
periodicity, and more — in real time to identify anomalies, streamline root cause analysis, and reduce false positives.

To set up anomaly detection, you create and run anomaly detection jobs.
Expand Down Expand Up @@ -51,7 +51,7 @@ To learn more about anomaly detection, refer to the {ml-docs}/ml-ad-overview.htm
[[create-anomaly-detection-job]]
== Create and run an anomaly detection job

. In your {observability} project, go to **AIOps** → **Anomaly detection**.
. In your {obs-serverless} project, go to **AIOps** → **Anomaly detection**.
. Click **Create anomaly detection job** (or **Create job** if other jobs exist).
. Choose a data view or saved search to access the data you want to analyze.
. Select the wizard for the type of job you want to create.
Expand Down Expand Up @@ -114,7 +114,7 @@ When an event occurs outside of the baselines of normal behavior, that event is
== View the results

After the anomaly detection job has processed some data,
you can view the results in {observability}.
you can view the results in {obs-serverless}.

[TIP]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ preview:[]

// <DocCallOut template="technical preview" />

The change point detection feature in {observability} detects distribution changes,
The change point detection feature in {obs-serverless} detects distribution changes,
trend changes, and other statistically significant change points in time series data.
Unlike anomaly detection, change point detection does not require you to configure a job or generate a model.
Instead you select a metric and immediately see a visual representation that splits the time series into two parts, before and after the change point.

{observability} uses a {ref}/search-aggregations-change-point-aggregation.html[change point aggregation]
{obs-serverless} uses a {ref}/search-aggregations-change-point-aggregation.html[change point aggregation]
to detect change points. This aggregation can detect change points when:

* a significant dip or spike occurs
Expand All @@ -23,7 +23,7 @@ to detect change points. This aggregation can detect change points when:

To detect change points:

. In your {observability} project, go to **AIOps** → **Change point detection**.
. In your {obs-serverless} project, go to **AIOps** → **Change point detection**.
. Choose a data view or saved search to access the data you want to analyze.
. Select a function: **avg**, **max**, **min**, or **sum**.
. In the time filter, specify a time range over which you want to detect change points.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The {ml} model is not ill-affected, and you do not receive spurious results.

To create a calendar and add scheduled events:

. In your {observability} project, go to **AIOps** → **Anomaly detection**.
. In your {obs-serverless} project, go to **AIOps** → **Anomaly detection**.
. Click **Settings**.
. Under **Calendars**, click **Create**.
. Enter an ID and description for the calendar.
Expand Down Expand Up @@ -110,7 +110,7 @@ This gives you much greater control over which anomalous events affect the {ml}

To create a job rule, first create any filter lists you want to use in the rule, then configure the rule:

. In your {observability} project, go to **AIOps** → **Anomaly detection**.
. In your {obs-serverless} project, go to **AIOps** → **Anomaly detection**.
. (Optional) Create one or more filter lists:
+
.. Click **Settings**.
Expand Down Expand Up @@ -144,7 +144,7 @@ For example, you can define a custom URL that enables users to drill down to the

To add a custom URL to the **Actions** menu:

. In your {observability} project, go to **AIOps** → **Anomaly detection**.
. In your {obs-serverless} project, go to **AIOps** → **Anomaly detection**.
. From the **Actions** menu in the job list, select **Edit job**.
. Select the **Custom URLs** tab, then click **Add custom URL**.
. Enter the label to use for the link text.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/serverless/aiops/aiops.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

preview:[]

The AIOps capabilities available in {observability} enable you to consume and process large observability data sets at scale, reducing the time and effort required to detect, understand, investigate, and resolve incidents.
The AIOps capabilities available in {obs-serverless} enable you to consume and process large observability data sets at scale, reducing the time and effort required to detect, understand, investigate, and resolve incidents.
Built on predictive analytics and {ml}, our AIOps capabilities require no prior experience with {ml}.
DevOps engineers, SREs, and security analysts can get started right away using these AIOps features with little or no advanced configuration:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ For example, you can create a rule to check every fifteen minutes for critical a

To create an anomaly detection rule:

. In your {observability} project, go to **AIOps** → **Anomaly detection**.
. In your {obs-serverless} project, go to **AIOps** → **Anomaly detection**.
. In the list of anomaly detection jobs, find the job you want to check for anomalies.
Haven't created a job yet? <<observability-aiops-detect-anomalies,Create one now>>.
. From the **Actions** menu next to the job, select **Create alert rule**.
Expand Down Expand Up @@ -194,6 +194,6 @@ The typical value for the bucket, according to analytical modeling.

To edit an anomaly detection rule:

. In your {observability} project, go to **AIOps** → **Anomaly detection**.
. In your {obs-serverless} project, go to **AIOps** → **Anomaly detection**.
. Expand the job that uses the rule you want to edit.
. On the **Job settings** tab, under **Alert rules**, click the rule to edit it.
2 changes: 1 addition & 1 deletion docs/en/serverless/alerting/alerting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Once you've defined your rules, you can monitor any alerts triggered by these ru
On the **Alerts** page, the Alerts table provides a snapshot of alerts occurring within the specified time frame. The table includes the alert status, when it was last updated, the reason for the alert, and more.

[role="screenshot"]
image::images/observability-alerts-overview.png[Summary of Alerts on the {observability} overview page]
image::images/observability-alerts-overview.png[Summary of Alerts on the {obs-serverless} overview page]

You can filter this table by alert status or time period, customize the visible columns, and search for specific alerts (for example, alerts related to a specific service or environment) using KQL. Select **View alert detail** from the **More actions** menu image:images/icons/boxesHorizontal.svg[action menu], or click the Reason link for any alert to <<observability-view-alerts,view alert>> in detail, and you can then either **View in app** or **View rule details**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can also create an anomaly rule directly from any page within **Applications

To create your anomaly rule:

. In your {observability} project, go to **Alerts**.
. In your {obs-serverless} project, go to **Alerts**.
. Select **Manage Rules** from the **Alerts** page, and select **Create rule**.
. Enter a **Name** for your rule, and any optional **Tags** for more granular reporting (leave blank if unsure).
. Select the **APM Anomaly** rule type.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ include::../partials/roles.asciidoc[]

:goal!:

Create a custom threshold rule to trigger an alert when an {observability} data type reaches or exceeds a given value.
Create a custom threshold rule to trigger an alert when an {obs-serverless} data type reaches or exceeds a given value.

. To access this page, from your project go to **Alerts**.
. Click **Manage Rules** -> **Create rule**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can also create an error count threshold rule directly from any page within

To create your error count threshold rule:

. In your {observability} project, go to **Alerts**.
. In your {obs-serverless} project, go to **Alerts**.
. Select **Manage Rules** from the **Alerts** page, and select **Create rule**.
. Enter a **Name** for your rule, and any optional **Tags** for more granular reporting (leave blank if unsure).
. Select the **Error count threshold** rule type from the APM use case.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can also create a failed transaction rate threshold rule directly from any p

To create your failed transaction rate threshold rule:

. In your {observability} project, go to **Alerts**.
. In your {obs-serverless} project, go to **Alerts**.
. Select **Manage Rules** from the **Alerts** page, and select **Create rule**.
. Enter a **Name** for your rule, and any optional **Tags** for more granular reporting (leave blank if unsure).
. Select the **Failed transaction rate threshold** rule type from the APM use case.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can also create a latency threshold rule directly from any page within **App

To create your latency threshold rule:

. In your {observability} project, go to **Alerts**.
. In your {obs-serverless} project, go to **Alerts**.
. Select **Manage Rules** from the **Alerts** page, and select **Create rule**.
. Enter a **Name** for your rule, and any optional **Tags** for more granular reporting (leave blank if unsure).
. Select the **Latency threshold** rule type from the APM use case.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You must configure a connector if you want to receive alerts for SLO breaches.

To create an SLO burn rate rule:

. In your {observability} project, go to **Alerts**.
. In your {obs-serverless} project, go to **Alerts**.
. Select **Manage Rules** from the **Alerts** page, and select **Create rule**.
. Enter a **Name** for your rule, and any optional **Tags** for more granular reporting (leave blank if unsure).
. Select **SLO burn rate** from the **Select rule type** list.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<titleabbrev>Threshold breaches</titleabbrev>
++++

Threshold breaches occur when an {observability} data type reaches or exceeds the threshold set in your <<observability-create-custom-threshold-alert-rule,custom threshold rule>>.
Threshold breaches occur when an {obs-serverless} data type reaches or exceeds the threshold set in your <<observability-create-custom-threshold-alert-rule,custom threshold rule>>.
For example, you might have a custom threshold rule that triggers an alert when the total number of log documents with a log level of `error` reaches 100.

To triage issues quickly, go to the alert details page:
Expand Down
2 changes: 1 addition & 1 deletion docs/en/serverless/alerting/view-alerts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ You can choose to move active alerts to this state when you disable or delete ru
[NOTE]
====
The flapping state is possible only if you have enabled alert flapping detection.
Go to the **Alerts** page and click **Manage Rules** to navigate to the {observability} **{rules-app}** page.
Go to the **Alerts** page and click **Manage Rules** to navigate to the {obs-serverless} **{rules-app}** page.
Click **Settings** then set the look back window and threshold that are used to determine whether alerts are flapping.
For example, you can specify that the alert must change status at least 6 times in the last 10 runs.
If the rule has actions that run when the alert status changes, those actions are suppressed while the alert is flapping.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ for more information.
Use **Discover** to validate that metrics are successfully reported to your project.

. Open your Observability project.
. In your {observability} project, go to **Discover**, and select the **Logs Explorer** tab.
. In your {obs-serverless} project, go to **Discover**, and select the **Logs Explorer** tab.
. Click **All logs** → **Data Views** then select **APM**.
. Filter the data to only show documents with metrics: `processor.name :"metric"`
. Narrow your search with a known OpenTelemetry field. For example, if you have an `order_value` field, add `order_value: *` to your search to return
Expand All @@ -52,7 +52,7 @@ Use **Lens** to create visualizations for OpenTelemetry metrics. Lens enables yo

To get started with a new Lens visualization:

. In your {observability} project, go to **Visualizations**.
. In your {obs-serverless} project, go to **Visualizations**.
. Click **Create new visualization**.
. Select **Lens**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ be sent directly to Elastic.
[[observability-apm-agents-opentelemetry-opentelemetry-native-support-send-data-from-an-upstream-opentelemetry-collector]]
== Send data from an upstream OpenTelemetry Collector

Connect your OpenTelemetry Collector instances to {observability} using the OTLP exporter:
Connect your OpenTelemetry Collector instances to {obs-serverless} using the OTLP exporter:

[source,yaml]
----
Expand Down Expand Up @@ -70,7 +70,7 @@ https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otl

<3> The https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/loggingexporter[logging exporter] is helpful for troubleshooting and supports various logging levels, like `debug`, `info`, `warn`, and `error`.

<4> {observability} endpoint configuration.
<4> {obs-serverless} endpoint configuration.
Elastic supports a ProtoBuf payload via both the OTLP protocol over gRPC transport https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#otlpgrpc[(OTLP/gRPC)]
and the OTLP protocol over HTTP transport https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#otlphttp[(OTLP/HTTP)].
To learn more about these exporters, see the OpenTelemetry Collector documentation:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ address or region, is facing increased latency due to local data center issues.

To find correlations:

. In your {observability} project, go to **Applications** → **Services**.
. In your {obs-serverless} project, go to **Applications** → **Services**.
. Select a service.
. Select the **Transactions** tab.
. Select a transaction group in the **Transactions** table.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/serverless/apm/apm-get-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ written in several languages and supports OpenTelemetry. Which agent you'll use
To send APM data to Elastic, you must install an APM agent and configure it to send data to
your project:

. <<observability-create-an-observability-project,Create a new {observability} project>>, or open an existing one.
. <<observability-create-an-observability-project,Create a new {obs-serverless} project>>, or open an existing one.
. To install and configure one or more APM agents, do one of following:
+
** In your Observability project, go to **Add data** → **Monitor my application performance** → **Elastic APM** and follow the prompts.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ image::images/service-maps/service-map-anomaly.png[Example view of anomaly score

To enable machine learning anomaly detection:

. In your {observability} project, go to any **Applications** page.
. In your {obs-serverless} project, go to any **Applications** page.
. Click **Anomaly detection**.
. Click **Create Job**.
. Machine learning jobs are created at the environment level.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/serverless/apm/apm-keep-data-secure.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Requests without a valid API key will be denied.

To create a new API key:

. In your {observability} project, go to any **Applications** page.
. In your {obs-serverless} project, go to any **Applications** page.
. Click **Settings**.
. Select the **APM agent keys** tab.
. Click **Create APM agent key**.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/serverless/apm/apm-ui-services.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ image::images/services/apm-service-group.png[Example view of service group in th

To create a service group:

. In your {observability} project, go to **Applications** → **Services**.
. In your {obs-serverless} project, go to **Applications** → **Services**.
. Switch to **Service groups**.
. Click **Create group**.
. Specify a name, color, and description.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/serverless/cases/create-manage-cases.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ include::../partials/roles.asciidoc[]
Open a new case to keep track of issues and share the details with colleagues.
To create a case in your Observability project:

. In your {observability} project, go to **Cases**.
. In your {obs-serverless} project, go to **Cases**.
. Click **Create case**.
. (Optional) If you defined <<observability-case-settings-templates,templates>>, select one to use its default field values. preview:[]
. Give the case a name, severity, and description.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/serverless/cases/manage-cases-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[observability-case-settings]]
= Configure case settings

// :description: Change the default behavior of {observability} cases by adding connectors, custom fields, templates, and closure options.
// :description: Change the default behavior of {obs-serverless} cases by adding connectors, custom fields, templates, and closure options.
// :keywords: serverless, observability, how-to

preview:[]
Expand All @@ -13,7 +13,7 @@ include::../partials/roles.asciidoc[]

:goal!:

To access case settings in an {observability} project, go to **Cases** → **Settings**.
To access case settings in an {obs-serverless} project, go to **Cases** → **Settings**.

[role="screenshot"]
image::images/observability-cases-settings.png[View case settings]
Expand Down
4 changes: 1 addition & 3 deletions docs/en/serverless/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:doctype: book

include::{asciidoc-dir}/../../shared/versions/stack/master.asciidoc[]
include::{asciidoc-dir}/../../shared/versions/stack/current.asciidoc[]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I initially used master because I thought we wanted to link to the master version of stateful docs, but that messed up code blocks using version (example). 😬

include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

[[what-is-observability-serverless]]
Expand Down
Loading