Skip to content

Docs: describe diagnostics collection #19007

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
Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Docs: describe diagnostics collection #19007

wants to merge 22 commits into from

Conversation

shnikd
Copy link
Contributor

@shnikd shnikd commented May 29, 2025 •
edited
Loading

Changelog entry

Changelog category

  • Documentation (changelog entry is not required)

Description for reviewers

Docs for:

Issues:

@shnikd shnikd requested a review from a team as a code owner May 29, 2025 11:40
@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

🟢 2025-06-06 13:09:51 UTC The validation of the Pull Request description is successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

⚪ 2025-05-29 11:41:32 UTC Pre-commit check linux-x86_64-relwithdebinfo for 2ab02e8 has started.
⚪ 2025-05-29 11:41:47 UTC Artifacts will be uploaded here
⚪ 2025-05-29 11:44:09 UTC ya make is running...

@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

⚪ 2025-05-29 11:41:37 UTC Pre-commit check linux-x86_64-release-asan for 2ab02e8 has started.
⚪ 2025-05-29 11:41:48 UTC Artifacts will be uploaded here
⚪ 2025-05-29 11:44:11 UTC ya make is running...

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 29, 2025
gridnevvvit
gridnevvvit reviewed May 29, 2025
View reviewed changes
gridnevvvit
gridnevvvit reviewed May 29, 2025
View reviewed changes
gridnevvvit
gridnevvvit reviewed May 29, 2025
View reviewed changes
ydb/docs/ru/core/reference/ydb-cli/sql.md Outdated

Опция `--diagnostics-file <path_to_diagnostics>` позволяет сохранять расширенную информацию о выполнении SQL-запросов в отдельный JSON-файл.

Диагностика формируется при сборе статистики (`--stats full` или `--stats profile`), а также при выполнении `EXPLAIN`-запросов. Для каждого запроса будет создан файл `<path_to_diagnostics>.json` со следующими полями:
Copy link
Member

Choose a reason for hiding this comment

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

Для каждого запроса - откуда их несколько возникает?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Для каждого запроса который ты выполняешь через ydb sql

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@ydbot
Copy link
Collaborator

ydbot commented May 29, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

⚪ 2025-05-29 12:18:36 UTC Pre-commit check linux-x86_64-release-asan for 6bf37ba has started.
⚪ 2025-05-29 12:18:47 UTC Artifacts will be uploaded here
⚪ 2025-05-29 12:21:00 UTC ya make is running...

@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

⚪ 2025-05-29 12:18:37 UTC Pre-commit check linux-x86_64-relwithdebinfo for 6bf37ba has started.
⚪ 2025-05-29 12:18:47 UTC Artifacts will be uploaded here
⚪ 2025-05-29 12:21:09 UTC ya make is running...

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@ydbot
Copy link
Collaborator

ydbot commented May 29, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

⚪ 2025-05-29 12:51:50 UTC Pre-commit check linux-x86_64-release-asan for ee631fa has started.
⚪ 2025-05-29 12:52:00 UTC Artifacts will be uploaded here
⚪ 2025-05-29 12:54:16 UTC ya make is running...
🟢 2025-05-29 12:54:22 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-29 12:54:27 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

⚪ 2025-05-29 12:56:03 UTC Pre-commit check linux-x86_64-release-asan for d631397 has started.
⚪ 2025-05-29 12:56:14 UTC Artifacts will be uploaded here
⚪ 2025-05-29 12:58:36 UTC ya make is running...
🟢 2025-05-29 12:58:42 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-29 12:58:48 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

⚪ 2025-05-29 12:56:04 UTC Pre-commit check linux-x86_64-relwithdebinfo for d631397 has started.
⚪ 2025-05-29 12:56:15 UTC Artifacts will be uploaded here
⚪ 2025-05-29 12:58:37 UTC ya make is running...
🟢 2025-05-29 12:58:43 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-29 12:58:48 UTC Build successful.

@ydbot
Copy link
Collaborator

ydbot commented May 29, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

gridnevvvit
gridnevvvit reviewed May 29, 2025
View reviewed changes
ydb/docs/ru/core/reference/ydb-cli/sql.md Outdated
> **Важно:**
> Файл диагностики может содержать конфиденциальные данные в полях **`meta.query_text`**, **`plan`** и **`ast`**. Перед передачей такого файла сторонним лицам (например, в техническую поддержку) рекомендуется вручную просмотреть и отредактировать содержимое файла, чтобы удалить или заменить чувствительную информацию.

**Пример запроса с чувствительной информацией:**
Copy link
Member

Choose a reason for hiding this comment

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

