Skip to content

Commit

Permalink
update for docsmobile v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis committed Jun 12, 2024
1 parent bbaa6a4 commit 3fe8088
Show file tree
Hide file tree
Showing 151 changed files with 660 additions and 782 deletions.
7 changes: 3 additions & 4 deletions docs/en/serverless/ai-assistant/ai-assistant.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityAiAssistant
slug: /serverless/observability/ai-assistant
title: AI Assistant
# description: Description to be written
Expand Down Expand Up @@ -245,7 +244,7 @@ You can continue a conversation from a contextual prompt by clicking **Start cha
You can use the Observability AI Assistant connector to add AI-generated insights and custom actions to your alerting workflows.
To do this:

1. <DocLink id="serverlessObservabilityCreateRules" text="Create (or edit) an alerting rule" /> and specify the conditions that must be met for the alert to fire.
1. <DocLink slug="/serverless/observability/create-manage-rules" text="Create (or edit) an alerting rule" /> and specify the conditions that must be met for the alert to fire.
1. Under **Actions**, select the **Observability AI Assistant** connector type.
1. In the **Connector** list, select the AI connector you created when you set up the assistant.
1. In the **Message** field, specify the message to send to the assistant:
Expand Down Expand Up @@ -278,7 +277,7 @@ The AI Assistant runs the tasks requested in the message and creates a conversat
It might take a minute or two for the AI Assistant to process the message and create the conversation.

Note that overly broad prompts may result in the request exceeding token limits.
For more information, refer to <DocLink id="serverlessObservabilityAiAssistant" section="token-limits" />
For more information, refer to <DocLink slug="/serverless/observability/ai-assistant" section="token-limits" />
Also, attempting to analyze several alerts in a single connector execution may cause you to exceed the function call limit.
If this happens, modify the message specified in the connector configuration to avoid exceeding limits.

Expand All @@ -289,7 +288,7 @@ the AI Assistant attempts to include a link to the generated conversation.

The Observability AI Assistant connector is called when the alert fires and when it recovers.

To learn more about alerting, actions, and connectors, refer to <DocLink id="serverlessObservabilityAlerting" />.
To learn more about alerting, actions, and connectors, refer to <DocLink slug="/serverless/observability/alerting" />.

## Known issues

Expand Down
5 changes: 2 additions & 3 deletions docs/en/serverless/aiops/aiops-analyze-spikes.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityAiopsAnalyzeSpikes
slug: /serverless/observability/aiops-analyze-spikes
title: Analyze log spikes and drops
description: Find and investigate the causes of unusual spikes or drops in log rates.
Expand Down Expand Up @@ -35,7 +34,7 @@ To analyze log spikes and drops:
The table shows an indicator of the level of impact and a sparkline showing the shape of the impact in the chart.
1. Select a row to display the impact of the field on the histogram chart.
1. From the **Actions** menu in the table, you can choose to view the field in **Discover**,
view it in <DocLink id="serverlessObservabilityAiopsAnalyzeSpikes" section="log-pattern-analysis" text="Log Pattern Analysis" />,
view it in <DocLink slug="/serverless/observability/aiops-analyze-spikes" section="log-pattern-analysis" text="Log Pattern Analysis" />,
or copy the table row information to the clipboard as a query filter.

To pin a table row, click the row, then move the cursor to the histogram chart.
Expand All @@ -60,7 +59,7 @@ It also helps you group logs in ways that go beyond what you can achieve with a

To run log pattern analysis:

1. Follow the steps under <DocLink id="serverlessObservabilityAiopsAnalyzeSpikes"/> to run a log rate analysis.
1. Follow the steps under <DocLink slug="/serverless/observability/aiops-analyze-spikes"/> to run a log rate analysis.
1. From the **Actions** menu, choose **View in Log Pattern Analysis**.
1. Select a category field and optionally apply any filters that you want.
1. Click **Run pattern analysis**.
Expand Down
15 changes: 7 additions & 8 deletions docs/en/serverless/aiops/aiops-detect-anomalies.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityAiopsDetectAnomalies
slug: /serverless/observability/aiops-detect-anomalies
title: Detect anomalies
description: Detect anomalies by comparing real-time and historical data from different sources to look for unusual, problematic patterns.
Expand Down Expand Up @@ -106,7 +105,7 @@ Then you can create multi-metric jobs and split the data or create more complex
When you're done, go back to the first step and create your job.
</DocCallOut>
5. Step through the instructions in the job creation wizard to configure your job.
You can accept the default settings for most settings now and <DocLink id="serverlessObservabilityAiopsTuneAnomalyDetectionJob" text="tune the job" /> later.
You can accept the default settings for most settings now and <DocLink slug="/serverless/observability/aiops-tune-anomaly-detection-job" text="tune the job" /> later.
1. If you want the job to start immediately when the job is created, make sure that option is selected on the summary page.
1. When you're done, click **Create job**.
When the job runs, the ((ml)) features analyze the input stream of data, model its behavior, and perform analysis based on the detectors in each job.
Expand All @@ -128,8 +127,8 @@ To switch between these tools, click the icons in the upper-left corner of each

Read the following sections to learn more about these tools:

* <DocLink id="serverlessObservabilityAiopsDetectAnomalies" section="view-single-metric" text="View single metric job results" />
* <DocLink id="serverlessObservabilityAiopsDetectAnomalies" section="anomaly-explorer" text="View advanced or multi-metric job results" />
* <DocLink slug="/serverless/observability/aiops-detect-anomalies" section="view-single-metric" text="View single metric job results" />
* <DocLink slug="/serverless/observability/aiops-detect-anomalies" section="anomaly-explorer" text="View advanced or multi-metric job results" />

<div id="view-single-metric"></div>

Expand Down Expand Up @@ -184,7 +183,7 @@ The **Anomaly explanation** section gives you further insights about each anomal

1. (Optional) From the **Actions** menu in the **Anomalies** table, you can choose to view relevant documents in **Discover** or create a job rule.
Job rules instruct anomaly detectors to change their behavior based on domain-specific knowledge that you provide.
To learn more, refer to <DocLink id="serverlessObservabilityAiopsTuneAnomalyDetectionJob" />
To learn more, refer to <DocLink slug="/serverless/observability/aiops-tune-anomaly-detection-job" />

After you have identified anomalies, often the next step is to try to determine
the context of those situations. For example, are there other factors that are
Expand Down Expand Up @@ -258,6 +257,6 @@ the actual and expected ("typical") values, and the influencers that contributed

After setting up an anomaly detection job, you may want to:

* <DocLink id="serverlessObservabilityAiopsTuneAnomalyDetectionJob" />
* <DocLink id="serverlessObservabilityAiopsDetectAnomaliesForecast" />
* <DocLink id="serverlessObservabilityGenerateAnomalyAlerts" />
* <DocLink slug="/serverless/observability/aiops-tune-anomaly-detection-job" />
* <DocLink slug="/serverless/observability/aiops-forecast-anomalies" />
* <DocLink slug="/serverless/observability/aiops-generate-anomaly-alerts" />
1 change: 0 additions & 1 deletion docs/en/serverless/aiops/aiops-detect-change-points.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityAiopsDetectChangePoints
slug: /serverless/observability/aiops-detect-change-points
title: Detect change points
description: Detect distribution changes, trend changes, and other statistically significant change points in a metric of your time series data.
Expand Down
3 changes: 1 addition & 2 deletions docs/en/serverless/aiops/aiops-forecast-anomaly.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityAiopsDetectAnomaliesForecast
slug: /serverless/observability/aiops-forecast-anomalies
title: Forecast future behavior
description: Predict future behavior of your data by creating a forecast for an anomaly detection job.
Expand All @@ -24,7 +23,7 @@ For example, you might want to determine how likely it is that your disk utiliza

