Skip to content
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

Jump to bottom

Added the Troubleshooting section #10888

Merged
merged 11 commits into from
Nov 28, 2024
Merged

Added the Troubleshooting section #10888

merged 11 commits into from
Nov 28, 2024

Conversation

anton-bobkov
Copy link
Collaborator

Changelog category

  • Documentation

Additional information

Added a new section about Troubleshooting performance issues

@anton-bobkov anton-bobkov requested a review from a team as a code owner October 25, 2024 09:54
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 25, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 25, 2024 •
edited
Loading

⚪ 2024-10-25 09:55:38 UTC Pre-commit check linux-x86_64-relwithdebinfo for 3631f63 has started.
⚪ 2024-10-25 09:56:14 UTC Artifacts will be uploaded here
⚪ 2024-10-25 09:59:23 UTC ya make is running...
🟢 2024-10-25 10:01:35 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-25 10:01:40 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 25, 2024 •
edited
Loading

⚪ 2024-10-25 09:56:17 UTC Pre-commit check linux-x86_64-release-asan for 3631f63 has started.
⚪ 2024-10-25 09:56:53 UTC Artifacts will be uploaded here
⚪ 2024-10-25 09:59:54 UTC ya make is running...
🟢 2024-10-25 10:01:25 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-25 10:01:30 UTC Build successful.

@anton-bobkov anton-bobkov requested a review from blinkov October 25, 2024 09:56
@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

eivanov89
eivanov89 reviewed Oct 25, 2024
View reviewed changes
ydb/docs/en/core/dev/troubleshooting/performance/index.md Outdated Show resolved Hide resolved
ydb/docs/en/core/dev/troubleshooting/performance/infrastructure/_includes/network.md
@@ -0,0 +1,11 @@
To diagnose network issues, use the healthcheck in the [Embedded UI](../../../../../reference/embedded-ui/index.md):
Copy link
Member

Choose a reason for hiding this comment

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

I might be wrong, but I believe that network issues in UI are related to connectivity issues, i.e. when some nodes are not reachable. But other network issues are probably not displayed in our UI. Instead, user should check metrics.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added a step to use third-party tools to monitor network performance metrics

ydb/docs/en/core/dev/troubleshooting/performance/infrastructure/hardware.md Show resolved Hide resolved
ydb/docs/en/core/dev/troubleshooting/performance/hardware/_includes/cpu-bottleneck.md

1. Open the **CPU** dashboard in Grafana.

1. See if the following charts show any spikes:
Copy link
Member

Choose a reason for hiding this comment

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

I would add information how to check CPU utilization: number of cores used vs. number of cores available.

ydb/docs/en/core/dev/troubleshooting/performance/hardware/insufficient-memory.md Outdated Show resolved Hide resolved
shmel1k
shmel1k previously requested changes Oct 27, 2024
View reviewed changes
ydb/docs/en/core/dev/troubleshooting/performance/hardware/cpu-bottleneck.md Outdated Show resolved Hide resolved
ydb/docs/en/core/dev/troubleshooting/performance/hardware/disk-space.md Outdated

{% note info %}

You can also use the [Healthcheck API](../../../../reference/ydb-sdk/health-check-api.md) in your application to get this information.
Copy link
Member

Choose a reason for hiding this comment

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

Probably, we can write something like

It is also recommended to use the Healthcheck API (we are using it in internal installations, by the way)

Task opensource active checks sounds good for SRE Team @kobzonega

ydb/docs/en/core/dev/troubleshooting/performance/index.md Outdated Show resolved Hide resolved
ydb/docs/en/core/dev/troubleshooting/performance/system/ydb-updates.md Outdated Show resolved Hide resolved
ydb/docs/en/core/dev/troubleshooting/performance/system/ydb-updates.md Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 29, 2024 •
edited
Loading

⚪ 2024-10-29 16:12:50 UTC Pre-commit check linux-x86_64-release-asan for 4ae4e83 has started.
⚪ 2024-10-29 16:13:00 UTC Artifacts will be uploaded here
⚪ 2024-10-29 16:15:30 UTC ya make is running...
🟢 2024-10-29 16:16:54 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-29 16:16:59 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 29, 2024 •
edited
Loading

⚪ 2024-10-29 16:14:02 UTC Pre-commit check linux-x86_64-relwithdebinfo for 4ae4e83 has started.
⚪ 2024-10-29 16:14:12 UTC Artifacts will be uploaded here
⚪ 2024-10-29 16:16:42 UTC ya make is running...
🟢 2024-10-29 16:17:44 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-29 16:17:49 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 30, 2024 •
edited
Loading

⚪ 2024-10-30 08:04:13 UTC Pre-commit check linux-x86_64-release-asan for e80ad02 has started.
⚪ 2024-10-30 08:04:17 UTC Artifacts will be uploaded here
⚪ 2024-10-30 08:06:45 UTC ya make is running...
🟢 2024-10-30 08:08:08 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-30 08:08:13 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 30, 2024 •
edited
Loading

⚪ 2024-10-30 08:04:15 UTC Pre-commit check linux-x86_64-relwithdebinfo for e80ad02 has started.
⚪ 2024-10-30 08:04:19 UTC Artifacts will be uploaded here
⚪ 2024-10-30 08:06:55 UTC ya make is running...
🟢 2024-10-30 08:08:47 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-30 08:08:52 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 21, 2024 •
edited
Loading

