Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply IA changes to serverless docs #4532

Merged
merged 4 commits into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion docs/en/observability/create-alerts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Alerting enables you to detect complex conditions defined by a *rule*
within the Applications, Logs, Infrastructure, Synthetics, and Uptime UIs. When a condition is met, the rule
tracks it as an *alert* and responds by triggering one or more *actions*.

Alerts and rules related to service level objectives (SLOs), and {observability} apps, including Applications, Logs, Infrastructure, Synthetics, and Uptime, can be managed in the {observability} UI.
Alerts and rules related to service-level objectives (SLOs), and {observability} apps, including Applications, Logs, Infrastructure, Synthetics, and Uptime, can be managed in the {observability} UI.
You can also manage {observability} app rules alongside rules for other apps from the {kibana-ref}/create-and-manage-rules.html[{kib} Management UI].

[discrete]
Expand Down
6 changes: 1 addition & 5 deletions docs/en/observability/slo-overview.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
[[slo]]
= SLOs

++++
<titleabbrev>Service-level objectives (SLOs)</titleabbrev>
++++
= Service-level objectives (SLOs)

// tag::slo-license[]
[IMPORTANT]
Expand Down
2 changes: 1 addition & 1 deletion docs/en/serverless/ai-assistant/ai-assistant.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[observability-ai-assistant]]
= AI Assistant
= {observability} AI Assistant

// :keywords: serverless, observability, overview

Expand Down
17 changes: 17 additions & 0 deletions docs/en/serverless/application-and-service-monitoring.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[[application-and-service-monitoring]]
= Application and service monitoring

++++
<titleabbrev>Applications and services</titleabbrev>
++++

Explore the topics in this section to learn how to observe and monitor software applications and services running in your environment.

[cols="1,1"]
|===
|<<observability-apm>>
|Monitor software services and applications in real time, by collecting detailed performance information on response time for incoming requests, database queries, calls to caches, external HTTP requests, and more.

|<<observability-monitor-synthetics>>
|Monitor the availability of network endpoints and services.
|===
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[observability-dashboards]]
= Dashboards
= Get started with dashboards

// :description: Visualize your observability data using pre-built dashboards or create your own.
// :keywords: serverless, observability, overview
Expand Down
21 changes: 21 additions & 0 deletions docs/en/serverless/images/get-started.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/en/serverless/incident-management.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[[incident-management]]
= Incident management

Explore the topics in this section to learn how to respond to incidents detected in your {observability} data.


[cols="1,1"]
|===
|<<observability-alerting>>
|Trigger alerts when incidents occur, and use built-in connectors to send the alerts to email, slack, or other third-party systems, such as your external incident management application.

|<<observability-cases>>
|Collect and share information about {observability} issues by opening cases and optionally sending them to your external incident management application.

|<<observability-slos>>
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
|Set clear, measurable targets for your service performance, based on factors like availability, response times, error rates, and other key metrics.
|===


300 changes: 181 additions & 119 deletions docs/en/serverless/index.asciidoc

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[observability-infrastructure-monitoring]]
= Infrastructure monitoring
= Analyze infrastructure and host metrics

// :description: Monitor metrics from your servers, Docker, Kubernetes, Prometheus, and other services and applications.
// :keywords: serverless, observability, overview
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[[infrastructure-and-host-monitoring-intro]]
= Infrastructure and host monitoring

++++
<titleabbrev>Infrastructure and hosts</titleabbrev>
++++

Explore the topics in this section to learn how to observe and monitor hosts and other systems running in your environment.

[cols="1,1"]
|===
|<<observability-infrastructure-monitoring>>
|Visualize infrastructure metrics to help diagnose problematic spikes, identify high resource utilization, automatically discover and track pods, and unify your metrics with other observability data.

|<<observability-troubleshooting-infrastructure-monitoring>>
|Troubleshoot common issues on your own or ask for help.

|<<observability-metrics-reference>>
|Learn about the key metrics displayed in the Infrastructure UI and how they are calculated.
|===
4 changes: 4 additions & 0 deletions docs/en/serverless/logging/log-monitoring.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
[[observability-log-monitoring]]
= Log monitoring

++++
<titleabbrev>Logs</titleabbrev>
++++

// :description: Use Elastic to deploy and manage logs at a petabyte scale, and get insights from your logs in minutes.
// :keywords: serverless, observability, overview

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
[[observability-aiops]]
= AIOps
[[observability-machine-learning]]
= Machine learning and AIOps

++++
<titleabbrev>Machine learning</titleabbrev>
++++

// :description: Automate anomaly detection and accelerate root cause analysis with AIOps.
// :keywords: serverless, observability, overview

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.
The machine learning 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
4 changes: 4 additions & 0 deletions docs/en/serverless/monitor-datasets.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
[[observability-monitor-datasets]]
= Data set quality monitoring

++++
<titleabbrev>Data set quality</titleabbrev>
++++

