From 338725d6a23db3c3e59fe7dad7471629131f8b73 Mon Sep 17 00:00:00 2001 From: Ivan Blinkov Date: Mon, 13 May 2024 07:47:58 -0700 Subject: [PATCH] YDBDOCS-668: use proper playbook name (#4474) --- .../devops/ansible/observability/logging.md | 22 +++++++++---------- .../devops/ansible/observability/logging.md | 22 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/ydb/docs/en/core/devops/ansible/observability/logging.md b/ydb/docs/en/core/devops/ansible/observability/logging.md index 79595c9e055e..a554be41140b 100644 --- a/ydb/docs/en/core/devops/ansible/observability/logging.md +++ b/ydb/docs/en/core/devops/ansible/observability/logging.md @@ -4,14 +4,14 @@ During [initial deployment](../initial-deployment.md), the Ansible playbook sets ## View logs via Ansible playbook -[ydb-ansible-examples](https://github.com/ydb-platform/ydb-ansible-examples) repository contains a playbook called `logs.yaml` that can be used to show logs of all {{ ydb-short-name }} nodes in a cluster. The playbook gathers logs from nodes and outputs them to `stdout`, which allows to pipe them for further processing, for example with commands like `grep` or `awk`. +[ydb-ansible-examples](https://github.com/ydb-platform/ydb-ansible-examples) repository contains a playbook called `ydb_platform.ydb.logs` that can be used to show logs of all {{ ydb-short-name }} nodes in a cluster. The playbook gathers logs from nodes and outputs them to `stdout`, which allows to pipe them for further processing, for example with commands like `grep` or `awk`. ### All logs of all nodes -By default, the `logs.yaml` playbook fetches logs of all {{ ydb-short-name }} nodes. The command to do it: +By default, the `ydb_platform.ydb.logs` playbook fetches logs of all {{ ydb-short-name }} nodes. The command to do it: ```bash -ansible-playbook logs.yaml +ansible-playbook ydb_platform.ydb.logs ``` ### Filter by node type @@ -21,18 +21,18 @@ There are two main node types in a {{ ydb-short-name }} cluster: * Storage (also known as static) * Database (also known as dynamic) -Tasks in the `logs.yaml` playbook are tagged with node types, so you can use Ansible's tags functionality to filter logs by node type. +Tasks in the `ydb_platform.ydb.logs` playbook are tagged with node types, so you can use Ansible's tags functionality to filter logs by node type. These two commands are equivalent and will output the storage node logs: ```bash -ansible-playbook logs.yaml --tags storage -ansible-playbook logs.yaml --tags static +ansible-playbook ydb_platform.ydb.logs --tags storage +ansible-playbook ydb_platform.ydb.logs --tags static ``` These two commands are equivalent, too, and will output the database node logs: ```bash -ansible-playbook logs.yaml --tags database -ansible-playbook logs.yaml --tags dynamic +ansible-playbook ydb_platform.ydb.logs --tags database +ansible-playbook ydb_platform.ydb.logs --tags dynamic ``` ### Filter by hostname @@ -40,13 +40,13 @@ ansible-playbook logs.yaml --tags dynamic To show logs of a specific host or subset of hosts, use the `--limit` argument: ```bash -ansible-playbook logs.yaml --limit='' -ansible-playbook logs.yaml --limit='' +ansible-playbook ydb_platform.ydb.logs --limit='' +ansible-playbook ydb_platform.ydb.logs --limit='' ``` It can be used together with tags, too: ```bash -ansible-playbook logs.yaml --tags database --limit='' +ansible-playbook ydb_platform.ydb.logs --tags database --limit='' ``` ## View logs via ssh diff --git a/ydb/docs/ru/core/devops/ansible/observability/logging.md b/ydb/docs/ru/core/devops/ansible/observability/logging.md index fffe0b07e04f..6beef5986945 100644 --- a/ydb/docs/ru/core/devops/ansible/observability/logging.md +++ b/ydb/docs/ru/core/devops/ansible/observability/logging.md @@ -4,14 +4,14 @@ ## Просмотр логов с помощью Ansible playbook -Репозиторий [ydb-ansible-examples](https://github.com/ydb-platform/ydb-ansible-examples) содержит playbook под названием `logs.yaml`, который можно использовать для просмотра логов со всех узлов {{ ydb-short-name }} кластера. Этот playbook собирает логи с узлов и выводит в `stdout`, что позволяет при необходимости дальше их обработать, например, с помощью команд `grep` или `awk`. +Репозиторий [ydb-ansible-examples](https://github.com/ydb-platform/ydb-ansible-examples) содержит playbook под названием `ydb_platform.ydb.logs`, который можно использовать для просмотра логов со всех узлов {{ ydb-short-name }} кластера. Этот playbook собирает логи с узлов и выводит в `stdout`, что позволяет при необходимости дальше их обработать, например, с помощью команд `grep` или `awk`. ### Все логи всех узлов -По умолчанию playbook `logs.yaml` извлекает логи всех узлов {{ ydb-short-name }}. Команда для этого: +По умолчанию playbook `ydb_platform.ydb.logs` извлекает логи всех узлов {{ ydb-short-name }}. Команда для этого: ```bash -ansible-playbook logs.yaml +ansible-playbook ydb_platform.ydb.logs ``` ### Фильтрация по типу узла @@ -21,20 +21,20 @@ ansible-playbook logs.yaml * Storage (также известны как статические) * Database (также известны как динамические) -Задачи в playbook'е `logs.yaml` размечены тегами по типам узлов, благодаря чему можно использовать функциональность тегов Ansible для фильтрации логов по типу узла. +Задачи в playbook'е `ydb_platform.ydb.logs` размечены тегами по типам узлов, благодаря чему можно использовать функциональность тегов Ansible для фильтрации логов по типу узла. Следующие две команды эквивалентны и будут выводить логи статических узлов: ```bash -ansible-playbook logs.yaml --tags storage -ansible-playbook logs.yaml --tags static +ansible-playbook ydb_platform.ydb.logs --tags storage +ansible-playbook ydb_platform.ydb.logs --tags static ``` Эти две команды также эквивалентны и будут выводить логи динамических узлов: ```bash -ansible-playbook logs.yaml --tags database -ansible-playbook logs.yaml --tags dynamic +ansible-playbook ydb_platform.ydb.logs --tags database +ansible-playbook ydb_platform.ydb.logs --tags dynamic ``` ### Фильтрация по имени хоста @@ -42,14 +42,14 @@ ansible-playbook logs.yaml --tags dynamic Чтобы отобразить логи определенного хоста или подмножества хостов, используйте аргумент `--limit`: ```bash -ansible-playbook logs.yaml --limit='' -ansible-playbook logs.yaml --limit='' +ansible-playbook ydb_platform.ydb.logs --limit='' +ansible-playbook ydb_platform.ydb.logs --limit='' ``` Его также можно использовать вместе с тегами: ```bash -ansible-playbook logs.yaml --tags database --limit='' +ansible-playbook ydb_platform.ydb.logs --tags database --limit='' ``` ## Просмотр логов по ssh