сейчас сформулированно странно.
я бы так не писал, ты важность этого подчернул выше. зачем это дублировать и подчеркивать непонятно.
я бы написал например так

Например, чтобы собрать диагностику в файл somefilename.json и проверить содержимое диагностического по выполнению запроса, выполните команду

..

Чтобы прочитать ast запроса выполните команду и через инструмент jq получите доступ к ast.

Что то похожее нужно и для explain , при этом в тексте нужно подчеркнуть, что вы хотите собрать диагностику относительно плана для запроса, но при этом не хотите его выполнять нужно выполнить команду.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Build logs

Warnings (16)

⚠️ en/reference/ydb-cli/sql.md: 71: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]

⚠️ en/reference/ydb-cli/sql.md: 73: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```json"]

⚠️ en/reference/ydb-cli/sql.md: 75: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]

⚠️ en/reference/ydb-cli/sql.md: 79: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```json"]

⚠️ en/reference/ydb-cli/sql.md: 81: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]

⚠️ en/reference/ydb-cli/sql.md: 83: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```json"]

⚠️ en/reference/ydb-cli/sql.md: 88: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]

⚠️ en/reference/ydb-cli/sql.md: 90: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```json"]

⚠️ ru/reference/ydb-cli/sql.md: 71: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]

⚠️ ru/reference/ydb-cli/sql.md: 73: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```json"]

⚠️ ru/reference/ydb-cli/sql.md: 75: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]

⚠️ ru/reference/ydb-cli/sql.md: 79: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```json"]

⚠️ ru/reference/ydb-cli/sql.md: 81: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]

