2016-02-07 21:58:58 +00:00
<?xml version="1.0"?>
2019-02-13 21:16:40 +00:00
<!--
NOTE: User and query level settings are set up in "users.xml" file.
2020-08-08 01:21:04 +00:00
If you have accidentally specified user-level settings here, server won't start.
2020-06-04 19:30:30 +00:00
You can either move the settings to the right place inside "users.xml" file
or add <skip_check_for_incorrect_settings > 1</skip_check_for_incorrect_settings> here.
2019-02-13 21:16:40 +00:00
-->
2016-02-07 21:58:58 +00:00
<yandex >
2017-04-01 07:20:54 +00:00
<logger >
2020-01-23 20:35:32 +00:00
<!-- Possible levels: https://github.com/pocoproject/poco/blob/poco - 1.9.4 - release/Foundation/include/Poco/Logger.h#L105 -->
2017-04-01 07:20:54 +00:00
<level > trace</level>
<log > /var/log/clickhouse-server/clickhouse-server.log</log>
<errorlog > /var/log/clickhouse-server/clickhouse-server.err.log</errorlog>
2020-11-18 20:06:58 +00:00
<!-- Rotation policy
See https://github.com/pocoproject/poco/blob/poco-1.9.4-release/Foundation/include/Poco/FileChannel.h#L54-L85
-->
2017-04-01 07:20:54 +00:00
<size > 1000M</size>
<count > 10</count>
2018-02-08 19:12:37 +00:00
<!-- <console>1</console> --> <!-- Default behavior is autodetection (log to console if not daemon mode and is tty) -->
2020-04-27 18:21:01 +00:00
2020-04-27 18:21:01 +00:00
<!-- Per level overrides (legacy):
2020-04-27 18:21:01 +00:00
For example to suppress logging of the ConfigReloader you can use:
2020-04-27 18:21:01 +00:00
NOTE: levels.logger is reserved, see below.
2020-04-27 18:21:01 +00:00
-->
<!--
<levels >
<ConfigReloader > none</ConfigReloader>
</levels>
-->
2020-04-27 18:21:01 +00:00
<!-- Per level overrides:
For example to suppress logging of the RBAC for default user you can use:
(But please note that the logger name maybe changed from version to version, even after minor upgrade)
-->
<!--
<levels >
<logger >
<name > ContextAccess (default)</name>
<level > none</level>
</logger>
<logger >
<name > DatabaseOrdinary (test)</name>
<level > none</level>
</logger>
</levels>
-->
2017-04-01 07:20:54 +00:00
</logger>
2020-04-27 18:21:01 +00:00
2020-05-29 19:53:16 +00:00
<send_crash_reports >
2020-06-16 12:56:28 +00:00
<!-- Changing <enabled> to true allows sending crash reports to -->
<!-- the ClickHouse core developers team via Sentry https://sentry.io -->
2020-05-29 19:53:16 +00:00
<!-- Doing so at least in pre - production environments is highly appreciated -->
<enabled > false</enabled>
2020-05-30 08:13:04 +00:00
<!-- Change <anonymize> to true if you don't feel comfortable attaching the server hostname to the crash report -->
<anonymize > false</anonymize>
2020-06-16 20:01:15 +00:00
<!-- Default endpoint should be changed to different Sentry DSN only if you have -->
<!-- some in - house engineers or hired consultants who're going to debug ClickHouse issues for you -->
<endpoint > https://6f33034cfe684dd7a3ab9875e57b1c8d@o388870.ingest.sentry.io/5226277</endpoint>
2020-05-29 19:53:16 +00:00
</send_crash_reports>
2018-02-26 06:49:17 +00:00
<!-- display_name>production</display_name --> <!-- It is the name that will be shown in the client -->
2017-04-01 07:20:54 +00:00
<http_port > 8123</http_port>
2017-10-12 18:30:45 +00:00
<tcp_port > 9000</tcp_port>
2020-01-21 22:38:20 +00:00
<mysql_port > 9004</mysql_port>
2020-02-22 14:26:39 +00:00
<!-- For HTTPS and SSL over native protocol. -->
2020-02-22 00:45:53 +00:00
<!--
2017-04-01 07:20:54 +00:00
<https_port > 8443</https_port>
2018-03-29 01:41:06 +00:00
<tcp_port_secure > 9440</tcp_port_secure>
2020-02-22 00:45:53 +00:00
-->
2020-02-22 14:26:39 +00:00
<!-- Used with https_port and tcp_port_secure. Full ssl options list: https://github.com/ClickHouse - Extras/poco/blob/master/NetSSL_OpenSSL/include/Poco/Net/SSLManager.h#L71 -->
<openSSL >
<server > <!-- Used for https server AND secure tcp port -->
<!-- openssl req - subj "/CN=localhost" - new - newkey rsa:2048 - days 365 - nodes - x509 - keyout /etc/clickhouse - server/server.key - out /etc/clickhouse - server/server.crt -->
<certificateFile > /etc/clickhouse-server/server.crt</certificateFile>
<privateKeyFile > /etc/clickhouse-server/server.key</privateKeyFile>
<!-- openssl dhparam - out /etc/clickhouse - server/dhparam.pem 4096 -->
<dhParamsFile > /etc/clickhouse-server/dhparam.pem</dhParamsFile>
<verificationMode > none</verificationMode>
<loadDefaultCAFile > true</loadDefaultCAFile>
<cacheSessions > true</cacheSessions>
<disableProtocols > sslv2,sslv3</disableProtocols>
<preferServerCiphers > true</preferServerCiphers>
</server>
2020-04-06 19:27:57 +00:00
<client > <!-- Used for connecting to https dictionary source and secured Zookeeper communication -->
2020-02-22 14:26:39 +00:00
<loadDefaultCAFile > true</loadDefaultCAFile>
<cacheSessions > true</cacheSessions>
<disableProtocols > sslv2,sslv3</disableProtocols>
<preferServerCiphers > true</preferServerCiphers>
<!-- Use for self - signed: <verificationMode>none</verificationMode> -->
<invalidCertificateHandler >
<!-- Use for self - signed: <name>AcceptCertificateHandler</name> -->
<name > RejectCertificateHandler</name>
</invalidCertificateHandler>
</client>
</openSSL>
2017-04-01 07:20:54 +00:00
<!-- Default root page on http[s] server. For example load UI from https://tabix.io/ when opening http://localhost:8123 -->
<!--
<http_server_default_response > <![CDATA[<html ng-app="SMI2"><head><base href="http://ui.tabix.io/"></head><body><div ui-view="" class="content-ui"></div><script src="http://loader.tabix.io/master.js"></script></body></html>]]> </http_server_default_response>
-->
<!-- Port for communication between replicas. Used for data exchange. -->
<interserver_http_port > 9009</interserver_http_port>
<!-- Hostname that is used by other replicas to request this server.
2020-08-08 01:21:04 +00:00
If not specified, than it is determined analogous to 'hostname -f' command.
2017-04-01 07:20:54 +00:00
This setting could be used to switch replication to another network interface.
-->
<!--
<interserver_http_host > example.yandex.ru</interserver_http_host>
-->
<!-- Listen specified host. use :: (wildcard IPv6 address), if you want to accept connections both with IPv4 and IPv6 from everywhere. -->
<!-- <listen_host>::</listen_host> -->
2017-12-09 21:29:14 +00:00
<!-- Same for hosts with disabled ipv6: -->
<!-- <listen_host>0.0.0.0</listen_host> -->
<!-- Default values - try listen localhost on ipv4 and ipv6: -->
<!--
2017-04-01 07:20:54 +00:00
<listen_host > ::1</listen_host>
<listen_host > 127.0.0.1</listen_host>
2017-12-09 21:29:14 +00:00
-->
2018-02-12 19:36:18 +00:00
<!-- Don't exit if ipv6 or ipv4 unavailable, but listen_host with this protocol specified -->
<!-- <listen_try>0</listen_try> -->
2017-04-01 07:20:54 +00:00
2018-04-06 12:07:40 +00:00
<!-- Allow listen on same address:port -->
<!-- <listen_reuse_port>0</listen_reuse_port> -->
<!-- <listen_backlog>64</listen_backlog> -->
2017-04-01 07:20:54 +00:00
<max_connections > 4096</max_connections>
<keep_alive_timeout > 3</keep_alive_timeout>
2020-10-27 14:38:55 +00:00
<!-- gRPC protocol (see src/Server/grpc_protos/clickhouse_grpc.proto for the API)
<grpc_port > 9001</grpc_port>
<grpc >
<enable_ssl > true</enable_ssl> -->
<!-- The following two files are used only if enable_ssl=1
<ssl_cert_file > /path/to/ssl_cert_file</ssl_cert_file>
<ssl_key_file > /path/to/ssl_key_file</ssl_key_file> -->
<!-- Whether server will request client for a certificate
<ssl_require_client_auth > true</ssl_require_client_auth> -->
<!-- The following file is used only if ssl_require_client_auth=1
<ssl_ca_cert_file > /path/to/ssl_ca_cert_file</ssl_ca_cert_file> -->
<!-- Default compression algorithm (applied if client doesn't specify another algorithm).
Supported algorithms: none, deflate, gzip, stream_gzip
<compression > gzip</compression> -->
<!-- Default compression level (applied if client doesn't specify another level).
Supported levels: none, low, medium, high
<compression_level > high</compression_level> -->
<!-- Send/receive message size limits in bytes. - 1 means unlimited
<max_send_message_size > -1</max_send_message_size>
<max_receive_message_size > 4194304</max_receive_message_size>
</grpc> -->
2017-04-01 07:20:54 +00:00
<!-- Maximum number of concurrent queries. -->
<max_concurrent_queries > 100</max_concurrent_queries>
2020-04-21 22:40:18 +00:00
<!-- Maximum memory usage (resident set size) for server process.
Zero value or unset means default. Default is "max_server_memory_usage_to_ram_ratio" of available physical RAM.
If the value is larger than "max_server_memory_usage_to_ram_ratio" of available physical RAM, it will be cut down.
The constraint is checked on query execution time.
If a query tries to allocate memory and the current memory usage plus allocation is greater
than specified threshold, exception will be thrown.
It is not practical to set this constraint to small values like just a few gigabytes,
because memory allocator will keep this amount of memory in caches and the server will deny service of queries.
-->
<max_server_memory_usage > 0</max_server_memory_usage>
2020-06-14 06:43:01 +00:00
<!-- Maximum number of threads in the Global thread pool.
This will default to a maximum of 10000 threads if not specified.
This setting will be useful in scenarios where there are a large number
of distributed queries that are running concurrently but are idling most
of the time, in which case a higher number of threads might be required.
-->
2020-08-08 03:42:42 +00:00
<max_thread_pool_size > 10000</max_thread_pool_size>
2020-06-14 06:43:01 +00:00
2020-04-21 22:40:18 +00:00
<!-- On memory constrained environments you may have to set this to value larger than 1.
-->
<max_server_memory_usage_to_ram_ratio > 0.9</max_server_memory_usage_to_ram_ratio>
2020-04-22 17:52:21 +00:00
<!-- Simple server - wide memory profiler. Collect a stack trace at every peak allocation step (in bytes).
Data will be stored in system.trace_log table with query_id = empty string.
2020-05-01 19:18:35 +00:00
Zero means disabled.
2020-04-22 17:52:21 +00:00
-->
2020-05-01 19:18:35 +00:00
<total_memory_profiler_step > 4194304</total_memory_profiler_step>
2020-04-30 13:25:17 +00:00
2020-05-01 19:18:35 +00:00
<!-- Collect random allocations and deallocations and write them into system.trace_log with 'MemorySample' trace_type.
The probability is for every alloc/free regardless to the size of the allocation.
Note that sampling happens only when the amount of untracked memory exceeds the untracked memory limit,
which is 4 MiB by default but can be lowered if 'total_memory_profiler_step' is lowered.
You may want to set 'total_memory_profiler_step' to 1 for extra fine grained sampling.
-->
<total_memory_tracker_sample_probability > 0</total_memory_tracker_sample_probability>
2020-04-22 17:52:21 +00:00
2017-04-01 07:20:54 +00:00
<!-- Set limit on number of open files (default: maximum). This setting makes sense on Mac OS X because getrlimit() fails to retrieve
correct maximum value. -->
<!-- <max_open_files>262144</max_open_files> -->
<!-- Size of cache of uncompressed blocks of data, used in tables of MergeTree family.
In bytes. Cache is single for server. Memory is allocated only on demand.
Cache is used when 'use_uncompressed_cache' user setting turned on (off by default).
Uncompressed cache is advantageous only for very short queries and in rare cases.
-->
<uncompressed_cache_size > 8589934592</uncompressed_cache_size>
<!-- Approximate size of mark cache, used in tables of MergeTree family.
In bytes. Cache is single for server. Memory is allocated only on demand.
You should not lower this value.
-->
<mark_cache_size > 5368709120</mark_cache_size>
<!-- Path to data directory, with trailing slash. -->
<path > /var/lib/clickhouse/</path>
<!-- Path to temporary data for processing hard queries. -->
<tmp_path > /var/lib/clickhouse/tmp/</tmp_path>
2020-01-19 14:26:28 +00:00
<!-- Policy from the <storage_configuration> for the temporary files.
If not set <tmp_path > is used, otherwise <tmp_path > is ignored.
Notes:
- move_factor is ignored
- keep_free_space_bytes is ignored
- max_data_part_size_bytes is ignored
- you must have exactly one volume in that policy
-->
<!-- <tmp_policy>tmp</tmp_policy> -->
2018-04-19 05:32:09 +00:00
<!-- Directory with user provided files that are accessible by 'file' table function. -->
<user_files_path > /var/lib/clickhouse/user_files/</user_files_path>
2020-07-23 17:55:24 +00:00
<!-- LDAP server definitions. -->
2020-06-10 22:48:15 +00:00
<ldap_servers >
2020-07-27 10:24:56 +00:00
<!-- List LDAP servers with their connection parameters here to later 1) use them as authenticators for dedicated local users,
who have 'ldap' authentication mechanism specified instead of 'password', or to 2) use them as remote user directories.
2020-06-10 22:48:15 +00:00
Parameters:
host - LDAP server hostname or IP, this parameter is mandatory and cannot be empty.
port - LDAP server port, default is 636 if enable_tls is set to true, 389 otherwise.
auth_dn_prefix, auth_dn_suffix - prefix and suffix used to construct the DN to bind to.
Effectively, the resulting DN will be constructed as auth_dn_prefix + escape(user_name) + auth_dn_suffix string.
Note, that this implies that auth_dn_suffix should usually have comma ',' as its first non-space character.
enable_tls - flag to trigger use of secure connection to the LDAP server.
Specify 'no' for plain text (ldap://) protocol (not recommended).
Specify 'yes' for LDAP over SSL/TLS (ldaps://) protocol (recommended, the default).
Specify 'starttls' for legacy StartTLS protocol (plain text (ldap://) protocol, upgraded to TLS).
2020-06-12 17:59:47 +00:00
tls_minimum_protocol_version - the minimum protocol version of SSL/TLS.
Accepted values are: 'ssl2', 'ssl3', 'tls1.0', 'tls1.1', 'tls1.2' (the default).
tls_require_cert - SSL/TLS peer certificate verification behavior.
Accepted values are: 'never', 'allow', 'try', 'demand' (the default).
tls_cert_file - path to certificate file.
tls_key_file - path to certificate key file.
tls_ca_cert_file - path to CA certificate file.
tls_ca_cert_dir - path to the directory containing CA certificates.
2020-07-23 17:55:24 +00:00
tls_cipher_suite - allowed cipher suite (in OpenSSL notation).
2020-06-12 17:59:47 +00:00
Example:
2020-06-10 22:48:15 +00:00
<my_ldap_server >
<host > localhost</host>
<port > 636</port>
2020-06-23 14:23:34 +00:00
<auth_dn_prefix > uid=</auth_dn_prefix>
<auth_dn_suffix > ,ou=users,dc=example,dc=com</auth_dn_suffix>
2020-06-10 22:48:15 +00:00
<enable_tls > yes</enable_tls>
2020-06-12 17:59:47 +00:00
<tls_minimum_protocol_version > tls1.2</tls_minimum_protocol_version>
<tls_require_cert > demand</tls_require_cert>
<tls_cert_file > /path/to/tls_cert_file</tls_cert_file>
<tls_key_file > /path/to/tls_key_file</tls_key_file>
<tls_ca_cert_file > /path/to/tls_ca_cert_file</tls_ca_cert_file>
<tls_ca_cert_dir > /path/to/tls_ca_cert_dir</tls_ca_cert_dir>
2020-06-16 13:49:18 +00:00
<tls_cipher_suite > ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:AES256-GCM-SHA384</tls_cipher_suite>
2020-06-10 22:48:15 +00:00
</my_ldap_server>
-->
</ldap_servers>
2020-09-14 14:53:46 +00:00
<!-- Sources to read users, roles, access rights, profiles of settings, quotas. -->
2020-07-23 17:55:24 +00:00
<user_directories >
2020-09-14 14:53:46 +00:00
<users_xml >
<!-- Path to configuration file with predefined users. -->
<path > users.xml</path>
</users_xml>
<local_directory >
<!-- Path to folder where users created by SQL commands are stored. -->
<path > /var/lib/clickhouse/access/</path>
</local_directory>
2020-07-27 10:24:56 +00:00
<!-- To add an LDAP server as a remote user directory of users that are not defined locally, define a single 'ldap' section
with the following parameters:
2020-07-23 17:55:24 +00:00
server - one of LDAP server names defined in 'ldap_servers' config section above.
This parameter is mandatory and cannot be empty.
2020-08-20 08:46:42 +00:00
roles - section with a list of locally defined roles that will be assigned to each user retrieved from the LDAP server.
2020-08-20 07:39:27 +00:00
If no roles are specified, user will not be able to perform any actions after authentication.
2020-10-27 11:04:03 +00:00
If any of the listed roles is not defined locally at the time of authentication, the authenthication attempt
2020-08-20 07:39:27 +00:00
will fail as if the provided password was incorrect.
2020-07-23 17:55:24 +00:00
Example:
<ldap >
<server > my_ldap_server</server>
2020-08-20 07:39:27 +00:00
<roles >
<my_local_role1 />
<my_local_role2 />
</roles>
2020-07-23 17:55:24 +00:00
</ldap>
-->
</user_directories>
2018-02-01 13:52:29 +00:00
<!-- Default profile of settings. -->
2017-04-01 07:20:54 +00:00
<default_profile > default</default_profile>
2020-07-28 23:39:18 +00:00
<!-- Comma - separated list of prefixes for user - defined settings. -->
<custom_settings_prefixes > </custom_settings_prefixes>
2020-08-08 01:21:04 +00:00
<!-- System profile of settings. This settings are used by internal processes (Buffer storage, Distributed DDL worker and so on). -->
2018-02-07 18:28:39 +00:00
<!-- <system_profile>default</system_profile> -->
2018-02-01 13:52:29 +00:00
2017-04-01 07:20:54 +00:00
<!-- Default database. -->
<default_database > default</default_database>
<!-- Server time zone could be set here.
Time zone is used when converting between String and DateTime types,
when printing DateTime in text formats and parsing DateTime from text,
it is used in date and time related functions, if specific time zone was not passed as an argument.
Time zone is specified as identifier from IANA time zone database, like UTC or Africa/Abidjan.
If not specified, system time zone at server startup is used.
2017-08-18 17:05:53 +00:00
Please note, that server could display time zone alias instead of specified name.
Example: W-SU is an alias for Europe/Moscow and Zulu is an alias for UTC.
2017-04-01 07:20:54 +00:00
-->
<!-- <timezone>Europe/Moscow</timezone> -->
2017-08-18 01:00:13 +00:00
<!-- You can specify umask here (see "man umask"). Server will apply it on startup.
Number is always parsed as octal. Default umask is 027 (other users cannot read logs, data files, etc; group can only read).
-->
<!-- <umask>022</umask> -->
2018-11-14 01:20:46 +00:00
<!-- Perform mlockall after startup to lower first queries latency
and to prevent clickhouse executable from being paged out under high IO load.
Enabling this option is recommended but will lead to increased startup time for up to a few seconds.
-->
2020-05-22 11:31:27 +00:00
<mlock_executable > true</mlock_executable>
2018-11-14 01:20:46 +00:00
2020-09-14 18:08:09 +00:00
<!-- Reallocate memory for machine code ("text") using huge pages. Highly experimental. -->
<remap_executable > false</remap_executable>
2017-04-01 07:20:54 +00:00
<!-- Configuration of clusters that could be used in Distributed tables.
2020-02-11 10:33:38 +00:00
https://clickhouse.tech/docs/en/operations/table_engines/distributed/
2017-04-01 07:20:54 +00:00
-->
2017-10-12 19:46:24 +00:00
<remote_servers incl= "clickhouse_remote_servers" >
<!-- Test only shard config for testing distributed storage -->
<test_shard_localhost >
2020-09-14 21:55:43 +00:00
<!-- Inter - server per - cluster secret for Distributed queries
default: no secret (no authentication will be performed)
If set, then Distributed queries will be validated on shards, so at least:
- such cluster should exist on the shard,
- such cluster should have the same secret.
And also (and which is more important), the initial_user will
be used as current user for the query.
Right now the protocol is pretty simple and it only takes into account:
- cluster name
- query
Also it will be nice if the following will be implemented:
- source hostname (see interserver_http_host), but then it will depends from DNS,
it can use IP address instead, but then the you need to get correct on the initiator node.
- target hostname / ip address (same notes as for source hostname)
- time-based security tokens
-->
<!-- <secret></secret> -->
2017-10-12 19:46:24 +00:00
<shard >
2020-04-26 11:03:28 +00:00
<!-- Optional. Whether to write data to just one of the replicas. Default: false (write data to all replicas). -->
<!-- <internal_replication>false</internal_replication> -->
2020-06-27 06:47:02 +00:00
<!-- Optional. Shard weight when writing data. Default: 1. -->
<!-- <weight>1</weight> -->
2017-10-12 19:46:24 +00:00
<replica >
<host > localhost</host>
<port > 9000</port>
2020-06-27 06:52:10 +00:00
<!-- Optional. Priority of the replica for load_balancing. Default: 1 (less value has more priority). -->
<!-- <priority>1</priority> -->
2017-10-12 19:46:24 +00:00
</replica>
</shard>
</test_shard_localhost>
2018-11-22 09:18:13 +00:00
<test_cluster_two_shards_localhost >
<shard >
<replica >
<host > localhost</host>
2018-11-22 15:09:55 +00:00
<port > 9000</port>
2018-11-22 09:18:13 +00:00
</replica>
</shard>
<shard >
<replica >
<host > localhost</host>
2018-11-22 15:09:55 +00:00
<port > 9000</port>
2018-11-22 09:18:13 +00:00
</replica>
</shard>
2019-10-18 07:22:43 +00:00
</test_cluster_two_shards_localhost>
<test_cluster_two_shards >
<shard >
<replica >
<host > 127.0.0.1</host>
<port > 9000</port>
</replica>
</shard>
<shard >
<replica >
<host > 127.0.0.2</host>
<port > 9000</port>
</replica>
</shard>
</test_cluster_two_shards>
2020-10-25 11:14:52 +00:00
<test_cluster_two_shards_internal_replication >
<shard >
<internal_replication > true</internal_replication>
<replica >
<host > 127.0.0.1</host>
<port > 9000</port>
</replica>
</shard>
<shard >
<internal_replication > true</internal_replication>
<replica >
<host > 127.0.0.2</host>
<port > 9000</port>
</replica>
</shard>
</test_cluster_two_shards_internal_replication>
2018-03-29 01:41:06 +00:00
<test_shard_localhost_secure >
<shard >
<replica >
<host > localhost</host>
<port > 9440</port>
<secure > 1</secure>
</replica>
</shard>
</test_shard_localhost_secure>
2018-11-28 18:44:50 +00:00
<test_unavailable_shard >
<shard >
<replica >
<host > localhost</host>
<port > 9000</port>
</replica>
</shard>
<shard >
<replica >
2018-12-17 18:06:50 +00:00
<host > localhost</host>
<port > 1</port>
2018-11-28 18:44:50 +00:00
</replica>
</shard>
</test_unavailable_shard>
2017-10-12 19:46:24 +00:00
</remote_servers>
2017-04-01 07:20:54 +00:00
2020-03-02 15:29:52 +00:00
<!-- The list of hosts allowed to use in URL - related storage engines and table functions.
If this section is not present in configuration, all hosts are allowed.
-->
<remote_url_allow_hosts >
<!-- Host should be specified exactly as in URL. The name is checked before DNS resolution.
Example: "yandex.ru", "yandex.ru." and "www.yandex.ru" are different hosts.
If port is explicitly specified in URL, the host:port is checked as a whole.
If host specified here without port, any port with this host allowed.
"yandex.ru" -> "yandex.ru:443", "yandex.ru:80" etc. is allowed, but "yandex.ru:80" -> only "yandex.ru:80" is allowed.
If the host is specified as IP address, it is checked as specified in URL. Example: "[2a02:6b8:a::a]".
If there are redirects and support for redirects is enabled, every redirect (the Location field) is checked.
-->
<!-- Regular expression can be specified. RE2 engine is used for regexps.
Regexps are not aligned: don't forget to add ^ and $. Also don't forget to escape dot (.) metacharacter
(forgetting to do so is a common source of error).
-->
</remote_url_allow_hosts>
2017-04-01 07:20:54 +00:00
<!-- If element has 'incl' attribute, then for it's value will be used corresponding substitution from another file.
By default, path to file with substitutions is /etc/metrika.xml. It could be changed in config in 'include_from' element.
Values for substitutions are specified in /yandex/name_of_substitution elements in that file.
-->
<!-- ZooKeeper is used to store metadata about replicas, when using Replicated tables.
Optional. If you don't use replicated tables, you could omit that.
2018-03-10 23:36:26 +00:00
See https://clickhouse.yandex/docs/en/table_engines/replication/
2017-04-01 07:20:54 +00:00
-->
2019-08-14 19:51:03 +00:00
2017-04-01 07:20:54 +00:00
<zookeeper incl= "zookeeper-servers" optional= "true" />
<!-- Substitutions for parameters of replicated tables.
Optional. If you don't use replicated tables, you could omit that.
2018-03-10 23:36:26 +00:00
See https://clickhouse.yandex/docs/en/table_engines/replication/#creating-replicated-tables
2017-04-01 07:20:54 +00:00
-->
<macros incl= "macros" optional= "true" />
<!-- Reloading interval for embedded dictionaries, in seconds. Default: 3600. -->
<builtin_dictionaries_reload_interval > 3600</builtin_dictionaries_reload_interval>
2017-06-02 18:48:33 +00:00
<!-- Maximum session timeout, in seconds. Default: 3600. -->
<max_session_timeout > 3600</max_session_timeout>
<!-- Default session timeout, in seconds. Default: 60. -->
<default_session_timeout > 60</default_session_timeout>
2017-04-01 07:20:54 +00:00
<!-- Sending data to Graphite for monitoring. Several sections can be defined. -->
<!--
interval - send every X second
root_path - prefix for keys
2017-12-25 20:36:24 +00:00
hostname_in_path - append hostname to root_path (default = true)
2017-04-01 07:20:54 +00:00
metrics - send data from table system.metrics
events - send data from table system.events
asynchronous_metrics - send data from table system.asynchronous_metrics
-->
<!--
<graphite >
<host > localhost</host>
<port > 42000</port>
<timeout > 0.1</timeout>
<interval > 60</interval>
<root_path > one_min</root_path>
2018-03-25 04:43:12 +00:00
<hostname_in_path > true</hostname_in_path>
2017-04-01 07:20:54 +00:00
<metrics > true</metrics>
<events > true</events>
2019-09-22 22:57:06 +00:00
<events_cumulative > false</events_cumulative>
2017-04-01 07:20:54 +00:00
<asynchronous_metrics > true</asynchronous_metrics>
</graphite>
<graphite >
<host > localhost</host>
<port > 42000</port>
<timeout > 0.1</timeout>
<interval > 1</interval>
<root_path > one_sec</root_path>
<metrics > true</metrics>
<events > true</events>
2019-09-22 22:57:06 +00:00
<events_cumulative > false</events_cumulative>
2017-04-01 07:20:54 +00:00
<asynchronous_metrics > false</asynchronous_metrics>
</graphite>
-->
2020-08-08 01:21:04 +00:00
<!-- Serve endpoint for Prometheus monitoring. -->
2019-11-24 16:27:00 +00:00
<!--
endpoint - mertics path (relative to root, statring with "/")
port - port to setup server. If not defined or 0 than http_port used
metrics - send data from table system.metrics
events - send data from table system.events
2019-11-26 20:27:24 +00:00
asynchronous_metrics - send data from table system.asynchronous_metrics
2020-03-18 03:09:19 +00:00
status_info - send data from different component from CH, ex: Dictionaries status
2019-11-24 16:27:00 +00:00
-->
2019-12-14 16:40:50 +00:00
<!--
2019-11-24 12:06:10 +00:00
<prometheus >
<endpoint > /metrics</endpoint>
2019-12-21 17:56:24 +00:00
<port > 9363</port>
2019-11-24 15:43:53 +00:00
<metrics > true</metrics>
<events > true</events>
2019-11-26 20:27:24 +00:00
<asynchronous_metrics > true</asynchronous_metrics>
2020-03-18 03:09:19 +00:00
<status_info > true</status_info>
2019-11-24 12:06:10 +00:00
</prometheus>
2019-12-14 16:40:50 +00:00
-->
2017-04-01 07:20:54 +00:00
<!-- Query log. Used only for queries with setting log_queries = 1. -->
<query_log >
<!-- What table to insert data. If table is not exist, it will be created.
When query log structure is changed after system update,
then old table will be renamed and new table will be created automatically.
-->
<database > system</database>
<table > query_log</table>
2018-03-10 23:36:26 +00:00
<!--
PARTITION BY expr https://clickhouse.yandex/docs/en/table_engines/custom_partitioning_key/
Example:
2018-02-14 08:01:41 +00:00
event_date
toMonday(event_date)
toYYYYMM(event_date)
toStartOfHour(event_time)
-->
<partition_by > toYYYYMM(event_date)</partition_by>
2020-01-25 18:47:02 +00:00
<!-- Instead of partition_by, you can provide full engine expression (starting with ENGINE = ) with parameters,
Example: <engine > ENGINE = MergeTree PARTITION BY toYYYYMM(event_date) ORDER BY (event_date, event_time) SETTINGS index_granularity = 1024</engine>
-->
2017-04-01 07:20:54 +00:00
<!-- Interval of flushing data. -->
<flush_interval_milliseconds > 7500</flush_interval_milliseconds>
</query_log>
2019-07-05 13:48:47 +00:00
<!-- Trace log. Stores stack traces collected by query profilers.
2019-07-10 20:47:39 +00:00
See query_profiler_real_time_period_ns and query_profiler_cpu_time_period_ns settings. -->
2019-02-03 21:30:45 +00:00
<trace_log >
<database > system</database>
<table > trace_log</table>
<partition_by > toYYYYMM(event_date)</partition_by>
<flush_interval_milliseconds > 7500</flush_interval_milliseconds>
</trace_log>
2019-02-23 23:29:38 +00:00
<!-- Query thread log. Has information about all threads participated in query execution.
Used only for queries with setting log_query_threads = 1. -->
<query_thread_log >
<database > system</database>
<table > query_thread_log</table>
<partition_by > toYYYYMM(event_date)</partition_by>
<flush_interval_milliseconds > 7500</flush_interval_milliseconds>
</query_thread_log>
2017-04-01 07:20:54 +00:00
2019-02-23 23:29:38 +00:00
<!-- Uncomment if use part log.
Part log contains information about all actions with parts in MergeTree tables (creation, deletion, merges, downloads).
2017-04-01 07:20:54 +00:00
<part_log >
<database > system</database>
<table > part_log</table>
<flush_interval_milliseconds > 7500</flush_interval_milliseconds>
</part_log>
-->
2019-07-25 23:00:18 +00:00
<!-- Uncomment to write text log into table.
Text log contains all information from usual server log but stores it in structured and efficient way.
2020-01-23 20:19:51 +00:00
The level of the messages that goes to the table can be limited (<level > ), if not specified all messages will go to the table.
2019-07-25 23:00:18 +00:00
<text_log >
<database > system</database>
<table > text_log</table>
<flush_interval_milliseconds > 7500</flush_interval_milliseconds>
2020-01-23 20:19:51 +00:00
<level > </level>
2019-07-25 23:00:18 +00:00
</text_log>
-->
2017-04-01 07:20:54 +00:00
2020-02-19 13:39:20 +00:00
<!-- Metric log contains rows with current values of ProfileEvents, CurrentMetrics collected with "collect_interval_milliseconds" interval. -->
2019-08-14 12:54:41 +00:00
<metric_log >
<database > system</database>
<table > metric_log</table>
<flush_interval_milliseconds > 7500</flush_interval_milliseconds>
<collect_interval_milliseconds > 1000</collect_interval_milliseconds>
</metric_log>
2017-04-01 07:20:54 +00:00
2020-06-10 19:17:30 +00:00
<!--
Asynchronous metric log contains values of metrics from
system.asynchronous_metrics.
-->
<asynchronous_metric_log >
<database > system</database>
<table > asynchronous_metric_log</table>
<!--
Asynchronous metrics are updated once a minute, so there is
2020-06-10 21:16:58 +00:00
no need to flush more often.
2020-06-10 19:17:30 +00:00
-->
2020-06-10 21:16:58 +00:00
<flush_interval_milliseconds > 60000</flush_interval_milliseconds>
2020-06-10 19:17:30 +00:00
</asynchronous_metric_log>
2020-08-20 20:59:40 +00:00
<!--
OpenTelemetry log contains OpenTelemetry trace spans.
-->
2020-10-22 16:47:20 +00:00
<opentelemetry_span_log >
2020-09-08 13:19:27 +00:00
<!--
The default table creation code is insufficient, this <engine > spec
is a workaround. There is no 'event_time' for this log, but two times,
start and finish. It is sorted by finish time, to avoid inserting
data too far away in the past (probably we can sometimes insert a span
that is seconds earlier than the last span in the table, due to a race
between several spans inserted in parallel). This gives the spans a
global order that we can use to e.g. retry insertion into some external
system.
-->
<engine >
engine MergeTree
partition by toYYYYMM(finish_date)
2020-09-30 16:16:33 +00:00
order by (finish_date, finish_time_us, trace_id)
2020-09-08 13:19:27 +00:00
</engine>
2020-08-20 20:59:40 +00:00
<database > system</database>
2020-10-22 16:47:20 +00:00
<table > opentelemetry_span_log</table>
2020-08-20 20:59:40 +00:00
<flush_interval_milliseconds > 7500</flush_interval_milliseconds>
2020-10-22 16:47:20 +00:00
</opentelemetry_span_log>
2020-08-20 20:59:40 +00:00
2020-07-09 04:15:45 +00:00
<!-- Crash log. Stores stack traces for fatal errors.
This table is normally empty. -->
<crash_log >
<database > system</database>
<table > crash_log</table>
<partition_by />
<flush_interval_milliseconds > 1000</flush_interval_milliseconds>
</crash_log>
2017-04-01 07:20:54 +00:00
<!-- Parameters for embedded dictionaries, used in Yandex.Metrica.
2018-03-10 23:36:26 +00:00
See https://clickhouse.yandex/docs/en/dicts/internal_dicts/
2017-04-01 07:20:54 +00:00
-->
<!-- Path to file with region hierarchy. -->
<!-- <path_to_regions_hierarchy_file>/opt/geo/regions_hierarchy.txt</path_to_regions_hierarchy_file> -->
<!-- Path to directory with files containing names of regions -->
<!-- <path_to_regions_names_files>/opt/geo/</path_to_regions_names_files> -->
<!-- Configuration of external dictionaries. See:
2018-03-10 23:36:26 +00:00
https://clickhouse.yandex/docs/en/dicts/external_dicts/
2017-04-01 07:20:54 +00:00
-->
<dictionaries_config > *_dictionary.xml</dictionaries_config>
<!-- Uncomment if you want data to be compressed 30 - 100% better.
Don't do that if you just started using ClickHouse.
-->
<compression incl= "clickhouse_compression" >
<!--
<!- - Set of variants. Checked in order. Last matching case wins. If nothing matches, lz4 will be used. - ->
<case >
<!- - Conditions. All must be satisfied. Some conditions may be omitted. - ->
<min_part_size > 10000000000</min_part_size> <!- - Min part size in bytes. - ->
2017-12-14 17:42:27 +00:00
<min_part_size_ratio > 0.01</min_part_size_ratio> <!- - Min size of part relative to whole table size. - ->
2017-04-01 07:20:54 +00:00
<!- - What compression method to use. - ->
2017-12-14 17:42:27 +00:00
<method > zstd</method>
2017-04-01 07:20:54 +00:00
</case>
-->
</compression>
2017-06-01 09:22:22 +00:00
<!-- Allow to execute distributed DDL queries (CREATE, DROP, ALTER, RENAME) on cluster.
Works only if ZooKeeper is enabled. Comment it if such functionality isn't required. -->
<distributed_ddl >
<!-- Path in ZooKeeper to queue with DDL queries -->
<path > /clickhouse/task_queue/ddl</path>
2018-02-01 13:52:29 +00:00
<!-- Settings from this profile will be used to execute DDL queries -->
2018-02-07 18:28:39 +00:00
<!-- <profile>default</profile> -->
2020-09-02 22:35:47 +00:00
<!-- Controls how much ON CLUSTER queries can be run simultaneously. -->
<!-- <pool_size>1</pool_size> -->
2017-06-01 09:22:22 +00:00
</distributed_ddl>
2017-04-01 07:20:54 +00:00
<!-- Settings to fine tune MergeTree tables. See documentation in source code, in MergeTreeSettings.h -->
<!--
<merge_tree >
<max_suspicious_broken_parts > 5</max_suspicious_broken_parts>
</merge_tree>
-->
<!-- Protection from accidental DROP.
If size of a MergeTree table is greater than max_table_size_to_drop (in bytes) than table could not be dropped with any DROP query.
2019-11-20 16:40:27 +00:00
If you want do delete one table and don't want to change clickhouse-server config, you could create special file <clickhouse-path > /flags/force_drop_table and make DROP once.
2018-08-06 17:23:27 +00:00
By default max_table_size_to_drop is 50GB; max_table_size_to_drop=0 allows to DROP any tables.
The same for max_partition_size_to_drop.
2017-04-01 07:20:54 +00:00
Uncomment to disable protection.
-->
<!-- <max_table_size_to_drop>0</max_table_size_to_drop> -->
2018-08-06 17:23:27 +00:00
<!-- <max_partition_size_to_drop>0</max_partition_size_to_drop> -->
2017-04-01 07:20:54 +00:00
<!-- Example of parameters for GraphiteMergeTree table engine -->
<graphite_rollup_example >
<pattern >
<regexp > click_cost</regexp>
<function > any</function>
<retention >
<age > 0</age>
<precision > 3600</precision>
</retention>
<retention >
<age > 86400</age>
<precision > 60</precision>
</retention>
</pattern>
<default >
<function > max</function>
<retention >
<age > 0</age>
<precision > 60</precision>
</retention>
<retention >
<age > 3600</age>
<precision > 300</precision>
</retention>
<retention >
<age > 86400</age>
<precision > 3600</precision>
</retention>
</default>
</graphite_rollup_example>
2017-11-10 06:48:28 +00:00
<!-- Directory in <clickhouse - path> containing schema files for various input formats.
The directory will be created if it doesn't exist.
-->
2018-01-09 17:02:52 +00:00
<format_schema_path > /var/lib/clickhouse/format_schemas/</format_schema_path>
2018-03-29 20:21:01 +00:00
2020-09-14 15:15:07 +00:00
<!-- Default query masking rules, matching lines would be replaced with something else in the logs
(both text logs and system.query_log).
2019-06-20 07:17:21 +00:00
name - name for the rule (optional)
regexp - RE2 compatible regular expression (mandatory)
replace - substitution string for sensitive data (optional, by default - six asterisks)
2020-09-14 15:15:07 +00:00
-->
2019-06-20 07:17:21 +00:00
<query_masking_rules >
<rule >
2020-09-14 15:15:07 +00:00
<name > hide encrypt/decrypt arguments</name>
<regexp > ((?:aes_)?(?:encrypt|decrypt)(?:_mysql)?)\s*\(\s*(?:'(?:\\'|.)+'|.*?)\s*\)</regexp>
<!-- or more secure, but also more invasive:
(aes_\w+)\s*\(.*\)
-->
<replace > \1(???)</replace>
2019-06-20 07:17:21 +00:00
</rule>
</query_masking_rules>
2020-04-27 20:51:39 +00:00
<!-- Uncomment to use custom http handlers.
rules are checked from top to bottom, first match runs the handler
2020-04-26 11:06:14 +00:00
url - to match request URL, you can use 'regex:' prefix to use regex match(optional)
methods - to match request method, you can use commas to separate multiple method matches(optional)
headers - to match request headers, match each child element(child element name is header name), you can use 'regex:' prefix to use regex match(optional)
handler is request handler
2020-04-27 20:51:39 +00:00
type - supported types: static, dynamic_query_handler, predefined_query_handler
query - use with predefined_query_handler type, executes query when the handler is called
2020-04-26 11:06:14 +00:00
query_param_name - use with dynamic_query_handler type, extracts and executes the value corresponding to the <query_param_name > value in HTTP request params
status - use with static type, response status code
content_type - use with static type, response content-type
response_content - use with static type, Response content sent to client, when using the prefix 'file://' or 'config://', find the content from the file or configuration send to client.
2020-04-21 11:30:45 +00:00
2020-04-27 20:51:39 +00:00
<http_handlers >
<rule >
2020-04-26 11:06:14 +00:00
<url > /</url>
<methods > POST,GET</methods>
<headers > <pragma > no-cache</pragma> </headers>
2020-04-21 11:30:45 +00:00
<handler >
<type > dynamic_query_handler</type>
<query_param_name > query</query_param_name>
</handler>
2020-04-27 20:51:39 +00:00
</rule>
2020-04-21 11:30:45 +00:00
2020-04-27 20:51:39 +00:00
<rule >
<url > /predefined_query</url>
2020-04-26 11:06:14 +00:00
<methods > POST,GET</methods>
2020-04-21 11:30:45 +00:00
<handler >
2020-04-27 20:51:39 +00:00
<type > predefined_query_handler</type>
2020-04-26 11:06:14 +00:00
<query > SELECT * FROM system.settings</query>
2020-04-21 11:30:45 +00:00
</handler>
2020-04-27 20:51:39 +00:00
</rule>
2020-04-21 11:30:45 +00:00
2020-04-27 20:51:39 +00:00
<rule >
2020-04-21 11:30:45 +00:00
<handler >
<type > static</type>
2020-04-26 11:06:14 +00:00
<status > 200</status>
<content_type > text/plain; charset=UTF-8</content_type>
<response_content > config://http_server_default_response</response_content>
2020-04-21 11:30:45 +00:00
</handler>
2020-04-27 20:51:39 +00:00
</rule>
</http_handlers>
2020-04-21 11:30:45 +00:00
-->
2019-11-07 03:51:11 +00:00
2018-03-29 20:21:01 +00:00
<!-- Uncomment to disable ClickHouse internal DNS caching. -->
<!-- <disable_internal_dns_cache>1</disable_internal_dns_cache> -->
2016-02-07 21:58:58 +00:00
</yandex>