diff --git a/docs/en/serverless/images/quickstart-autodetection-command.png b/docs/en/serverless/images/quickstart-autodetection-command.png new file mode 100644 index 0000000000..8ee8386567 Binary files /dev/null and b/docs/en/serverless/images/quickstart-autodetection-command.png differ diff --git a/docs/en/serverless/images/quickstart-host-overview.png b/docs/en/serverless/images/quickstart-host-overview.png new file mode 100644 index 0000000000..bf94de5fe6 Binary files /dev/null and b/docs/en/serverless/images/quickstart-host-overview.png differ diff --git a/docs/en/serverless/images/quickstart-k8s-entry-point.png b/docs/en/serverless/images/quickstart-k8s-entry-point.png new file mode 100644 index 0000000000..6a00630071 Binary files /dev/null and b/docs/en/serverless/images/quickstart-k8s-entry-point.png differ diff --git a/docs/en/serverless/images/quickstart-k8s-overview.png b/docs/en/serverless/images/quickstart-k8s-overview.png new file mode 100644 index 0000000000..1adab9b752 Binary files /dev/null and b/docs/en/serverless/images/quickstart-k8s-overview.png differ diff --git a/docs/en/serverless/quickstarts/k8s-logs-metrics.mdx b/docs/en/serverless/quickstarts/k8s-logs-metrics.mdx new file mode 100644 index 0000000000..ccbd826157 --- /dev/null +++ b/docs/en/serverless/quickstarts/k8s-logs-metrics.mdx @@ -0,0 +1,48 @@ +--- +slug: /serverless/observability/quickstarts/k8s-logs-metrics +title: Monitor your Kubernetes cluster with Elastic Agent +description: Learn how to monitor your cluster infrastructure running on Kubernetes. +tags: [ 'serverless', 'observability', 'how-to' ] +--- + +

+ +In this quickstart guide, you'll learn how to create the Kubernetes resources that are required to monitor your cluster infrastructure. + +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. + +The kubectl command installs the standalone Elastic Agent in your Kubernetes cluster, downloads all the Kubernetes resources needed to collect metrics from the cluster, and sends it to Elastic. + +## Before you begin + +This quickstart has the following requirements: + +- The **Admin** role or higher is required to onboard system logs and metrics. To learn more, refer to . +- You have a running Kubernetes cluster. +- You have installed [Kubectl](https://kubernetes.io/docs/reference/kubectl/). + +## Collect your data + +1. Create a new ((observability)) project, or open an existing one. +1. In your ((observability)) project, go to **Add Data**. +1. Select **Monitor infrastructure**, and then select **Kubernetes**. + ![Kubernetes entry point](../images/quickstart-k8s-entry-point.png) +1. To install the Elastic Agent on your host, copy and run the install command. + + You will use the kubectl command to download a manifest file, inject user's API key generated by Kibana, and create the Kubernetes resources. + +1. Go back to the **Add Observability Data** page. + There might be a slight delay before data are ingested. When ready, you will see the message **We are monitoring your cluster**. + +1. Click **Explore Kubernetes cluster** to navigate to dashboards and explore your data. + +## Visualize your data + +After installation is complete and all relevant data is flowing into Elastic, +the **Visualize your data** section allows you to access the Kubernetes Cluster Overview dashboard that can be used to monitor the health of the cluster. + +![Kubernetes overview dashboard](../images/quickstart-k8s-overview.png) + +Furthermore, you can access other useful prebuilt dashboards for monitoring Kunernetes resources, for example running pods per namespace, as well as the resources they consume, like CPU and memory. + +Refer to for a description of other useful features. diff --git a/docs/en/serverless/quickstarts/monitor-hosts-with-elastic-agent.mdx b/docs/en/serverless/quickstarts/monitor-hosts-with-elastic-agent.mdx new file mode 100644 index 0000000000..f492d944bd --- /dev/null +++ b/docs/en/serverless/quickstarts/monitor-hosts-with-elastic-agent.mdx @@ -0,0 +1,111 @@ +--- +slug: /serverless/observability/quickstarts/monitor-hosts-with-elastic-agent +title: Monitor hosts with ((agent)) +description: Learn how to scan your hosts to detect and collect logs and metrics. +tags: [ 'serverless', 'observability', 'how-to' ] +--- + +