⚠️ ru/reference/ydb-cli/sql.md: 83: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```json"]

⚠️ ru/reference/ydb-cli/sql.md: 88: MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]

Log was truncated. (1 records)

@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

⚪ 2025-05-29 13:25:22 UTC Pre-commit check linux-x86_64-relwithdebinfo for d9e7e1b has started.
⚪ 2025-05-29 13:25:45 UTC Artifacts will be uploaded here
⚪ 2025-05-29 13:28:26 UTC ya make is running...
🟢 2025-05-29 13:28:32 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-29 13:28:38 UTC Build successful.

@ydbot
Copy link
Collaborator

ydbot commented May 29, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 29, 2025 •
edited
Loading

⚪ 2025-05-29 13:29:53 UTC Pre-commit check linux-x86_64-release-asan for d9e7e1b has started.
⚪ 2025-05-29 13:30:05 UTC Artifacts will be uploaded here
⚪ 2025-05-29 13:32:27 UTC ya make is running...
🟢 2025-05-29 13:32:32 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-05-29 13:32:38 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 Jun 17, 2025 •
edited
Loading

⚪ 2025-06-17 18:40:02 UTC Pre-commit check linux-x86_64-release-asan for ee9c703 has started.
⚪ 2025-06-17 18:40:14 UTC Artifacts will be uploaded here
⚫ 2025-06-17 18:42:29 UTC Check cancelled

@shnikd @blinkov
Apply suggestions from code review
d6fa1d3 
Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>
@ydbot
Copy link
Collaborator

ydbot commented Jun 17, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 17, 2025 •
edited
Loading

⚪ 2025-06-17 18:46:12 UTC Pre-commit check linux-x86_64-relwithdebinfo for 255c478 has started.
⚪ 2025-06-17 18:46:24 UTC Artifacts will be uploaded here
⚪ 2025-06-17 18:48:55 UTC ya make is running...
🟢 2025-06-17 18:49:02 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-17 18:49:08 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 17, 2025 •
edited
Loading

⚪ 2025-06-17 18:46:15 UTC Pre-commit check linux-x86_64-release-asan for 255c478 has started.
⚪ 2025-06-17 18:46:27 UTC Artifacts will be uploaded here
⚪ 2025-06-17 18:48:56 UTC ya make is running...
🟢 2025-06-17 18:49:03 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-17 18:49:12 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 Jun 25, 2025 •
edited
Loading

⚪ 2025-06-25 00:18:58 UTC Pre-commit check linux-x86_64-release-asan for 613dab0 has started.
⚪ 2025-06-25 00:19:24 UTC Artifacts will be uploaded here
⚪ 2025-06-25 00:21:45 UTC ya make is running...
🟢 2025-06-25 00:21:52 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-25 00:21:59 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@ydbot
Copy link
Collaborator

ydbot commented Jun 25, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 25, 2025 •
edited
Loading

⚪ 2025-06-25 00:53:16 UTC Pre-commit check linux-x86_64-relwithdebinfo for 613dab0 has started.
⚪ 2025-06-25 00:53:40 UTC Artifacts will be uploaded here
⚪ 2025-06-25 00:56:25 UTC ya make is running...
🟢 2025-06-25 00:56:31 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-25 00:56:39 UTC Build successful.

@shnikd shnikd requested a review from blinkov June 25, 2025 10:04
@ydbot
Copy link
Collaborator

ydbot commented Jun 25, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 25, 2025 •
edited
Loading

⚪ 2025-06-25 18:05:48 UTC Pre-commit check linux-x86_64-relwithdebinfo for b23510f has started.
⚪ 2025-06-25 18:06:00 UTC Artifacts will be uploaded here
⚪ 2025-06-25 18:08:25 UTC ya make is running...
🟢 2025-06-25 18:08:32 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-25 18:08:38 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 25, 2025 •
edited
Loading

⚪ 2025-06-25 18:07:26 UTC Pre-commit check linux-x86_64-release-asan for b23510f has started.
⚪ 2025-06-25 18:07:39 UTC Artifacts will be uploaded here
⚪ 2025-06-25 18:10:07 UTC ya make is running...
🟢 2025-06-25 18:10:14 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-25 18:10:21 UTC Build successful.

@ydbot
Copy link
Collaborator

ydbot commented Jun 26, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 26, 2025 •
edited
Loading

⚪ 2025-06-26 00:44:53 UTC Pre-commit check linux-x86_64-relwithdebinfo for 1116048 has started.
⚪ 2025-06-26 00:45:23 UTC Artifacts will be uploaded here
⚪ 2025-06-26 00:48:35 UTC ya make is running...
🟢 2025-06-26 00:48:42 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-26 00:48:49 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 26, 2025 •
edited
Loading

⚪ 2025-06-26 00:53:08 UTC Pre-commit check linux-x86_64-release-asan for 1116048 has started.
⚪ 2025-06-26 00:53:21 UTC Artifacts will be uploaded here
⚪ 2025-06-26 00:55:42 UTC ya make is running...
🟢 2025-06-26 00:55:48 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-26 00:55:55 UTC Build successful.

@ydbot
Copy link
Collaborator

ydbot commented Jun 27, 2025

Hey @ElenaAfina, it has been 53 business-hours since the author's last update, could you please review?

@ydbot
Copy link
Collaborator

ydbot commented Jun 27, 2025

🔄 New commits pushed — @ElenaAfina please take a look.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 27, 2025 •
edited
Loading

⚪ 2025-06-27 10:20:48 UTC Pre-commit check linux-x86_64-release-asan for cdbef9b has started.
⚪ 2025-06-27 10:21:17 UTC Artifacts will be uploaded here
⚪ 2025-06-27 10:24:14 UTC ya make is running...
🟢 2025-06-27 10:24:22 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-27 10:24:29 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 27, 2025 •
edited
Loading

⚪ 2025-06-27 10:21:21 UTC Pre-commit check linux-x86_64-relwithdebinfo for cdbef9b has started.
⚪ 2025-06-27 10:21:29 UTC Artifacts will be uploaded here
⚪ 2025-06-27 10:23:56 UTC ya make is running...
🟢 2025-06-27 10:24:03 UTC Tests successful.

Test history | Ya make output | Test bloat

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

🟢 2025-06-27 10:24:11 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@ydbot
Copy link
Collaborator

ydbot commented Jun 30, 2025

Hey @ElenaAfina, it has been 83 business-hours since the author's last update, could you please review?

@ydbot
Copy link
Collaborator

ydbot commented Jul 1, 2025

Hey @ElenaAfina, it has been 113 business-hours since the author's last update, could you please review?

@ydbot
Copy link
Collaborator

ydbot commented Jul 3, 2025

Hey @ElenaAfina, it has been 143 business-hours since the author's last update, could you please review?

@ElenaAfina
Copy link
Collaborator

@shnikd - тут осталось замечание о том, что надо указать, какая статистика будет собрана и выгружена в поле stats, и в каких единицах - так что тут надо доделать, пока ревью не пройдено до конца

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gridnevvvit gridnevvvit gridnevvvit left review comments

Copilot code review Copilot Copilot left review comments

@ElenaAfina ElenaAfina Awaiting requested review from ElenaAfina

@blinkov blinkov Awaiting requested review from blinkov

Requested changes must be addressed to merge this pull request.

Assignees

@ElenaAfina ElenaAfina

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

Successfully merging this pull request may close these issues.
5 participants
@shnikd @ydbot @ElenaAfina @blinkov @gridnevvvit