Skip to content

Commit 0b97a08

Browse files
Rebuild onboarding docs (Get Started) for obs (#1929)
This PR: - Rebuilds the Get started structure for Obs around the [main onboarding flow](https://www.elastic.co/getting-started/) as a supertask. - Migrates most of the Obs content from https://www.elastic.co/getting-started/ - Moves out some guides that don't belong to Get started (Add Splunk data, Java tutorial, and so on). - Adds relevant metadata to existing Quickstarts and give them a secondary role. Each step of the supertask should link to relevant day-2 docs within Observability or to EDOT reference docs. Pending: Moving EDOT narrative docs to Solutions. --------- Co-authored-by: Mike Birnstiehl <[email protected]>
1 parent 13ca00a commit 0b97a08

File tree

40 files changed

+579
-271
lines changed

40 files changed

+579
-271
lines changed

deploy-manage/deploy/elastic-cloud/create-serverless-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ Choose the type of project that matches your needs and we’ll help you get star
2020
| --- | --- |
2121
| | |
2222
| ![elasticsearch](../../images/64x64_Color_elasticsearch-logo-color-64px.png "elasticsearch =50%") | **Elasticsearch**<br> Build custom search applications with {{es}}.<br><br>[**View guide →**](/solutions/search/serverless-elasticsearch-get-started.md)<br> |
23-
| ![observability](../../images/64x64_Color_observability-logo-color-64px.png "observability =50%") | **Observability**<br> Monitor applications and systems with Elastic Observability.<br><br>[**View guide →**](/solutions/observability/get-started/create-an-observability-project.md)<br> |
23+
| ![observability](../../images/64x64_Color_observability-logo-color-64px.png "observability =50%") | **Observability**<br> Monitor applications and systems with Elastic Observability.<br><br>[**View guide →**](/solutions/observability/get-started.md)<br> |
2424
| ![security](../../images/64x64_Color_security-logo-color-64px.png "security =50%") | **Security**<br> Detect, investigate, and respond to threats with Elastic Security.<br><br>[**View guide →**](/solutions/security/get-started/create-security-project.md)<br> |
2525
| | |

deploy-manage/deploy/elastic-cloud/serverless.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ There are differences between {{es-serverless}} and {{ech}}, for a list of diffe
2828
Elastic provides three serverless solutions available on {{ecloud}}. Follow these guides to get started with your serverless project:
2929

3030
* **[{{es-serverless}}](../../../solutions/search/serverless-elasticsearch-get-started.md)**: Build powerful applications and search experiences using a rich ecosystem of vector search capabilities, APIs, and libraries.
31-
* **[{{obs-serverless}}](../../../solutions/observability/get-started/create-an-observability-project.md)**: Monitor your own platforms and services using powerful machine learning and analytics tools with your logs, metrics, traces, and APM data.
31+
* **[{{obs-serverless}}](../../../solutions/observability/get-started.md)**: Monitor your own platforms and services using powerful machine learning and analytics tools with your logs, metrics, traces, and APM data.
3232
* **[{{sec-serverless}}](../../../solutions/security/get-started/create-security-project.md)**: Detect, investigate, and respond to threats with SIEM, endpoint protection, and AI-powered analytics capabilities.
3333

3434
Afterwards, you can:

manage-data/ingest/ingest-reference-architectures/agent-to-es.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Info on {{es}}:
3535

3636
This basic architecture is a common approach for ingesting data for the [Elastic Observability](https://www.elastic.co/observability) and [Elastic Security](https://www.elastic.co/security) solutions:
3737

38-
* [Elastic Observability tutorials](/solutions/observability/get-started.md#_get_started_with_other_features)
38+
* [Elastic Observability tutorials](/solutions/observability/get-started.md)
3939
* [Ingest data to Elastic Security](../../../solutions/security/get-started/ingest-data-to-elastic-security.md)
4040

4141

redirects.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ redirects:
187187
'solutions/observability/apps/analyze-monitors.md': 'solutions/observability/uptime/analyze-monitors.md'
188188
'solutions/observability/apps/inspect-uptime-duration-anomalies.md': 'solutions/observability/uptime/inspect-duration-anomalies.md'
189189
'solutions/observability/apps/configure-settings.md': 'solutions/observability/uptime/configure-settings.md'
190-
'solutions/observability/apps/tutorial-monitor-java-application.md': 'solutions/observability/applications/tutorial-monitor-java-application.md'
190+
'solutions/observability/apps/tutorial-monitor-java-application.md': 'solutions/observability/get-started/other-tutorials/tutorial-monitor-java-application.md'
191191
# we can't redirect to the search-ui book so this is the next best option
192192
'reference/search/index.md': 'reference/index.md'
193193

@@ -207,6 +207,8 @@ redirects:
207207
'troubleshoot/elasticsearch/elasticsearch-client-net-api/logging.md': 'troubleshoot/elasticsearch/clients.md'
208208
'troubleshoot/elasticsearch/elasticsearch-client-net-api/net.md': 'troubleshoot/elasticsearch/clients.md'
209209
'troubleshoot/elasticsearch/elasticsearch-client-ruby-api/ruby.md': 'troubleshoot/elasticsearch/clients.md'
210-
210+
'solutions/observability/get-started/add-data-from-splunk.md': 'solutions/observability/get-started/other-tutorials/add-data-from-splunk.md'
211+
'solutions/observability/get-started/create-an-observability-project.md': 'solutions/observability/get-started.md'
212+
'solutions/observability/get-started/get-started-with-dashboards.md': 'solutions/observability/get-started.md'
211213
# Related to https://github.com/elastic/docs-content/pull/1329
212214
'manage-data/ingest/transform-enrich/ingest-pipelines-serverless.md': 'manage-data/ingest/transform-enrich/ingest-pipelines.md'

reference/observability/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ products:
99
- id: cloud-serverless
1010
- id: observability
1111
---
12+
1213
# Observability
1314

1415
This section contains reference information for Elastic Observability features, including:
@@ -20,3 +21,10 @@ To interface with Elastic Observability features, you can use the following APIs
2021

2122
* [Observability Intake Serverless APIs](https://www.elastic.co/docs/api/doc/observability-serverless)
2223
* [Service level objectives](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-slo)
24+
25+
You can also browse reference documentation for the following components:
26+
27+
- [Elastic Distributions of OpenTelemetry (EDOT)](opentelemetry://reference/index.md)
28+
- [Fleet and Elastic Agent](/reference/fleet/index.md)
29+
- [Elastic APM](/reference/apm/observability/apm.md)
30+
- [Elastic APM agents](/reference/apm-agents/index.md)
491 KB
Loading
549 KB
Loading
354 KB
Loading

solutions/images/observability-get-started.svg

Lines changed: 0 additions & 21 deletions
This file was deleted.
Loading
Loading
Loading

solutions/images/synth-monitors.png

416 KB
Loading
Loading

solutions/observability.md

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,39 +15,36 @@ products:
1515

1616
# Observability
1717

18-
{{observability}} accelerates problem resolution with open, flexible, and unified observability powered by advanced machine learning and analytics. Elastic ingests all operational and business telemetry and correlates for faster root cause detection.
18+
Elastic {{observability}} accelerates problem resolution with open, flexible, and unified observability powered by advanced machine learning and analytics. Elastic ingests all operational and business telemetry and correlates for faster root cause detection.
1919

20-
## Get started [_get_started]
20+
For a complete overview, refer to [**What is Elastic {{observability}}**](/solutions/observability/get-started/what-is-elastic-observability.md).
2121

22-
Read the following quickstart guides to get started with {{observability}}:
22+
## Get started [_get_started]
2323

24-
* [**Get started**](/solutions/observability/get-started.md): Discover more about our observability features and how to get started.
24+
To start your {{observability}} journey, read the [**Get started**](/solutions/observability/get-started.md) guide, which presents all the essential steps, with links to valuable resources. You can also browse the {{observability}} [**Quickstart guides**](/solutions/observability/get-started/quickstarts.md).
2525

26-
Ingest observability data using OpenTelemetry:
26+
## {{observability}} features [_observability_features]
2727

28-
* [**Quickstart: Monitor hosts with OpenTelemetry**](/solutions/observability/get-started/quickstart-monitor-hosts-with-opentelemetry.md)
29-
* [**Quickstart: Monitor Kubernetes with OpenTelemetry**](/solutions/observability/get-started/quickstart-unified-kubernetes-observability-with-elastic-distributions-of-opentelemetry-edot.md)
30-
* [**Quickstart: Send data to the Elastic Cloud Managed OTLP Endpoint**](/solutions/observability/get-started/quickstart-elastic-cloud-otel-endpoint.md)
28+
Read the documentation for each of the {{observability}} features to learn more about how to use them.
3129

32-
Use the Elastic Agent to ingest data:
30+
- [Log monitoring](/solutions/observability/logs.md)
31+
- [Infrastructure and hosts monitoring](/solutions/observability/infra-and-hosts.md)
32+
- [Applications performance monitoring](/solutions/observability/apm/index.md)
33+
- [Synthetics monitoring](/solutions/observability/synthetics/index.md)
34+
- [Incident management](/solutions/observability/incident-management.md)
35+
- [AI Assistant](/solutions/observability/observability-ai-assistant.md)
3336

34-
* [**Quickstart: Monitor hosts with Elastic Agent**](/solutions/observability/get-started/quickstart-monitor-hosts-with-elastic-agent.md): Scan your host to detect and collect logs and metrics.
35-
* [**Quickstart: Monitor your Kubernetes cluster with Elastic Agent**](/solutions/observability/get-started/quickstart-monitor-kubernetes-cluster-with-elastic-agent.md): Create the Kubernetes resources that are required to monitor your cluster infrastructure.
37+
## Reference documentation [_reference_documentation]
3638

37-
Explore your data:
39+
The {{observability}} reference documentation is available in the [Elastic reference documentation](/reference/observability/index.md).
3840

39-
* [**Get started with Logs**](/solutions/observability/logs/get-started-with-system-logs.md): Add your log data to {{observability}} and start exploring your logs.
40-
* [**Get started with traces and APM**](/solutions/observability/apm/get-started.md): Collect Application Performance Monitoring (APM) data and visualize it in real time.
41-
* [**Get started with metrics**](/solutions/observability/infra-and-hosts/get-started-with-system-metrics.md): Add your metrics data to {{observability}} and visualize it in real time.
41+
You can also browse reference documentation for the following components:
4242

43-
## How to [_how_to]
43+
- [Elastic Distributions of OpenTelemetry (EDOT)](opentelemetry://reference/index.md)
44+
- [Fleet and Elastic Agent](/reference/fleet/index.md)
45+
- [Elastic APM](/reference/apm/observability/apm.md)
46+
- [Elastic APM agents](/reference/apm-agents/index.md)
4447

45-
After you've collected your data, you can:
48+
## Release notes [_release_notes]
4649

47-
* [**Explore log data**](/solutions/observability/logs/discover-logs.md): Use Discover to explore your log data.
48-
* [**Trigger alerts and triage problems**](/solutions/observability/incident-management/create-manage-rules.md): Create rules to detect complex conditions and trigger alerts.
49-
* [**Track and deliver on your SLOs**](/solutions/observability/incident-management/service-level-objectives-slos.md): Measure key metrics important to the business.
50-
* [**Detect anomalies and spikes**](/explore-analyze/machine-learning/anomaly-detection.md): Find unusual behavior in time series data.
51-
* [**Monitor application performance**](/solutions/observability/apm/index.md): Monitor your software services and applications in real time.
52-
* [**Integrate with OpenTelemetry**](/solutions/observability/apm/use-opentelemetry-with-apm.md): Reuse existing APM instrumentation to capture logs, traces, and metrics.
53-
* [**Monitor your hosts and services**](/solutions/observability/infra-and-hosts/analyze-compare-hosts.md): Get a metrics-driven view of your hosts backed by an interface called Lens.
50+
Browse the latest [{{observability}} release notes](/release-notes/elastic-observability/index.md) for more information on new features, enhancements, and fixes.

solutions/observability/apm/get-started-serverless.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You’ll use APM agents to send APM data from your application to Elastic. Elast
2424

2525
To send APM data to Elastic, you must install an APM agent and configure it to send data to your project:
2626

27-
1. [Create a new {{obs-serverless}} project](/solutions/observability/get-started/create-an-observability-project.md), or open an existing one.
27+
1. [Create a new {{obs-serverless}} project](/solutions/observability/get-started.md), or open an existing one.
2828
2. To install and configure one or more APM agents, do one of following:
2929

3030
* In your Observability project, go to **Add data****Application****Elastic APM** and follow the prompts.

solutions/observability/applications/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,3 @@ Explore the topics in this section to learn how to observe and monitor software
2525
| [Synthetic monitoring](/solutions/observability/synthetics/index.md) | Monitor the availability of network endpoints and services. |
2626
| [Real user monitoring](/solutions/observability/applications/user-experience.md) | Quantify and analyze the perceived performance of your web application using real-world user experiences. |
2727
| [Uptime monitoring (deprecated)](/solutions/observability/uptime/index.md) | Periodically check the status of your services and applications. |
28-
| [Tutorial: Monitor a Java application](/solutions/observability/applications/tutorial-monitor-java-application.md) | Monitor a Java application using Elastic Observability: Logs, Infrastructure metrics, APM, and Uptime. |

0 commit comments

Comments
 (0)