Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikepan/clickhouse-bulk
Collects many small inserts to ClickHouse and send in big inserts
https://github.com/nikepan/clickhouse-bulk
clickhouse clickhouse-bulk clickhouse-server
Last synced: 21 days ago
JSON representation
Collects many small inserts to ClickHouse and send in big inserts
- Host: GitHub
- URL: https://github.com/nikepan/clickhouse-bulk
- Owner: nikepan
- License: apache-2.0
- Created: 2017-04-29T10:38:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-01T18:41:31.000Z (12 months ago)
- Last Synced: 2024-11-13T07:01:55.448Z (about 1 month ago)
- Topics: clickhouse, clickhouse-bulk, clickhouse-server
- Language: Go
- Homepage:
- Size: 164 KB
- Stars: 477
- Watchers: 8
- Forks: 87
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - clickhouse-bulk - Collects small inserts and sends big requests to ClickHouse servers. (Database / Database Tools)
- awesome-clickhouse - nikepan/clickhouse-bulk - ClickHouse-Bulk is a tool for collecting and sending multiple small inserts to ClickHouse as larger batch inserts. (Integrations / ETL and Data Processing)
- awesome-go - clickhouse-bulk - Collects many small insterts to ClickHouse and send in big inserts - ★ 86 (Database)
- awesome-go-extra - clickhouse-bulk - 04-29T10:38:41Z|2022-08-08T15:40:52Z| (Generators / Database Tools)
README
# ClickHouse-Bulk
[](https://github.com/nikepan/clickhouse-bulk/actions/workflows/test.yml)
[](https://codecov.io/gh/nikepan/clickhouse-bulk)
[](https://github.com/nikepan/clickhouse-bulk/releases)
[](https://goreportcard.com/report/github.com/nikepan/clickhouse-bulk)
[](https://godoc.org/github.com/nikepan/clickhouse-bulk)
Simple [Yandex ClickHouse](https://clickhouse.yandex/) insert collector. It collect requests and send to ClickHouse servers.
### Installation
[Download binary](https://github.com/nikepan/clickhouse-bulk/releases) for you platorm
or
[Use docker image](https://hub.docker.com/r/nikepan/clickhouse-bulk/)
or from sources (Go 1.13+):
```text
git clone https://github.com/nikepan/clickhouse-bulk
cd clickhouse-bulk
go build
```
### Features
- Group n requests and send to any of ClickHouse server
- Sending collected data by interval
- Tested with VALUES, TabSeparated formats
- Supports many servers to send
- Supports query in query parameters and in body
- Supports other query parameters like username, password, database
- Supports basic authentication
For example:
```sql
INSERT INTO table3 (c1, c2, c3) VALUES ('v1', 'v2', 'v3')
INSERT INTO table3 (c1, c2, c3) VALUES ('v4', 'v5', 'v6')
```
sends as
```sql
INSERT INTO table3 (c1, c2, c3) VALUES ('v1', 'v2', 'v3')('v4', 'v5', 'v6')
```
### Options
- -config - config file (json); default _config.json_
### Configuration file
```javascript
{
"listen": ":8124",
"flush_count": 10000, // check by \n char
"flush_interval": 1000, // milliseconds
"clean_interval": 0, // how often cleanup internal tables - e.g. inserts to different temporary tables, or as workaround for query_id etc. milliseconds
"remove_query_id": true, // some drivers sends query_id which prevents inserts to be batched
"dump_check_interval": 300, // interval for try to send dumps (seconds); -1 to disable
"debug": false, // log incoming requests
"dump_dir": "dumps", // directory for dump unsended data (if clickhouse errors)
"clickhouse": {
"down_timeout": 60, // wait if server in down (seconds)
"connect_timeout": 10, // wait for server connect (seconds)
"tls_server_name": "", // override TLS serverName for certificate verification (e.g. in cases you share same "cluster" certificate across multiple nodes)
"insecure_tls_skip_verify": false, // INSECURE - skip certificate verification at all
"servers": [
"http://127.0.0.1:8123"
]
},
"metrics_prefix": "prefix"
}
```
### Environment variables (used for docker image)
* `CLICKHOUSE_BULK_DEBUG` - enable debug logging
* `CLICKHOUSE_SERVERS` - comma separated list of servers
* `CLICKHOUSE_FLUSH_COUNT` - count of rows for insert
* `CLICKHOUSE_FLUSH_INTERVAL` - insert interval
* `CLICKHOUSE_CLEAN_INTERVAL` - internal tables clean interval
* `DUMP_CHECK_INTERVAL` - interval of resend dumps
* `CLICKHOUSE_DOWN_TIMEOUT` - wait time if server is down
* `CLICKHOUSE_CONNECT_TIMEOUT` - clickhouse server connect timeout
* `CLICKHOUSE_TLS_SERVER_NAME` - server name for TLS certificate verification
* `CLICKHOUSE_INSECURE_TLS_SKIP_VERIFY` - skip certificate verification at all
* `METRICS_PREFIX` - prefix for prometheus metrics
### Quickstart
`./clickhouse-bulk`
and send queries to :8124
### Metrics
manual check main metrics
`curl -s http://127.0.0.1:8124/metrics | grep "^ch_"`
* `ch_bad_servers 0` - actual count of bad servers
* `ch_dump_count 0` - dumps saved from launch
* `ch_queued_dumps 0` - actual dump files id directory
* `ch_good_servers 1` - actual good servers count
* `ch_received_count 40` - received requests count from launch
* `ch_sent_count 1` - sent request count from launch
### Tips
For better performance words FORMAT and VALUES must be uppercase.