-
Notifications
You must be signed in to change notification settings - Fork 166
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Apply IA changes to serverless docs (#4532)
* Apply IA changes to serverless docs * Remove inline comments * Apply changes from colleenmcginnis (cherry picked from commit 5b81307) # Conflicts: # docs/en/serverless/ai-assistant/ai-assistant.asciidoc # docs/en/serverless/dashboards/dashboards-and-visualizations.asciidoc # docs/en/serverless/index.asciidoc # docs/en/serverless/infra-monitoring/infra-monitoring.asciidoc # docs/en/serverless/logging/log-monitoring.asciidoc # docs/en/serverless/machine-learning/aiops-analyze-spikes.asciidoc # docs/en/serverless/machine-learning/aiops-detect-anomalies.asciidoc # docs/en/serverless/machine-learning/aiops-detect-change-points.asciidoc # docs/en/serverless/machine-learning/aiops-forecast-anomaly.asciidoc # docs/en/serverless/machine-learning/aiops-tune-anomaly-detection-job.asciidoc # docs/en/serverless/machine-learning/machine-learning.asciidoc # docs/en/serverless/monitor-datasets.asciidoc # docs/en/serverless/observability-overview.asciidoc # docs/en/serverless/quickstarts/collect-data-with-aws-firehose.asciidoc # docs/en/serverless/quickstarts/k8s-logs-metrics.asciidoc # docs/en/serverless/quickstarts/monitor-hosts-with-elastic-agent.asciidoc # docs/en/serverless/redirects.asciidoc # docs/en/serverless/reference/elastic-entity-model.asciidoc # docs/en/serverless/reference/metrics-app-fields.asciidoc # docs/en/serverless/slos/slos.asciidoc # docs/en/serverless/what-is-observability-serverless.asciidoc
- Loading branch information
1 parent
e2b968a
commit a302d6c
Showing
29 changed files
with
2,633 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
17 changes: 17 additions & 0 deletions
17
docs/en/serverless/application-and-service-monitoring.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|=== |
44 changes: 44 additions & 0 deletions
44
docs/en/serverless/dashboards/dashboards-and-visualizations.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
[[observability-dashboards]] | ||
= Get started with dashboards | ||
|
||
// :description: Visualize your observability data using pre-built dashboards or create your own. | ||
// :keywords: serverless, observability, overview | ||
|
||
Elastic provides a wide range of pre-built dashboards for visualizing observability data from a variety of sources. | ||
These dashboards are loaded automatically when you install https://docs.elastic.co/integrations[Elastic integrations]. | ||
|
||
You can also create new dashboards and visualizations based on your data views to get a full picture of your data. | ||
|
||
In your Observability project, go to **Dashboards** to see installed dashboards or create your own. | ||
This example shows dashboards loaded by the System integration: | ||
|
||
[role="screenshot"] | ||
image::images/dashboards.png[Screenshot showing list of System dashboards] | ||
|
||
Notice you can filter the list of dashboards: | ||
|
||
* Use the text search field to filter by name or description. | ||
* Use the **Tags** menu to filter by tag. To create a new tag or edit existing tags, click **Manage tags**. | ||
* Click a dashboard's tags to toggle filtering for each tag. | ||
|
||
[discrete] | ||
[[observability-dashboards-create-new-dashboards]] | ||
== Create new dashboards | ||
|
||
To create a new dashboard, click **Create Dashboard** and begin adding visualizations. | ||
You can create charts, graphs, maps, tables, and other types of visualizations from your data, | ||
or you can add visualizations from the library. | ||
|
||
You can also add other types of panels — such as filters, links, and text — and add | ||
controls like time sliders. | ||
|
||
For more information about creating dashboards, | ||
refer to {kibana-ref}/create-a-dashboard-of-panels-with-web-server-data.html[Create your first dashboard]. | ||
|
||
[NOTE] | ||
==== | ||
The tutorial about creating your first dashboard is written for {kib} users, | ||
but the steps for serverless are very similar. | ||
To load the sample data in serverless, go to **Project Settings** → **Integrations** in the navigation pane, | ||
then search for "sample data". | ||
==== |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>> | ||
|Set clear, measurable targets for your service performance, based on factors like availability, response times, error rates, and other key metrics. | ||
|=== | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,225 @@ | ||
include::{asciidoc-dir}/../../shared/versions/stack/current.asciidoc[] | ||
include::{asciidoc-dir}/../../shared/attributes.asciidoc[] | ||
|
||
[[what-is-observability-serverless]] | ||
== Elastic Observability serverless | ||
|
||
++++ | ||
<titleabbrev>Elastic Observability</titleabbrev> | ||
++++ | ||
|
||
include::./what-is-observability-serverless.asciidoc[leveloffset=+2] | ||
|
||
// Group: Get started with Elastic Observability | ||
include::observability-get-started.asciidoc[leveloffset=+2] | ||
|
||
// What is Observability? | ||
include::./observability-overview.asciidoc[leveloffset=+3] | ||
|
||
// Observability billing dimensions | ||
include::./projects/billing.asciidoc[leveloffset=+3] | ||
|
||
// Create an Elastic Observability Serverless project | ||
include::./projects/create-an-observability-project.asciidoc[leveloffset=+3] | ||
|
||
// Quickstarts | ||
include::./quickstarts/monitor-hosts-with-elastic-agent.asciidoc[leveloffset=+3] | ||
include::./quickstarts/k8s-logs-metrics.asciidoc[leveloffset=+3] | ||
include::./quickstarts/collect-data-with-aws-firehose.asciidoc[leveloffset=+3] | ||
|
||
// Dashboards | ||
include::./dashboards/dashboards-and-visualizations.asciidoc[leveloffset=+3] | ||
|
||
// Group: Application and service monitoring | ||
include::./application-and-service-monitoring.asciidoc[leveloffset=+2] | ||
|
||
// APM | ||
include::./apm/apm.asciidoc[leveloffset=+3] | ||
include::./apm/apm-get-started.asciidoc[leveloffset=+4] | ||
include::./apm/apm-send-traces-to-elastic.asciidoc[leveloffset=+4] | ||
include::./apm-agents/apm-agents-elastic-apm-agents.asciidoc[leveloffset=+5] | ||
include::./apm-agents/apm-agents-opentelemetry.asciidoc[leveloffset=+5] | ||
include::./apm-agents/apm-agents-opentelemetry-opentelemetry-native-support.asciidoc[leveloffset=+6] | ||
include::./apm-agents/apm-agents-opentelemetry-collect-metrics.asciidoc[leveloffset=+6] | ||
include::./apm-agents/apm-agents-opentelemetry-limitations.asciidoc[leveloffset=+6] | ||
include::./apm-agents/apm-agents-opentelemetry-resource-attributes.asciidoc[leveloffset=+6] | ||
include::./apm-agents/apm-agents-aws-lambda-functions.asciidoc[leveloffset=+5] | ||
include::./apm/apm-view-and-analyze-traces.asciidoc[leveloffset=+4] | ||
include::./apm/apm-find-transaction-latency-and-failure-correlations.asciidoc[leveloffset=+5] | ||
include::./apm/apm-integrate-with-machine-learning.asciidoc[leveloffset=+5] | ||
include::./apm/apm-create-custom-links.asciidoc[leveloffset=+5] | ||
include::./apm/apm-track-deployments-with-annotations.asciidoc[leveloffset=+5] | ||
include::./apm/apm-query-your-data.asciidoc[leveloffset=+5] | ||
include::./apm/apm-filter-your-data.asciidoc[leveloffset=+5] | ||
include::./apm/apm-observe-lambda-functions.asciidoc[leveloffset=+5] | ||
include::./apm/apm-ui-overview.asciidoc[leveloffset=+5] | ||
include::./apm/apm-ui-services.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-traces.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-dependencies.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-service-map.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-service-overview.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-transactions.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-trace-sample-timeline.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-errors.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-metrics.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-infrastructure.asciidoc[leveloffset=+6] | ||
include::./apm/apm-ui-logs.asciidoc[leveloffset=+6] | ||
include::./apm/apm-data-types.asciidoc[leveloffset=+4] | ||
include::./apm/apm-distributed-tracing.asciidoc[leveloffset=+4] | ||
include::./apm/apm-reduce-your-data-usage.asciidoc[leveloffset=+4] | ||
include::./apm/apm-transaction-sampling.asciidoc[leveloffset=+5] | ||
include::./apm/apm-compress-spans.asciidoc[leveloffset=+5] | ||
include::./apm/apm-stacktrace-collection.asciidoc[leveloffset=+5] | ||
include::./apm/apm-keep-data-secure.asciidoc[leveloffset=+4] | ||
include::./apm/apm-troubleshooting.asciidoc[leveloffset=+4] | ||
include::./apm/apm-reference.asciidoc[leveloffset=+4] | ||
include::./apm/apm-kibana-settings.asciidoc[leveloffset=+5] | ||
include::./apm/apm-server-api.asciidoc[leveloffset=+5] | ||
|
||
// Synthetics | ||
include::./synthetics/synthetics-intro.asciidoc[leveloffset=+3] | ||
|
||
include::./synthetics/synthetics-get-started.asciidoc[leveloffset=+4] | ||
include::./synthetics/synthetics-get-started-project.asciidoc[leveloffset=+5] | ||
include::./synthetics/synthetics-get-started-ui.asciidoc[leveloffset=+5] | ||
|
||
include::./synthetics/synthetics-journeys.asciidoc[leveloffset=+4] | ||
include::./synthetics/synthetics-create-test.asciidoc[leveloffset=+5] | ||
include::./synthetics/synthetics-monitor-use.asciidoc[leveloffset=+5] | ||
include::./synthetics/synthetics-recorder.asciidoc[leveloffset=+5] | ||
|
||
include::./synthetics/synthetics-lightweight.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-manage-monitors.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-params-secrets.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-analyze.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-private-location.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-command-reference.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-configuration.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-mfa.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-settings.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-feature-roles.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-manage-retention.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-scale-and-architect.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-security-encryption.asciidoc[leveloffset=+4] | ||
|
||
include::./synthetics/synthetics-troubleshooting.asciidoc[leveloffset=+4] | ||
|
||
// Group: Infrastructure and hosts | ||
include::./infrastructure-and-host-monitoring-intro.asciidoc[leveloffset=+2] | ||
|
||
include::./infra-monitoring/infra-monitoring.asciidoc[leveloffset=+3] | ||
include::./infra-monitoring/get-started-with-metrics.asciidoc[leveloffset=+4] | ||
include::./infra-monitoring/view-infrastructure-metrics.asciidoc[leveloffset=4] | ||
include::./infra-monitoring/analyze-hosts.asciidoc[leveloffset=+4] | ||
include::./infra-monitoring/detect-metric-anomalies.asciidoc[leveloffset=+4] | ||
include::./infra-monitoring/configure-infra-settings.asciidoc[leveloffset=+4] | ||
|
||
include::./infra-monitoring/troubleshooting-infra.asciidoc[leveloffset=+3] | ||
include::./infra-monitoring/handle-no-results-found-message.asciidoc[leveloffset=+4] | ||
|
||
include::./infra-monitoring/metrics-reference.asciidoc[leveloffset=+3] | ||
include::./infra-monitoring/host-metrics.asciidoc[leveloffset=+4] | ||
include::./infra-monitoring/container-metrics.asciidoc[leveloffset=+4] | ||
include::./infra-monitoring/kubernetes-pod-metrics.asciidoc[leveloffset=+4] | ||
include::./infra-monitoring/aws-metrics.asciidoc[leveloffset=+4] | ||
|
||
// Group: Logs | ||
// TODO: Check the diff to see which changes need to be applied to these files. Also ask Mike if it's expected for serverless and stateful to be out of sync. | ||
|
||
include::./logging/log-monitoring.asciidoc[leveloffset=+2] | ||
|
||
include::./logging/get-started-with-logs.asciidoc[leveloffset=+3] | ||
include::./logging/stream-log-files.asciidoc[leveloffset=+3] | ||
include::./logging/correlate-application-logs.asciidoc[leveloffset=+3] | ||
include::./logging/plaintext-application-logs.asciidoc[leveloffset=+4] | ||
include::./logging/ecs-application-logs.asciidoc[leveloffset=+4] | ||
include::./logging/send-application-logs.asciidoc[leveloffset=+4] | ||
include::./logging/parse-log-data.asciidoc[leveloffset=+3] | ||
include::./logging/filter-and-aggregate-logs.asciidoc[leveloffset=+3] | ||
include::./logging/view-and-monitor-logs.asciidoc[leveloffset=+3] | ||
include::./logging/add-logs-service-name.asciidoc[leveloffset=+3] | ||
include::./logging/run-log-pattern-analysis.asciidoc[leveloffset=+3] | ||
include::./logging/troubleshoot-logs.asciidoc[leveloffset=+3] | ||
|
||
//TODO: Figure out where to put this. It's under "view and analyze data" in stateful, but that category doesn't exist in serverless yet. | ||
include::./inventory.asciidoc[leveloffset=+2] | ||
|
||
// Group: Incident management | ||
include::./incident-management.asciidoc[leveloffset=+2] | ||
|
||
// Alerting | ||
include::./alerting/alerting.asciidoc[leveloffset=+3] | ||
include::./alerting/create-manage-rules.asciidoc[leveloffset=+4] | ||
include::./alerting/aiops-generate-anomaly-alerts.asciidoc[leveloffset=+5] | ||
include::./alerting/create-anomaly-alert-rule.asciidoc[leveloffset=+5] | ||
include::./alerting/create-custom-threshold-alert-rule.asciidoc[leveloffset=+5] | ||
include::./alerting/create-elasticsearch-query-alert-rule.asciidoc[leveloffset=+5] | ||
include::./alerting/create-error-count-threshold-alert-rule.asciidoc[leveloffset=+5] | ||
include::./alerting/create-failed-transaction-rate-threshold-alert-rule.asciidoc[leveloffset=+5] | ||
include::./alerting/create-inventory-threshold-alert-rule.asciidoc[leveloffset=+5] | ||
include::./alerting/create-latency-threshold-alert-rule.asciidoc[leveloffset=+5] | ||
include::./alerting/create-slo-burn-rate-alert-rule.asciidoc[leveloffset=+5] | ||
include::./alerting/synthetic-monitor-status-alert.asciidoc[leveloffset=+5] | ||
include::./alerting/aggregation-options.asciidoc[leveloffset=+4] | ||
include::./alerting/rate-aggregation.asciidoc[leveloffset=+5] | ||
include::./alerting/view-alerts.asciidoc[leveloffset=+4] | ||
include::./alerting/triage-slo-burn-rate-breaches.asciidoc[leveloffset=+5] | ||
include::./alerting/triage-threshold-breaches.asciidoc[leveloffset=+5] | ||
|
||
// Cases | ||
include::./cases/cases.asciidoc[leveloffset=+3] | ||
|
||
include::./cases/create-manage-cases.asciidoc[leveloffset=+4] | ||
|
||
include::./cases/manage-cases-settings.asciidoc[leveloffset=+4] | ||
|
||
//SLOs | ||
include::./slos/slos.asciidoc[leveloffset=+3] | ||
|
||
include::./slos/create-an-slo.asciidoc[leveloffset=+4] | ||
|
||
//Data Set Quality | ||
include::./monitor-datasets.asciidoc[leveloffset=+2] | ||
|
||
//Observability AI Assistant | ||
include::./ai-assistant/ai-assistant.asciidoc[leveloffset=+2] | ||
|
||
//Machine learning | ||
|
||
include::./machine-learning/machine-learning.asciidoc[leveloffset=+2] | ||
include::./machine-learning/aiops-detect-anomalies.asciidoc[leveloffset=+3] | ||
include::./machine-learning/aiops-tune-anomaly-detection-job.asciidoc[leveloffset=+4] | ||
include::./machine-learning/aiops-forecast-anomaly.asciidoc[leveloffset=+4] | ||
include::./machine-learning/aiops-analyze-spikes.asciidoc[leveloffset=+3] | ||
include::./machine-learning/aiops-detect-change-points.asciidoc[leveloffset=+3] | ||
|
||
// Reference group | ||
|
||
include::./reference.asciidoc[leveloffset=+2] | ||
|
||
// Fields | ||
|
||
include::./reference/metrics-app-fields.asciidoc[leveloffset=+3] | ||
|
||
// Elastic Entity Model | ||
|
||
include::./reference/elastic-entity-model.asciidoc[leveloffset=+3] | ||
|
||
// Technical preview limitations | ||
|
||
include::./limitations.asciidoc[leveloffset=+2] | ||
|
||
// add redirects file | ||
include::redirects.asciidoc[] |
30 changes: 30 additions & 0 deletions
30
docs/en/serverless/infra-monitoring/infra-monitoring.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
[[observability-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 | ||
|
||
{obs-serverless} allows you to visualize infrastructure metrics to help diagnose problematic spikes, | ||
identify high resource utilization, automatically discover and track pods, | ||
and unify your metrics with logs and APM data. | ||
|
||
Using {agent} integrations, you can ingest and analyze metrics from servers, | ||
Docker containers, Kubernetes orchestrations, explore and analyze application | ||
telemetry, and more. | ||
|
||
For more information, refer to the following links: | ||
|
||
* <<observability-get-started-with-metrics>>: | ||
Learn how to onboard your system metrics data quickly. | ||
* <<observability-view-infrastructure-metrics>>: | ||
Use the **Inventory page** to get a metrics-driven view of your infrastructure grouped by resource type. | ||
* <<observability-analyze-hosts>>: | ||
Use the **Hosts** page to get a metrics-driven view of your infrastructure backed by an easy-to-use interface called Lens. | ||
* <<observability-detect-metric-anomalies>>: Detect and inspect memory usage and network traffic anomalies for hosts and Kubernetes pods. | ||
* <<observability-configure-intra-settings>>: Learn how to configure infrastructure UI settings. | ||
* <<observability-metrics-reference>>: Learn about key metrics used for infrastructure monitoring. | ||
* <<observability-infrastructure-monitoring-required-fields>>: Learn about the fields required to display data in the Infrastructure UI. | ||
|
||
By default, the Infrastructure UI displays metrics from {es} indices that | ||
match the `metrics-*` and `metricbeat-*` index patterns. To learn how to change | ||
this behavior, refer to <<observability-configure-intra-settings,Configure settings>>. |
20 changes: 20 additions & 0 deletions
20
docs/en/serverless/infrastructure-and-host-monitoring-intro.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|=== |
Oops, something went wrong.