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.

Sign up for GitHub

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 15 additions & 17 deletions troubleshoot/ingest/logstash/diagnostic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,29 +50,27 @@ To capture a {{ls}} diagnostic:

The following command options are recommended:

::::{tab-set}
:::{tab-item} Unix-based systems
* Unix-based systems

```sh
sudo ./diagnostics.sh --type logstash-local --host 127.0.0.1 --port 9600 --bypassDiagVerify
```
:::

:::{tab-item} Windows
```sh
sudo ./diagnostics.sh --type logstash-local --host 127.0.0.1 --port 9600 --bypassDiagVerify
```

* Windows

```sh
.\diagnostics.bat --type logstash-local --host 127.0.0.1 --port 9600 --bypassDiagVerify
```
```sh
.\diagnostics.bat --type logstash-local --host 127.0.0.1 --port 9600 --bypassDiagVerify
```

::::{tip}
::::{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.

::::
::::
Comment on lines +65 to +73
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 •
edited
Loading

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


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).

Expand Down
Loading