// :description: Monitor data sets to find degraded documents.
// :keywords: serverless, observability, how-to

Expand Down
78 changes: 78 additions & 0 deletions docs/en/serverless/observability-get-started.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
[[observability-get-started]]
= Get started with Elastic Observability

++++
<titleabbrev>Get started</titleabbrev>
++++

New to Elastic {observability}? Discover more about our observability features and how to get started.

[discrete]
== Learn about Elastic {observability}

Learn about key features available to help you get value from your observability data and what it will cost you:

* <<observability-serverless-observability-overview>>
* <<observability-billing>>

[discrete]
[[get-started-with-use-case]]
== Get started with your use case

Learn how to create an Observability project and use Elastic
Observability to gain deeper insight into the behavior of your applications and
systems.

image::images/get-started.svg[]

1. **Choose your source.** Elastic integrates with hundreds of data sources for
unified visibility across all your applications and systems.

2. **Ingest your data.** Turn-key integrations provide a repeatable workflow to
ingest data from all your sources: you install an integration, configure it, and
deploy an agent to collect your data.

3. **View your data.** Navigate seamlessly between Observabilty UIs and
dashboards to identify and resolve problems quickly.

4. **Customize.** Expand your deployment and add features like alerting and anomaly
detection.

To get started, <<observability-create-an-observability-project,create an Observability project>>,
then follow one of our <<quickstarts-overview,quickstarts>> to learn how to ingest and visualize your observability data.

[discrete]
[[quickstarts-overview]]
=== Quickstarts

Our quickstarts dramatically reduce your time-to-value by offering a fast path to ingest and visualize your Observability data.
Each quickstart provides:

* A highly opinionated, fast path to data ingestion
* Sensible configuration defaults with minimal configuration required
* Auto-detection of logs and metrics for monitoring hosts
* Quick access to related dashboards and visualizations

Follow the steps in these guides to get started quickly:

* <<observability-quickstarts-monitor-hosts-with-elastic-agent>>
* <<observability-quickstarts-k8s-logs-metrics>>
* <<collect-data-with-aws-firehose>>

[discrete]
=== Get started with other features

Want to use {fleet} or some other feature not covered in the quickstarts?
Follow the steps in these guides to get started:

* <<observability-get-started-with-logs,Get started with system metrics>>
* <<observability-apm-get-started,Get started with application traces and APM>>
* <<observability-synthetics-get-started,Get started with synthetic monitoring>>

[discrete]
== Additional guides

Ready to dig into more features of Elastic Observability? See these guides:

* <<observability-alerting>>
* <<observability-slos>>
4 changes: 2 additions & 2 deletions docs/en/serverless/observability-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ image::images/cases.png[Screenshot showing list of cases]

[discrete]
[[observability-serverless-observability-overview-aiops]]
== AIOps
== Machine learning and AIOps

Reduce the time and effort required to detect, understand, investigate, and resolve incidents at scale
by leveraging predictive analytics and machine learning:
Expand All @@ -146,4 +146,4 @@ by leveraging predictive analytics and machine learning:
[role="screenshot"]
image::images/log-rate-analysis.png[Log rate analysis page showing log rate spike ]

<<observability-aiops,Learn more about AIOps →>>
<<observability-machine-learning,Learn more about machine learning and AIOps →>>
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
[[collect-data-with-aws-firehose]]
= Collect data with AWS Firehose

preview::[]
= Quickstart: Collect data with AWS Firehose

In this quickstart guide, you'll learn how to use AWS Firehose to send logs and metrics to Elastic.

Expand Down Expand Up @@ -47,10 +45,10 @@ You can use an AWS CLI command or upload the template to the AWS CloudFormation
* `FirehoseStreamNameForLogs`: Name for Amazon Data Firehose Stream for collecting CloudWatch logs. Default is `elastic-firehose-logs`.
====

IMPORTANT: Some AWS services need additional manual configuration to properly ingest logs and metrics. For more information, check the
IMPORTANT: Some AWS services need additional manual configuration to properly ingest logs and metrics. For more information, check the
link:https://www.elastic.co/docs/current/integrations/aws[AWS integration] documentation.

Data collection with AWS Firehose is supported on Amazon Web Services.
Data collection with AWS Firehose is supported on Amazon Web Services.

[discrete]
== Prerequisites
Expand All @@ -66,16 +64,16 @@ NOTE: The default CloudFormation stack is created in the AWS region selected for

The AWS Firehose receiver has the following limitations:

* It does not support AWS PrivateLink.
* The CloudFormation template detects and ingests logs and metrics within a single AWS region only.
* It does not support AWS PrivateLink.
* The CloudFormation template detects and ingests logs and metrics within a single AWS region only.

The following table shows the type of data ingested by the supported AWS services:

|===
| AWS Service | Data type
| AWS Service | Data type

