From e6f1a5a26d5ec356c93903864df14e439a9b8ae7 Mon Sep 17 00:00:00 2001 From: George Wallace Date: Fri, 28 Mar 2025 07:57:44 -0600 Subject: [PATCH 1/7] updating langing page for reference --- reference/index.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/reference/index.md b/reference/index.md index 2b80fc94ef..4670aa3fb2 100644 --- a/reference/index.md +++ b/reference/index.md @@ -5,6 +5,87 @@ mapped_pages: # Reference [api-reference] +Explore the comprehensive reference documentation for the Elastic Stack, designed to equip you with the knowledge necessary to effectively manage and optimize your data infrastructure. Whether you are configuring security protocols, enhancing search functionalities, or integrating with cloud services, our detailed manuals, API guides, and configuration settings provide the essential information you need. This section serves as your foundational resource for leveraging the full potential of the Elastic Stack. + +## Security + +Ensure your data is protected with robust security features. Learn about fields and object schemas, endpoint command references, and observability tools to maintain a secure environment. + +**Learn more in [Security](security/index.md)** + +## Observability + +Access detailed reference documentation to enhance your understanding of system performance and health monitoring within the Elastic Stack. Explore Logs Explorer fields and Infrastructure app fields to gain precise insights into system logs and infrastructure metrics. Additionally, utilize the Elastic Entity Model documentation to achieve real-time data visibility and operational efficiency, ensuring comprehensive observability across your environment. + +**Learn more in [Observability](observability/index.md)** + +## Search + +Explore manuals on Search UI, Elasticsearch management, index management, configuration settings, and REST APIs to optimize your search experience. + +**Learn more in [Search](search/index.md)** + +## Elaticsearch and index management + +Customize your Elastic Stack setup with our configuration reference guides. From JVM settings to Elasticsearch privileges and index lifecycle actions, find the detailed information you need to configure your environment to meet your specific needs. + +**Learn more in [Elasticsearch and index management](elasticsearch://reference/index.md)** + +## Ingestion tools + +Streamline data ingestion with tools like Fleet and Elastic Agent, APM, and Beats. Explore processor references and Logstash plugins to efficiently manage your data flow. + +**Learn more in [Ingestion tools](ingestion-tools/index.md)** + +## Elastic Integrations + +Integrate seamlessly with various platforms using Elastic integrations. Discover connectors for Kibana, Elasticsearch for Apache Hadoop, and more to expand your data capabilities. + +**Learn more in [Integrations](integrations://extend/index.md)** + +## Kibana + +Visualize and analyze your data with Kibana. Configure advanced settings, explore plugins, and utilize command line tools to enhance your data insights. + +**Learn more in [Kibana](kibana://reference/index.md)** + +## Plugins + +Extend the functionality of your Elastic Stack with a variety of plugins. From analysis and discovery to snapshot/restore and store plugins, customize your setup to fit your requirements. + +**Learn more in [Plugins](elasticsearch://reference/elasticsearch-plugins/index.md)** + +## Query Languages + +Master data querying with our comprehensive guides on QueryDSL, ES|QL, SQL, EQL, and Kibana Query Language. Leverage scripting languages like Painless for advanced data manipulation. + +**Learn more in [Query languages](elasticsearch://reference/query-languages/index.md)** + +## Scripting Languages + +Explore our reference documentation on Painless scripting. Painless is the default scripting language for Elasticsearch, designed for safe and efficient execution. Access syntax references, function libraries, and best practices to of Painless scripting. + +**Learn more in [Painless scripting](elasticsearch://reference/scripting-languages/painless/painless.md)** + +## Data analysis + +Unlock insights with powerful data analysis tools. Utilize text analysis components, aggregations, and function references to derive meaningful conclusions from your data. + +**Learn more in [Data analysis](data-analysis/index.md)** + +## ECS (Elastic Common Schema) reference + +Standardize your data with ECS. Access logging libraries, field references, and categorization fields to ensure consistency and compatibility across your data sources. + +**Learn more in [ECS](ecs://reference/index.md)** + +## Cloud + +Leverage the power of the cloud with Elastic Cloud solutions. Explore Elastic Cloud on Kubernetes, Elastic Cloud Enterprise, and Elastic Cloud Hosted to scale your operations effortlessly. + +**Learn more in [Cloud](cloud://reference/index.md)** + +## APIs Explore the reference documentation for Elastic APIs. | | | From 39120559b2c6706c83827d5b79a75590704f0af6 Mon Sep 17 00:00:00 2001 From: George Wallace Date: Fri, 28 Mar 2025 08:03:01 -0600 Subject: [PATCH 2/7] updates --- reference/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/index.md b/reference/index.md index 4670aa3fb2..0a05108609 100644 --- a/reference/index.md +++ b/reference/index.md @@ -9,19 +9,19 @@ Explore the comprehensive reference documentation for the Elastic Stack, designe ## Security -Ensure your data is protected with robust security features. Learn about fields and object schemas, endpoint command references, and observability tools to maintain a secure environment. +Access detailed reference documentation on field and object schemas as well as the diffferent commands used to manage and troubleshoot Elastic Endpoint. **Learn more in [Security](security/index.md)** ## Observability -Access detailed reference documentation to enhance your understanding of system performance and health monitoring within the Elastic Stack. Explore Logs Explorer fields and Infrastructure app fields to gain precise insights into system logs and infrastructure metrics. Additionally, utilize the Elastic Entity Model documentation to achieve real-time data visibility and operational efficiency, ensuring comprehensive observability across your environment. +Access detailed reference documentation on field and object schemas as well as the Elastic Entity Model. **Learn more in [Observability](observability/index.md)** ## Search -Explore manuals on Search UI, Elasticsearch management, index management, configuration settings, and REST APIs to optimize your search experience. +Explore reference content on Search UI and how you can develop fast, modern, and engaging search experiences. **Learn more in [Search](search/index.md)** From 8099dbd6abb0531f949ede19d663f50ef4042d19 Mon Sep 17 00:00:00 2001 From: George Wallace Date: Fri, 28 Mar 2025 10:50:57 -0600 Subject: [PATCH 3/7] updates --- reference/index.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/reference/index.md b/reference/index.md index 0a05108609..f48d7c9453 100644 --- a/reference/index.md +++ b/reference/index.md @@ -5,7 +5,7 @@ mapped_pages: # Reference [api-reference] -Explore the comprehensive reference documentation for the Elastic Stack, designed to equip you with the knowledge necessary to effectively manage and optimize your data infrastructure. Whether you are configuring security protocols, enhancing search functionalities, or integrating with cloud services, our detailed manuals, API guides, and configuration settings provide the essential information you need. This section serves as your foundational resource for leveraging the full potential of the Elastic Stack. +Explore the reference documentation for the Elastic Stack. Whether you are configuring security protocols, enhancing search functionalities, or integrating with cloud services, our detailed manuals, API guides, and configuration settings provide the information you need. ## Security @@ -27,7 +27,7 @@ Explore reference content on Search UI and how you can develop fast, modern, and ## Elaticsearch and index management -Customize your Elastic Stack setup with our configuration reference guides. From JVM settings to Elasticsearch privileges and index lifecycle actions, find the detailed information you need to configure your environment to meet your specific needs. +Customize your Elastic Stack setup with our configuration reference guides. From JVM settings, our client documentation, Elasticsearch privileges and index lifecycle actions, find the detailed information you need to configure your environment to meet your specific needs. **Learn more in [Elasticsearch and index management](elasticsearch://reference/index.md)** @@ -37,12 +37,6 @@ Streamline data ingestion with tools like Fleet and Elastic Agent, APM, and Beat **Learn more in [Ingestion tools](ingestion-tools/index.md)** -## Elastic Integrations - -Integrate seamlessly with various platforms using Elastic integrations. Discover connectors for Kibana, Elasticsearch for Apache Hadoop, and more to expand your data capabilities. - -**Learn more in [Integrations](integrations://extend/index.md)** - ## Kibana Visualize and analyze your data with Kibana. Configure advanced settings, explore plugins, and utilize command line tools to enhance your data insights. @@ -57,13 +51,13 @@ Extend the functionality of your Elastic Stack with a variety of plugins. From a ## Query Languages -Master data querying with our comprehensive guides on QueryDSL, ES|QL, SQL, EQL, and Kibana Query Language. Leverage scripting languages like Painless for advanced data manipulation. +Master data querying with our comprehensive guides on QueryDSL, ES|QL, SQL, EQL, and Kibana Query Language. **Learn more in [Query languages](elasticsearch://reference/query-languages/index.md)** ## Scripting Languages -Explore our reference documentation on Painless scripting. Painless is the default scripting language for Elasticsearch, designed for safe and efficient execution. Access syntax references, function libraries, and best practices to of Painless scripting. +Access syntax references, function libraries, and best practices to of Painless scripting. **Learn more in [Painless scripting](elasticsearch://reference/scripting-languages/painless/painless.md)** @@ -81,7 +75,7 @@ Standardize your data with ECS. Access logging libraries, field references, and ## Cloud -Leverage the power of the cloud with Elastic Cloud solutions. Explore Elastic Cloud on Kubernetes, Elastic Cloud Enterprise, and Elastic Cloud Hosted to scale your operations effortlessly. +Leverage the power of the cloud with Elastic Cloud solutions. Explore Elastic Cloud on Kubernetes, Elastic Cloud Enterprise, and Elastic Cloud Hosted to scale your operations. **Learn more in [Cloud](cloud://reference/index.md)** From b5278d34d484c6d8305dcb935754a863f7677fe2 Mon Sep 17 00:00:00 2001 From: George Wallace Date: Tue, 1 Apr 2025 08:54:34 -0600 Subject: [PATCH 4/7] Apply suggestions from code review Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com> --- reference/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/index.md b/reference/index.md index f48d7c9453..147cd9aa88 100644 --- a/reference/index.md +++ b/reference/index.md @@ -27,7 +27,7 @@ Explore reference content on Search UI and how you can develop fast, modern, and ## Elaticsearch and index management -Customize your Elastic Stack setup with our configuration reference guides. From JVM settings, our client documentation, Elasticsearch privileges and index lifecycle actions, find the detailed information you need to configure your environment to meet your specific needs. +Customize your Elastic Stack setup with our configuration reference guides. Explore JVM settings, client documentation, Elasticsearch privileges, and index lifecycle actions to find the detailed information you need to configure your environment to your specific needs. **Learn more in [Elasticsearch and index management](elasticsearch://reference/index.md)** @@ -57,7 +57,7 @@ Master data querying with our comprehensive guides on QueryDSL, ES|QL, SQL, EQL, ## Scripting Languages -Access syntax references, function libraries, and best practices to of Painless scripting. +Access syntax references, function libraries, and best practices for Painless scripting. **Learn more in [Painless scripting](elasticsearch://reference/scripting-languages/painless/painless.md)** From ff2c22e9d7c833a4567a6ea135fc739fb64549c2 Mon Sep 17 00:00:00 2001 From: George Wallace Date: Tue, 1 Apr 2025 09:01:09 -0600 Subject: [PATCH 5/7] Update index.md --- reference/elasticsearch-clients/index.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/reference/elasticsearch-clients/index.md b/reference/elasticsearch-clients/index.md index 27ccf4820b..0a5fd659fe 100644 --- a/reference/elasticsearch-clients/index.md +++ b/reference/elasticsearch-clients/index.md @@ -10,8 +10,8 @@ navigation_title: Clients This section contains documentation for all the official Elasticsearch clients: * Eland -* Go -* Java +* [Go](go-elasticsearch://reference/getting-started.md) +* [Java](elasticsearch-java://reference/getting-started.md) * JavaScript * .NET * PHP @@ -21,8 +21,6 @@ This section contains documentation for all the official Elasticsearch clients: You can use the following language clients with {{es-serverless}}: -* [Go](go-elasticsearch://reference/getting-started-serverless.md) -* [Java](elasticsearch-java://reference/getting-started-serverless.md) * [.NET](elasticsearch-net://reference/getting-started.md) * [Node.JS](elasticsearch-js://reference/getting-started.md) * [PHP](elasticsearch-php://reference/getting-started.md) @@ -31,4 +29,4 @@ You can use the following language clients with {{es-serverless}}: ::::{tip} Learn how to [connect to your {{es-serverless}} endpoint](/solutions/search/serverless-elasticsearch-get-started.md). -:::: \ No newline at end of file +:::: From 993e0a2e1fa3de57a73c6ec5bc370279dbc7281b Mon Sep 17 00:00:00 2001 From: George Wallace Date: Tue, 1 Apr 2025 09:04:49 -0600 Subject: [PATCH 6/7] Update grok-debugger.md --- explore-analyze/query-filter/tools/grok-debugger.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/explore-analyze/query-filter/tools/grok-debugger.md b/explore-analyze/query-filter/tools/grok-debugger.md index 783b0b2586..ec19496a0d 100644 --- a/explore-analyze/query-filter/tools/grok-debugger.md +++ b/explore-analyze/query-filter/tools/grok-debugger.md @@ -11,7 +11,7 @@ mapped_pages: You can build and debug grok patterns in the {{kib}} **Grok Debugger** before you use them in your data processing pipelines. Grok is a pattern matching syntax that you can use to parse arbitrary text and structure it. Grok is good for parsing syslog, apache, and other webserver logs, mysql logs, and in general, any log format that is written for human consumption. -Grok patterns are supported in {{es}} [runtime fields](../../../manage-data/data-store/mapping/runtime-fields.md), the {{es}} [grok ingest processor](elasticsearch://reference/ingestion-tools/enrich-processor/grok-processor.md), and the {{ls}} [grok filter](logstash-docs-md://lsr/plugins-filters-grok.md). For syntax, see [Grokking grok](../../scripting/grok.md). +Grok patterns are supported in {{es}} [runtime fields](../../../manage-data/data-store/mapping/runtime-fields.md), the {{es}} [grok ingest processor](elasticsearch://reference/enrich-processor/grok-processor.md), and the {{ls}} [grok filter](logstash-docs-md://lsr/plugins-filters-grok.md). For syntax, see [Grokking grok](../../scripting/grok.md). The {{stack}} ships with more than 120 reusable grok patterns. For a complete list of patterns, see [{{es}} grok patterns](https://github.com/elastic/elasticsearch/tree/master/libs/grok/src/main/resources/patterns) and [{{ls}} grok patterns](https://github.com/logstash-plugins/logstash-patterns-core/tree/master/patterns). From 0cfca9ec210ed4e9be9d981060c01fe96741cb28 Mon Sep 17 00:00:00 2001 From: George Wallace Date: Tue, 1 Apr 2025 19:51:28 -0600 Subject: [PATCH 7/7] Update reference/index.md Co-authored-by: Karen Metts <35154725+karenzone@users.noreply.github.com> --- reference/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/index.md b/reference/index.md index f20e8fd553..0d8e3d24e4 100644 --- a/reference/index.md +++ b/reference/index.md @@ -25,7 +25,7 @@ Explore reference content on Search UI and how you can develop fast, modern, and **Learn more in [Search](search/index.md)** -## Elaticsearch and index management +## Elasticsearch and index management Customize your Elastic Stack setup with our configuration reference guides. Explore JVM settings, client documentation, Elasticsearch privileges, and index lifecycle actions to find the detailed information you need to configure your environment to your specific needs.