Doc: Add monitoring for serverless (#15636) (#15796)

(cherry picked from commit 968fb24450)

Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com>
This commit is contained in:
github-actions[bot] 2024-01-11 16:40:58 -05:00 committed by GitHub
parent c5acb696bd
commit f43ea43aec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 86 additions and 7 deletions

View file

@ -11,18 +11,24 @@ Plus you have the option to manage all of your monitoring agents from a central
types of data to a host. Each agent has a single policy you can update to add
integrations for new data sources, security protections, and more.
You can use {agent} to collect monitoring data for:
You can use {agent} to collect {ls} monitoring data on:
* <<dashboard-monitoring-with-elastic-agent,Dashboards>>. {agent} collects
* <<dashboard-monitoring-with-elastic-agent,{ecloud} or self-managed dashboards>>. +
{agent} collects
monitoring data from your {ls} instance, sends it directly to your monitoring
cluster, and shows the data in {ls} dashboards.
{ls} dashboards include an extended range of metrics, including plugin
drilldowns, and plugin specific dashboards for the dissect filter, the grok filter, and the elasticsearch output.
* <<monitoring-with-elastic-agent,{stack} monitoring>>. Use the Elastic Stack monitoring features to gain insight into the health of {ls} instances running in your environment.
* <<serverless-monitoring-with-elastic-agent,{ecloud} dashboards (serverless)>>. +
{agent} collects
monitoring data from your {ls} instance, sends it to
https://docs.elastic.co/serverless[Elastic serverless],
and shows the data in {ls} dashboards in https://docs.elastic.co/serverless/observability/what-is-observability-serverless[Elastic Observability].
{ls} dashboards include an extended range of metrics, including plugin
drilldowns, and plugin specific dashboards for the dissect filter, the grok filter, and the elasticsearch output.
* <<monitoring-with-elastic-agent,{stack} monitoring>>. +
Use the Elastic Stack monitoring features to gain insight into the health of {ls} instances running in your environment.
include::monitoring-ea-dashboards.asciidoc[]
include::monitoring-ea-serverless.asciidoc[]
include::monitoring-ea.asciidoc[]

View file

@ -0,0 +1,73 @@
[[serverless-monitoring-with-elastic-agent]]
=== Collect {ls} monitoring data for dashboards ({serverless-short})
[subs="attributes"]
++++
<titleabbrev>Collect monitoring data for dashboards ({serverless-short} )</titleabbrev>
++++
{ls} monitoring is available on {serverless-full} through the https://github.com/elastic/integrations/blob/main/packages/logstash/_dev/build/docs/README.md[{ls} Integration] in {serverless-docs}/observability/what-is-observability-serverless[Elastic Observability].
{agent} collects monitoring data from your {ls} instance, sends it directly to {serverless-full}, and shows the data in {ls} dashboards.
You'll need to have an {serverless-docs}/observability/what-is-observability-serverless[Elastic Observability] project.
We'll provide steps to help you create one.
**Prerequisite**
[[disable-default-svrless]]
.Disable default collection of {ls} monitoring metrics
[%collapsible]
====
include::monitoring-prereq-disable-default.asciidoc[]
====
[discrete]
[[setup-project]]
=== Add and configure the {ls} integration
**Add the {ls} integration**
. Log in to your https://cloud.elastic.co/[cloud.elastic.co] account and create an Observability serverless project.
. Select **Get Started** from the main menu.
. Select **Start exploring** (near the bottom of the page).
. On the **Integrations** page, search for **{ls}** and select it to see details.
. Click **Add {ls}**.
. Follow the instructions to install {agent} and add the {ls} integration.
For more info, check out the {serverless-docs}/observability/what-is-observability-serverless[Elastic Observability] docs.
**Configure the integration to collect logs**
* Make sure that **Logs** is ON if you want to collect logs from your {ls} instance. Check the settings to be sure that they are configured correctly.
* Modify the log paths to match your {ls} environment.
**Configure the integration to collect metrics**
* Make sure that **Metrics (Stack Monitoring)** is OFF, and that **Metrics (Technical Preview)** is ON.
* Set the {ls} URL to point to your {ls} instance. +
By default, the integration collects {ls}
monitoring metrics from `https://localhost:9600`. If that host and port number are not
correct, update the `Logstash URL` setting. If you configured {ls} to use encrypted
communications and/or a username and password, you must access it using HTTPS. Expand the **Advanced Settings** options, and fill in the appropriate values for your {ls} instance.
[discrete]
[[view-assets-esvrless]]
=== View assets
. Go to **Project settings -> Integrations** to see your **Installed integrations**.
. Select the {ls} integration, and then select **Assets** to access dashboards for the {ls} integration.
[discrete]
[[view-data-svrless]]
=== Monitor {ls} logs and metrics
From the list of assets, open the **[Metrics {ls}] {ls} overview** dashboard to view overall performance. Then follow the navigation panel to further drill down into {ls} performance.
[role="screenshot"]
image::images/integration-dashboard-overview.png[The {ls} Overview dashboard in {kib} with various metrics from your monitored {ls}]
You can hover over any visualization to adjust its settings, or click the
**Edit** button to make changes to the dashboard. To learn more, refer to
{kibana-ref}/dashboard.html[Dashboard and visualizations].