To create a forecast:

1. <DocLink id="serverlessObservabilityAiopsDetectAnomalies" text="Create an anomaly detection job" /> and view the results in the **Single Metric Viewer**.
1. <DocLink slug="/serverless/observability/aiops-detect-anomalies" text="Create an anomaly detection job" /> and view the results in the **Single Metric Viewer**.
1. Click **Forecast**.
1. Specify a duration for your forecast.
This value indicates how far to extrapolate beyond the last record that was processed.
Expand Down
7 changes: 3 additions & 4 deletions docs/en/serverless/aiops/aiops-tune-anomaly-detection-job.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityAiopsTuneAnomalyDetectionJob
slug: /serverless/observability/aiops-tune-anomaly-detection-job
title: Tune your anomaly detection job
description: Tune your job by creating calendars, adding job rules, and defining custom URLs.
Expand All @@ -17,10 +16,10 @@ you might find that you need to alter the job configuration or settings.

To further tune your job, you can:

* <DocLink id="serverlessObservabilityAiopsTuneAnomalyDetectionJob" section="create-calendars" text="Create calendars" /> that contain a list of scheduled events for which you do not want to generate anomalies, such as planned system outages or public holidays.
* <DocLink id="serverlessObservabilityAiopsTuneAnomalyDetectionJob" section="create-job-rules" text="Create job rules" /> that instruct anomaly detectors to change their behavior based on domain-specific knowledge that you provide.
* <DocLink slug="/serverless/observability/aiops-tune-anomaly-detection-job" section="create-calendars" text="Create calendars" /> that contain a list of scheduled events for which you do not want to generate anomalies, such as planned system outages or public holidays.
* <DocLink slug="/serverless/observability/aiops-tune-anomaly-detection-job" section="create-job-rules" text="Create job rules" /> that instruct anomaly detectors to change their behavior based on domain-specific knowledge that you provide.
Your job rules can use filter lists, which contain values that you can use to include or exclude events from the ((ml)) analysis.
* <DocLink id="serverlessObservabilityAiopsTuneAnomalyDetectionJob" section="define-custom-urls" text="Define custom URLs"/> to make dashboards and other resources readily available when viewing job results.
* <DocLink slug="/serverless/observability/aiops-tune-anomaly-detection-job" section="define-custom-urls" text="Define custom URLs"/> to make dashboards and other resources readily available when viewing job results.

For more information about tuning your job,
refer to the how-to guides in the [((ml))](((ml-docs))/anomaly-how-tos.html) documentation.
Expand Down
7 changes: 3 additions & 4 deletions docs/en/serverless/aiops/aiops.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityAiops
slug: /serverless/observability/aiops
title: AIOps
description: Automate anomaly detection and accelerate root cause analysis with AIOps.
Expand All @@ -14,15 +13,15 @@ DevOps engineers, SREs, and security analysts can get started right away using t

