Skip to content

Commit 44c03ec

Browse files
committed
Incorporating some feedback.
1 parent 14d0008 commit 44c03ec

File tree

2 files changed

+44
-46
lines changed

2 files changed

+44
-46
lines changed

get-started/howto-use-the-docs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Our documentation is organized to guide you through your journey with Elastic, f
99

1010
Here is a detailed breakdown of the documentation structure:
1111

12-
* [**Elastic fundamentals**](/get-started/index.md): Understand the basics about the deployment options, platform, and solutions, and features of the documentation.
12+
* [**Elastic fundamentals**](/get-started/index.md): Understand the basics about the deployment options, platform, solutions, and features of the documentation.
1313
* [**Solutions and use cases**](/solutions/index.md): Learn use cases, evaluate, and implement Elastic's solutions: Observability, Search, and Security.
1414
* [**Manage data**](/manage-data/index.md): Learn about data store primitives, ingestion and enrichment, managing the data lifecycle, and migrating data.
1515
* [**Explore and analyze**](/explore-analyze/index.md): Get value from data through querying, visualization, machine learning, and alerting.
@@ -18,24 +18,24 @@ Here is a detailed breakdown of the documentation structure:
1818
* [**Troubleshoot**](/troubleshoot/index.md): Identify and resolve problems.
1919
* [**Extend and contribute**](/extend/index.md): How to contribute to or integrate with Elastic, from open source to plugins to integrations.
2020
* [**Release notes**](/release-notes/index.md): Contains release notes and changelogs for each new release.
21-
* [**Reference**](/reference/index.md): Reference material for core tasks and manuals for optional products.
21+
* [**Reference**](/reference/index.md): Reference material for core tasks and manuals for other Elastic products.
2222

2323
## Applicability badges
2424

25-
Because Elastic products can be deployed in different ways (like on {{ecloud}} or in your own data center) and have different versions, not all documentation applies to every user. To help you quickly see if a topic is relevant to your situation, we use **applicability badges**.
25+
Because you can deploy Elastic products in different ways (like on {{ecloud}} or in your own data center) and have different versions, not all documentation applies to every user. To help you quickly see if a topic is relevant to your situation, we use **applicability badges**.
2626

2727
These badges appear at the top of a page or section and tell you which products, deployment models, and versions the content applies to. They also indicate the maturity level of a feature, such as **beta**, **technical preview**, or **generally available (GA)**. This system ensures that you can identify content specific to your environment and version.
2828

2929
:::{tip}
30-
An {{stack}} badge indicates that a page applies to [{{stack}}](/get-started/the-stack.md) components across all deployment options except {{serverless-full}}. If a page applies to all deployment options, it will have both {{serverless-short}} and Stack badges.
30+
A **Stack** badge indicates that a page applies to [{{stack}}](/get-started/the-stack.md) components across all deployment options except {{serverless-full}}. If a page applies to all deployment options, it will have **{{serverless-short}}** and Stack badges.
3131
:::
3232

3333
## Page options
3434

3535
On each documentation page, you'll find several links that allow you to interact with the content:
3636

3737
* **View as Markdown**: This link shows you the raw Markdown source code for the page you're viewing. This can be helpful if you want to reuse the source or feed the document to AI.
38-
* **Edit this page**: Selecting this link will take you directly to the page's source file in our GitHub repository. From there, you can propose edits, which our team will review.
38+
* **Edit this page**: Selecting this link will take you directly to the page's source file in its GitHub repository. From there, you can propose edits, which our team will review.
3939
* **Report an issue**: If you've found a problem, like a typo, a technical error, or confusing content, but don't want to edit the page yourself, use this link. It will open a new issue in our GitHub repository, pre-filled with information about the page you were on, so you can describe the problem in detail.
4040

4141
## Versioned documentation

get-started/introduction.md

Lines changed: 39 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,51 @@ Before you decide what type of search to use with {{es}} or bring in your data,
5656
* **Node:** A single running instance of the {{es}} server.
5757
* **Cluster:** A collection of one or more nodes that holds all your data and provides indexing and search capabilities across all nodes. {{es}} clusters feature primary and replica shards to provide failover in the case of a node going down. When a primary shard goes down, the replica takes its place.
5858
:::{note}
59-
If you're running {{es}} on a serverless deployment, you don't have to worry a bout shards, nodes, or clusters. Elastic manages these for you.
59+
If you're running {{es}} on a serverless deployment, you don't have to worry about shards, nodes, or clusters. Elastic manages these for you.
6060
:::
6161
* **Mapping:** The process that defines how a document and its fields are stored and indexed.
6262
* **Client:** Software or an application that facilitates communication and interaction with an {{es}} cluster. It enables applications written in various programming languages to send requests to {{es}}, process the response, and then push that data into the cluster.
6363

