diff --git a/get-started/contribute.md b/get-started/contribute.md deleted file mode 100644 index e8487ef13..000000000 --- a/get-started/contribute.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contribute - -% What needs to be done: Write from scratch - -% Scope notes: stub about building on (e.g. search) and extending/contributing to (e.g. plugins) elastic. link down to the search solution + contribute docs Contributing prior art: - https://www.elastic.co/guide/en/kibana/current/contributing.html - https://www.elastic.co/guide/en/logstash/current/contributing-to-logstash.html - https://www.elastic.co/guide/en/beats/filebeat/current/contributing-to-beats.html \ No newline at end of file diff --git a/get-started/installing-elastic-stack.md b/get-started/installing-elastic-stack.md index 2b9d27226..32971c0d5 100644 --- a/get-started/installing-elastic-stack.md +++ b/get-started/installing-elastic-stack.md @@ -30,23 +30,21 @@ For more information on supported network configurations, refer to [{{es}} Inges Install the Elastic Stack products you want to use in the following order: -1. Elasticsearch ({{ref}}/install-elasticsearch.html[install instructions]) -2. Kibana ({{kibana-ref}}/install.html[install]) -3. Logstash ({{logstash-ref}}/installing-logstash.html[install]) -4. Elastic Agent ({{fleet-guide}}/elastic-agent-installation.html[install instructions]) or Beats ({{beats-ref}}/getting-started.html[install instructions]) -5. APM ({{apm-guide-ref}}/apm-quick-start.html[install instructions]) -6. Elasticsearch Hadoop ({{hadoop-ref}}/install.html[install instructions]) +1. [Elasticsearch]({{ref}}/install-elasticsearch.html) +2. [Kibana]({{kibana-ref}}/install.html) +3. [Logstash]({{logstash-ref}}/installing-logstash.html) +4. [Elastic Agent]({{fleet-guide}}/elastic-agent-installation.html) or [Beats]({{beats-ref}}/getting-started.html) +5. [APM]({{apm-guide-ref}}/apm-quick-start.html) +6. [Elasticsearch Hadoop]({{hadoop-ref}}/install.html) Installing in this order ensures that the components each product depends on are in place. ## Installing on {{ecloud}} [install-elastic-stack-for-elastic-cloud] -{ess-leadin-short} - Installing on {{ecloud}} is easy: a single click creates an {{es}} cluster configured to the size you want, with or without high availability. The subscription features are always installed, so you automatically have the ability to secure and monitor your cluster. {{kib}} is enabled automatically, and a number of popular plugins are readily available. -Some {{ecloud}} features can be used only with a specific subscription. For more information, see [https://www.elastic.co/pricing/](https://www.elastic.co/pricing/). +Some {{ecloud}} features can be used only with a specific subscription. For more information, refer to [https://www.elastic.co/pricing/](https://www.elastic.co/pricing/). diff --git a/get-started/introduction.md b/get-started/introduction.md index 0693fb7e4..fbdf23ba4 100644 --- a/get-started/introduction.md +++ b/get-started/introduction.md @@ -26,9 +26,9 @@ navigation_title: "What is Kibana?" Being able to search, observe, and protect your data is a requirement for any analyst. {{kib}} provides solutions for each of these use cases. -* [**Enterprise Search**](https://www.elastic.co/guide/en/enterprise-search/current/index.html) enables you to create a search experience for your app, workplace, and website. -* [**Elastic Observability**](../solutions/observability/get-started/what-is-elastic-observability.md) enables you to monitor and apply analytics in real time to events happening across all your environments. You can analyze log events, monitor the performance metrics for the host or container that it ran in, trace the transaction, and check the overall service availability. -* Designed for security analysts, [**Elastic Security**](../solutions/security.md) provides an overview of the events and alerts from your environment. Elastic Security helps you defend your organization from threats before damage and loss occur. +* [**Enterprise Search**](https://www.elastic.co/guide/en/enterprise-search/current/index.html) enables you to implement premier search experiences for your apps, organizations, and websites. +* [**Elastic Observability**](../solutions/observability/get-started/what-is-elastic-observability.md) enables you to monitor and apply analytics in real time to events happening across all your environments. You can analyze log events, monitor performance metrics for hosts and containers, trace transactions, and maintain service availability. +* Designed for security analysts, [**Elastic Security**](../solutions/security.md) includes a multitude of prebuilt detection rules and data integrations to help you collect important information in one place, get an overview of events and alerts, and secure your environments from endpoints to the cloud. ## Analyze [visualize-and-analyze] @@ -44,11 +44,11 @@ $$$get-data-into-kibana$$$ | | | | --- | --- | -| **1** | **Add data.** The best way to add data to the Elastic Stack is to use one of our many [integrations](../manage-data/ingest.md).On the **Integrations** page, you can also find options to add sample data sets or to upload a file. | -| **2** | **Explore.** With [**Discover**](../explore-analyze/discover.md), you can search your data for hiddeninsights and relationships. Ask your questions, and then filter the results to just the data you want.You can limit your results to the most recent documents added to {{es}}. | -| **3** | **Visualize.** {{kib}} provides many options to create visualizations of your data, fromaggregation-based data to time series data to geo data.[**Dashboard**](../explore-analyze/dashboards.md) is your starting point to create visualizations,and then pulling them together to show your data from multiple perspectives.Use [**Canvas**](../explore-analyze/visualize/canvas.md),to give your datathe “wow” factor for display on a big screen. Use **Graph** to explore patterns and relationships. | -| **4** | **Model data behavior.**Use [**{{ml-cap}}**](../explore-analyze/machine-learning/machine-learning-in-kibana.md) to model the behavior of your data—forecast unusual behavior andperform outlier detection, regression, and classification analysis. | -| **5** | **Share.** Ready to [share](../explore-analyze/report-and-share.md) your findings with a larger audience? {{kib}} offers many options—embeda dashboard, share a link, export to PDF, and more. | +| **1** | **Add data.** The best way to add data to the Elastic Stack is to use one of our many [integrations](../manage-data/ingest.md). On the **Integrations** page, you can also find options to add sample data sets or to upload a file. | +| **2** | **Explore.** With [**Discover**](../explore-analyze/discover.md), you can search your data for hidden insights and relationships. Ask your questions, and then filter the results using a wide range of criteria. | +| **3** | **Visualize.** {{kib}} provides many options to create visualizations of your data, from aggregation-based data to time series data to geospatial data. Use [**Dashboards**](../explore-analyze/dashboards.md) to visualize your data from multiple perspectives tailored for your use case. Use [**Canvas**](../explore-analyze/visualize/canvas.md) to give your data the “wow” factor for display on a big screen. Use **Graph** to identify patterns and relationships. | +| **4** | **Model data behavior.** Use [**{{ml-cap}}**](../explore-analyze/machine-learning/machine-learning-in-kibana.md) to gain a deeper understanding of your data. You can use a wide range of models for supervised and unsupervised learning on tasks including classification, regression, trend forecasting, and anomaly detection. | +| **5** | **Share.** Ready to [share](../explore-analyze/report-and-share.md) your findings with a larger audience? {{kib}} offers many options—embed a dashboard, share a link, export to PDF, and more. | ## Manage your data [_manage_your_data] @@ -73,7 +73,7 @@ For a full list of data management UIs, refer to [**Stack Management**](../deplo Detecting and acting on significant shifts and signals in your data is a need that exists in almost every use case. Alerting allows you to detect conditions in different {{kib}} apps and trigger actions when those conditions are met. For example, you might trigger an alert when a shift occurs in your business critical KPIs or when memory, CPU, or disk space take a dip. When the alert triggers, you can send a notification to a system that is part of your daily workflow: email, Slack, PagerDuty, ServiceNow, and other third party integrations. -A dedicated view for creating, searching, and editing rules is in [**{{rules-ui}}**](../explore-analyze/alerts-cases/alerts/create-manage-rules.md). +The [**{{rules-ui}}**](../explore-analyze/alerts-cases/alerts/create-manage-rules.md) page provides a dedicated view for creating, searching, and editing rules. ## Organize content [organize-and-secure] @@ -83,7 +83,7 @@ You might be managing tens, hundreds, or even thousands of dashboards, visualiza ### Collect related items in a space [organize-in-spaces] -{{kib}} provides [spaces](../deploy-manage/manage-spaces.md) for organizing your visualizations, dashboards, {{data-sources}}, and more. Think of a space as its own mini {{kib}} installation—it’s isolated from all other spaces, so you can tailor it to your specific needs without impacting others. +{{kib}} [spaces](../deploy-manage/manage-spaces.md) help you organize your visualizations, dashboards, {{data-sources}}, and more. Think of a space as its own mini {{kib}} instance—it’s isolated from all other spaces, so you can tailor it to your specific needs without impacting others. :::{image} ../images/kibana-select-your-space.png :alt: Space selector view @@ -93,9 +93,9 @@ You might be managing tens, hundreds, or even thousands of dashboards, visualiza ### Organize your content with tags [_organize_your_content_with_tags] -Tags are keywords or labels that you assign to saved objects, such as dashboards and visualizations, so you can classify them in a way that is meaningful to you. For example, if you tag objects with “design”, you can search and filter on the tag to see all related objects. Tags are also good for grouping content into categories within a space. +Tags are keywords or labels that you assign to saved objects, such as dashboards and visualizations, so you can classify them in a way that is meaningful to you. For example, if you tag objects with “design”, you can search and filter on the tag to display all related objects. Tags are also good for grouping content into categories within a space. -Don’t worry if you have hundreds of dashboards that need to be tagged. Use [**Tags**](../explore-analyze/find-and-organize/tags.md) in **Stack Management** to create your tags, then assign and delete them in bulk operations. +Don’t worry if you have hundreds of dashboards that need to be tagged. Use [**Tags**](../explore-analyze/find-and-organize/tags.md) in **Stack Management** to create your tags, then assign and delete them using bulk operations. ## Secure {{kib}} [intro-kibana-Security] @@ -105,7 +105,7 @@ Don’t worry if you have hundreds of dashboards that need to be tagged. Use [** ### Log in [_log_in] -{{kib}} supports several [authentication providers](../deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication.md), allowing you to login using {{es}}’s built-in realms, or with your own single sign-on provider. +{{kib}} supports several [authentication providers](../deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication.md), allowing you to login using {{es}} or your own single sign-on provider. :::{image} ../images/kibana-kibana-login.png :alt: Login page @@ -129,7 +129,7 @@ The {{kib}} role management interface allows you to describe these various acces ### Audit access [_audit_access] -Once you have your users and roles configured, you might want to maintain a record of who did what, when. The {{kib}} audit log will record this information for you, which can then be correlated with {{es}} audit logs to gain more insights into your users’ behavior. For more information, see [{{kib}} audit logging](../deploy-manage/monitor/logging-configuration/enabling-kibana-audit-logs.md). +Once you have your users and roles configured, you might want to maintain a record of who did what, when. The {{kib}} audit log will record this information for you, which can then be correlated with {{es}} audit logs to gain more insights into your users’ behavior. For more information, refer to [{{kib}} audit logging](../deploy-manage/monitor/logging-configuration/enabling-kibana-audit-logs.md). ## Find apps and objects [kibana-navigation-search] @@ -143,7 +143,7 @@ To quickly find apps and the objects you create, use the search field in the glo You can search for objects by type, name, and tag. To get the most from the search feature, follow these tips: -* Use the keyboard shortcut—Ctrl+/ on Windows and Linux, Command+/ on MacOS—to focus on the input at any time. +* Use the keyboard shortcut—Ctrl+/ on Windows and Linux, Command+/ on MacOS—to focus on the search bar at any time. * Use the provided syntax keywords. | | | @@ -154,7 +154,7 @@ You can search for objects by type, name, and tag. To get the most from the sear | Advanced searches | `tag:(tagname1 or tagname2) my_dashboard_title`
`type:lens tag:(tagname1 or tagname2)`
`type:(dashboard or canvas-workpad) logs`
| -This example searches for visualizations with the tag `design` . +This example searches for visualizations with the tag `design`. :::{image} ../images/kibana-tags-search.png :alt: Example of searching for tags diff --git a/get-started/stack-components.md b/get-started/stack-components.md index e21591e22..b035c0fb3 100644 --- a/get-started/stack-components.md +++ b/get-started/stack-components.md @@ -16,7 +16,7 @@ Trying to decide which ingest component to use? Refer to [Adding data to {{es}}] $$$stack-components-agent$$$ -{{fleet}} and {agent} +{{fleet}} and {{agent}} : {{agent}} is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Each agent has a single policy to which you can add integrations for new data sources, security protections, and more. {{fleet}} enables you to centrally manage {{agents}} and their policies. Use {{fleet}} to monitor the state of all your {{agents}}, manage agent policies, and upgrade {{agent}} binaries or integrations. @@ -31,7 +31,7 @@ APM $$$stack-components-beats$$$ -{beats} +{{beats}} : {{beats}} are data shippers that you install as agents on your servers to send operational data to {{es}}. {{beats}} are available for many standard observability data scenarios, including audit data, log files and journals, cloud data, availability, metrics, network traffic, and Windows event logs. [Learn more about {{beats}}](https://www.elastic.co/guide/en/beats/libbeat/current/beats-reference.html). $$$stack-components-ingest-pipelines$$$ @@ -41,7 +41,7 @@ $$$stack-components-ingest-pipelines$$$ $$$stack-components-logstash$$$ -{ls} +{{ls}} : {{ls}} is a data collection engine with real-time pipelining capabilities. It can dynamically unify data from disparate sources and normalize the data into destinations of your choice. {{ls}} supports a broad array of input, filter, and output plugins, with many native codecs further simplifying the ingestion process. [Learn more about {{ls}}](https://www.elastic.co/guide/en/logstash/current/introduction.html). @@ -49,7 +49,7 @@ $$$stack-components-logstash$$$ $$$stack-components-elasticsearch$$$ -{es} +{{es}} : {{es}} is the distributed search and analytics engine at the heart of the {{stack}}. It provides near real-time search and analytics for all types of data. Whether you have structured or unstructured text, numerical data, or geospatial data, {{es}} can efficiently store and index it in a way that supports fast searches. {{es}} provides a REST API that enables you to store data in {{es}} and retrieve it. The REST API also provides access to {{es}}'s search and analytics capabilities. [Learn more about {{es}}](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html). @@ -59,7 +59,7 @@ Use {{kib}} to query and visualize the data that’s stored in {{es}}. Or, use t $$$stack-components-kibana$$$ -{kib} +{{kib}} : {{kib}} is the tool to harness your {{es}} data and to manage the {{stack}}. Use it to analyze and visualize the data that’s stored in {{es}}. {{kib}} is also the home for the Elastic Enterprise Search, Elastic Observability and Elastic Security solutions. [Learn more about {{kib}}](https://www.elastic.co/guide/en/kibana/current/introduction.html). $$$stack-components-elasticsearch-clients$$$ diff --git a/get-started/the-stack.md b/get-started/the-stack.md index 28efaeb94..bc63796a0 100644 --- a/get-started/the-stack.md +++ b/get-started/the-stack.md @@ -7,15 +7,7 @@ mapped_urls: # The stack -% What needs to be done: Lift-and-shift +This section provides an overview of the {{stack}} and its components — including {{kib}}, the primary user interface for all of Elastic's solutions: Enterprise Search, Elastic Observability, and Elastic Security. It then describes how to install the {{stack}}. -% Use migrated content from existing pages that map to this page: +$$$kibana-navigation-search$$$ -% - [ ] ./raw-migrated-files/tech-content/starting-with-the-elasticsearch-platform-and-its-solutions/stack-components.md -% Notes: Put this first -% - [ ] ./raw-migrated-files/kibana/kibana/introduction.md -% Notes: Put towards the top of the section -% - [ ] ./raw-migrated-files/stack-docs/elastic-stack/installing-elastic-stack.md -% Notes: hints about install order - -$$$kibana-navigation-search$$$ \ No newline at end of file diff --git a/get-started/toc.yml b/get-started/toc.yml index 7c8793312..e27385a1a 100644 --- a/get-started/toc.yml +++ b/get-started/toc.yml @@ -6,6 +6,4 @@ toc: - file: stack-components.md - file: introduction.md - file: installing-elastic-stack.md - - file: deployment-options.md - - file: use-cases.md - - file: contribute.md \ No newline at end of file + - file: deployment-options.md \ No newline at end of file diff --git a/get-started/use-cases.md b/get-started/use-cases.md deleted file mode 100644 index e7d5c102a..000000000 --- a/get-started/use-cases.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro-what-is-es.html ---- - -# Use cases [elasticsearch-intro-what-is-es] - -[{{es}}](https://github.com/elastic/elasticsearch/) is a distributed search and analytics engine, scalable data store, and vector database built on Apache Lucene. It’s optimized for speed and relevance on production-scale workloads. Use {{es}} to search, index, store, and analyze data of all shapes and sizes in near real time. - -{{es}} is the heart of the [Elastic Stack](the-stack.md). Combined with [{{kib}}](https://www.elastic.co/kibana), it powers the following Elastic solutions: - -* [Observability](https://www.elastic.co/observability) -* [Search](https://www.elastic.co/enterprise-search) -* [Security](https://www.elastic.co/security) - -::::{tip} -{{es}} has a lot of features. Explore the full list on the [product webpage](https://www.elastic.co/elasticsearch/features). - -:::: - - -::::{admonition} What is the Elastic Stack? -:name: elasticsearch-intro-elastic-stack - -{{es}} is the core component of the Elastic Stack, a suite of products for collecting, storing, searching, and visualizing data. [Learn more about the Elastic Stack](the-stack.md). - -:::: - - - -## Use cases [elasticsearch-intro-use-cases] - -{{es}} is used for a wide and growing range of use cases. Here are a few examples: - -**Observability** - -* **Logs, metrics, and traces**: Collect, store, and analyze logs, metrics, and traces from applications, systems, and services. -* **Application performance monitoring (APM)**: Monitor and analyze the performance of business-critical software applications. -* **Real user monitoring (RUM)**: Monitor, quantify, and analyze user interactions with web applications. -* **OpenTelemetry**: Reuse your existing instrumentation to send telemetry data to the Elastic Stack using the OpenTelemetry standard. - -**Search** - -* **Full-text search**: Build a fast, relevant full-text search solution using inverted indexes, tokenization, and text analysis. -* **Vector database**: Store and search vectorized data, and create vector embeddings with built-in and third-party natural language processing (NLP) models. -* **Semantic search**: Understand the intent and contextual meaning behind search queries using tools like synonyms, dense vector embeddings, and learned sparse query-document expansion. -* **Hybrid search**: Combine full-text search with vector search using state-of-the-art ranking algorithms. -* **Build search experiences**: Add hybrid search capabilities to apps or websites, or build enterprise search engines over your organization’s internal data sources. -* **Retrieval augmented generation (RAG)**: Use {{es}} as a retrieval engine to supplement generative AI models with more relevant, up-to-date, or proprietary data for a range of use cases. -* **Geospatial search**: Search for locations and calculate spatial relationships using geospatial queries. - -**Security** - -* **Security information and event management (SIEM)**: Collect, store, and analyze security data from applications, systems, and services. -* **Endpoint security**: Monitor and analyze endpoint security data. -* **Threat hunting**: Search and analyze data to detect and respond to security threats. - -This is just a sample of search, observability, and security use cases enabled by {{es}}. Refer to Elastic [customer success stories](https://www.elastic.co/customers/success-stories) for concrete examples across a range of industries.