/
README.freebsd
276 lines (174 loc) · 7.72 KB
/
README.freebsd
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
Kronometrix Data Recording
An automatic, simple to use, data collection and transport utility
with a low system footprint, supporting raw data, available as
open-source software. Kronometrix K1 is a commercial product, based
on Kronometrix Data Recording, available from Kronometrix Analytics
More information: www.kronometrix.com/k1
1.Supported Operating Systems
We support the following FreeBSD based operating systems:
FreeBSD 12+ amd64, aarch64
Note: 64bit only. IoT, weather and environment data recorders are supported
for Raspberry PI 3B/3B+/4B SBC ARM64 only.
2.Package Content
Kronometrix FreeBSD edition contains, all data records and the
transport utility. Along with these come the manual pages and
documentation, all for free:
- recorders:
Information and Communications Technology
* sysrec - overall system CPU, MEM, DISK, NIC utilization
* cpurec - per CPU statistics
* nicrec - per NIC statistics
* diskrec - per DISK statistics
* hdwrec - hardware and software data inventory
* jvmrec - Java VM statistics
* httprec - HTTP server statistics: NGINX, Apache, PFP-FPM
* certrec - X.509 security certificate statistics
* svcrec - TCP, UDP service performance and availability
* direc - filesystem directory statistics
* ntprec - NTP server statistics
* procrec - process statistics
* webrec - web application performance and availability
IoT, Weather and Environment
* rs485rec - Serial, MODBUS (ASCII, RTU, TCP) industrial recorder
* snmprec - SNMP data recorder
* sockrec - Network IO socket data recorder
* wsrec - Weather data recorder
* axisrec - AXIS Communications network video data recorder
Data Utilities
* kserial - Serial Command Line Utility
* speedtest - Network speed and latency of an Internet connection
* fio - Storage Flexible I/O performance tester
- transport: sender utility
- all needed libraries: openssl, libcurl, perl
- documentation: manual pages
3.Prerequisites
o You will need libidn installed on your FreeBSD distribution
4.Install
Kronometrix can be installed using the PKG package management system
found on all FreeBSD 10 installations. The data recorders
and started automatically, after the software has been installed. The
transport utility will not start automatically.
Both services: kronometrix and kronometrix_transport are enabled to rc.d
interface, so if you reboot your server both services should start
automatically.
PKG package
# pkg install kdr-1.0.16-freebsd10.1-amd64.txz
Updating FreeBSD repository catalogue...
FreeBSD repository is up-to-date.
All repositories are up-to-date.
Checking integrity... done (0 conflicting)
The following 1 package(s) will be affected (of 0 checked):
New packages to be INSTALLED:
kdr: 1.0.16
The process will require 65 MiB more space.
Proceed with this action? [y/N]: y
[1/1] Installing kdr-1.0.16...
[1/1] Extracting kdr-1.0.16: 100%
# ps -o uid,pid,command -U krmx
UID PID COMMAND
5000 62506 /opt/kronometrix/perl/bin/perl /opt/kronometrix/bin/sysrec 60
5000 62522 /opt/kronometrix/perl/bin/perl /opt/kronometrix/bin/cpurec 60
5000 62538 /opt/kronometrix/perl/bin/perl /opt/kronometrix/bin/diskrec 60
5000 62555 /opt/kronometrix/perl/bin/perl /opt/kronometrix/bin/nicrec 60
5000 62572 /opt/kronometrix/perl/bin/perl /opt/kronometrix/bin/hdwrec 60
4.Uninstall
PKG package
# pkg remove kdr
Checking integrity... done (0 conflicting)
Deinstallation has been requested for the following 1 packages (of 0 packages in the universe):
Installed packages to be REMOVED:
kdr-1.0.16
The operation will free 65 MiB.
Proceed with deinstalling packages? [y/N]: y
[1/1] Deinstalling kdr-1.0.16...
[1/1] Deleting files for kdr-1.0.16: 0%
pkg: /opt/kronometrix/etc/kronometrix.json fails original SHA256 checksum, not removing
[1/1] Deleting files for kdr-1.0.16: 100%
# ps -o uid,pid,command -U krmx
#
5.Start procedure
5.1 Recorders
We can start all data recorders using /opt/kronometrix/etc/rec
script. Make sure before running that you are logged as krmx user
As krmx user:
$ /opt/kronometrix/etc/rec start
OR
As root:
# /etc/rc.d/kdr start
5.1 Transport
We can start sender, the transport utility /opt/kronometrix/etc/transport
script. Make sure before running that you are logged as krmx user
As krmx user:
$ /opt/kronometrix/etc/transport start
OR
As root:
# /etc/rc.d/kdr_transport start
6.Stop procedure
6.1 Recorders
We can stop all data recorders using /opt/kronometrix/etc/rec
script. Make sure before running that you are logged as krmx user
As krmx user:
$ /opt/kronometrix/etc/rec stop
OR
As root:
# /etc/rc.d/kdr stop
6.2 Transport
We can start sender, the transport utility /opt/kronometrix/etc/transport
script. Make sure before running that you are logged as krmx user
As krmx user:
$ /opt/kronometrix/etc/transport stop
OR
As root:
# /etc/rc.d/kdr_transport stop
7.Raw data
Kronometrix data recorders will write the raw data under the main
prefix installation directory:
/opt/kronometrix/log/current
For every data recorder, one raw data file, having .krd extension
will be created and updated. Every night, we rotate these krd files
and store them under:
/opt/kronometrix/log/daily
8.Configuration
The main configuratin file, kronometrix.json stores information about
the active data recorders being used, the address where data will be
delivered for analysis. Additonal, certain recorders might have their
own configuration files, like: webrec.json, svcrec.json, rs485rec.json
8.1 kronometrix.json
This is the main configuration file, including:
Logging section
This is the section defining the base path and the location where all
raw data logs will be stored. This can be located on a local disk or
a remote LUN storage. Usually, this section, should not be changed or
removed.
Transport section
Describes all raw data files and their naming convention. Usually,
this section, should not be changed or removed.
Data Fabric section
This is the section where users should defined where they want to
send data. The platform section describes the details of one or
many data analytics fabrics, each with own settings.
All raw data can be transported to one or many platforms at the same
time. Under this section we need to define and configure, the following:
o port number, the port number default 80, or 443
o hostname, IP or FQD of the platform
o protocol: HTTP or HTTPS
o subscription type: cpd or amd or wcd. cpd means, computer performance data
and describes data belong to IT computer performance. There are many types
of data subscriptions, each having its own type, metrics and summary
statistics:
cpd - Computer Performance
epd - End User Performance
dpd - Datacenter Performance
spd - Service Provider Performance
wpd - Web Application Performance
iaqd - Indoor Air Quality
aqd - Outdoor Air Quality
wcd - General Meteorology
amd - Aviation Meteorology
o sid: subscription id
o tid: token id
o dsid: to be let empty, will be automatically be computed
8.2 Log rotation
Notes
Kronometrix uses its own log rotate mechanism in order to be flexible and
dont conflict with the operating system.