⚪ 2024-11-21 13:51:11 UTC Pre-commit check linux-x86_64-release-asan for 7e913c5 has started.
⚪ 2024-11-21 13:51:26 UTC Artifacts will be uploaded here
⚪ 2024-11-21 13:54:06 UTC ya make is running...
🟢 2024-11-21 13:55:22 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-11-21 13:55:29 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 21, 2024 •
edited
Loading

⚪ 2024-11-21 14:13:50 UTC Pre-commit check linux-x86_64-relwithdebinfo for a04539f has started.
⚪ 2024-11-21 14:14:02 UTC Artifacts will be uploaded here
⚪ 2024-11-21 14:16:29 UTC ya make is running...
🟢 2024-11-21 14:17:50 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-11-21 14:17:57 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 21, 2024 •
edited
Loading

⚪ 2024-11-21 14:14:06 UTC Pre-commit check linux-x86_64-release-asan for a04539f has started.
⚪ 2024-11-21 14:14:19 UTC Artifacts will be uploaded here
⚪ 2024-11-21 14:16:58 UTC ya make is running...
🟢 2024-11-21 14:18:13 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-11-21 14:18:20 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 22, 2024 •
edited
Loading

⚪ 2024-11-22 06:41:51 UTC Pre-commit check linux-x86_64-release-asan for 003eb7b has started.
⚪ 2024-11-22 06:42:03 UTC Artifacts will be uploaded here
⚪ 2024-11-22 06:44:29 UTC ya make is running...
⚫ 2024-11-22 06:45:50 UTC Check cancelled

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 22, 2024 •
edited
Loading

⚪ 2024-11-22 06:41:59 UTC Pre-commit check linux-x86_64-relwithdebinfo for 003eb7b has started.
⚪ 2024-11-22 06:42:11 UTC Artifacts will be uploaded here
⚪ 2024-11-22 06:44:44 UTC ya make is running...
⚫ 2024-11-22 06:45:54 UTC Check cancelled

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 22, 2024 •
edited
Loading

⚪ 2024-11-22 06:49:26 UTC Pre-commit check linux-x86_64-relwithdebinfo for 612feec has started.
⚪ 2024-11-22 06:49:39 UTC Artifacts will be uploaded here
⚪ 2024-11-22 06:52:06 UTC ya make is running...
🟢 2024-11-22 06:53:30 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-11-22 06:53:36 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 22, 2024 •
edited
Loading

⚪ 2024-11-22 06:49:28 UTC Pre-commit check linux-x86_64-release-asan for 612feec has started.
⚪ 2024-11-22 06:49:41 UTC Artifacts will be uploaded here
⚪ 2024-11-22 06:52:09 UTC ya make is running...
🟢 2024-11-22 06:53:30 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-11-22 06:53:37 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 27, 2024 •
edited
Loading

⚪ 2024-11-27 12:54:42 UTC Pre-commit check linux-x86_64-relwithdebinfo for af7bb06 has started.
⚪ 2024-11-27 12:54:55 UTC Artifacts will be uploaded here
⚪ 2024-11-27 12:57:23 UTC ya make is running...
🟢 2024-11-27 12:58:45 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-11-27 12:58:52 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 27, 2024 •
edited
Loading

⚪ 2024-11-27 12:55:10 UTC Pre-commit check linux-x86_64-release-asan for af7bb06 has started.
⚪ 2024-11-27 12:55:22 UTC Artifacts will be uploaded here
⚪ 2024-11-27 12:57:49 UTC ya make is running...
🟢 2024-11-27 12:59:06 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-11-27 12:59:14 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 28, 2024 •
edited
Loading

⚪ 2024-11-28 05:44:32 UTC Pre-commit check linux-x86_64-release-asan for 8e917bf has started.
⚪ 2024-11-28 05:44:44 UTC Artifacts will be uploaded here
⚪ 2024-11-28 05:47:12 UTC ya make is running...
🟢 2024-11-28 05:48:36 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-11-28 05:48:43 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 28, 2024 •
edited
Loading

⚪ 2024-11-28 05:46:49 UTC Pre-commit check linux-x86_64-relwithdebinfo for 8e917bf has started.
⚪ 2024-11-28 05:47:01 UTC Artifacts will be uploaded here
⚪ 2024-11-28 05:49:27 UTC ya make is running...
🟢 2024-11-28 05:49:34 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-11-28 05:49:40 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@blinkov blinkov enabled auto-merge (squash) November 28, 2024 09:45
@blinkov blinkov dismissed shmel1k’s stale review November 28, 2024 09:45

it blocks merge

@blinkov blinkov merged commit 7827174 into ydb-platform:main Nov 28, 2024
11 checks passed
@StekPerepolnen StekPerepolnen mentioned this pull request Nov 29, 2024
Open
@naspirato naspirato mentioned this pull request Dec 1, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eivanov89 eivanov89 eivanov89 left review comments

@CyberROFL CyberROFL CyberROFL left review comments

@fomichev3000 fomichev3000 fomichev3000 approved these changes

@shmel1k shmel1k shmel1k left review comments

@blinkov blinkov Awaiting requested review from blinkov

@serbel324 serbel324 Awaiting requested review from serbel324

@kruall kruall Awaiting requested review from kruall

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@anton-bobkov @CyberROFL @fomichev3000 @eivanov89 @shmel1k @blinkov