From 7bc7f92735b5eb1ac81a7af03798b48c43798387 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Wed, 12 Feb 2025 18:55:01 -0500 Subject: [PATCH 01/15] Consistency tweaks --- troubleshoot/elasticsearch/security/security-trb-extraargs.md | 2 +- troubleshoot/elasticsearch/security/security-trb-roles.md | 3 ++- troubleshoot/elasticsearch/security/trb-security-path.md | 4 ++-- troubleshoot/elasticsearch/security/trb-security-setup.md | 4 ++-- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/troubleshoot/elasticsearch/security/security-trb-extraargs.md b/troubleshoot/elasticsearch/security/security-trb-extraargs.md index beff84ba32..7d9a33bc56 100644 --- a/troubleshoot/elasticsearch/security/security-trb-extraargs.md +++ b/troubleshoot/elasticsearch/security/security-trb-extraargs.md @@ -1,5 +1,5 @@ --- -navigation_title: "Users command error: extra arguments" +navigation_title: "Error: Extra arguments provided" mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-trb-extraargs.html --- diff --git a/troubleshoot/elasticsearch/security/security-trb-roles.md b/troubleshoot/elasticsearch/security/security-trb-roles.md index a3e358fbdb..b3c2899fb8 100644 --- a/troubleshoot/elasticsearch/security/security-trb-roles.md +++ b/troubleshoot/elasticsearch/security/security-trb-roles.md @@ -1,9 +1,10 @@ --- +navigation_title: Authorization errors mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/security-trb-roles.html --- -# Authorization exceptions [security-trb-roles] +# Troubleshoot authorization errors [security-trb-roles] **Symptoms:** diff --git a/troubleshoot/elasticsearch/security/trb-security-path.md b/troubleshoot/elasticsearch/security/trb-security-path.md index 7421513854..9c8d913ec8 100644 --- a/troubleshoot/elasticsearch/security/trb-security-path.md +++ b/troubleshoot/elasticsearch/security/trb-security-path.md @@ -1,10 +1,10 @@ --- -navigation_title: Configuration file relocation +navigation_title: Configuration file locations mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-path.html --- -# Failures due to relocation of the configuration files [trb-security-path] +# Diagnose configuration file location issues [trb-security-path] **Symptoms:** diff --git a/troubleshoot/elasticsearch/security/trb-security-setup.md b/troubleshoot/elasticsearch/security/trb-security-setup.md index b79ec87557..4cb97fad6b 100644 --- a/troubleshoot/elasticsearch/security/trb-security-setup.md +++ b/troubleshoot/elasticsearch/security/trb-security-setup.md @@ -1,10 +1,10 @@ --- -navigation_title: Password setup connection failures +navigation_title: Password setup failures mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/trb-security-setup.html --- -# Troubleshoot connection failures with elasticsearch-setup-passwords [trb-security-setup] +# Diagnose password setup connection failures [trb-security-setup] The [elasticsearch-setup-passwords command](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-passwords.html) sets passwords for the built-in users by sending user management API requests. If your cluster uses SSL/TLS for the HTTP (REST) interface, the command attempts to establish a connection with the HTTPS protocol. If the connection attempt fails, the command fails. From 18103f3910f8c1a379862ee4aa738c4abe7ceac3 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Thu, 13 Feb 2025 14:15:35 -0500 Subject: [PATCH 02/15] more --- .../visualize/graph/graph-troubleshooting.md | 2 +- troubleshoot/kibana.md | 11 +++- troubleshoot/kibana/access.md | 66 ++++++++++--------- troubleshoot/kibana/alerts.md | 3 +- troubleshoot/kibana/capturing-diagnostics.md | 4 +- troubleshoot/kibana/error-server-not-ready.md | 55 ++-------------- troubleshoot/kibana/graph.md | 4 +- troubleshoot/kibana/maps.md | 6 +- troubleshoot/kibana/migration-failures.md | 3 +- troubleshoot/kibana/monitoring.md | 6 +- troubleshoot/kibana/reporting.md | 4 +- troubleshoot/kibana/task-manager.md | 6 +- ...ticsearch-query-to-the-origin-in-kibana.md | 3 +- .../kibana/using-kibana-server-logs.md | 3 +- 14 files changed, 70 insertions(+), 106 deletions(-) diff --git a/explore-analyze/visualize/graph/graph-troubleshooting.md b/explore-analyze/visualize/graph/graph-troubleshooting.md index 9f79dcc987..7b5853125f 100644 --- a/explore-analyze/visualize/graph/graph-troubleshooting.md +++ b/explore-analyze/visualize/graph/graph-troubleshooting.md @@ -7,7 +7,7 @@ mapped_pages: - https://www.elastic.co/guide/en/kibana/current/graph-troubleshooting.html --- - +% marciw redirect to ../../../troubleshoot/kibana/graph.md -- 100% dupe # Troubleshooting and limitations [graph-troubleshooting] diff --git a/troubleshoot/kibana.md b/troubleshoot/kibana.md index b076b64b5b..978dee45fd 100644 --- a/troubleshoot/kibana.md +++ b/troubleshoot/kibana.md @@ -1,16 +1,21 @@ --- +navigation_title: "Kibana" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/kibana-troubleshooting.html --- -# Kibana [kibana-troubleshooting] +# Troubleshoot Kibana [kibana-troubleshooting] -{{kib}} provides the following tools for debugging issues: +These topics help you troubleshoot issues with {{kib}}: + +## Debugging * [Using {{kib}} server logs](kibana/using-kibana-server-logs.md) * [Trace {{es}} query to the origin in {{kib}}](kibana/trace-elasticsearch-query-to-the-origin-in-kibana.md) * [Capture {{kib}} diagnostic](kibana/capturing-diagnostics.md) - +## General +* +* diff --git a/troubleshoot/kibana/access.md b/troubleshoot/kibana/access.md index daf4585e96..704a5032b6 100644 --- a/troubleshoot/kibana/access.md +++ b/troubleshoot/kibana/access.md @@ -3,38 +3,40 @@ mapped_pages: - https://www.elastic.co/guide/en/kibana/current/access.html#status --- -# Access [access] - -The fastest way to access {{kib}} is to use our hosted {{es}} Service. If you [installed {{kib}} on your own](../../deploy-manage/deploy/self-managed/install-kibana.md), access {{kib}} through the web application. - - -## Set up on cloud [_set_up_on_cloud] - -There’s no faster way to get started than with our hosted {{ess}} on Elastic Cloud: - -1. [Get a free trial](https://cloud.elastic.co/registration?page=docs&placement=docs-body). -2. Log into [Elastic Cloud](https://cloud.elastic.co?page=docs&placement=docs-body). -3. Click **Create deployment**. -4. Give your deployment a name. -5. Click **Create deployment** and download the password for the `elastic` user. - -That’s it! Now that you are up and running, it’s time to get some data into {{kib}}. {{kib}} will open as soon as your deployment is ready. - - -## Log on to the web application [log-on-to-the-web-application] - -If you are using a self-managed deployment, access {{kib}} through the web application on port 5601. - -1. Point your web browser to the machine where you are running {{kib}} and specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com:5601`. - - To remotely connect to {{kib}}, set [server.host](../../deploy-manage/deploy/self-managed/configure.md#server-host) to a non-loopback address. - -2. Log on to your account. -3. Go to the home page, then click **{{kib}}**. -4. To make the {{kib}} page your landing page, click **Make this my landing page**. - - -## Check the {{kib}} status [status] +# Check {{kib}} server status [access] +% The fastest way to access {{kib}} is to use our hosted {{es}} Service. If you [installed {{kib}} on your own](../../deploy-manage/deploy/self-managed/install-kibana.md), access {{kib}} through the web application. +% +% +% ## Set up on cloud [_set_up_on_cloud] +% +% There’s no faster way to get started than with our hosted {{ess}} on Elastic Cloud: +% +% 1. [Get a free trial](https://cloud.elastic.co/registration?page=docs&placement=docs-body). +% 2. Log into [Elastic Cloud](https://cloud.elastic.co?page=docs&placement=docs-body). +% 3. Click **Create deployment**. +% 4. Give your deployment a name. +% 5. Click **Create deployment** and download the password for the `elastic` user. +% +% That’s it! Now that you are up and running, it’s time to get some data into {{kib}}. {{kib}} will open as soon as your deployment is ready. +% +% +% ## Log on to the web application [log-on-to-the-web-application] +% +% If you are using a self-managed deployment, access {{kib}} through the web application on port 5601. +% +% 1. Point your web browser to the machine where you are running {{kib}} and specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com:5601`. +% +% To remotely connect to {{kib}}, set [server.host](../../deploy-manage/deploy/self-managed/configure.md#server-host) to a non-loopback address. +% +% 2. Log on to your account. +% 3. Go to the home page, then click **{{kib}}**. +% 4. To make the {{kib}} page your landing page, click **Make this my landing page**. +% +% +% ## Check the {{kib}} status [status] +% + +% cf (../../deploy-manage/deploy/self-managed/access.md#status) The status page displays information about the server resource usage and installed plugins. diff --git a/troubleshoot/kibana/alerts.md b/troubleshoot/kibana/alerts.md index c0958e34e2..71b071db96 100644 --- a/troubleshoot/kibana/alerts.md +++ b/troubleshoot/kibana/alerts.md @@ -1,9 +1,10 @@ --- +navigation_title: "Alerts" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/alerting-troubleshooting.html --- -# Alerts [alerting-troubleshooting] +# Troubleshoot {{kib}} alerts [alerting-troubleshooting] Alerting provides many options for diagnosing problems with rules and connectors. diff --git a/troubleshoot/kibana/capturing-diagnostics.md b/troubleshoot/kibana/capturing-diagnostics.md index 8fd5e348d6..feae8b0de4 100644 --- a/troubleshoot/kibana/capturing-diagnostics.md +++ b/troubleshoot/kibana/capturing-diagnostics.md @@ -1,12 +1,12 @@ --- -navigation_title: "Capture diagnostics" +navigation_title: "Diagnostics" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/kibana-diagnostic.html --- -# Capturing diagnostics [kibana-diagnostic] +# Capture {{kib}} diagnostics [kibana-diagnostic] The {{kib}} [Support Diagnostic](https://github.com/elastic/support-diagnostics) tool captures a point-in-time snapshot of {{kib}} and its Task Manager health. It works on {{kib}} versions 7.11.0 and above. diff --git a/troubleshoot/kibana/error-server-not-ready.md b/troubleshoot/kibana/error-server-not-ready.md index 2855617e56..d33ffe9b4c 100644 --- a/troubleshoot/kibana/error-server-not-ready.md +++ b/troubleshoot/kibana/error-server-not-ready.md @@ -1,56 +1,12 @@ --- +navigation_title: "Error: Server not ready" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/access.html#not-ready --- -# Error: Server not ready [access] +# Error: {{kib}} server is not ready yet [not-ready] -The fastest way to access {{kib}} is to use our hosted {{es}} Service. If you [installed {{kib}} on your own](../../deploy-manage/deploy/self-managed/install-kibana.md), access {{kib}} through the web application. - - -## Set up on cloud [_set_up_on_cloud] - -There’s no faster way to get started than with our hosted {{ess}} on Elastic Cloud: - -1. [Get a free trial](https://cloud.elastic.co/registration?page=docs&placement=docs-body). -2. Log into [Elastic Cloud](https://cloud.elastic.co?page=docs&placement=docs-body). -3. Click **Create deployment**. -4. Give your deployment a name. -5. Click **Create deployment** and download the password for the `elastic` user. - -That’s it! Now that you are up and running, it’s time to get some data into {{kib}}. {{kib}} will open as soon as your deployment is ready. - - -## Log on to the web application [log-on-to-the-web-application] - -If you are using a self-managed deployment, access {{kib}} through the web application on port 5601. - -1. Point your web browser to the machine where you are running {{kib}} and specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com:5601`. - - To remotely connect to {{kib}}, set [server.host](../../deploy-manage/deploy/self-managed/configure.md#server-host) to a non-loopback address. - -2. Log on to your account. -3. Go to the home page, then click **{{kib}}**. -4. To make the {{kib}} page your landing page, click **Make this my landing page**. - - -## Check the {{kib}} status [status] - -The status page displays information about the server resource usage and installed plugins. - -To view the {{kib}} status page, use the status endpoint. For example, `localhost:5601/status`. - -:::{image} ../../images/kibana-kibana-status-page-7_14_0.png -:alt: Kibana server status page -:class: screenshot -::: - -For JSON-formatted server status details, use the `localhost:5601/api/status` API endpoint. - - -## Troubleshoot {{kib}} UI error [not-ready] - -Troubleshoot the `Kibana Server is not Ready yet` error. +To troubleshoot the `Kibana server is not ready yet` error, try these steps: 1. From within a {{kib}} node, confirm the connection to {{es}}: @@ -75,6 +31,7 @@ Troubleshoot the `Kibana Server is not Ready yet` error. * When {{kib}} is unable to connect to a healthy {{es}} cluster, errors like `master_not_discovered_exception` or `unable to revive connection` or `license is not available` errors appear. * When one or more {{kib}}-backing indices are unhealthy, the `index_not_green_timeout` error appears. - -You can find a Kibana health troubleshooting walkthrough in [this blog](https://www.elastic.co/blog/troubleshooting-kibana-health) or in [this video](https://www.youtube.com/watch?v=AlgGYcpGvOA). +## Resources +* [{{kib}} health troubleshooting walkthrough](https://www.elastic.co/blog/troubleshooting-kibana-health) +* [{{kib}} health troubleshooting video](https://www.youtube.com/watch?v=AlgGYcpGvOA) diff --git a/troubleshoot/kibana/graph.md b/troubleshoot/kibana/graph.md index 2e3d6ac8b4..bdfa6ecc1d 100644 --- a/troubleshoot/kibana/graph.md +++ b/troubleshoot/kibana/graph.md @@ -1,12 +1,12 @@ --- -navigation_title: "Troubleshooting and limitations" +navigation_title: "Graph" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/graph-troubleshooting.html --- -# Graph [graph-troubleshooting] +# Troubleshoot graph analytics features [graph-troubleshooting] diff --git a/troubleshoot/kibana/maps.md b/troubleshoot/kibana/maps.md index d158f2ff8a..eca0115e4d 100644 --- a/troubleshoot/kibana/maps.md +++ b/troubleshoot/kibana/maps.md @@ -1,15 +1,15 @@ --- -navigation_title: "Troubleshoot" +navigation_title: "Maps" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/maps-troubleshooting.html --- -# Maps [maps-troubleshooting] +# Troubleshoot {{kib}} Maps [maps-troubleshooting] -Use the information in this section to inspect Elasticsearch requests and find solutions to common problems. +Use the information in this section to inspect Elasticsearch requests and find solutions to common problems with {{kib}} Maps. ## Inspect Elasticsearch requests [_inspect_elasticsearch_requests] diff --git a/troubleshoot/kibana/migration-failures.md b/troubleshoot/kibana/migration-failures.md index 0d6c3c49a4..55b4841a47 100644 --- a/troubleshoot/kibana/migration-failures.md +++ b/troubleshoot/kibana/migration-failures.md @@ -1,9 +1,10 @@ --- +navigation_title: "Migrating and updating" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/resolve-migrations-failures.html --- -# Migration failures [resolve-migrations-failures] +# Troubleshoot migrating and upgrading {{kibana}} [resolve-migrations-failures] Migrating {{kib}} primarily involves migrating saved object documents to be compatible with the new version. diff --git a/troubleshoot/kibana/monitoring.md b/troubleshoot/kibana/monitoring.md index 2be406ecda..a5f6de7cdf 100644 --- a/troubleshoot/kibana/monitoring.md +++ b/troubleshoot/kibana/monitoring.md @@ -1,12 +1,10 @@ --- -navigation_title: "Troubleshooting" +navigation_title: "Monitoring" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/monitor-troubleshooting.html --- - - -# Monitoring [monitor-troubleshooting] +# Troubleshoot {{kib}} monitoring [monitor-troubleshooting] Use the information in this section to troubleshoot common problems and find answers for frequently asked questions related to the {{kib}} {monitor-features}. diff --git a/troubleshoot/kibana/reporting.md b/troubleshoot/kibana/reporting.md index d6e3ae7708..312d6776bc 100644 --- a/troubleshoot/kibana/reporting.md +++ b/troubleshoot/kibana/reporting.md @@ -1,12 +1,12 @@ --- -navigation_title: "Troubleshooting" +navigation_title: "Reporting" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/reporting-troubleshooting.html --- -# Reporting [reporting-troubleshooting] +# Troubleshoot {{kib}} reporting [reporting-troubleshooting] Kibana excels as a data visualization tool. The {{report-features}} exist to export data as simple reports, however Kibana is not a data export tool. To export data at a large scale, there are better ways and better architectures for exporting data at scale from Elasticsearch. diff --git a/troubleshoot/kibana/task-manager.md b/troubleshoot/kibana/task-manager.md index 14990fb845..8af60c9a2f 100644 --- a/troubleshoot/kibana/task-manager.md +++ b/troubleshoot/kibana/task-manager.md @@ -1,12 +1,10 @@ --- -navigation_title: "Troubleshooting" +navigation_title: "Task Manager" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/task-manager-troubleshooting.html --- - - -# Task manager [task-manager-troubleshooting] +# Troubleshoot {{kib}} Task Manager [task-manager-troubleshooting] Task Manager is used by a wide range of services in {{kib}}, such as [Alerting](../../deploy-manage/production-guidance/kibana-alerting-production-considerations.md), Actions, Reporting, and Telemetry. Unexpected behavior in these services might be a downstream issue originating in Task Manager. diff --git a/troubleshoot/kibana/trace-elasticsearch-query-to-the-origin-in-kibana.md b/troubleshoot/kibana/trace-elasticsearch-query-to-the-origin-in-kibana.md index 98a6ac1e5e..ba1580023f 100644 --- a/troubleshoot/kibana/trace-elasticsearch-query-to-the-origin-in-kibana.md +++ b/troubleshoot/kibana/trace-elasticsearch-query-to-the-origin-in-kibana.md @@ -1,9 +1,10 @@ --- +navigation_title: "Trace {{es}} query" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/kibana-troubleshooting-trace-query.html --- -# Trace Elasticsearch query to the origin in Kibana [kibana-troubleshooting-trace-query] +# Trace an {{es}} query in {{kib}} [kibana-troubleshooting-trace-query] Sometimes the {{es}} server might be slowed down by the execution of an expensive query. Such queries are logged to {{es}}'s [search slow log](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-slowlog.html#search-slow-log) file. But there is a problem: it’s impossible to say what triggered a slow search request—a {{kib}} instance or a user accessing an {{es}} endpoint directly. To simplify the investigation of such cases, the search slow log file includes the `x-opaque-id` header, which might provide additional information about a request if it originated from {{kib}}. diff --git a/troubleshoot/kibana/using-kibana-server-logs.md b/troubleshoot/kibana/using-kibana-server-logs.md index 7f6ac6daf3..d2dc537ef6 100644 --- a/troubleshoot/kibana/using-kibana-server-logs.md +++ b/troubleshoot/kibana/using-kibana-server-logs.md @@ -1,11 +1,12 @@ --- +navigation_title: "Server logs" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/kibana-troubleshooting-kibana-server-logs.html --- # Using Kibana server logs [kibana-troubleshooting-kibana-server-logs] -{{kib}} Logs is a great way to see what’s going on in your application and to debug performance issues. Navigating through a large number of generated logs can be overwhelming, and following are some techniques that you can use to optimize the process. +{{kib}} Logs help you see what's going on in your application and debug performance issues. Navigating through a large number of generated logs can be overwhelming, and following are some techniques that you can use to optimize the process. Start by defining a problem area that you are interested in. For example, you might be interested in seeing how a particular {{kib}} Plugin is performing, so no need to gather logs for all of {{kib}}. Or you might want to focus on a particular feature, such as requests from the {{kib}} server to the {{es}} server. Depending on your needs, you can configure {{kib}} to generate logs for a specific feature. From da4be8f7794f566fef724f3194a67649ac1d00bf Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Thu, 13 Feb 2025 17:23:18 -0500 Subject: [PATCH 03/15] chugging along --- .../deployments/cloud-on-k8s/kubernetes.md | 5 ++- .../esf/elastic-serverless-forwarder.md | 1 - troubleshoot/kibana/access.md | 32 +------------------ troubleshoot/kibana/migration-failures.md | 4 +-- troubleshoot/toc.yml | 12 +++---- 5 files changed, 13 insertions(+), 41 deletions(-) diff --git a/troubleshoot/deployments/cloud-on-k8s/kubernetes.md b/troubleshoot/deployments/cloud-on-k8s/kubernetes.md index 8da268b493..748f120581 100644 --- a/troubleshoot/deployments/cloud-on-k8s/kubernetes.md +++ b/troubleshoot/deployments/cloud-on-k8s/kubernetes.md @@ -1,9 +1,12 @@ --- +navigation_title: "Elastic Cloud on Kubernetes" +applies: + eck: all mapped_pages: - https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-troubleshooting.html --- -# Kubernetes [k8s-troubleshooting] +# Troubleshoot Elastic Cloud on Kubernetes [k8s-troubleshooting] * [*Common problems*](common-problems.md) * [*Troubleshooting methods*](troubleshooting-methods.md) diff --git a/troubleshoot/deployments/esf/elastic-serverless-forwarder.md b/troubleshoot/deployments/esf/elastic-serverless-forwarder.md index 80408924dc..bf93100a09 100644 --- a/troubleshoot/deployments/esf/elastic-serverless-forwarder.md +++ b/troubleshoot/deployments/esf/elastic-serverless-forwarder.md @@ -1,5 +1,4 @@ --- -navigation_title: "Troubleshooting" mapped_pages: - https://www.elastic.co/guide/en/esf/current/aws-serverless-troubleshooting.html --- diff --git a/troubleshoot/kibana/access.md b/troubleshoot/kibana/access.md index 704a5032b6..991b83f919 100644 --- a/troubleshoot/kibana/access.md +++ b/troubleshoot/kibana/access.md @@ -1,4 +1,5 @@ --- +navigation_title: "Server status" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/access.html#status --- @@ -49,34 +50,3 @@ To view the {{kib}} status page, use the status endpoint. For example, `localhos For JSON-formatted server status details, use the `localhost:5601/api/status` API endpoint. - -## Troubleshoot {{kib}} UI error [not-ready] - -Troubleshoot the `Kibana Server is not Ready yet` error. - -1. From within a {{kib}} node, confirm the connection to {{es}}: - - ```sh - curl -XGET elasticsearch_ip_or_hostname:9200/ - ``` - -2. Guarantee the health of the three {{kib}}-backing indices. All indices must appear and display `status:green` and `status:open`: - - ```sh - curl -XGET elasticsearch_ip_or_hostname:9200/_cat/indices/.kibana,.kibana_task_manager,.kibana_security_session?v=true - ``` - - These {{kib}}-backing indices must also not have [index settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html) flagging `read_only_allow_delete` or `write` [index blocks](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html). - -3. [Shut down all {{kib}} nodes](../../deploy-manage/maintenance/start-stop-services/start-stop-kibana.md). -4. Choose any {{kib}} node, then update the config to set the [debug logging](../../deploy-manage/monitor/logging-configuration/kibana-log-settings-examples.md#change-overall-log-level). -5. [Start the node](../../deploy-manage/maintenance/start-stop-services/start-stop-kibana.md), then check the start-up debug logs for `ERROR` messages or other start-up issues. - - For example: - - * When {{kib}} is unable to connect to a healthy {{es}} cluster, errors like `master_not_discovered_exception` or `unable to revive connection` or `license is not available` errors appear. - * When one or more {{kib}}-backing indices are unhealthy, the `index_not_green_timeout` error appears. - - -You can find a Kibana health troubleshooting walkthrough in [this blog](https://www.elastic.co/blog/troubleshooting-kibana-health) or in [this video](https://www.youtube.com/watch?v=AlgGYcpGvOA). - diff --git a/troubleshoot/kibana/migration-failures.md b/troubleshoot/kibana/migration-failures.md index 55b4841a47..1060f3ccb0 100644 --- a/troubleshoot/kibana/migration-failures.md +++ b/troubleshoot/kibana/migration-failures.md @@ -1,10 +1,10 @@ --- -navigation_title: "Migrating and updating" +navigation_title: "Migration and upgrades" mapped_pages: - https://www.elastic.co/guide/en/kibana/current/resolve-migrations-failures.html --- -# Troubleshoot migrating and upgrading {{kibana}} [resolve-migrations-failures] +# Troubleshoot {{kib}} migration and upgrades [resolve-migrations-failures] Migrating {{kib}} primarily involves migrating saved object documents to be compatible with the new version. diff --git a/troubleshoot/toc.yml b/troubleshoot/toc.yml index 696465530f..795f255eba 100644 --- a/troubleshoot/toc.yml +++ b/troubleshoot/toc.yml @@ -100,17 +100,17 @@ toc: - file: kibana.md children: - file: kibana/using-kibana-server-logs.md - - file: kibana/trace-elasticsearch-query-to-the-origin-in-kibana.md - - file: kibana/capturing-diagnostics.md - file: kibana/access.md - file: kibana/error-server-not-ready.md - - file: kibana/migration-failures.md + - file: kibana/trace-elasticsearch-query-to-the-origin-in-kibana.md + - file: kibana/monitoring.md + - file: kibana/alerts.md + - file: kibana/reporting.md - file: kibana/task-manager.md - file: kibana/maps.md - - file: kibana/reporting.md - file: kibana/graph.md - - file: kibana/alerts.md - - file: kibana/monitoring.md + - file: kibana/migration-failures.md + - file: kibana/capturing-diagnostics.md - file: deployments.md children: - file: deployments/serverless.md From cd95483e84cc965eceff13a4ceb15d8ba8bae0d4 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Thu, 13 Feb 2025 18:42:46 -0500 Subject: [PATCH 04/15] missed these --- .../cloud/cloud-enterprise/ece-maintenance-mode-routing.md | 2 +- raw-migrated-files/cloud/cloud/ec-maintenance-mode-routing.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-maintenance-mode-routing.md b/raw-migrated-files/cloud/cloud-enterprise/ece-maintenance-mode-routing.md index 7533ae4906..0b5fe1236b 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-maintenance-mode-routing.md +++ b/raw-migrated-files/cloud/cloud-enterprise/ece-maintenance-mode-routing.md @@ -14,7 +14,7 @@ It might be helpful to temporarily block upstream requests in order to protect s * {{ecloud}} will automatically set and remove routing blocks during plan changes. Elastic recommends avoiding manually overriding these settings for a deployment while its plans are pending. * The [{{es}} API console](../../../explore-analyze/query-filter/tools/console.md) bypasses {{ecloud}} proxy routing blocks against {{es}} to enable administrative tasks while plan changes are pending. You should generally default traffic to the {{es}} endpoint. However, if you enable **Stop routing requests** across all {{es}} nodes, you need to use this UI to administer your cluster. -* While {{es}} has **Stop routing requests** set across all nodes, other products with the deployment may become unhealthy. This is because {{es}} is a prerequisite for those other products, such as {{kib}}. In {{kib}}, this results in a [**Kibana server is not ready yet**](../../../troubleshoot/kibana/error-server-not-ready.md#not-ready) message. +* While {{es}} has **Stop routing requests** set across all nodes, other products with the deployment may become unhealthy. This is because {{es}} is a prerequisite for those other products, such as {{kib}}. In {{kib}}, this results in a [**Kibana server is not ready yet**](/troubleshoot/kibana/error-server-not-ready.md) message. ## Stop routing requests [ece_stop_routing_requests] diff --git a/raw-migrated-files/cloud/cloud/ec-maintenance-mode-routing.md b/raw-migrated-files/cloud/cloud/ec-maintenance-mode-routing.md index 414464e1fe..4d58a2d3d2 100644 --- a/raw-migrated-files/cloud/cloud/ec-maintenance-mode-routing.md +++ b/raw-migrated-files/cloud/cloud/ec-maintenance-mode-routing.md @@ -14,7 +14,7 @@ It might be helpful to temporarily block upstream requests in order to protect s * {{ecloud}} will automatically set and remove routing blocks during plan changes. Elastic recommends avoiding manually overriding these settings for a deployment while its plans are pending. * The [{{es}} API console](https://www.elastic.co/guide/en/cloud/current/ec-api-console.html) bypasses {{ecloud}} proxy routing blocks against {{es}} to enable administrative tasks while plan changes are pending. You should generally default traffic to the {{es}} endpoint. However, if you enable **Stop routing requests** across all {{es}} nodes, you need to use this UI to administer your cluster. -* While {{es}} has **Stop routing requests** set across all nodes, other products with the deployment may become unhealthy. This is because {{es}} is a prerequisite for those other products, such as {{kib}}. In {{kib}}, this results in a [**Kibana server is not ready yet**](../../../troubleshoot/kibana/error-server-not-ready.md#not-ready) message. +* While {{es}} has **Stop routing requests** set across all nodes, other products with the deployment may become unhealthy. This is because {{es}} is a prerequisite for those other products, such as {{kib}}. In {{kib}}, this results in a [**Kibana server is not ready yet**](/troubleshoot/kibana/error-server-not-ready.md) message. * Enabling **Stop routing requests** does not affect your [billing](../../../deploy-manage/cloud-organization/billing.md). If needed, you can stop charges for a deployment by [deleting the deployment](../../../deploy-manage/uninstall/delete-a-cloud-deployment.md). From 74251893951b1bc2efa1da99ecd34fa0d5aebe5f Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 09:03:35 -0500 Subject: [PATCH 05/15] reconciling --- deploy-manage/deploy/self-managed/access.md | 48 ++------------------- 1 file changed, 3 insertions(+), 45 deletions(-) diff --git a/deploy-manage/deploy/self-managed/access.md b/deploy-manage/deploy/self-managed/access.md index a493ffe375..adceacdd0e 100644 --- a/deploy-manage/deploy/self-managed/access.md +++ b/deploy-manage/deploy/self-managed/access.md @@ -33,48 +33,6 @@ If you are using a self-managed deployment, access {{kib}} through the web appli 3. Go to the home page, then click **{{kib}}**. 4. To make the {{kib}} page your landing page, click **Make this my landing page**. - -## Check the {{kib}} status [status] - -The status page displays information about the server resource usage and installed plugins. - -To view the {{kib}} status page, use the status endpoint. For example, `localhost:5601/status`. - -:::{image} ../../../images/kibana-kibana-status-page-7_14_0.png -:alt: Kibana server status page -:class: screenshot -::: - -For JSON-formatted server status details, use the `localhost:5601/api/status` API endpoint. - - -## Troubleshoot {{kib}} UI error [not-ready] - -Troubleshoot the `Kibana Server is not Ready yet` error. - -1. From within a {{kib}} node, confirm the connection to {{es}}: - - ```sh - curl -XGET elasticsearch_ip_or_hostname:9200/ - ``` - -2. Guarantee the health of the three {{kib}}-backing indices. All indices must appear and display `status:green` and `status:open`: - - ```sh - curl -XGET elasticsearch_ip_or_hostname:9200/_cat/indices/.kibana,.kibana_task_manager,.kibana_security_session?v=true - ``` - - These {{kib}}-backing indices must also not have [index settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html) flagging `read_only_allow_delete` or `write` [index blocks](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html). - -3. [Shut down all {{kib}} nodes](../../maintenance/start-stop-services/start-stop-kibana.md). -4. Choose any {{kib}} node, then update the config to set the [debug logging](../../monitor/logging-configuration/kibana-log-settings-examples.md#change-overall-log-level). -5. [Start the node](../../maintenance/start-stop-services/start-stop-kibana.md), then check the start-up debug logs for `ERROR` messages or other start-up issues. - - For example: - - * When {{kib}} is unable to connect to a healthy {{es}} cluster, errors like `master_not_discovered_exception` or `unable to revive connection` or `license is not available` errors appear. - * When one or more {{kib}}-backing indices are unhealthy, the `index_not_green_timeout` error appears. - - -You can find a Kibana health troubleshooting walkthrough in [this blog](https://www.elastic.co/blog/troubleshooting-kibana-health) or in [this video](https://www.youtube.com/watch?v=AlgGYcpGvOA). - +## Resources +* [Troubleshoot: Check {{kib}} server status](/troubleshoot/kibana/access.md) +* [Troubleshoot: Error: {{kib}} server is not ready yet](/troubleshoot/kibana/error-server-not-ready.md) \ No newline at end of file From 01005982122061d5f480c2fb8ee525412069dba8 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 09:07:16 -0500 Subject: [PATCH 06/15] that ain't it, kid --- troubleshoot/kibana/access.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/troubleshoot/kibana/access.md b/troubleshoot/kibana/access.md index 991b83f919..c058356ed5 100644 --- a/troubleshoot/kibana/access.md +++ b/troubleshoot/kibana/access.md @@ -50,3 +50,34 @@ To view the {{kib}} status page, use the status endpoint. For example, `localhos For JSON-formatted server status details, use the `localhost:5601/api/status` API endpoint. +======= + +## Troubleshoot {{kib}} UI error [not-ready] + +Troubleshoot the `Kibana Server is not Ready yet` error. + +1. From within a {{kib}} node, confirm the connection to {{es}}: + + ```sh + curl -XGET elasticsearch_ip_or_hostname:9200/ + ``` + +2. Guarantee the health of the three {{kib}}-backing indices. All indices must appear and display `status:green` and `status:open`: + + ```sh + curl -XGET elasticsearch_ip_or_hostname:9200/_cat/indices/.kibana,.kibana_task_manager,.kibana_security_session?v=true + ``` + + These {{kib}}-backing indices must also not have [index settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) flagging `read_only_allow_delete` or `write` [index blocks](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html). + +3. [Shut down all {{kib}} nodes](../../deploy-manage/maintenance/start-stop-services/start-stop-kibana.md). +4. Choose any {{kib}} node, then update the config to set the [debug logging](../../deploy-manage/monitor/logging-configuration/kibana-log-settings-examples.md#change-overall-log-level). +5. [Start the node](../../deploy-manage/maintenance/start-stop-services/start-stop-kibana.md), then check the start-up debug logs for `ERROR` messages or other start-up issues. + + For example: + + * When {{kib}} is unable to connect to a healthy {{es}} cluster, errors like `master_not_discovered_exception` or `unable to revive connection` or `license is not available` errors appear. + * When one or more {{kib}}-backing indices are unhealthy, the `index_not_green_timeout` error appears. + + +You can find a Kibana health troubleshooting walkthrough in [this blog](https://www.elastic.co/blog/troubleshooting-kibana-health) or in [this video](https://www.youtube.com/watch?v=AlgGYcpGvOA). From a6145f394cfba0fbeaaf355a5cfb838817b780f3 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 17:36:15 -0500 Subject: [PATCH 07/15] various structure changes --- .../cloud-enterprise/cloud-enterprise.md | 19 +- .../finding-deployments-finding-problems.md | 25 -- .../deployments/elastic-cloud/monitoring.md | 3 +- troubleshoot/deployments/serverless.md | 2 +- .../elasticsearch/elasticsearch-reference.md | 4 +- .../index-lifecycle-management-errors.md | 5 +- .../elasticsearch/lifecycle-management.md | 9 - troubleshoot/elasticsearch/start-ilm.md | 105 +++++- troubleshoot/elasticsearch/start-slm.md | 96 ------ troubleshoot/ingest/logstash.md | 310 +++++++++++++++++- .../ingest/logstash/azure-event-hub.md | 163 +-------- troubleshoot/ingest/logstash/contribute.md | 16 + troubleshoot/ingest/logstash/kafka.md | 91 +---- troubleshoot/ingest/logstash/plugins.md | 3 +- troubleshoot/kibana/access.md | 31 -- troubleshoot/toc.yml | 10 +- 16 files changed, 463 insertions(+), 429 deletions(-) delete mode 100644 troubleshoot/deployments/cloud-enterprise/finding-deployments-finding-problems.md delete mode 100644 troubleshoot/elasticsearch/lifecycle-management.md delete mode 100644 troubleshoot/elasticsearch/start-slm.md create mode 100644 troubleshoot/ingest/logstash/contribute.md diff --git a/troubleshoot/deployments/cloud-enterprise/cloud-enterprise.md b/troubleshoot/deployments/cloud-enterprise/cloud-enterprise.md index b081debcfc..31c532bd6c 100644 --- a/troubleshoot/deployments/cloud-enterprise/cloud-enterprise.md +++ b/troubleshoot/deployments/cloud-enterprise/cloud-enterprise.md @@ -6,9 +6,20 @@ mapped_urls: # Elastic Cloud Enterprise -% What needs to be done: Lift-and-shift +## Finding deployments [ts-ece-find] -% Use migrated content from existing pages that map to this page: +% TODO compare to https://github.com/elastic/docs-content/tree/main/deploy-manage/deploy/cloud-enterprise/search-filter-deployments.md -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-troubleshooting.md -% - [ ] ./raw-migrated-files/cloud/cloud-enterprise/ece-find.md \ No newline at end of file +When you installed Elastic Cloud Enterprise and [logged into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md) for the first time, you were greeted by two deployments. We’ve also shown you how to [create your own first deployment](../../../deploy-manage/deploy/cloud-enterprise/create-deployment.md), but that still only makes a few deployments. What if you had hundreds of deployments to look after or maybe even a thousand? How would you find the ones that need your attention? + +The **Deployments** page in the Cloud UI provides several ways to find deployments that might need your attention, whether that’s deployments that have a problem or deployments that are at a specific version level or really almost anything you might want to find on a complex production system: + +* Check the visual health indicators of deployments +* Search for partial or whole deployment names or IDs in the search text box +* Add filters to the **Deployments** view to filter for specific conditions: + + :::{image} ../../../images/cloud-enterprise-deployment-filter.png + :alt: Add a filter + ::: + + Looking for all deployments of a specific version, because you want to upgrade them? Easy. Or what about that deployments you noticed before lunch that seemed to be spending an awfully long time changing its configuration—​is it done? Just add a filter to find any ongoing configuration changes. diff --git a/troubleshoot/deployments/cloud-enterprise/finding-deployments-finding-problems.md b/troubleshoot/deployments/cloud-enterprise/finding-deployments-finding-problems.md deleted file mode 100644 index a9732e1295..0000000000 --- a/troubleshoot/deployments/cloud-enterprise/finding-deployments-finding-problems.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -mapped_pages: - - https://www.elastic.co/guide/en/cloud-enterprise/current/ece-find.html ---- - -# Finding deployments, finding problems [ece-find] - -When you installed Elastic Cloud Enterprise and [logged into the Cloud UI](../../../deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md) for the first time, you were greeted by two deployments. We’ve also shown you how to [create your own first deployment](../../../deploy-manage/deploy/cloud-enterprise/create-deployment.md), but that still only makes a few deployments. What if you had hundreds of deployments to look after or maybe even a thousand? How would you find the ones that need your attention? - -The **Deployments** page in the Cloud UI provides several ways to find deployments that might need your attention, whether that’s deployments that have a problem or deployments that are at a specific version level or really almost anything you might want to find on a complex production system: - -* Check the visual health indicators of deployments -* Search for partial or whole deployment names or IDs in the search text box -* Add filters to the **Deployments** view to filter for specific conditions: - - :::{image} ../../../images/cloud-enterprise-deployment-filter.png - :alt: Add a filter - ::: - - Looking for all deployments of a specific version, because you want to upgrade them? Easy. Or what about that deployments you noticed before lunch that seemed to be spending an awfully long time changing its configuration—​is it done? Just add a filter to find any ongoing configuration changes. - - - - - diff --git a/troubleshoot/deployments/elastic-cloud/monitoring.md b/troubleshoot/deployments/elastic-cloud/monitoring.md index 16714a92cc..9e7608412e 100644 --- a/troubleshoot/deployments/elastic-cloud/monitoring.md +++ b/troubleshoot/deployments/elastic-cloud/monitoring.md @@ -2,4 +2,5 @@ % What needs to be done: Write from scratch -% Scope notes: xrefs to Monitoring section \ No newline at end of file +% Scope notes: xrefs to Monitoring section and other sections? +% or just remove this section until later? \ No newline at end of file diff --git a/troubleshoot/deployments/serverless.md b/troubleshoot/deployments/serverless.md index e3d4666188..6d604d87b4 100644 --- a/troubleshoot/deployments/serverless.md +++ b/troubleshoot/deployments/serverless.md @@ -3,7 +3,7 @@ mapped_pages: - https://www.elastic.co/guide/en/serverless/current/general-serverless-status.html --- -# Serverless [general-serverless-status] +# Check Serverless status and get updates [general-serverless-status] Serverless projects run on cloud platforms, which may undergo changes in availability. When availability changes, Elastic makes sure to provide you with a current service status. diff --git a/troubleshoot/elasticsearch/elasticsearch-reference.md b/troubleshoot/elasticsearch/elasticsearch-reference.md index 891b3758a9..a09c6b64cf 100644 --- a/troubleshoot/elasticsearch/elasticsearch-reference.md +++ b/troubleshoot/elasticsearch/elasticsearch-reference.md @@ -35,8 +35,8 @@ If you’re using Elastic Cloud Hosted, then you can use AutoOps to monitor your ## Management [troubleshooting-management] -* [Start index lifecycle management](start-ilm.md) -* [Start snapshot lifecycle management](start-slm.md) +* [Troubleshoot index and snapshot lifecycle management](start-ilm.md) +* [Fix index lifecycle management errors](.md) ## Capacity [troubleshooting-capacity] diff --git a/troubleshoot/elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md b/troubleshoot/elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md index 2a741cf058..6f5aa8a433 100644 --- a/troubleshoot/elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md +++ b/troubleshoot/elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md @@ -1,10 +1,11 @@ --- -navgiation_title: Index lifecycle management errors +navigation_title: "Index lifecycle management errors" mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-error-handling.html --- -% marciw consolidate ILM topics +% TODO restructure ILM and SLM dtopics +% TODO dropdowns or break it up # Fix index lifecycle management errors [index-lifecycle-error-handling] diff --git a/troubleshoot/elasticsearch/lifecycle-management.md b/troubleshoot/elasticsearch/lifecycle-management.md deleted file mode 100644 index d3563ad6df..0000000000 --- a/troubleshoot/elasticsearch/lifecycle-management.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -navigation_title: Lifecycle management ---- - -% temporary: remove how-to content, then trim to one page - -# Troubleshoot lifecycle management - -% see also fix-watermark-errors.md \ No newline at end of file diff --git a/troubleshoot/elasticsearch/start-ilm.md b/troubleshoot/elasticsearch/start-ilm.md index 2416b90dbc..f5356d2bd0 100644 --- a/troubleshoot/elasticsearch/start-ilm.md +++ b/troubleshoot/elasticsearch/start-ilm.md @@ -1,13 +1,22 @@ --- -navigation_title: Index lifecycle management +navigation_title: Lifecycle management mapped_pages: - https://www.elastic.co/guide/en/elasticsearch/reference/current/start-ilm.html --- -# Start index lifecycle management [start-ilm] +% TODO reframe how-to stuff as troubleshooting content +% TODO link to proper how-to content +% TODO dropdowns? +% TODO where does this belong? section w/ 1 page...? -% marciw consider moving out of troubleshooting and into how-tos -% marciw or add troubleshooting info from elsewhere + +# Troubleshoot index and snapshot lifecycle management + +If the automatic {{ilm}} or {{slm}} service is not working, you might need to start the service. + +% see also fix-watermark-errors.md + +## Start index lifecycle management [start-ilm] Automatic index lifecycle and data retention management is currently disabled. @@ -94,3 +103,91 @@ The response will look like this: :::::: ::::::: + +## Start snapshot lifecycle management [start-slm] + +Automatic snapshot lifecycle management is currently disabled. New backup snapshots will not be created automatically. + +In order to start the snapshot lifecycle management service, follow these steps: + +:::::::{tab-set} + +::::::{tab-item} Elasticsearch Service +In order to start {{slm}} we need to go to Kibana and execute the [start command](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start). + +**Use {{kib}}** + +1. Log in to the [{{ecloud}} console](https://cloud.elastic.co?page=docs&placement=docs-body). +2. On the **Elasticsearch Service** panel, click the name of your deployment. + + ::::{note} + If the name of your deployment is disabled your {{kib}} instances might be unhealthy, in which case please contact [Elastic Support](https://support.elastic.co). If your deployment doesn’t include {{kib}}, all you need to do is [enable it first](../../deploy-manage/deploy/elastic-cloud/access-kibana.md). + :::: + +3. Open your deployment’s side navigation menu (placed under the Elastic logo in the upper left corner) and go to **Dev Tools > Console**. + + :::{image} ../../images/elasticsearch-reference-kibana-console.png + :alt: {{kib}} Console + :class: screenshot + ::: + +4. [Start](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start) {{slm}}: + + ```console + POST _slm/start + ``` + + The response will look like this: + + ```console-result + { + "acknowledged": true + } + ``` + +5. Verify {{slm}} is now running: + + ```console + GET _slm/status + ``` + + The response will look like this: + + ```console-result + { + "operation_mode": "RUNNING" + } + ``` +:::::: + +::::::{tab-item} Self-managed +[Start](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start) {{slm}}: + +```console +POST _slm/start +``` + +The response will look like this: + +```console-result +{ + "acknowledged": true +} +``` + +Verify the {{slm}} is now running: + +```console +GET _slm/status +``` + +The response will look like this: + +```console-result +{ + "operation_mode": "RUNNING" +} +``` +:::::: + +::::::: diff --git a/troubleshoot/elasticsearch/start-slm.md b/troubleshoot/elasticsearch/start-slm.md deleted file mode 100644 index c4a527bc0a..0000000000 --- a/troubleshoot/elasticsearch/start-slm.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -navigation_title: Snapshot lifecycle management -mapped_pages: - - https://www.elastic.co/guide/en/elasticsearch/reference/current/start-slm.html ---- - -% marciw consider moving out of troubleshooting and into how-tos -% marciw or add troubleshooting info from elsewhere - -# Start snapshot lifecycle management [start-slm] - -Automatic snapshot lifecycle management is currently disabled. New backup snapshots will not be created automatically. - -In order to start the snapshot lifecycle management service, follow these steps: - -:::::::{tab-set} - -::::::{tab-item} Elasticsearch Service -In order to start {{slm}} we need to go to Kibana and execute the [start command](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start). - -**Use {{kib}}** - -1. Log in to the [{{ecloud}} console](https://cloud.elastic.co?page=docs&placement=docs-body). -2. On the **Elasticsearch Service** panel, click the name of your deployment. - - ::::{note} - If the name of your deployment is disabled your {{kib}} instances might be unhealthy, in which case please contact [Elastic Support](https://support.elastic.co). If your deployment doesn’t include {{kib}}, all you need to do is [enable it first](../../deploy-manage/deploy/elastic-cloud/access-kibana.md). - :::: - -3. Open your deployment’s side navigation menu (placed under the Elastic logo in the upper left corner) and go to **Dev Tools > Console**. - - :::{image} ../../images/elasticsearch-reference-kibana-console.png - :alt: {{kib}} Console - :class: screenshot - ::: - -4. [Start](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start) {{slm}}: - - ```console - POST _slm/start - ``` - - The response will look like this: - - ```console-result - { - "acknowledged": true - } - ``` - -5. Verify {{slm}} is now running: - - ```console - GET _slm/status - ``` - - The response will look like this: - - ```console-result - { - "operation_mode": "RUNNING" - } - ``` -:::::: - -::::::{tab-item} Self-managed -[Start](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start) {{slm}}: - -```console -POST _slm/start -``` - -The response will look like this: - -```console-result -{ - "acknowledged": true -} -``` - -Verify the {{slm}} is now running: - -```console -GET _slm/status -``` - -The response will look like this: - -```console-result -{ - "operation_mode": "RUNNING" -} -``` -:::::: - -::::::: diff --git a/troubleshoot/ingest/logstash.md b/troubleshoot/ingest/logstash.md index b1b9949e29..8925f1b251 100644 --- a/troubleshoot/ingest/logstash.md +++ b/troubleshoot/ingest/logstash.md @@ -1,14 +1,320 @@ --- +navigation_title: "Logstash" mapped_urls: - https://www.elastic.co/guide/en/logstash/current/troubleshooting.html - https://www.elastic.co/guide/en/logstash/current/ts-logstash.html --- -# Logstash +# Troubleshoot Logstash [ts-logstash] % What needs to be done: Lift-and-shift % Use migrated content from existing pages that map to this page: % - [ ] ./raw-migrated-files/logstash/logstash/troubleshooting.md -% - [ ] ./raw-migrated-files/logstash/logstash/ts-logstash.md \ No newline at end of file +% - [ ] ./raw-migrated-files/logstash/logstash/ts-logstash.md + +This page helps you troubleshoot Logstash. + + +## Installation and setup [ts-install] + +### Inaccessible temp directory [ts-temp-dir] + +Certain versions of the JRuby runtime and libraries in certain plugins (the Netty network library in the TCP input, for example) copy executable files to the temp directory. This situation causes subsequent failures when `/tmp` is mounted `noexec`. + +**Sample error** + +```sh +[2018-03-25T12:23:01,149][ERROR][org.logstash.Logstash ] +java.lang.IllegalStateException: org.jruby.exceptions.RaiseException: +(LoadError) Could not load FFI Provider: (NotImplementedError) FFI not +available: java.lang.UnsatisfiedLinkError: /tmp/jffi5534463206038012403.so: +/tmp/jffi5534463206038012403.so: failed to map segment from shared object: +Operation not permitted +``` + +**Possible solutions** + +* Change setting to mount `/tmp` with `exec`. +* Specify an alternate directory using the `-Djava.io.tmpdir` setting in the `jvm.options` file. + + + +## {{ls}} start up [ts-startup] + +### *Illegal reflective access* errors [ts-illegal-reflective-error] + +After an upgrade, Logstash may show warnings similar to these: + +```sh +WARNING: An illegal reflective access operation has occurred +WARNING: Illegal reflective access by org.jruby.ext.openssl.SecurityHelper (file:/{...}/jruby{...}jopenssl.jar) to field java.security.MessageDigest.provider +WARNING: Please consider reporting this to the maintainers of org.jruby.ext.openssl.SecurityHelper +WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations +WARNING: All illegal access operations will be denied in a future release +``` + +These errors appear related to [a known issue with JRuby](https://github.com/jruby/jruby/issues/4834). + +**Work around** + +Try adding these values to the `jvm.options` file. + +```sh +--add-opens=java.base/java.security=ALL-UNNAMED +--add-opens=java.base/java.io=ALL-UNNAMED +--add-opens=java.base/java.nio.channels=ALL-UNNAMED +--add-opens=java.base/sun.nio.ch=org.ALL-UNNAMED +--add-opens=java.management/sun.management=ALL-UNNAMED +``` + +**Notes:** + +* These settings allow Logstash to start without warnings. +* This workaround has been tested with simple pipelines. If you have experiences to share, please comment in the [issue](https://github.com/elastic/logstash/issues/10496). + + +### *Permission denied - NUL* errors on Windows [ts-windows-permission-denied-NUL] + +Logstash may not start with some user-supplied versions of the JDK on Windows. + +**Sample error** + +```sh +[FATAL] 2022-04-27 15:13:16.650 [main] Logstash - Logstash stopped processing because of an error: (EACCES) Permission denied - NUL +org.jruby.exceptions.SystemCallError: (EACCES) Permission denied - NUL +``` + +This error appears to be related to a [JDK issue](https://bugs.openjdk.java.net/browse/JDK-8285445) where a new property was added with an inappropriate default. + +This issue affects some OpenJDK-derived JVM versions (Adoptium, OpenJDK, and Azul Zulu) on Windows: + +* `11.0.15+10` +* `17.0.3+7` + +**Work around** + +* Use the [bundled JDK](https://www.elastic.co/guide/en/logstash/current/getting-started-with-logstash.html#ls-jvm) included with Logstash +* Or, try adding this value to the `jvm.options` file, and restarting Logstash + + ```sh + -Djdk.io.File.enableADS=true + ``` + + + +### Container exits with *An unexpected error occurred!* message [ts-container-cgroup] + +{{ls}} running in a container may not start due to a [bug in the JDK](https://bugs.openjdk.org/browse/JDK-8343191). + +**Sample error** + +```sh +[FATAL] 2024-11-11 11:11:11.465 [LogStash::Runner] runner - An unexpected error occurred! {:error=>#, :backtrace=>[ + "java.util.Objects.requireNonNull(java/util/Objects.java:233)", + "sun.nio.fs.UnixFileSystem.getPath(sun/nio/fs/UnixFileSystem.java:296)", + "java.nio.file.Path.of(java/nio/file/Path.java:148)", + "java.nio.file.Paths.get(java/nio/file/Paths.java:69)", + "jdk.internal.platform.CgroupUtil.lambda$readStringValue$1(jdk/internal/platform/CgroupUtil.java:67)", + "java.security.AccessController.doPrivileged(java/security/AccessController.java:571)", + "jdk.internal.platform.CgroupUtil.readStringValue(jdk/internal/platform/CgroupUtil.java:69)", + "jdk.internal.platform.CgroupSubsystemController.getStringValue(jdk/internal/platform/CgroupSubsystemController.java:65)", + "jdk.internal.platform.cgroupv1.CgroupV1Subsystem.getCpuSetCpus(jdk/internal/platform/cgroupv1/CgroupV1Subsystem.java:275)", + "jdk.internal.platform.CgroupMetrics.getCpuSetCpus(jdk/internal/platform/CgroupMetrics.java:100)", + "com.sun.management.internal.OperatingSystemImpl.isCpuSetSameAsHostCpuSet(com/sun/management/internal/OperatingSystemImpl.java:277)", + "com.sun.management.internal.OperatingSystemImpl$ContainerCpuTicks.getContainerCpuLoad(com/sun/management/internal/OperatingSystemImpl.java:96)", + "com.sun.management.internal.OperatingSystemImpl.getProcessCpuLoad(com/sun/management/internal/OperatingSystemImpl.java:271)", + "org.logstash.instrument.monitors.ProcessMonitor$Report.(org/logstash/instrument/monitors/ProcessMonitor.java:63)", + "org.logstash.instrument.monitors.ProcessMonitor.detect(org/logstash/instrument/monitors/ProcessMonitor.java:136)", + "org.logstash.instrument.reports.ProcessReport.generate(org/logstash/instrument/reports/ProcessReport.java:35)", + "jdk.internal.reflect.DirectMethodHandleAccessor.invoke(jdk/internal/reflect/DirectMethodHandleAccessor.java:103)", + "java.lang.reflect.Method.invoke(java/lang/reflect/Method.java:580)", + "org.jruby.javasupport.JavaMethod.invokeDirectWithExceptionHandling(org/jruby/javasupport/JavaMethod.java:300)", + "org.jruby.javasupport.JavaMethod.invokeStaticDirect(org/jruby/javasupport/JavaMethod.java:222)", + "RUBY.collect_process_metrics(/usr/share/logstash/logstash-core/lib/logstash/instrument/periodic_poller/jvm.rb:102)", + "RUBY.collect(/usr/share/logstash/logstash-core/lib/logstash/instrument/periodic_poller/jvm.rb:73)", + "RUBY.start(/usr/share/logstash/logstash-core/lib/logstash/instrument/periodic_poller/base.rb:72)", + "org.jruby.RubySymbol$SymbolProcBody.yieldSpecific(org/jruby/RubySymbol.java:1541)", + "org.jruby.RubySymbol$SymbolProcBody.doYield(org/jruby/RubySymbol.java:1534)", + "org.jruby.RubyArray.collectArray(org/jruby/RubyArray.java:2770)", + "org.jruby.RubyArray.map(org/jruby/RubyArray.java:2803)", + "org.jruby.RubyArray$INVOKER$i$0$0$map.call(org/jruby/RubyArray$INVOKER$i$0$0$map.gen)", + "RUBY.start(/usr/share/logstash/logstash-core/lib/logstash/instrument/periodic_pollers.rb:41)", + "RUBY.configure_metrics_collectors(/usr/share/logstash/logstash-core/lib/logstash/agent.rb:477)", + "RUBY.initialize(/usr/share/logstash/logstash-core/lib/logstash/agent.rb:88)", + "org.jruby.RubyClass.new(org/jruby/RubyClass.java:949)", + "org.jruby.RubyClass$INVOKER$i$newInstance.call(org/jruby/RubyClass$INVOKER$i$newInstance.gen)", + "RUBY.create_agent(/usr/share/logstash/logstash-core/lib/logstash/runner.rb:552)", + "RUBY.execute(/usr/share/logstash/logstash-core/lib/logstash/runner.rb:434)", + "RUBY.run(/usr/share/logstash/vendor/bundle/jruby/3.1.0/gems/clamp-1.0.1/lib/clamp/command.rb:68)", + "RUBY.run(/usr/share/logstash/logstash-core/lib/logstash/runner.rb:293)", + "RUBY.run(/usr/share/logstash/vendor/bundle/jruby/3.1.0/gems/clamp-1.0.1/lib/clamp/command.rb:133)", + "usr.share.logstash.lib.bootstrap.environment.
(/usr/share/logstash/lib/bootstrap/environment.rb:89)", + "usr.share.logstash.lib.bootstrap.environment.run(usr/share/logstash/lib/bootstrap//usr/share/logstash/lib/bootstrap/environment.rb)", + "java.lang.invoke.MethodHandle.invokeWithArguments(java/lang/invoke/MethodHandle.java:733)", + "org.jruby.Ruby.runScript(org/jruby/Ruby.java:1245)", + "org.jruby.Ruby.runNormally(org/jruby/Ruby.java:1157)", + "org.jruby.Ruby.runFromMain(org/jruby/Ruby.java:983)", + "org.logstash.Logstash.run(org/logstash/Logstash.java:163)", + "org.logstash.Logstash.main(org/logstash/Logstash.java:73)" + ] +} +[FATAL] 2024-11-11 11:11:11.516 [LogStash::Runner] Logstash - Logstash stopped processing because of an error: (SystemExit) exit + org.jruby.exceptions.SystemExit: (SystemExit) exit + at org.jruby.RubyKernel.exit(org/jruby/RubyKernel.java: 921) ~[jruby.jar:?] + at org.jruby.RubyKernel.exit(org/jruby/RubyKernel.java: 880) ~[jruby.jar:?] + at usr.share.logstash.lib.bootstrap.environment.
(/usr/share/logstash/lib/bootstrap/environment.rb: 90) ~[?:?] +``` + +This error can happen when cgroups v2 is not enabled, such as when running on a Red Had version 8 operating system. + +**Work around** + +Follow your operating system’s instructions for enabling cgroups v2. + + + +## Troubleshooting persistent queues [ts-pqs] + +Symptoms of persistent queue problems include {{ls}} or one or more pipelines not starting successfully, accompanied by an error message similar to this one. + +``` +message=>"java.io.IOException: Page file size is too small to hold elements" +``` + +See the [troubleshooting information](https://www.elastic.co/guide/en/logstash/current/persistent-queues.html#troubleshooting-pqs) in the persistent queue section for more information on remediating problems with persistent queues. + + +## Data ingestion [ts-ingest] + +### Error response code 429 [ts-429] + +A `429` message indicates that an application is busy handling other requests. For example, Elasticsearch sends a `429` code to notify Logstash (or other indexers) that the bulk failed because the ingest queue is full. Logstash will retry sending documents. + +**Possible actions** + +Check {{es}} to see if it needs attention. + +* [Cluster stats API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats) +* [Monitor a cluster](../../../deploy-manage/monitor.md) + +**Sample error** + +``` +[2018-08-21T20:05:36,111][INFO ][logstash.outputs.elasticsearch] retrying +failed action with response code: 429 +({"type"=>"es_rejected_execution_exception", "reason"=>"rejected execution of +org.elasticsearch.transport.TransportService$7@85be457 on +EsThreadPoolExecutor[bulk, queue capacity = 200, +org.elasticsearch.common.util.concurrent.EsThreadPoolExecutor@538c9d8a[Running, +pool size = 16, active threads = 16, queued tasks = 200, completed tasks = +685]]"}) +``` + + + +## Performance [ts-performance] + +For general performance tuning tips and guidelines, see [*Performance tuning*](https://www.elastic.co/guide/en/logstash/current/performance-tuning.html). + + +## Troubleshooting a pipeline [ts-pipeline] + +Pipelines, by definition, are unique. Here are some guidelines to help you get started. + +* Identify the offending pipeline. +* Start small. Create a minimum pipeline that manifests the problem. + +For basic pipelines, this configuration could be enough to make the problem show itself. + +```ruby +input {stdin{}} output {stdout{}} +``` + +{{ls}} can separate logs by pipeline. This feature can help you identify the offending pipeline. Set `pipeline.separate_logs: true` in your `logstash.yml` to enable the log per pipeline feature. + +For more complex pipelines, the problem could be caused by a series of plugins in a specific order. Troubleshooting these pipelines usually requires trial and error. Start by systematically removing input and output plugins until you’re left with the minimum set that manifest the issue. + +We want to expand this section to make it more helpful. If you have troubleshooting tips to share, please: + +* create an issue at [https://github.com/elastic/logstash/issues](https://github.com/elastic/logstash/issues), or +* create a pull request with your proposed changes at [https://github.com/elastic/logstash](https://github.com/elastic/logstash). + + +## Logging level can affect performances [ts-pipeline-logging-level-performance] + +**Symptoms** + +Simple filters such as `mutate` or `json` filter can take several milliseconds per event to execute. Inputs and outputs might be affected, too. + +**Background** + +The different plugins running on Logstash can be quite verbose if the logging level is set to `debug` or `trace`. As the logging library used in Logstash is synchronous, heavy logging can affect performances. + +**Solution** + +Reset the logging level to `info`. + + +## Logging in json format can write duplicate `message` fields [ts-pipeline-logging-json-duplicated-message-field] + +**Symptoms** + +When log format is `json` and certain log events (for example errors from JSON codec plugin) contains two instances of the `message` field. + +Without setting this flag, json log would contain objects like: + +```json +{ + "level":"WARN", + "loggerName":"logstash.codecs.jsonlines", + "timeMillis":1712937761955, + "thread":"[main]. The value -must be at least 100ms if `consumer_threads` is set to `1`. If it is set to a -higher value `n`, then the minimum session timeout increases proportionally to -`n * 100ms`. -``` - -In practice the value must be set much higher than the theoretical value because the behavior of the outputs and filters in a pipeline follows a distribution. The value should also be higher than the maximum time you expect your outputs to stall. The default setting is `10s == 10000ms`. If you are experiencing periodic problems with an output that can stall because of load or similar effects (such as the Elasticsearch output), there is little downside to increasing this value significantly to say `60s`. - -From a performance perspective, decreasing the `max_poll_records` value is preferable to increasing the timeout value. Increasing the timeout is your only option if the client’s issues are caused by periodically stalling outputs. Check logs for evidence of stalling outputs, such as `ES output logging status 429`. - - -#### Kafka input plugin crashes when using schema registry [ts-schema-registry] - -By default, the kafka input plugin checks connectivity and validates the schema registry during plugin registration before events are processed. In some circumstances, this process may fail when it tries to validate an authenticated schema registry, causing the plugin to crash. - -The plugin offers a `schema_registry_validation` setting to change the default behavior. This setting allows the plugin to skip validation during registration, which allows the plugin to continue and events to be processed. See the [kafka input plugin documentation](https://www.elastic.co/guide/en/logstash/current/plugins-inputs-kafka.html#plugins-inputs-kafka-schema_registry_validation) for more information about the plugin and other configuration options. - -::::{note} -An incorrectly configured schema registry will still stop the plugin from processing events. -:::: - - -::::{note} -The default setting of `auto` is the best option for most circumstances and should not need to be changed. -:::: - - - -#### Large number of offset commits (input) [ts-kafka-many-offset-commits] - -**Symptoms** - -Logstash’s Kafka Input is causing a much higher number of commits to the offset topic than expected. Often the complaint also mentions redundant offset commits where the same offset is committed repeatedly. - -**Solution** - -For Kafka Broker versions 0.10.2.1 to 1.0.x: The problem is caused by a bug in Kafka. [https://issues.apache.org/jira/browse/KAFKA-6362](https://issues.apache.org/jira/browse/KAFKA-6362) The client’s best option is upgrading their Kafka Brokers to version 1.1 or newer. - -For older versions of Kafka or if the above does not fully resolve the issue: The problem can also be caused by setting the value for `poll_timeout_ms` too low relative to the rate at which the Kafka Brokers receive events themselves (or if Brokers periodically idle between receiving bursts of events). Increasing the value set for `poll_timeout_ms` proportionally decreases the number of offsets commits in this scenario. For example, raising it by 10x will lead to 10x fewer offset commits. - - -#### Codec Errors in Kafka Input (before Plugin Version 6.3.4 only) [ts-kafka-codec-errors-input] - -**Symptoms** - -Logstash Kafka input randomly logs errors from the configured codec and/or reads events incorrectly (partial reads, mixing data between multiple events etc.). - -``` -Log example: [2018-02-05T13:51:25,773][FATAL][logstash.runner ] An -unexpected error occurred! {:error=>#, -:backtrace=>["org/jruby/RubyArray.java:1892:in `join'", -"org/jruby/RubyArray.java:1898:in `join'", -"/usr/share/logstash/logstash-core/lib/logstash/util/buftok.rb:87:in `extract'", -"/usr/share/logstash/vendor/bundle/jruby/1.9/gems/logstash-codec-line-3.0.8/lib/logstash/codecs/line.rb:38:in -`decode'", -"/usr/share/logstash/vendor/bundle/jruby/1.9/gems/logstash-input-kafka-5.1.11/lib/logstash/inputs/kafka.rb:241:in -`thread_runner'", -"file:/usr/share/logstash/vendor/jruby/lib/jruby.jar!/jruby/java/java_ext/java.lang.rb:12:in -`each'", -"/usr/share/logstash/vendor/bundle/jruby/1.9/gems/logstash-input-kafka-5.1.11/lib/logstash/inputs/kafka.rb:240:in -`thread_runner'"]} -``` - -**Background** - -There was a bug in the way the Kafka Input plugin was handling codec instances when running on multiple threads (`consumer_threads` set to > 1). [https://github.com/logstash-plugins/logstash-input-kafka/issues/210](https://github.com/logstash-plugins/logstash-input-kafka/issues/210) - -**Solution** - -* Upgrade Kafka Input plugin to v. 6.3.4 or later. -* If (and only if) upgrading is not possible, set `consumer_threads` to `1`. - - -#### Setting up debugging for Kerberos SASL [ts-kafka-kerberos-debug] - -You can set up your machine to help you troubleshoot authentication failures in the Kafka client. - -* In `config/jvm.options`, add: - - ```txt - -Dsun.security.krb5.debug=true - ``` - -* In `config/log4j2.properties`, add: - - ```txt - logger.kafkainput.name = logstash.inputs.kafka - logger.kafkainput.level = debug - logger.kafkaoutput.name = logstash.outputs.kafka - logger.kafkaoutput.level = debug - logger.kafka.name = org.apache.kafka - logger.kafka.level = debug - ``` - - -::::{note} -Logging entries for Kerberos are NOT sent through Log4j but go directly to the console. -:::: - - - -## Azure Event Hub issues and solutions [ts-azure] - - -#### Event Hub plugin can’t connect to Storage blob (input) [ts-azure-http] +## Event Hub plugin can’t connect to Storage blob (input) [ts-azure-http] **Symptoms** @@ -219,11 +70,3 @@ To inform the JUL framework of the selected definitions file a property (`java.u The logs could contain sensible information, such credentials, and could be verbose but should give hits on the connection problem at HTTP level with the Azure Blob Storage. -## Other issues [ts-other] - -Coming soon, and you can help! If you have something to add, please: - -* create an issue at [https://github.com/elastic/logstash/issues](https://github.com/elastic/logstash/issues), or -* create a pull request with your proposed changes at [https://github.com/elastic/logstash](https://github.com/elastic/logstash). - -Also check out the [Logstash discussion forum](https://discuss.elastic.co/c/logstash). diff --git a/troubleshoot/ingest/logstash/contribute.md b/troubleshoot/ingest/logstash/contribute.md new file mode 100644 index 0000000000..62c725e68f --- /dev/null +++ b/troubleshoot/ingest/logstash/contribute.md @@ -0,0 +1,16 @@ +--- +navigation_title: Contribute and discuss +--- + +# Contribute to Logstash repositories and discuss issues [ts-other] + +You can file an issue or open a pull request on GitHub: + +* Create an issue at [https://github.com/elastic/logstash/issues](https://github.com/elastic/logstash/issues), or +* Create a pull request with your proposed changes at [https://github.com/elastic/logstash](https://github.com/elastic/logstash). + +You might also want to try the [Logstash discussion forum](https://discuss.elastic.co/c/logstash). + +## Additional resources + +* [Troubleshoot: Contact us](/troubleshoot/index.md) \ No newline at end of file diff --git a/troubleshoot/ingest/logstash/kafka.md b/troubleshoot/ingest/logstash/kafka.md index f680d5b26c..d36e5769dd 100644 --- a/troubleshoot/ingest/logstash/kafka.md +++ b/troubleshoot/ingest/logstash/kafka.md @@ -1,14 +1,12 @@ --- +navigation_title: "Kafka" mapped_pages: - https://www.elastic.co/guide/en/logstash/current/ts-plugins.html --- -# Kafka [ts-plugins] +# Troubleshoot Logstash plugin for Kafka [ts-kafka] -## Kafka issues and solutions [ts-kafka] - - -#### Kafka session timeout issues (input) [ts-kafka-timeout] +## Kafka session timeout issues (input) [ts-kafka-timeout] **Symptoms** @@ -62,7 +60,7 @@ In practice the value must be set much higher than the theoretical value because From a performance perspective, decreasing the `max_poll_records` value is preferable to increasing the timeout value. Increasing the timeout is your only option if the client’s issues are caused by periodically stalling outputs. Check logs for evidence of stalling outputs, such as `ES output logging status 429`. -#### Kafka input plugin crashes when using schema registry [ts-schema-registry] +## Kafka input plugin crashes when using schema registry [ts-schema-registry] By default, the kafka input plugin checks connectivity and validates the schema registry during plugin registration before events are processed. In some circumstances, this process may fail when it tries to validate an authenticated schema registry, causing the plugin to crash. @@ -79,7 +77,7 @@ The default setting of `auto` is the best option for most circumstances and shou -#### Large number of offset commits (input) [ts-kafka-many-offset-commits] +## Large number of offset commits (input) [ts-kafka-many-offset-commits] **Symptoms** @@ -92,7 +90,7 @@ For Kafka Broker versions 0.10.2.1 to 1.0.x: The problem is caused by a bug in K For older versions of Kafka or if the above does not fully resolve the issue: The problem can also be caused by setting the value for `poll_timeout_ms` too low relative to the rate at which the Kafka Brokers receive events themselves (or if Brokers periodically idle between receiving bursts of events). Increasing the value set for `poll_timeout_ms` proportionally decreases the number of offsets commits in this scenario. For example, raising it by 10x will lead to 10x fewer offset commits. -#### Codec Errors in Kafka Input (before Plugin Version 6.3.4 only) [ts-kafka-codec-errors-input] +# **Symptoms** @@ -124,7 +122,7 @@ There was a bug in the way the Kafka Input plugin was handling codec instances w * If (and only if) upgrading is not possible, set `consumer_threads` to `1`. -#### Setting up debugging for Kerberos SASL [ts-kafka-kerberos-debug] +## Setting up debugging for Kerberos SASL [ts-kafka-kerberos-debug] You can set up your machine to help you troubleshoot authentication failures in the Kafka client. @@ -152,78 +150,3 @@ Logging entries for Kerberos are NOT sent through Log4j but go directly to the c -## Azure Event Hub issues and solutions [ts-azure] - - -#### Event Hub plugin can’t connect to Storage blob (input) [ts-azure-http] - -**Symptoms** - -Azure EventHub can’t connect to blob storage: - -``` -[2024-01-01T13:13:13,123][ERROR][com.microsoft.azure.eventprocessorhost.AzureStorageCheckpointLeaseManager][azure_eventhub_pipeline][eh_input_plugin] host logstash-a0a00a00-0aa0-0000-aaaa-0a00a0a0aaaa: Failure while creating lease store -com.microsoft.azure.storage.StorageException: The client could not finish the operation within specified maximum execution timeout. -``` - -Plugin can’t complete registration phase because it can’t connect to Azure Blob Storage configured in the plugin `storage_connection` setting. - -**Background** - -Azure Event Hub plugin can share the offset position of a consumer group with other consumers only if Blob Storage connection settings are configured. EventHub uses the AMQP protocol to transfer data, but Blob storage uses a library which leverages the JDK’s http client, `HttpURLConnection`. To troubleshoot HTTP connection problems, which may be related to proxy settings, the logging level for this part of the JDK has to be increased. The problem is that JDK uses Java Util Logging for its internal logging needs, which is not configurable with the standard `log4j2.properties` shipped with {{ls}}. - -**Possible solutions** - -* Configure {{ls}} settings to enable the JDK logging. - -**Details** - -Steps to enable JDK logging on {{ls}}: - -* Create a properties file with the logging definitions for Java Util Logging (JUL). -* Configure a JVM property to inform JUL to use such definitions file. - -**JUL definitions** - -Create a file that you can use to define logging levels, handlers and loggers. For example, `/conf/jul.properties`. - -```txt -handlers= java.util.logging.ConsoleHandler,java.util.logging.FileHandler -.level= ALL -java.util.logging.FileHandler.pattern = /logs/jul_http%u.log <1> -java.util.logging.FileHandler.limit = 50000 -java.util.logging.FileHandler.count = 1 -java.util.logging.FileHandler.level=ALL -java.util.logging.FileHandler.maxLocks = 100 -java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter - -java.util.logging.ConsoleHandler.level = INFO -java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter - -# defines the logger we are interested in -sun.net.www.protocol.http.HttpURLConnection.level = ALL <2> -``` - -1. The log file will be created in a path defined by the user (`/logs/`) -2. This configuration enables the `sun.net.www.protocol.http.HttpURLConnection` logger, and sets the logging level to `ALL`. It will log all messages directed to it, from highest to lowest priority. - - -**JVM property** - -To inform the JUL framework of the selected definitions file a property (`java.util.logging.config.file`) has to be evaluated, this is where {{ls}}'s `config/jvm.properties` come in handy. Edit the file adding the property, pointing to the path where the JUL definitions file was created: - -```txt --Djava.util.logging.config.file=/conf/jul.properties -``` - -The logs could contain sensible information, such credentials, and could be verbose but should give hits on the connection problem at HTTP level with the Azure Blob Storage. - - -## Other issues [ts-other] - -Coming soon, and you can help! If you have something to add, please: - -* create an issue at [https://github.com/elastic/logstash/issues](https://github.com/elastic/logstash/issues), or -* create a pull request with your proposed changes at [https://github.com/elastic/logstash](https://github.com/elastic/logstash). - -Also check out the [Logstash discussion forum](https://discuss.elastic.co/c/logstash). diff --git a/troubleshoot/ingest/logstash/plugins.md b/troubleshoot/ingest/logstash/plugins.md index f55aa12f7e..4b1e547697 100644 --- a/troubleshoot/ingest/logstash/plugins.md +++ b/troubleshoot/ingest/logstash/plugins.md @@ -1,9 +1,10 @@ --- +navigation_title: "Plugins" mapped_pages: - https://www.elastic.co/guide/en/logstash/current/ts-plugins-general.html --- -# Plugins [ts-plugins-general] +# Troubleshoot Logstash plugins [ts-plugins-general] ## Plugin tracing [ts-plugin-tracing] diff --git a/troubleshoot/kibana/access.md b/troubleshoot/kibana/access.md index c058356ed5..991b83f919 100644 --- a/troubleshoot/kibana/access.md +++ b/troubleshoot/kibana/access.md @@ -50,34 +50,3 @@ To view the {{kib}} status page, use the status endpoint. For example, `localhos For JSON-formatted server status details, use the `localhost:5601/api/status` API endpoint. -======= - -## Troubleshoot {{kib}} UI error [not-ready] - -Troubleshoot the `Kibana Server is not Ready yet` error. - -1. From within a {{kib}} node, confirm the connection to {{es}}: - - ```sh - curl -XGET elasticsearch_ip_or_hostname:9200/ - ``` - -2. Guarantee the health of the three {{kib}}-backing indices. All indices must appear and display `status:green` and `status:open`: - - ```sh - curl -XGET elasticsearch_ip_or_hostname:9200/_cat/indices/.kibana,.kibana_task_manager,.kibana_security_session?v=true - ``` - - These {{kib}}-backing indices must also not have [index settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-settings) flagging `read_only_allow_delete` or `write` [index blocks](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html). - -3. [Shut down all {{kib}} nodes](../../deploy-manage/maintenance/start-stop-services/start-stop-kibana.md). -4. Choose any {{kib}} node, then update the config to set the [debug logging](../../deploy-manage/monitor/logging-configuration/kibana-log-settings-examples.md#change-overall-log-level). -5. [Start the node](../../deploy-manage/maintenance/start-stop-services/start-stop-kibana.md), then check the start-up debug logs for `ERROR` messages or other start-up issues. - - For example: - - * When {{kib}} is unable to connect to a healthy {{es}} cluster, errors like `master_not_discovered_exception` or `unable to revive connection` or `license is not available` errors appear. - * When one or more {{kib}}-backing indices are unhealthy, the `index_not_green_timeout` error appears. - - -You can find a Kibana health troubleshooting walkthrough in [this blog](https://www.elastic.co/blog/troubleshooting-kibana-health) or in [this video](https://www.youtube.com/watch?v=AlgGYcpGvOA). diff --git a/troubleshoot/toc.yml b/troubleshoot/toc.yml index 795f255eba..046695a908 100644 --- a/troubleshoot/toc.yml +++ b/troubleshoot/toc.yml @@ -49,12 +49,8 @@ toc: - file: elasticsearch/diagnosing-invalid-repositories.md - file: elasticsearch/repeated-snapshot-failures.md - file: elasticsearch/troubleshooting-searches.md - - - file: elasticsearch/lifecycle-management.md - children: - - file: elasticsearch/start-ilm.md - - file: elasticsearch/start-slm.md - - file: elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md + - file: elasticsearch/start-ilm.md + - file: elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md - file: elasticsearch/elasticsearch-reference/security.md children: - file: elasticsearch/security/security-trb-settings.md @@ -127,7 +123,6 @@ toc: - file: deployments/cloud-enterprise/troubleshooting-container-engines.md - file: deployments/cloud-enterprise/run-ece-diagnostics-tool.md - file: deployments/cloud-enterprise/ask-for-help.md - - file: deployments/cloud-enterprise/finding-deployments-finding-problems.md - file: deployments/cloud-enterprise/heap-dumps.md - file: deployments/cloud-enterprise/thread-dumps.md - file: deployments/cloud-on-k8s/kubernetes.md @@ -159,6 +154,7 @@ toc: - file: ingest/logstash/kafka.md - file: ingest/logstash/azure-event-hub.md - file: ingest/logstash/health-report-pipelines.md + - file: ingest/logstash/contribute.md - file: ingest/fleet/fleet-elastic-agent.md children: - file: ingest/fleet/common-problems.md From 3f7ce2f7d17e7a25cda7fa35a04f1dfdc62e7db7 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 17:43:39 -0500 Subject: [PATCH 08/15] fix links --- troubleshoot/elasticsearch/elasticsearch-reference.md | 2 +- troubleshoot/ingest/logstash.md | 2 +- troubleshoot/ingest/logstash/contribute.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/troubleshoot/elasticsearch/elasticsearch-reference.md b/troubleshoot/elasticsearch/elasticsearch-reference.md index a09c6b64cf..916e1dcdb2 100644 --- a/troubleshoot/elasticsearch/elasticsearch-reference.md +++ b/troubleshoot/elasticsearch/elasticsearch-reference.md @@ -36,7 +36,7 @@ If you’re using Elastic Cloud Hosted, then you can use AutoOps to monitor your ## Management [troubleshooting-management] * [Troubleshoot index and snapshot lifecycle management](start-ilm.md) -* [Fix index lifecycle management errors](.md) +* [Fix index lifecycle management errors](/troubleshoot/elasticsearch/elasticsearch-reference/index-lifecycle-management-errors.md) ## Capacity [troubleshooting-capacity] diff --git a/troubleshoot/ingest/logstash.md b/troubleshoot/ingest/logstash.md index 8925f1b251..0770ceb074 100644 --- a/troubleshoot/ingest/logstash.md +++ b/troubleshoot/ingest/logstash.md @@ -314,7 +314,7 @@ With `log.format.json.fix_duplicate_message_fields` enabled the duplication of ` * [Troubleshoot Logstash plugins](/troubleshoot/ingest/logstash/plugins.md) * [Logstash: Contribute and discuss](/troubleshoot/ingest/logstash/contribute.md) -* [Troubleshoot: Contact us](/troubleshoot/troubleshoot.md#contact-us) +* [Troubleshoot: Contact us](/troubleshoot/troubleshoot/index.md#contact-us) diff --git a/troubleshoot/ingest/logstash/contribute.md b/troubleshoot/ingest/logstash/contribute.md index 62c725e68f..93837838a0 100644 --- a/troubleshoot/ingest/logstash/contribute.md +++ b/troubleshoot/ingest/logstash/contribute.md @@ -13,4 +13,4 @@ You might also want to try the [Logstash discussion forum](https://discuss.elast ## Additional resources -* [Troubleshoot: Contact us](/troubleshoot/index.md) \ No newline at end of file +* [Troubleshoot: Contact us](/troubleshoot/troubleshoot/index.md) \ No newline at end of file From 213aaf72dc6417a6401b619a7291af82cf2830f9 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 17:54:46 -0500 Subject: [PATCH 09/15] fix build errors --- .../cloud/cloud-enterprise/ece-monitoring-deployments.md | 2 +- troubleshoot/ingest/logstash.md | 2 +- troubleshoot/troubleshoot/index.md | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md b/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md index 023d560f65..dddc704f63 100644 --- a/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md +++ b/raw-migrated-files/cloud/cloud-enterprise/ece-monitoring-deployments.md @@ -2,7 +2,7 @@ Elastic Cloud Enterprise monitors many aspects of your installation, but some issues require a human to resolve them. Use this section to learn how you can: -* [Find clusters](../../../troubleshoot/deployments/cloud-enterprise/finding-deployments-finding-problems.md) that have issues. +* [Find clusters](/troubleshoot/deployments/elastic-cloud.md) that have issues. * [Move affected nodes off an allocator](../../../deploy-manage/maintenance/ece/move-nodes-instances-from-allocators.md), if the allocator fails. * [Enable deployment logging and monitoring](../../../deploy-manage/monitor/stack-monitoring/ece-stack-monitoring.md) to keep an eye on the performance of deployments and debug stack and solution issues. diff --git a/troubleshoot/ingest/logstash.md b/troubleshoot/ingest/logstash.md index 0770ceb074..c01eadfb80 100644 --- a/troubleshoot/ingest/logstash.md +++ b/troubleshoot/ingest/logstash.md @@ -197,7 +197,7 @@ A `429` message indicates that an application is busy handling other requests. F Check {{es}} to see if it needs attention. * [Cluster stats API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats) -* [Monitor a cluster](../../../deploy-manage/monitor.md) +* [Monitoring](/deploy-manage/monitor.md) **Sample error** diff --git a/troubleshoot/troubleshoot/index.md b/troubleshoot/troubleshoot/index.md index f6b810de79..58f4dc087f 100644 --- a/troubleshoot/troubleshoot/index.md +++ b/troubleshoot/troubleshoot/index.md @@ -13,6 +13,8 @@ mapped_urls: % Use migrated content from existing pages that map to this page: +## Contact us [contact-us] + % - [ ] ./raw-migrated-files/tech-content/starting-with-the-elasticsearch-platform-and-its-solutions/get-support-help.md % - [ ] ./raw-migrated-files/tech-content/starting-with-the-elasticsearch-platform-and-its-solutions/troubleshooting-and-faqs.md % - next one added by marciw manually for tracking From cb255aa02b2cf56693e0e7f4483513c94e3851f5 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 17:57:55 -0500 Subject: [PATCH 10/15] revert a moot comment --- explore-analyze/visualize/graph/graph-troubleshooting.md | 1 - 1 file changed, 1 deletion(-) diff --git a/explore-analyze/visualize/graph/graph-troubleshooting.md b/explore-analyze/visualize/graph/graph-troubleshooting.md index 7b5853125f..be825f82e6 100644 --- a/explore-analyze/visualize/graph/graph-troubleshooting.md +++ b/explore-analyze/visualize/graph/graph-troubleshooting.md @@ -7,7 +7,6 @@ mapped_pages: - https://www.elastic.co/guide/en/kibana/current/graph-troubleshooting.html --- -% marciw redirect to ../../../troubleshoot/kibana/graph.md -- 100% dupe # Troubleshooting and limitations [graph-troubleshooting] From ecc986698aa48c6bf851ce61fb1eecf9c6cbb567 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 17:58:16 -0500 Subject: [PATCH 11/15] Update graph-troubleshooting.md --- explore-analyze/visualize/graph/graph-troubleshooting.md | 1 + 1 file changed, 1 insertion(+) diff --git a/explore-analyze/visualize/graph/graph-troubleshooting.md b/explore-analyze/visualize/graph/graph-troubleshooting.md index be825f82e6..9f79dcc987 100644 --- a/explore-analyze/visualize/graph/graph-troubleshooting.md +++ b/explore-analyze/visualize/graph/graph-troubleshooting.md @@ -8,6 +8,7 @@ mapped_pages: --- + # Troubleshooting and limitations [graph-troubleshooting] From c1bd64d2116c093eaa89971b2c0c903662e181ac Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 18:06:56 -0500 Subject: [PATCH 12/15] please --- troubleshoot/troubleshoot/index.md | 28 ---------------------------- 1 file changed, 28 deletions(-) delete mode 100644 troubleshoot/troubleshoot/index.md diff --git a/troubleshoot/troubleshoot/index.md b/troubleshoot/troubleshoot/index.md deleted file mode 100644 index 58f4dc087f..0000000000 --- a/troubleshoot/troubleshoot/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -mapped_urls: - - https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/get-support-help.html - - https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current/troubleshooting-and-faqs.html - - https://www.elastic.co/guide/en/cloud/current/ec-get-help.html ---- - -# Troubleshoot - -% What needs to be done: Refine - -% Scope notes: - Match new content type; TOC entry TBD - consider splitting out subsections? - -% Use migrated content from existing pages that map to this page: - -## Contact us [contact-us] - -% - [ ] ./raw-migrated-files/tech-content/starting-with-the-elasticsearch-platform-and-its-solutions/get-support-help.md -% - [ ] ./raw-migrated-files/tech-content/starting-with-the-elasticsearch-platform-and-its-solutions/troubleshooting-and-faqs.md -% - next one added by marciw manually for tracking -% - [ ] ./raw-migrated-files/cloud/cloud/ec-get-help.md (especially IDs -- no generated list because page was incorrectly mapped to a new v3 page instead of as a many-to-one for this page) - -% WIP sections added by marciw -% see https://docs.elastic.dev/content-architecture/content-type/troubleshooting/entrypoint -% ## one for each grouping -% ## Additional resources [troubleshoot-additional-resources] -% ## Contact us [troubleshoot-contact-us] -% ### Working with support \ No newline at end of file From 8a4ba8460e96fe56a732ca34b52e8ea20351a8bf Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 18:09:36 -0500 Subject: [PATCH 13/15] fix path --- troubleshoot/ingest/logstash.md | 2 +- troubleshoot/ingest/logstash/contribute.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/troubleshoot/ingest/logstash.md b/troubleshoot/ingest/logstash.md index c01eadfb80..2d83fb51ab 100644 --- a/troubleshoot/ingest/logstash.md +++ b/troubleshoot/ingest/logstash.md @@ -314,7 +314,7 @@ With `log.format.json.fix_duplicate_message_fields` enabled the duplication of ` * [Troubleshoot Logstash plugins](/troubleshoot/ingest/logstash/plugins.md) * [Logstash: Contribute and discuss](/troubleshoot/ingest/logstash/contribute.md) -* [Troubleshoot: Contact us](/troubleshoot/troubleshoot/index.md#contact-us) +* [Troubleshoot: Contact us](/troubleshoot/index.md#contact-us) diff --git a/troubleshoot/ingest/logstash/contribute.md b/troubleshoot/ingest/logstash/contribute.md index 93837838a0..62c725e68f 100644 --- a/troubleshoot/ingest/logstash/contribute.md +++ b/troubleshoot/ingest/logstash/contribute.md @@ -13,4 +13,4 @@ You might also want to try the [Logstash discussion forum](https://discuss.elast ## Additional resources -* [Troubleshoot: Contact us](/troubleshoot/troubleshoot/index.md) \ No newline at end of file +* [Troubleshoot: Contact us](/troubleshoot/index.md) \ No newline at end of file From ea5be14a719c6eceb39b309cb5bd4ea8ecc39f57 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Fri, 14 Feb 2025 18:11:18 -0500 Subject: [PATCH 14/15] Update index.md --- troubleshoot/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/troubleshoot/index.md b/troubleshoot/index.md index f6b810de79..2d9ce6d005 100644 --- a/troubleshoot/index.md +++ b/troubleshoot/index.md @@ -9,6 +9,8 @@ mapped_urls: % What needs to be done: Refine +## Contact us [contact-us] + % Scope notes: - Match new content type; TOC entry TBD - consider splitting out subsections? % Use migrated content from existing pages that map to this page: From 69dfd03cee7ecf2f11cb7fba1da8ffb22af9cc86 Mon Sep 17 00:00:00 2001 From: Marci W <333176+marciw@users.noreply.github.com> Date: Mon, 17 Feb 2025 12:13:10 -0500 Subject: [PATCH 15/15] checkpoint --- .../esf/elastic-serverless-forwarder.md | 12 ++++---- troubleshoot/deployments/serverless-status.md | 29 +++++++++++++++++++ troubleshoot/deployments/serverless.md | 26 ++++------------- troubleshoot/toc.yml | 4 ++- 4 files changed, 44 insertions(+), 27 deletions(-) create mode 100644 troubleshoot/deployments/serverless-status.md diff --git a/troubleshoot/deployments/esf/elastic-serverless-forwarder.md b/troubleshoot/deployments/esf/elastic-serverless-forwarder.md index bf93100a09..9800532cc5 100644 --- a/troubleshoot/deployments/esf/elastic-serverless-forwarder.md +++ b/troubleshoot/deployments/esf/elastic-serverless-forwarder.md @@ -1,15 +1,16 @@ --- +navigation_title: "Elastic Serverless Forwarder" mapped_pages: - https://www.elastic.co/guide/en/esf/current/aws-serverless-troubleshooting.html --- -# Elastic Serverless Forwarder [aws-serverless-troubleshooting] +# Troubleshoot Elastic Serverless Forwarder for AWS [aws-serverless-troubleshooting] -## Troubleshooting deployment errors [_troubleshooting_deployment_errors] +## Check deployment errors [_troubleshooting_deployment_errors] You can view the status of deployment actions and get additional information on events, including why a particular event fails e.g. misconfiguration details. @@ -22,12 +23,12 @@ For example, if you don’t increase the visibility timeout for an SQS queue as -## Preventing unexpected costs [preventing-unexpected-costs] +## Prevent unexpected costs [preventing-unexpected-costs] It is important to monitor the Elastic Serverless Forwarder Lambda function for timeouts to prevent unexpected costs. You can use the [AWS Lambda integration](https://docs.elastic.co/en/integrations/aws/lambda) for this. If the timeouts are constant, you should throttle the Lambda function to stop its execution before proceeding with any troubleshooting steps. In most cases, constant timeouts will cause the records and messages from the event triggers to go back to their sources and trigger the function again, which will cause further timeouts and force a loop that will incure unexpected high costs. For more information on throttling Lambda functions, refer to [AWS docs](https://docs.aws.amazon.com/lambda/latest/operatorguide/throttling.md). -### Increase debug information [_increase_debug_information] +## Increase debug information [_increase_debug_information] To help with debugging, you can increase the amount of logging detail by adding an environment variable as follows: @@ -35,7 +36,6 @@ To help with debugging, you can increase the amount of logging detail by adding 2. Click **Configuration** and select **Environment Variables** and choose **Edit** 3. Click **Add environment variable** and enter `LOG_LEVEL` as **Key*** and `DEBUG` as ***Value** and click **Save** - ## Using the Event ID format (version 1.6.0 and above) [aws-serverless-troubleshooting-event-id-format] Version 1.6.0 introduces a new event ID format that prevents duplicate ID errors when a high volume of events is ingested to {{es}}. This new format combines a timestamp with data specific to the relevant AWS resource, extracted from the AWS Lambda event received by the forwarder. @@ -46,7 +46,7 @@ The timestamp is used as a prefix for the ID, because identifiers that gradually If old events that are already published to {{es}} using a version of Elastic Serverless Forwarder before v1.6.0 are ingested again, they will be treated as new events and published to {{es}} as duplicates. :::: - +% TODO pull out error info to separate topic ## Error handling [_error_handling] diff --git a/troubleshoot/deployments/serverless-status.md b/troubleshoot/deployments/serverless-status.md new file mode 100644 index 0000000000..d67dd6d335 --- /dev/null +++ b/troubleshoot/deployments/serverless-status.md @@ -0,0 +1,29 @@ +--- +navigation_title: "Check status" +mapped_pages: + - https://www.elastic.co/guide/en/serverless/current/general-serverless-status.html +--- + +# Check Serverless status and get updates [general-serverless-status] + +Serverless projects run on cloud platforms, which may undergo changes in availability. When availability changes, Elastic makes sure to provide you with a current service status. + +To check current and past service availability, go to the Elastic [service status](https://status.elastic.co/?section=serverless) page. + + +## Subscribe to updates [general-serverless-status-subscribe-to-updates] + +You can be notified about changes to the service status automatically. + +To receive service status updates: + +1. Go to the Elastic [service status](https://status.elastic.co/?section=serverless) page. +2. Select **SUBSCRIBE TO UPDATES**. +3. You can be notified in the following ways: + + * Email + * Slack + * Atom or RSS feeds + + +After you subscribe, you’ll be notified whenever a service status update is posted. diff --git a/troubleshoot/deployments/serverless.md b/troubleshoot/deployments/serverless.md index 6d604d87b4..4406ff2c6b 100644 --- a/troubleshoot/deployments/serverless.md +++ b/troubleshoot/deployments/serverless.md @@ -1,28 +1,14 @@ --- -mapped_pages: - - https://www.elastic.co/guide/en/serverless/current/general-serverless-status.html +navigation_title: "Serverless" --- -# Check Serverless status and get updates [general-serverless-status] +# Troubleshoot {{serverless-full}} -Serverless projects run on cloud platforms, which may undergo changes in availability. When availability changes, Elastic makes sure to provide you with a current service status. +Use the topics in this section to troubleshoot {{serverless-full}}: -To check current and past service availability, go to the Elastic [service status](https://status.elastic.co/?section=serverless) page. +* [](/troubleshoot/deployments/serverless-status.md) +* [](/troubleshoot/deployments/esf/elastic-serverless-forwarder.md) -## Subscribe to updates [general-serverless-status-subscribe-to-updates] -You can be notified about changes to the service status automatically. - -To receive service status updates: - -1. Go to the Elastic [service status](https://status.elastic.co/?section=serverless) page. -2. Select **SUBSCRIBE TO UPDATES**. -3. You can be notified in the following ways: - - * Email - * Slack - * Atom or RSS feeds - - -After you subscribe, you’ll be notified whenever a service status update is posted. +## Additional resources diff --git a/troubleshoot/toc.yml b/troubleshoot/toc.yml index 2da839c41a..3e134ea8d1 100644 --- a/troubleshoot/toc.yml +++ b/troubleshoot/toc.yml @@ -110,6 +110,9 @@ toc: - file: deployments.md children: - file: deployments/serverless.md + children: + - file: deployments/serverless-status.md + - file: deployments/esf/elastic-serverless-forwarder.md - file: deployments/elastic-cloud.md children: - file: deployments/elastic-cloud/monitoring.md @@ -131,7 +134,6 @@ toc: - file: deployments/cloud-on-k8s/troubleshooting-methods.md - file: deployments/cloud-on-k8s/run-eck-diagnostics.md - file: deployments/cloud-on-k8s/jvm-heap-dumps.md - - file: deployments/esf/elastic-serverless-forwarder.md - file: monitoring/cloud.md children: - file: monitoring/autoops.md