-
Notifications
You must be signed in to change notification settings - Fork 106
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
base: main
Are you sure you want to change the base?
Conversation
👋 @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 🙂
🔍 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. |
There was a problem hiding this 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. 🙂
::::{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. | ||
|
||
:::: | ||
:::: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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).

👋 @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