Skip to content

Update logstah/diagnostic.md #1902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update logstah/diagnostic.md #1902

wants to merge 1 commit into from

Conversation

stefnestor
Copy link
Contributor

👋 @theletterf, removing the tabs from just created LS Diag page from #1726 because it sub-content'd wrong but afterwards if it's okay I decided I like not tabs for searchability 🙂

"3." onwards shouldn't be sub-content

  • image
  • image

👋 @theletterf, removing the tabs from just created [LS Diag](https://www.elastic.co/docs/troubleshoot/ingest/logstash/diagnostic) page from #1726 because it sub-content'd wrong but afterwards if it's okay I decided I like not tabs for searchability 🙂
@stefnestor stefnestor requested a review from a team as a code owner June 24, 2025 16:03
Copy link

🔍 Preview links for changed docs:

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A minor suggestion below. 🙂

Comment on lines +65 to +73
::::{tip}

You can run the script in three [modes](https://github.com/elastic/support-diagnostics#diagnostic-types):
You can run the script in three [modes](https://github.com/elastic/support-diagnostics#diagnostic-types):

* `local` (default, recommended): Polls the [{{ls}} API](https://www.elastic.co/docs/api/doc/logstash/), gathers operating system info, and captures node logs.
* `remote`: Establishes an ssh session to the applicable target server to pull the same information as `local`.
* `api`: Polls the [{{ls}} API](https://www.elastic.co/docs/api/doc/logstash/). All other data must be collected manually.
* `local` (default, recommended): Polls the [{{ls}} API](https://www.elastic.co/docs/api/doc/logstash/), gathers operating system info, and captures node logs.
* `remote`: Establishes an ssh session to the applicable target server to pull the same information as `local`.
* `api`: Polls the [{{ls}} API](https://www.elastic.co/docs/api/doc/logstash/). All other data must be collected manually.

::::
::::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you indent all the lines in the {tip} (65-73) one more time, the admonition block should better align with the list items:

Before After
image Screenshot 2025-06-24 at 5 53 47 PM

Copy link
Contributor

@colleenmcginnis colleenmcginnis Jun 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, just for the future, it looks like before the second {tab-item} and the {tab-set} were never closed. This snippet would fix that:

2. Using the same environment parameters, run the diagnostic tool script.

    For information about the parameters that you can pass to the tool, refer to the [diagnostic parameter reference](https://github.com/elastic/support-diagnostics#standard-options).

    :::::{tab-set}
    ::::{tab-item} Unix-based systems
    ```sh
    sudo ./diagnostics.sh --type logstash-local --host 127.0.0.1 --port 9600 --bypassDiagVerify
    ```
    ::::
    ::::{tab-item} Windows
    ```sh
    .\diagnostics.bat --type logstash-local --host 127.0.0.1 --port 9600 --bypassDiagVerify
    ```
    ::::
    :::::

    ::::{tip}

    You can run the script in three [modes](https://github.com/elastic/support-diagnostics#diagnostic-types):

    * `local` (default, recommended): Polls the [{{ls}} API](https://www.elastic.co/docs/api/doc/logstash/), gathers operating system info, and captures node logs.
    * `remote`: Establishes an ssh session to the applicable target server to pull the same information as `local`.
    * `api`: Polls the [{{ls}} API](https://www.elastic.co/docs/api/doc/logstash/). All other data must be collected manually.

    ::::

3. When the script has completed, verify that no errors were logged to `diagnostic.log`. If the log file contains errors, refer to [Diagnose errors in `diagnostic.log`](#diagnostic-log-errors).
Screenshot 2025-06-24 at 5 52 52 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants