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.

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

sync EN and RU version operations/server-configuration-parameters/settings.md add text_log description, translate to RU trace_log.md #13923

Merged
merged 6 commits into from
Aug 25, 2020
53 changes: 43 additions & 10 deletions docs/en/operations/server-configuration-parameters/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,13 +339,13 @@ Writing to the syslog is also supported. Config example:
</logger>
```

Keys:
Keys for syslog:

- use\_syslog — Required setting if you want to write to the syslog.
- address — The host\[:port\] of syslogd. If omitted, the local daemon is used.
- hostname — Optional. The name of the host that logs are sent from.
- facility — [The syslog facility keyword](https://en.wikipedia.org/wiki/Syslog#Facility) in uppercase letters with the “LOG\_” prefix: (`LOG_USER`, `LOG_DAEMON`, `LOG_LOCAL3`, and so on).
Default value: `LOG_USER` if `address` is specified, `LOG_DAEMON otherwise.`
Default value: `LOG_USER` if `address` is specified, `LOG_DAEMON` otherwise.
- format – Message format. Possible values: `bsd` and `syslog.`

## send\_crash\_reports {#server_configuration_parameters-logger}
Expand All @@ -357,8 +357,8 @@ The server will need an access to public Internet via IPv4 (at the time of writi

Keys:

- `enabled` – Boolean flag to enable the feature. Set to `true` to allow sending crash reports.
- `endpoint` – Overrides the Sentry endpoint.
- `enabled` – Boolean flag to enable the feature, `false` by default. Set to `true` to allow sending crash reports.
- `endpoint` – You can override the Sentry endpoint URL for sending crash reports. It can be either separate Sentry account or your self-hosted Sentry instance. Use the [Sentry DSN](https://docs.sentry.io/error-reporting/quickstart/?platform=native#configure-the-sdk) syntax.
- `anonymize` - Avoid attaching the server hostname to crash report.
- `http_proxy` - Configure HTTP proxy for sending crash reports.
- `debug` - Sets the Sentry client into debug mode.
Expand Down Expand Up @@ -397,6 +397,7 @@ The cache is shared for the server and memory is allocated as needed. The cache
``` xml
<mark_cache_size>5368709120</mark_cache_size>
```

## max\_server\_memory\_usage {#max_server_memory_usage}

Limits total RAM usage by the ClickHouse server.
Expand Down Expand Up @@ -589,7 +590,8 @@ Use the following parameters to configure logging:

- `database` – Name of the database.
- `table` – Name of the system table.
- `partition_by` – Sets a [custom partitioning key](../../engines/table-engines/mergetree-family/custom-partitioning-key.md).
- `partition_by` — [Custom partitioning key](../../engines/table-engines/mergetree-family/custom-partitioning-key.md) for a system table. Can't be used if `engine` defined.
- `engine` - [MergeTree Engine Definition](../../engines/table-engines/mergetree-family/mergetree.md#table_engine-mergetree-creating-a-table) for a system table. Can't be used if `partition_by` defined.
- `flush_interval_milliseconds` – Interval for flushing data from the buffer in memory to the table.

**Example**
Expand Down Expand Up @@ -650,7 +652,8 @@ Use the following parameters to configure logging:

- `database` – Name of the database.
- `table` – Name of the system table the queries will be logged in.
- `partition_by` – Sets a [custom partitioning key](../../engines/table-engines/mergetree-family/custom-partitioning-key.md) for a table.
- `partition_by` — [Custom partitioning key](../../engines/table-engines/mergetree-family/custom-partitioning-key.md) for a system table. Can't be used if `engine` defined.
- `engine` - [MergeTree Engine Definition](../../engines/table-engines/mergetree-family/mergetree.md#table_engine-mergetree-creating-a-table) for a system table. Can't be used if `partition_by` defined.
- `flush_interval_milliseconds` – Interval for flushing data from the buffer in memory to the table.

If the table doesn’t exist, ClickHouse will create it. If the structure of the query log changed when the ClickHouse server was updated, the table with the old structure is renamed, and a new table is created automatically.
Expand All @@ -661,7 +664,7 @@ If the table doesn’t exist, ClickHouse will create it. If the structure of the
<query_log>
<database>system</database>
<table>query_log</table>
<partition_by>toMonday(event_date)</partition_by>
<engine>Engine = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_date + INTERVAL 30 day</engine>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
</query_log>
```
Expand All @@ -676,7 +679,8 @@ Use the following parameters to configure logging:

