1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
{ lib, pkgs, ... }:
let
# Take the original journald message and create a new payload which only
# contains the relevant fields - these must match the database columns.
journalVrlRemapTransform = {
journald_remap = {
inputs = [ "journald" ];
type = "remap";
source = ''
m = {}
m.app = .SYSLOG_IDENTIFIER
m.host = .host
m.boot_id = ._BOOT_ID
m.severity = to_int(.PRIORITY) ?? 0
m.level = to_syslog_level(m.severity) ?? ""
m.message = strip_ansi_escape_codes!(.message)
m.timestamp = .timestamp
m.uid = to_int(._UID) ?? 0
m.pid = to_int(._PID) ?? 0
. = [m]
'';
};
};
in
{
name = "vector-journald-clickhouse";
meta.maintainers = [ pkgs.lib.maintainers.happysalada ];
nodes = {
clickhouse =
{ config, pkgs, ... }:
{
virtualisation.diskSize = 5 * 1024;
virtualisation.memorySize = 4096;
networking.firewall.allowedTCPPorts = [ 6000 ];
services.vector = {
enable = true;
journaldAccess = true;
settings = {
sources = {
journald = {
type = "journald";
};
vector_source = {
type = "vector";
address = "[::]:6000";
};
};
transforms = journalVrlRemapTransform;
sinks = {
clickhouse = {
type = "clickhouse";
inputs = [
"journald_remap"
"vector_source"
];
endpoint = "http://localhost:8123";
auth = {
strategy = "basic";
user = "vector";
password = "helloclickhouseworld";
};
database = "journald";
table = "logs";
date_time_best_effort = true;
};
};
};
};
services.clickhouse = {
enable = true;
};
# ACL configuration for Vector
environment = {
etc."clickhouse-server/users.d/vector.xml".text = ''
<clickhouse>
<users>
<vector>
<password>helloclickhouseworld</password>
<access_management>0</access_management>
<quota>default</quota>
<default_database>journald</default_database>
<grants>
<query>GRANT INSERT ON journald.logs</query>
</grants>
</vector>
</users>
</clickhouse>
'';
# ACL configuration for read-only client
etc."clickhouse-server/users.d/grafana.xml".text = ''
<clickhouse>
<users>
<grafana>
<password>helloclickhouseworld2</password>
<access_management>0</access_management>
<quota>default</quota>
<default_database>journald</default_database>
<grants>
<query>GRANT SELECT ON journald.logs</query>
</grants>
</grafana>
</users>
</clickhouse>
'';
};
};
vector =
{ config, pkgs, ... }:
{
services.vector = {
enable = true;
journaldAccess = true;
settings = {
sources = {
journald = {
type = "journald";
};
};
transforms = journalVrlRemapTransform;
sinks = {
vector_sink = {
type = "vector";
inputs = [ "journald_remap" ];
address = "clickhouse:6000";
};
};
};
};
};
};
testScript =
let
# work around quote/substitution complexity by Nix, Perl, bash and SQL.
databaseDDL = pkgs.writeText "database.sql" "CREATE DATABASE IF NOT EXISTS journald";
# https://clickhouse.com/blog/storing-log-data-in-clickhouse-fluent-bit-vector-open-telemetry
# ORDER BY advice: https://kb.altinity.com/engines/mergetree-table-engine-family/pick-keys/
tableDDL = pkgs.writeText "table.sql" ''
CREATE TABLE IF NOT EXISTS journald.logs (
timestamp DateTime64(6),
host LowCardinality(String),
boot_id LowCardinality(String),
app LowCardinality(String),
level LowCardinality(String),
severity UInt8,
message String,
uid UInt16,
pid UInt32,
)
ENGINE = MergeTree()
ORDER BY (host, boot_id, toStartOfHour(timestamp), app, timestamp)
PARTITION BY toYYYYMM(timestamp)
'';
selectQuery = pkgs.writeText "select.sql" ''
SELECT COUNT(host) FROM journald.logs
WHERE message LIKE '%Vector has started%'
'';
in
''
clickhouse.wait_for_unit("clickhouse")
clickhouse.wait_for_open_port(6000)
clickhouse.wait_for_open_port(8123)
clickhouse.succeed(
"cat ${databaseDDL} | clickhouse-client"
)
clickhouse.succeed(
"cat ${tableDDL} | clickhouse-client"
)
for machine in clickhouse, vector:
machine.wait_for_unit("vector")
machine.wait_until_succeeds(
"journalctl -o cat -u vector.service | grep 'Vector has started'"
)
clickhouse.fail(
"cat ${selectQuery} | clickhouse-client --user vector --password helloclickhouseworld | grep -v 0"
)
clickhouse.wait_until_succeeds(
"cat ${selectQuery} | clickhouse-client --user grafana --password helloclickhouseworld2 | grep -v 0"
)
'';
}
|