6464
::::
6565

66+
## Elastic {{observability}}
67+
68+
### {{observability}} overview [observability-overview]
69+
70+
Elastic {{observability}} provides unified observability across applications and infrastructure. It combines logs, metrics, application traces, user experience data, and more into a single, integrated platform. This consolidation allows for powerful, cross-referenced analysis, enabling teams to move from detecting issues to understanding their root causes with speed and efficiency. By leveraging the search and analytics capabilities of {{es}}, it offers a holistic view of system behavior.
71+
72+
Elastic {{observability}} embraces open standards like OpenTelemetry for flexible data collection, and offers scalable, cost-efficient data retention with tiered storage.
73+
74+
### {{observability}} use cases [observability-use-cases]
75+
76+
Apply {{observability}} to various scenarios to improve operational awareness and system reliability.
77+
:::{dropdown} Use cases
78+
* **Log Monitoring and Analytics:** Centralize and analyze petabytes of log data from any source. This enables quick searching, ad-hoc queries with ES|QL, and visualization with prebuilt dashboards to diagnose issues.
79+
* **Application Performance Monitoring (APM):** Gain code-level visibility into application performance. By collecting and analyzing traces with native OTel support, teams can identify bottlenecks, track errors, and optimize the end-user experience.
80+
* **Infrastructure Monitoring:** Monitor metrics from servers, virtual machines, containers, and serverless environments with over 400 out-of-the-box integrations, including OpenTelemetry. This provides deep insights into resource utilization and overall system health.
81+
* **Digital Experience Monitoring:**
82+
* **Real User Monitoring (RUM):** Capture and analyze data on how real users interact with web applications to improve perceived performance.
83+
* **Synthetic Monitoring:** Proactively simulate user journeys and API calls to test application availability and functionality.
84+
* **Uptime Monitoring:** Continuously check the status of services and applications to ensure they are available.
85+
* **Universal Profiling:** Gain visibility into system performance and identify expensive lines of code without application instrumentation, helping to increase CPU efficiency and reduce cloud spend.
86+
* **LLM Observability:** Gain deep insights into the performance, usage, and costs of Large Language Model (LLM) prompts and responses.
87+
* **Incident Response and Management:** Facilitate the investigation of operational incidents by correlating data from multiple sources, which accelerates root cause analysis and resolution.
88+
:::
89+
90+
### {{observability}} core concepts [observability-concepts]
91+
At the heart of Elastic {{observability}} are several key concepts that enable its capabilities.
92+
93+
:::{dropdown} Concepts
94+
* The three pillars of {{observability}} are:
95+
* **Logs:** Timestamped records of events that provide detailed, contextual information.
96+
* **Metrics:** Numerical measurements of system performance and health over time.
97+
* **Traces:** A representation of the end-to-end journey of a request as it travels through a distributed system.
98+
* **OpenTelemetry:** {{Observability}} offers first-class, production-grade support for OpenTelemetry. This allows organizations to use vendor-neutral instrumentation and stream native OTel data without proprietary agents, leveraging the Elastic Distribution of OpenTelemetry (EDOT).
99+
* **AIOps and AI Assistant:** Leverages predictive analytics and an LLM-powered AI Assistant to reduce the time required to detect, investigate, and resolve incidents. This includes zero-config anomaly detection, pattern analysis, and the ability to surface correlations and root causes.
100+
* **Alerting and Cases:** A built-in feature for creating rules to detect complex conditions and trigger actions. It allows teams to stay aware of potential issues and use Cases to track investigation details, assign tasks, and collaborate on resolutions.
101+
* **Service Level Objectives (SLOs):** A framework for defining and monitoring the reliability of a service. Elastic Observability allows for creating and tracking SLOs to ensure that performance targets are being met.
102+
:::
103+
66104
## {{elastic-sec}}
67105