- `database` – Name of the database.
- `table` – Name of the system table the queries will be logged in.
- `partition_by` – Sets a [custom partitioning key](../../engines/table-engines/mergetree-family/custom-partitioning-key.md) for a system table.
- `partition_by` — [Custom partitioning key](../../engines/table-engines/mergetree-family/custom-partitioning-key.md) for a system table. Can't be used if `engine` defined.
- `engine` - [MergeTree Engine Definition](../../engines/table-engines/mergetree-family/mergetree.md#table_engine-mergetree-creating-a-table) for a system table. Can't be used if `partition_by` defined.
- `flush_interval_milliseconds` – Interval for flushing data from the buffer in memory to the table.

If the table doesn’t exist, ClickHouse will create it. If the structure of the query thread log changed when the ClickHouse server was updated, the table with the old structure is renamed, and a new table is created automatically.
Expand All @@ -692,6 +696,34 @@ If the table doesn’t exist, ClickHouse will create it. If the structure of the
</query_thread_log>
```

## text\_log {#server_configuration_parameters-text_log}

Settings for the [text\_log](../../operations/system-tables/text_log.md#system_tables-text_log) system table for logging text messages.

Parameters:

- `level` — Maximum Message Level (by default `Trace`) which will be stored in a table.
- `database` — Database name.
- `table` — Table name.
- `partition_by` — [Custom partitioning key](../../engines/table-engines/mergetree-family/custom-partitioning-key.md) for a system table. Can't be used if `engine` defined.
- `engine` - [MergeTree Engine Definition](../../engines/table-engines/mergetree-family/mergetree.md#table_engine-mergetree-creating-a-table) for a system table. Can't be used if `partition_by` defined.
- `flush_interval_milliseconds` — Interval for flushing data from the buffer in memory to the table.

**Example**
```xml
<yandex>
<text_log>
<level>notice</level>
<database>system</database>
<table>text_log</table>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
<!-- <partition_by>event_date</partition_by> -->
<engine>Engine = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_date + INTERVAL 30 day</engine>
</text_log>
</yandex>
```


## trace\_log {#server_configuration_parameters-trace_log}

Settings for the [trace\_log](../../operations/system-tables/trace_log.md#system_tables-trace_log) system table operation.
Expand All @@ -700,7 +732,8 @@ Parameters:

- `database` — Database for storing a table.
- `table` — Table name.
- `partition_by` — [Custom partitioning key](../../engines/table-engines/mergetree-family/custom-partitioning-key.md) for a system table.
- `partition_by` — [Custom partitioning key](../../engines/table-engines/mergetree-family/custom-partitioning-key.md) for a system table. Can't be used if `engine` defined.
- `engine` - [MergeTree Engine Definition](../../engines/table-engines/mergetree-family/index.md) for a system table. Can't be used if `partition_by` defined.
- `flush_interval_milliseconds` — Interval for flushing data from the buffer in memory to the table.

The default server configuration file `config.xml` contains the following settings section:
Expand All @@ -717,7 +750,7 @@ The default server configuration file `config.xml` contains the following settin
## query\_masking\_rules {#query-masking-rules}

Regexp-based rules, which will be applied to queries as well as all log messages before storing them in server logs,
`system.query_log`, `system.text_log`, `system.processes` table, and in logs sent to the client. That allows preventing
`system.query_log`, `system.text_log`, `system.processes` tables, and in logs sent to the client. That allows preventing
sensitive data leakage from SQL queries (like names, emails, personal
identifiers or credit card numbers) to logs.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/operations/system-tables/text_log.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# system.text_log {#system-tables-text-log}
# system.text\_log {#system_tables-text_log}

Contains logging entries. Logging level which goes to this table can be limited with `text_log.level` server setting.

Expand Down
2 changes: 1 addition & 1 deletion docs/es/operations/system-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ Columna:
- `query` (String) – The query text. For `INSERT`, no incluye los datos para insertar.
- `query_id` (String) – Query ID, if defined.

## sistema.text\_log {#system-tables-text-log}
## sistema.text\_log {#system_tables-text_log}

Contiene entradas de registro. El nivel de registro que va a esta tabla se puede limitar con `text_log.level` configuración del servidor.

Expand Down
2 changes: 1 addition & 1 deletion docs/fa/operations/system-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ CurrentMetric_ReplicatedChecks: 0
- `query` (String) – The query text. For `INSERT` این شامل داده ها برای وارد کردن نیست.
- `query_id` (String) – Query ID, if defined.

## سیستم.\_خروج {#system-tables-text-log}
## سیستم.\_خروج {#system_tables-text_log}

شامل ورودی ورود به سیستم. سطح ورود به سیستم که می رود به این جدول را می توان با محدود `text_log.level` تنظیم سرور.

Expand Down
2 changes: 1 addition & 1 deletion docs/fr/operations/system-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ Colonne:
- `query` (String) – The query text. For `INSERT` il n'inclut pas les données à insérer.
- `query_id` (String) – Query ID, if defined.

## système.text\_log {#system-tables-text-log}
## système.text\_log {#system_tables-text_log}

Contient des entrées de journalisation. Niveau de journalisation qui va à cette table peut être limité `text_log.level` paramètre de serveur.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -320,10 +320,9 @@ ou
LAYOUT(DIRECT())
```

### complex\_key\_cache {#complex-key-cache}

Ce type de stockage est pour une utilisation avec composite [touches](external-dicts-dict-structure.md). Semblable à `direct`.
### complex\_key\_direct {#complex-key-direct}

Ce type de stockage est destiné à être utilisé avec des [clés](../../../sql-reference/dictionaries/external-dictionaries/external-dicts-dict-structure.md) composites. Similaire à `direct`

### ip\_trie {#ip-trie}

Expand Down
2 changes: 1 addition & 1 deletion docs/ja/operations/system-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ CurrentMetric_ReplicatedChecks: 0
- `query` (String) – The query text. For `INSERT`,挿入するデータは含まれません。
- `query_id` (String) – Query ID, if defined.

## システムtext\_log {#system-tables-text-log}
## システムtext\_log {#system_tables-text_log}

を含むログイン作品の応募がありました。 ログレベルがこのテーブルで限定 `text_log.level` サーバー設定。

Expand Down