Skip to content

Commit f955527

Browse files
mergify[bot]dedemortongithub-actions[bot]
authored
[8.17](backport #4582) Update quickstarts for 8.16 (#4592)
* Update quickstarts for 8.16 (#4582) * Update quickstarts for 8.16 * Add preview tag to aws firehose quickstart (cherry picked from commit 9afec56) * Delete docs/en/serverless directory --------- Co-authored-by: DeDe Morton <dede.morton@elastic.co> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 7063143 commit f955527

9 files changed

+34
-35
lines changed
-65.1 KB
Binary file not shown.
161 KB
Loading
22.1 KB
Loading
-239 KB
Loading
156 KB
Loading

docs/en/observability/quickstarts/collect-data-with-aws-firehose.asciidoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,17 @@ You can use an AWS CLI command or upload the template to the AWS CloudFormation
4747
* `FirehoseStreamNameForLogs`: Name for Amazon Data Firehose Stream for collecting CloudWatch logs. Default is `elastic-firehose-logs`.
4848
====
4949

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

53-
Data collection with AWS Firehose is supported on ESS deployments in AWS, Azure and GCP.
53+
Data collection with AWS Firehose is supported on ESS deployments in AWS, Azure and GCP.
5454

5555
[discrete]
5656
== Prerequisites
5757

5858
* A deployment using our hosted {ess} on {ess-trial}[{ecloud}]. The deployment includes an {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data.
5959
* A user with the `superuser` {ref}/built-in-roles.html[built-in role] or the privileges required to onboard data.
60-
+
60+
+
6161
[%collapsible]
6262
.Expand to view required privileges
6363
====
@@ -75,16 +75,16 @@ NOTE: The default CloudFormation stack is created in the AWS region selected for
7575
The AWS Firehose receiver has the following limitations:
7676

7777
* It does not support AWS PrivateLink.
78-
* It is not available for on-premise Elastic Stack deployments.
79-
* The CloudFormation template detects and ingests logs and metrics within a single AWS region only.
78+
* It is not available for on-premise Elastic Stack deployments.
79+
* The CloudFormation template detects and ingests logs and metrics within a single AWS region only.
8080

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

8383
|===
84-
| AWS Service | Data type
84+
| AWS Service | Data type
8585

86-
| VPC Flow Logs |Logs
87-
| API Gateway|Logs, Metrics
86+
| VPC Flow Logs |Logs
87+
| API Gateway|Logs, Metrics
8888
| CloudTrail | Logs
8989
| Network Firewall | Logs, Metrics
9090
| Route53 | Logs
@@ -113,9 +113,9 @@ The following table shows the type of data ingested by the supported AWS service
113113
[discrete]
114114
== Collect your data
115115

116-
. In {kib}, go to **Observability** and click **Add Data**.
116+
. In {kib}, go to the **Observability** UI and click **Add Data**.
117117

118-
. Select **Cloud**, **AWS**, and then select **AWS Firehose**.
118+
. Under **What do you want to monitor?** select **Cloud**, **AWS**, and then select **AWS Firehose**.
119119
+
120120
[role="screenshot"]
121121
image::images/quickstart-aws-firehose-entry-point.png[AWS Firehose entry point]

docs/en/observability/quickstarts/monitor-hosts-with-elastic-agent.asciidoc

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
[[quickstart-monitor-hosts-with-elastic-agent]]
22
= Quickstart: Monitor hosts with {agent}
33

4-
preview::[]
5-
64
In this quickstart guide, you'll learn how to scan your host to detect and collect logs and metrics,
75
then navigate to dashboards to further analyze and explore your observability data.
86
You'll also learn how to get value out of your observability data.
@@ -15,7 +13,7 @@ The script also generates an {agent} configuration file that you can use with yo
1513
[discrete]
1614
== Prerequisites
1715

18-
* A deployment using our hosted {ess} on {ess-trial}[{ecloud}]. The deployment includes an {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data.
16+
* An {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data. This quickstart is available for all Elastic deployment models. To get started quickly, try out our hosted {ess} on {ess-trial}[{ecloud}].
1917
* A user with the `superuser` {ref}/built-in-roles.html[built-in role] or the privileges required to onboard data.
2018
+
2119
[%collapsible]
@@ -30,23 +28,21 @@ The script also generates an {agent} configuration file that you can use with yo
3028
[discrete]
3129
== Limitations
3230

33-
* The auto-detection script currently scans for metrics and logs from Apache, Docker, Nginx, and the host system.
34-
It also scans for custom log files.
3531
* The auto-detection script works on Linux and MacOS only. Support for the `lsof` command is also required if you want to detect custom log files.
3632
* If you've installed Apache or Nginx in a non-standard location, you'll need to specify log file paths manually when you run the scan.
3733
* Because Docker Desktop runs in a VM, its logs are not auto-detected.
3834

3935
[discrete]
4036
== Collect your data
4137

42-
. Go to the **Observability** UI and click **Add Data**.
43-
. Select **Collect and analyze logs**, and then select **Auto-detect logs and metrics**.
44-
. Copy the command that's shown. For example:
38+
. In {kib}, go to the **Observability** UI and click **Add Data**.
39+
. Under **What do you want to monitor?** select **Host**, and then select **Elastic Agent: Logs & Metrics**.
4540
+
4641
[role="screenshot"]
47-
image::images/quickstart-autodetection-command.png[Quick start showing command for running auto-detection]
42+
image::images/quickstart-monitor-hosts-entry-point.png[Host monitoring entry point]
43+
. Copy the install command.
4844
+
49-
You'll run this command to download the auto-detection script and scan your system for observability data.
45+
You'll run this command to download the auto-detection script, scan your system for observability data, and install {agent}.
5046
. Open a terminal on the host you want to scan, and run the command.
5147
. Review the list of log files:
5248
* Enter `Y` to ingest all the log files listed.
@@ -59,6 +55,7 @@ There might be a slight delay before logs and other data are ingested.
5955
*****
6056
**Need to scan your host again?**
6157
58+
The auto-detection script (`auto_detect.sh`) is downloaded to the directory where you ran the installation command.
6259
You can re-run the script on the same host to detect additional logs.
6360
The script will scan the host and reconfigure {agent} with any additional logs that are found.
6461
If the script misses any custom logs, you can add them manually by entering `n` after the script has finished scanning the host.
@@ -75,23 +72,27 @@ the page may link to the following integration assets:
7572
|====
7673
| Integration asset | Description
7774

78-
| **System**
79-
| Prebuilt dashboard for monitoring host status and health using system metrics.
80-
8175
| **Apache**
8276
| Prebuilt dashboard for monitoring Apache HTTP server health using error and access log data.
8377

78+
| **Custom .log files**
79+
| Logs Explorer for analyzing custom logs.
8480

8581
| **Docker**
8682
| Prebuilt dashboard for monitoring the status and health of Docker containers.
8783

84+
| **MySQL**
85+
| Prebuilt dashboard for monitoring MySQl server health using error and access log data.
8886

8987
| **Nginx**
9088
| Prebuilt dashboard for monitoring Nginx server health using error and access log data.
9189

90+
| **System**
91+
| Prebuilt dashboard for monitoring host status and health using system metrics.
9292

93-
| **Custom .log files**
94-
| Logs Explorer for analyzing custom logs.
93+
| **Other prebuilt dashboards**
94+
| Prebuilt dashboards are also available for systems and services not described here,
95+
including PostgreSQL, Redis, HAProxy, Kafka, RabbitMQ, Prometheus, Apache Tomcat, and MongoDB.
9596
|====
9697

9798
For example, you can navigate the **Host overview** dashboard to explore detailed metrics about system usage and throughput.

docs/en/observability/quickstarts/monitor-k8s-logs-metrics.asciidoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
[[monitor-k8s-logs-metrics-with-elastic-agent]]
22
= Quickstart: Monitor your Kubernetes cluster with {agent}
33

4-
preview::[]
5-
64
In this quickstart guide, you'll learn how to create the Kubernetes resources that are required to monitor your cluster infrastructure.
75

86
This new approach requires minimal configuration and provides you with an easy setup to monitor your infrastructure. You no longer need to download, install, or configure the Elastic Agent, everything happens automatically when you run the kubectl command.
@@ -12,7 +10,7 @@ The kubectl command installs the standalone Elastic Agent in your Kubernetes clu
1210
[discrete]
1311
== Prerequisites
1412

15-
* A deployment using our hosted {ess} on {ess-trial}[{ecloud}]. The deployment includes an {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data.
13+
* An {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data. This quickstart is available for all Elastic deployment models. To get started quickly, try out our hosted {ess} on {ess-trial}[{ecloud}].
1614
* A user with the `superuser` {ref}/built-in-roles.html[built-in role] or the privileges required to onboard data.
1715
+
1816
[%collapsible]
@@ -28,9 +26,9 @@ The kubectl command installs the standalone Elastic Agent in your Kubernetes clu
2826
[discrete]
2927
== Collect your data
3028

31-
. Go to the **Observability** UI and click **Add Data**.
29+
. In {kib}, go to the **Observability** UI and click **Add Data**.
3230

33-
. Select **Monitor infrastructure**, and then select **Kubernetes**.
31+
. Under **What do you want to monitor?** select **Kubernetes**, and then select **Elastic Agent: Logs & Metrics**.
3432
+
3533
[role="screenshot"]
3634
image::images/quickstart-k8s-entry-point.png[Kubernetes entry point]

docs/en/observability/quickstarts/monitor-k8s-otel.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
preview::[]
55

6-
In this quickstart guide, you will learn how to send Kubernetes logs, metrics, and application traces to Elasticsearch, using the https://github.com/open-telemetry/opentelemetry-operator/[OpenTelemetry Operator] to orchestrate https://github.com/elastic/opentelemetry/tree/main[Elastic Distributions of OpenTelemetry] (EDOT) Collectors and SDK instances.
6+
In this quickstart guide, you'll learn how to send Kubernetes logs, metrics, and application traces to Elasticsearch, using the https://github.com/open-telemetry/opentelemetry-operator/[OpenTelemetry Operator] to orchestrate https://github.com/elastic/opentelemetry/tree/main[Elastic Distributions of OpenTelemetry] (EDOT) Collectors and SDK instances.
77

88
All the components will be deployed through the https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack[opentelemetry-kube-stack] helm chart. They include:
99

@@ -17,7 +17,7 @@ For a more detailed description of the components and advanced configuration, re
1717
[discrete]
1818
== Prerequisites
1919

20-
* A deployment using our hosted {ess} on {ess-trial}[{ecloud}]. The deployment includes an {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data.
20+
* An {es} cluster for storing and searching your data, and {kib} for visualizing and managing your data. This quickstart is available for all Elastic deployment models. To get started quickly, try out our hosted {ess} on {ess-trial}[{ecloud}].
2121
* A running Kubernetes cluster (v1.23 or newer).
2222
* https://kubernetes.io/docs/reference/kubectl/[Kubectl].
2323
* https://helm.sh/docs/intro/install/[Helm].
@@ -26,9 +26,9 @@ For a more detailed description of the components and advanced configuration, re
2626
[discrete]
2727
== Collect your data
2828

29-
. In {kib}, go to the **Observability** UI and click **Add Data**.
29+
. In {kib}, go to the **Observability** UI and click **Add Data**.
3030

31-
. Under *`What do you want to monitor?`*, select **Kubernetes**, and then select the **OpenTelemetry: Full Observability** option.
31+
. Under **What do you want to monitor?** select **Kubernetes**, and then select **OpenTelemetry: Full Observability**.
3232
+
3333
[role="screenshot"]
3434
image::images/quickstart-k8s-otel-entry-point.png[Kubernetes-OTel entry point]
@@ -41,7 +41,7 @@ The default installation deploys the OpenTelemetry Operator with a self-signed T
4141
====
4242
+
4343
Deploy the OpenTelemetry Operator and EDOT Collectors using the kube-stack Helm chart with the provided `values.yaml` file. You will run a few commands to:
44-
+
44+
+
4545
* Add the helm chart repository needed for the installation.
4646
* Create a namespace.
4747
* Create a secret with an API Key and the {es} endpoint to be used by the collectors.

0 commit comments

Comments
 (0)