<DocTable columns={[{ title: "Feature" }, { title: "Description" }]}>
<DocRow>
<DocCell><DocLink id="serverlessObservabilityAiopsDetectAnomalies" text="Anomaly detection"/></DocCell>
<DocCell><DocLink slug="/serverless/observability/aiops-detect-anomalies" text="Anomaly detection"/></DocCell>
<DocCell>Detect anomalies by comparing real-time and historical data from different sources to look for unusual, problematic patterns.</DocCell>
</DocRow>
<DocRow>
<DocCell><DocLink id="serverlessObservabilityAiopsAnalyzeSpikes" text="Log rate analysis"/></DocCell>
<DocCell><DocLink slug="/serverless/observability/aiops-analyze-spikes" text="Log rate analysis"/></DocCell>
<DocCell>Find and investigate the causes of unusual spikes or drops in log rates.</DocCell>
</DocRow>
<DocRow>
<DocCell><DocLink id="serverlessObservabilityAiopsDetectChangePoints" text="Change point detection"/></DocCell>
<DocCell><DocLink slug="/serverless/observability/aiops-detect-change-points" text="Change point detection"/></DocCell>
<DocCell>Detect distribution changes, trend changes, and other statistically significant change points in a metric of your time series data.</DocCell>
</DocRow>
</DocTable>
3 changes: 1 addition & 2 deletions docs/en/serverless/alerting/aggregation-options.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityAggregationOptions
slug: /serverless/observability/aggregationOptions
title: Aggregation options
description: Learn about aggregations available in alerting rules.
Expand Down Expand Up @@ -40,7 +39,7 @@ The following aggregations are available in some rules:
</DocRow>
<DocRow>
<DocCell>Rate</DocCell>
<DocCell>Rate at which a specific field changes over time. To learn about how the rate is calculated, refer to <DocLink id="serverlessObservabilityRateAggregation" />.</DocCell>
<DocCell>Rate at which a specific field changes over time. To learn about how the rate is calculated, refer to <DocLink slug="/serverless/observability/rateAggregation" />.</DocCell>
</DocRow>
<DocRow>
<DocCell>Sum</DocCell>
Expand Down
5 changes: 2 additions & 3 deletions docs/en/serverless/alerting/aiops-generate-anomaly-alerts.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityGenerateAnomalyAlerts
slug: /serverless/observability/aiops-generate-anomaly-alerts
title: Create an anomaly detection rule
description: Get alerts when anomalies match specific conditions.
Expand All @@ -26,7 +25,7 @@ To create an anomaly detection rule:

1. In your ((observability)) project, go to **AIOps****Anomaly detection**.
1. In the list of anomaly detection jobs, find the job you want to check for anomalies.
Haven't created a job yet? <DocLink id="serverlessObservabilityAiopsDetectAnomalies" text="Create one now" />.
Haven't created a job yet? <DocLink slug="/serverless/observability/aiops-detect-anomalies" text="Create one now" />.
1. From the **Actions** menu next to the job, select **Create alert rule**.
1. Specify a name and optional tags for the rule. You can use these tags later to filter alerts.
1. Verify that the correct job is selected and configure the alert details:
Expand Down Expand Up @@ -93,7 +92,7 @@ The following connectors are available when defining actions for alerting rules:

<Connectors />

For more information on creating connectors, refer to <DocLink id="serverlessActionConnectors">Connectors</DocLink>.
For more information on creating connectors, refer to <DocLink slug="/serverless/action-connectors">Connectors</DocLink>.

</DocAccordion>

Expand Down
9 changes: 4 additions & 5 deletions docs/en/serverless/alerting/alerting.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityAlerting
slug: /serverless/observability/alerting
title: Alerting
description: Get alerts based on rules you define for detecting complex conditions in your applications and services.
Expand All @@ -14,7 +13,7 @@ Alerting enables you to define _rules_, which detect complex conditions within d

Alerting works by running checks on a schedule to detect conditions defined by a rule. You can define rules at different levels (service, environment, transaction) or use custom KQL queries. When a condition is met, the rule tracks it as an _alert_ and responds by triggering one or more _actions_.

Actions typically involve interaction with Elastic services or third-party integrations. <DocLink id="serverlessObservabilitySendCasesToAnExternalSystem" text="Connectors"/> enable actions to talk to these services and integrations.
Actions typically involve interaction with Elastic services or third-party integrations. <DocLink slug="/serverless/observability/send-cases-to-an-external-system" text="Connectors"/> enable actions to talk to these services and integrations.

Once you've defined your rules, you can monitor any alerts triggered by these rules in real time, with detailed dashboards that help you quickly identify and troubleshoot any issues that may arise. You can also extend your alerts with notifications via services or third-party incident management systems.

Expand All @@ -24,9 +23,9 @@ On the **Alerts** page, the Alerts table provides a snapshot of alerts occurring