| VPC Flow Logs |Logs
| API Gateway|Logs, Metrics
| VPC Flow Logs |Logs
| API Gateway|Logs, Metrics
| CloudTrail | Logs
| Network Firewall | Logs, Metrics
| Route53 | Logs
Expand Down
2 changes: 1 addition & 1 deletion docs/en/serverless/quickstarts/k8s-logs-metrics.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[observability-quickstarts-k8s-logs-metrics]]
= Monitor your Kubernetes cluster with Elastic Agent
= Quickstart: Monitor your Kubernetes cluster with Elastic Agent

// :description: Learn how to monitor your cluster infrastructure running on Kubernetes.
// :keywords: serverless, observability, how-to
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[observability-quickstarts-monitor-hosts-with-elastic-agent]]
= Monitor hosts with {agent}
= Quickstart: Monitor hosts with {agent}

// :description: Learn how to scan your hosts to detect and collect logs and metrics.
// :keywords: serverless, observability, how-to
Expand Down Expand Up @@ -117,7 +117,7 @@ You can also:
** <<observability-monitor-datasets,Monitor log data set quality>> to find degraded documents.
** <<observability-run-log-pattern-analysis,Run a pattern analysis>> to find patterns in unstructured log messages.
** <<observability-alerting,Create alerts>> that notify you when an Observability data type reaches or exceeds a given value.
* Use <<observability-aiops,AIOps features>> to apply predictive analytics and machine learning to your data:
* Use <<observability-machine-learning,machine learning and AIOps features>> to apply predictive analytics and machine learning to your data:
+
** <<observability-aiops-detect-anomalies,Detect anomalies>> by comparing real-time and historical data from different sources to look for unusual, problematic patterns.
** <<observability-aiops-analyze-spikes,Analyze log spikes and drops>>.
Expand Down
21 changes: 0 additions & 21 deletions docs/en/serverless/quickstarts/overview.asciidoc

This file was deleted.

5 changes: 5 additions & 0 deletions docs/en/serverless/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,8 @@ The following pages have moved or been deleted.
=== Technical preview limitations

Refer to <<observability-limitations,Limitations>>.

[role="exclude",id="observability-aiops"]
=== AIOps

Refer to <<observability-machine-learning>>.
7 changes: 7 additions & 0 deletions docs/en/serverless/reference.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[[reference]]
= Reference

This section contains reference information related to using Elastic {observability}.

* <<observability-infrastructure-monitoring-required-fields>>
* <<observability-elastic-entity-model>>
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The Elastic Entity Model currently supports the <<observability-inventory,new in

:role: Admin
:goal: enable the Elastic Entity Model
include::./partials/roles.asciidoc[]
include::../partials/roles.asciidoc[]
:role!:

:goal!:
Expand All @@ -42,7 +42,7 @@ You can enable the Elastic Entity Model from the new <<observability-inventory,I

:role: Admin
:goal: enable the Elastic Entity Model
include::./partials/roles.asciidoc[]
include::../partials/roles.asciidoc[]
:role!:

:goal!:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[observability-infrastructure-monitoring-required-fields]]
= Required fields
= Infrastructure app fields

// :description: Learn about the fields required to display data in the Infrastructure UI.
// :keywords: serverless, observability, reference
Expand Down
4 changes: 2 additions & 2 deletions docs/en/serverless/slos/slos.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[observability-slos]]
= SLOs
= Service-level objectives (SLOs)

// :description: Set clear, measurable targets for your service performance with service-level objectives (SLOs).
// :keywords: serverless, observability, overview

Service-level objectives (SLOs) allow you to set clear, measurable targets for your service performance, based on factors like availability, response times, error rates, and other key metrics.
SLOs allow you to set clear, measurable targets for your service performance, based on factors like availability, response times, error rates, and other key metrics.
You can define SLOs based on different types of data sources, such as custom KQL queries and APM latency or availability data.

Once you've defined your SLOs, you can monitor them in real time, with detailed dashboards and alerts that help you quickly identify and troubleshoot any issues that may arise.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ While in technical preview, Elastic Observability serverless projects should not
[discrete]
== Get started

* <<observability-quickstarts-overview,*Quickstarts*>>: Learn how to ingest your observability data and get immediate value.
* <<observability-get-started,*Get started*>>: Discover more about our observability features and how to get started.
* <<observability-quickstarts-monitor-hosts-with-elastic-agent,*Quickstart: Monitor hosts with Elastic Agent*>>: Scan your host to detect and collect logs and metrics.
* <<observability-quickstarts-k8s-logs-metrics,*Quickstart: Monitor your Kubernetes cluster with Elastic Agent*>>: Create the Kubernetes resources that are required to monitor your cluster infrastructure.
* <<observability-get-started-with-logs,*Get started with Logs*>>: Add your log data to Elastic Observability and start exploring your logs.
* <<observability-apm-get-started,*Get started with traces and APM*>>: Collect Application Performance Monitoring (APM) data and visualize it in real time.
* <<observability-get-started-with-metrics,*Get started with metrics*>>: Add your metrics data to Elastic Observability and visualize it in real time.
Expand Down