+ +In this quickstart guide, you'll learn how to scan your host to detect and collect logs and metrics, +then navigate to dashboards to further analyze and explore your observability data. +You'll also learn how to get value out of your observability data. + +To scan your host, you'll run an auto-detection script that downloads and installs ((agent)), +which is used to collect observability data from the host and send it to Elastic. + +The script also generate an ((agent)) configuration file that you can use with your existing Infrastructure-as-Code tooling. + +## Prerequisites and limitations + +This quickstart has the following requirements and limitations: + +- The **Admin** role or higher is required to onboard system logs and metrics. To learn more, refer to . +- Root privileges on the host are required to run the auto-detection script used in this quickstart. +- The auto-detection script currently scans for metrics and logs from Apache, Docker, Nginx, and the host system. + It also scans for custom log files. +- 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. +- 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. +- Because Docker Desktop runs in a VM, its logs are not auto-detected. + +## Detect and collect observability data + +1. Create a new ((observability)) project, or open an existing one. +1. In your ((observability)) project, go to **Add Data**. +1. Select **Collect and analyze logs**, and then select **Auto-detect logs and metrics**. +1. Copy the command that's shown. For example: + ![Quick start showing command for running auto-detection](../images/quickstart-autodetection-command.png) + You'll run this command to download the auto-detection script and scan your system for observability data. +1. Open a terminal on the host you want to scan, and run the command. +1. Review the list of log files: + - Enter `Y` to ingest all the log files listed + - Enter `n` to either exclude log files or specify additional log paths. Enter `Y` to confirm your selections. + + When the script is done, you'll see a message like "((agent)) is configured and running." + +There might be a slight delay before logs and other data are ingested. + + + You can re-run the script on the same host to detect additional logs. + The script will scan the host and reconfigure ((agent)) with any additional logs that are found. + If the script misses any custom logs, you can add them manually by entering `n` after the script has finished scanning the host. + + +## Visualize your data + +After installation is complete and all relevant data is flowing into Elastic, +the **Visualize your data** section will show links to assets you can use to analyze your data. +Depending on what type of observability data was collected, +the page may link to the following integration assets: + + + + **System** + Prebuilt dashboard for monitoring host status and health using system metrics. + + + **Apache** + Prebuilt dashboard for monitoring Apache HTTP server health using error and access log data. + + + **Docker** + Prebuilt dashboard for monitoring the status and health of Docker containers. + + + **Nginx** + Prebuilt dashboard for monitoring Nginx server health using error and access log data. + + + **Custom .log files** + Logs Explorer for analyzing custom logs. + + + +For example, you can navigate the **Host overview** dashboard to explore detailed metrics about system usage and throughput. +Metrics that indicate a possible problem are highlighted in red. + +![Host overview dashboard](../images/quickstart-host-overview.png) + +## Get value out of your data + +After using the dashboards to examine your data and confirm you've ingested all the host logs and metrics you want to monitor, +you can use Elastic ((observability)) to gain deeper insight into your data. + +For host monitoring, the following capabilities and features are recommended: + +- In the Infrastructure UI, analyze and compare data collected from your hosts. +You can also: + - Detect anomalies for memory usage and network traffic on hosts. + - Create alerts that notify you when an anomaly is detected or a metric exceeds a given value. +- In the Logs Explorer, search and filter your log data, +get information about the structure of log fields, and display your findings in a visualization. +You can also: + - Monitor log data set quality to find degraded documents. + - Run a pattern analysis to find patterns in unstructured log messages. + - Create alerts that notify you when an Observability data type reaches or exceeds a given value. +- Use AIOps features to apply predictive analytics and machine learning to your data: + - Detect anomalies by comparing real-time and historical data from different sources to look for unusual, problematic patterns. + - Analyze log spikes and drops. + - Detect change points in your time series data. + +Refer to for a description of other useful features. diff --git a/docs/en/serverless/quickstarts/overview.mdx b/docs/en/serverless/quickstarts/overview.mdx new file mode 100644 index 0000000000..970addc46f --- /dev/null +++ b/docs/en/serverless/quickstarts/overview.mdx @@ -0,0 +1,20 @@ +--- +slug: /serverless/observability/quickstarts/overview +title: Quickstarts +description: Learn how to ingest your observability data and get immediate value. +tags: [ 'serverless', 'observability', 'how-to' ] +--- + +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 + +## Available quickstarts + +- +- + diff --git a/docs/en/serverless/serverless-observability.docnav.json b/docs/en/serverless/serverless-observability.docnav.json index 0afbbd8ceb..bf49c5de0a 100644 --- a/docs/en/serverless/serverless-observability.docnav.json +++ b/docs/en/serverless/serverless-observability.docnav.json @@ -10,6 +10,17 @@ "classic-sources": [ "enObservabilityObservabilityIntroduction" ], "classic-skip": true }, + { + "slug": "/serverless/observability/quickstarts/overview", + "items": [ + { + "slug": "/serverless/observability/quickstarts/monitor-hosts-with-elastic-agent" + }, + { + "slug": "/serverless/observability/quickstarts/k8s-logs-metrics" + } + ] + }, { "slug": "/serverless/observability/observability-billing" }, diff --git a/docs/en/serverless/what-is-observability-serverless.mdx b/docs/en/serverless/what-is-observability-serverless.mdx index ea58e5b981..930bee10ab 100644 --- a/docs/en/serverless/what-is-observability-serverless.mdx +++ b/docs/en/serverless/what-is-observability-serverless.mdx @@ -22,6 +22,11 @@ layout: landing sectionTitle="Get started" items={ [ + { + "title": "Quickstarts", + slug: "/serverless/observability/quickstarts/overview", + "description": "Learn how to ingest your observability data and get immediate value.", + }, { "title": "Get started with Logs", slug: "/serverless/observability/get-started-with-logs",