![Summary of Alerts on the ((observability)) overview page](../images/observability-alerts-overview.png)

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 <DocIcon type="boxesHorizontal" title="action menu" />, or click the Reason link for any alert to <DocLink id="serverlessObservabilityViewAlerts" text="view alert"/> in detail, and you can then either **View in app** or **View rule details**.
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 <DocIcon type="boxesHorizontal" title="action menu" />, or click the Reason link for any alert to <DocLink slug="/serverless/observability/view-alerts" text="view alert"/> in detail, and you can then either **View in app** or **View rule details**.

## Next steps

* <DocLink id="serverlessObservabilityCreateRules" Create and manage rules/>
* <DocLink id="serverlessObservabilityViewAlerts" View alerts/>
* <DocLink slug="/serverless/observability/create-manage-rules" Create and manage rules/>
* <DocLink slug="/serverless/observability/view-alerts" View alerts/>
3 changes: 1 addition & 2 deletions docs/en/serverless/alerting/create-anomaly-alert-rule.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityCreateAnomalyAlertRule
slug: /serverless/observability/create-anomaly-alert-rule
title: Create an APM anomaly rule
description: Get alerts when either the latency, throughput, or failed transaction rate of a service is abnormal.
Expand Down Expand Up @@ -47,7 +46,7 @@ The following connectors are available when defining actions for alerting rules:

<Connectors />

For more information on creating connectors, refer to <DocLink id="serverlessActionConnectors">Connectors</DocLink>.
For more information on creating connectors, refer to <DocLink slug="/serverless/action-connectors">Connectors</DocLink>.

</DocAccordion>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityCreateCustomThresholdAlertRule
slug: /serverless/observability/create-custom-threshold-alert-rule
title: Create a custom threshold rule
description: Get alerts when an Observability data type reach a given value.
Expand Down Expand Up @@ -44,7 +43,7 @@ Set the conditions for the rule to detect using aggregations, an equation, and a
Aggregations summarize your data to make it easier to analyze.
Set any of the following aggregation types to gather data to create your rule:
`Average`, `Max`, `Min`, `Cardinality`, `Count`, `Sum,` `Percentile`, or `Rate`.
For more information about these options, refer to <DocLink id="serverlessObservabilityAggregationOptions" />.
For more information about these options, refer to <DocLink slug="/serverless/observability/aggregationOptions" />.

For example, to gather the total number of log documents with a log level of `warn`:

Expand Down Expand Up @@ -125,7 +124,7 @@ The following connectors are available when defining actions for alerting rules:

<Connectors />

For more information on creating connectors, refer to <DocLink id="serverlessActionConnectors">Connectors</DocLink>.
For more information on creating connectors, refer to <DocLink slug="/serverless/action-connectors">Connectors</DocLink>.

</DocAccordion>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityCreateElasticsearchQueryRule
slug: /serverless/observability/create-elasticsearch-query-rule
title: Create an Elasticsearch query rule
description: Get alerts when matches are found during the latest query run.
Expand Down Expand Up @@ -125,7 +124,7 @@ The following connectors are available when defining actions for alerting rules:

<Connectors />

For more information on creating connectors, refer to <DocLink id="serverlessActionConnectors">Connectors</DocLink>.
For more information on creating connectors, refer to <DocLink slug="/serverless/action-connectors">Connectors</DocLink>.

</DocAccordion>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
id: serverlessObservabilityCreateErrorCountThresholdAlertRule
slug: /serverless/observability/create-error-count-threshold-alert-rule
title: Create an error count threshold rule
description: Get alerts when the number of errors in a service exceeds a defined threshold.
Expand Down Expand Up @@ -49,7 +48,7 @@ The following connectors are available when defining actions for alerting rules:

<Connectors />

For more information on creating connectors, refer to <DocLink id="serverlessActionConnectors">Connectors</DocLink>.
For more information on creating connectors, refer to <DocLink slug="/serverless/action-connectors">Connectors</DocLink>.

</DocAccordion>

Expand Down
Loading

0 comments on commit 3fe8088

Please sign in to comment.