68106
### Security overview [security-overview]
@@ -109,46 +147,6 @@ Before diving into setup and configuration, familiarize yourself with the founda
109147
* **AI Assistant:** A generative AI-powered tool that helps with tasks like alert investigation, incident response, and query generation. It utilizes natural language processing and knowledge retrieval to provide context-aware assistance, summarize threats, suggest next steps, and automate workflows. Use AI Assistant to better understand and respond to security incidents.
110148
:::
111149

112-
113-
## Elastic {{observability}}
114-
115-
### {{observability}} overview [observability-overview]
116-
117-
Elastic {{observability}} provides unified observability across applications and infrastructure. It combines logs, metrics, application traces, user experience data, and more into a single, integrated platform. This consolidation allows for powerful, cross-referenced analysis, enabling teams to move from detecting issues to understanding their root causes with speed and efficiency. By leveraging the search and analytics capabilities of {{es}}, it offers a holistic view of system behavior.
118-
119-
Elastic {{observability}} embraces open standards like OpenTelemetry for flexible data collection, and offers scalable, cost-efficient data retention with tiered storage.
120-
121-
### {{observability}} use cases [observability-use-cases]
122-
123-
Apply {{observability}} to various scenarios to improve operational awareness and system reliability.
124-
:::{dropdown} Use cases
125-
* **Log Monitoring and Analytics:** Centralize and analyze petabytes of log data from any source. This enables quick searching, ad-hoc queries with ES|QL, and visualization with prebuilt dashboards to diagnose issues.
126-
* **Application Performance Monitoring (APM):** Gain code-level visibility into application performance. By collecting and analyzing traces with native OTel support, teams can identify bottlenecks, track errors, and optimize the end-user experience.
127-
* **Infrastructure Monitoring:** Monitor metrics from servers, virtual machines, containers, and serverless environments with over 400 out-of-the-box integrations, including OpenTelemetry. This provides deep insights into resource utilization and overall system health.
128-
* **Digital Experience Monitoring:**
129-
* **Real User Monitoring (RUM):** Capture and analyze data on how real users interact with web applications to improve perceived performance.
130-
* **Synthetic Monitoring:** Proactively simulate user journeys and API calls to test application availability and functionality.
131-
* **Uptime Monitoring:** Continuously check the status of services and applications to ensure they are available.
132-
* **Universal Profiling:** Gain visibility into system performance and identify expensive lines of code without application instrumentation, helping to increase CPU efficiency and reduce cloud spend.
133-
* **LLM Observability:** Gain deep insights into the performance, usage, and costs of Large Language Model (LLM) prompts and responses.
134-
* **Incident Response and Management:** Facilitate the investigation of operational incidents by correlating data from multiple sources, which accelerates root cause analysis and resolution.
135-
:::
136-
137-
### {{observability}} core concepts [observability-concepts]
138-
At the heart of Elastic {{observability}} are several key concepts that enable its capabilities.
139-
140-
:::{dropdown} Concepts
141-
* The three pillars of {{observability}} are:
142-
* **Logs:** Timestamped records of events that provide detailed, contextual information.
143-
* **Metrics:** Numerical measurements of system performance and health over time.
144-
* **Traces:** A representation of the end-to-end journey of a request as it travels through a distributed system.
145-
* **OpenTelemetry:** {{Observability}} offers first-class, production-grade support for OpenTelemetry. This allows organizations to use vendor-neutral instrumentation and stream native OTel data without proprietary agents, leveraging the Elastic Distribution of OpenTelemetry (EDOT).
146-
* **AIOps and AI Assistant:** Leverages predictive analytics and an LLM-powered AI Assistant to reduce the time required to detect, investigate, and resolve incidents. This includes zero-config anomaly detection, pattern analysis, and the ability to surface correlations and root causes.
147-
* **Alerting and Cases:** A built-in feature for creating rules to detect complex conditions and trigger actions. It allows teams to stay aware of potential issues and use Cases to track investigation details, assign tasks, and collaborate on resolutions.
148-
* **Service Level Objectives (SLOs):** A framework for defining and monitoring the reliability of a service. Elastic Observability allows for creating and tracking SLOs to ensure that performance targets are being met.
149-
:::
150-
151-
152150
<!--TBD: Call out how solutions map to Serverless project types? -->
153151
<!-- Content moved from the-stack.md
154152
## Get data into Elasticsearch

0 commit comments

Comments
 (0)