aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoralextarazanov <alextarazanov@yandex-team.com>2022-10-11 12:53:41 +0300
committeralextarazanov <alextarazanov@yandex-team.com>2022-10-11 12:53:41 +0300
commit2af1f5432f8a7af75c3e2b1ba1c61aef355a322f (patch)
tree45809f82d4d74fb99e7bd27abe03801c7f58e1c0
parent6bdd88bc45f7e0cb7acb377bb2c3b86ea6c28bd9 (diff)
downloadydb-2af1f5432f8a7af75c3e2b1ba1c61aef355a322f.tar.gz
[review] [YDB] Logs docs check translate
-rw-r--r--ydb/docs/en/core/cluster/audit-logs.md24
-rw-r--r--ydb/docs/en/core/cluster/logs.md17
-rw-r--r--ydb/docs/en/core/deploy/toc_p.yaml2
-rw-r--r--ydb/docs/ru/core/cluster/audit-logs.md4
4 files changed, 44 insertions, 3 deletions
diff --git a/ydb/docs/en/core/cluster/audit-logs.md b/ydb/docs/en/core/cluster/audit-logs.md
index 3b88c5013a7..d2fbc93f515 100644
--- a/ydb/docs/en/core/cluster/audit-logs.md
+++ b/ydb/docs/en/core/cluster/audit-logs.md
@@ -2,6 +2,28 @@
All schema changes (successful and unsuccessful) and ACL changes are recorded in _audit logs_.
+## Enabling audit logs
+
+Audit logs are provided as part of YDB [component logging](./logs.md).
+
+To enable audit logs, you need to [change the logging level](../maintenance/embedded_monitoring/logs.md#change_log_level):
+
+1. Follow the link in the format
+
+ ```bash
+ http://<endpoint>:8765/cms
+ ```
+
+ The `Cluster Management System` page opens.
+
+1. On the **Configs** tab, click on the `LogConfigItems` line.
+
+1. Under `Component log settings`, find the `FLAT_TX_SCHEMESHARD` component. Set this component's logging level to `NOTICE` or higher.
+
+1. To save changes, click `Submit`
+
+Audit logs are written together with other YDB logs.
+
## Audit log format {#format}
A log event consists of comma-separated `key: value` fields:
@@ -27,7 +49,7 @@ One event describes one transaction. An event can describe several operations pe
### Operation fields {#sub-operation-fields}
* `operation`: (mandatory) The operation name.
-* `path`: (optional) The path to the change object.
+* `path`: (optional) The path to the change object. This field might change during a transaction.
* `src path`: (optional) The path to the source object (for copy and move operations).
* `dst path`: (optional) The path to the target object (for copy and move operations).
* `no path`: (optional) If there is no change object, the value is `no path`.
diff --git a/ydb/docs/en/core/cluster/logs.md b/ydb/docs/en/core/cluster/logs.md
new file mode 100644
index 00000000000..db3eb246868
--- /dev/null
+++ b/ydb/docs/en/core/cluster/logs.md
@@ -0,0 +1,17 @@
+# Logs
+Each YDB component writes messages to logs at different levels. They can be used to detect severe issues or identify the root causes of issues.
+
+## Logging setup {#log_setup}
+You can configure logging for the various components of the YDB [monitoring system](../maintenance/embedded_monitoring/logs.md#change_log_level).
+
+There are currently two options for running YDB logging.
+
+### Manually {#log_setup_manually}
+YDB provides standard mechanisms for collecting logs and metrics.
+Logging is done to standard `stdout` and `stderr` streams and can be redirected using popular solutions. We recommend using a combination of Fluentd and Elastic Stack.
+
+### Using systemd {#log_setup_systemd}
+Default logs are written to `journald` and can be retrieved via
+```
+journalctl -u ydbd
+```
diff --git a/ydb/docs/en/core/deploy/toc_p.yaml b/ydb/docs/en/core/deploy/toc_p.yaml
index 2057b32ae08..2b153d64d3f 100644
--- a/ydb/docs/en/core/deploy/toc_p.yaml
+++ b/ydb/docs/en/core/deploy/toc_p.yaml
@@ -3,6 +3,8 @@ items:
href: index.md
- name: System requirements and recommendations
href: ../cluster/system-requirements.md
+- name: Logging
+ href: ../cluster/logs.md
- name: Topology
href: ../cluster/topology.md
- include: { mode: link, path: toc_i.yaml } \ No newline at end of file
diff --git a/ydb/docs/ru/core/cluster/audit-logs.md b/ydb/docs/ru/core/cluster/audit-logs.md
index d32837f15a3..42c159e4690 100644
--- a/ydb/docs/ru/core/cluster/audit-logs.md
+++ b/ydb/docs/ru/core/cluster/audit-logs.md
@@ -6,7 +6,7 @@
Аудитный логи поставляются в рамках [логгирования компонентов](./logs.md) YDB.
-Чтобы подключить аудитных логи нужно [измененить уровни логирования](../maintenance/embedded_monitoring/logs.md#change_log_level):
+Чтобы подключить аудитные логи, нужно [изменить уровни логирования](../maintenance/embedded_monitoring/logs.md#change_log_level):
1. Перейти по ссылке вида
@@ -18,7 +18,7 @@
1. На вкладке **Configs** кликнуть на строку `LogConfigItems`.
-1. В разделе `Component log settings` найти компонент `FLAT_TX_SCHEMESHARD`. Выставить у этого компонента уровень логирования не ниже чем `NOTICE`.
+1. В разделе `Component log settings` найти компонент `FLAT_TX_SCHEMESHARD`. Выставить у этого компонента уровень логирования не ниже, чем `NOTICE`.
1. Сохранить изменения нажатием кнопки `Submit`