Outcold Solutions LLC

Monitoring Docker - Version 5

Collector Configuration

The default Configuration file 001-general.conf is mapped to the /config/001-general.conf inside the image. You can override configurations by placing another files in the same folder. The collector reads all the *.conf files in the /config folder in the alphabetical order.

With the configuration files, you can override general settings for how collector behaves, what data it forwards to Splunk, how it should connect to Splunk, and default configurations for data pipelines (logs, metrics). You can also configure data forwarding for the specific containers using annotations attached to these containers, use it to define join-rules for multi-line events, enable removing the terminal colors, redirecting events base on patterns to /dev/null, defining fields extraction, replace patterns in the logs, configuring application logs for the containers.

Overriding configuration by embedding configuration files

You can create your configuration files, which overrides the default values in 001-general.conf. Just place only the values that you want to replace inside this file, for example, create a file 002-conf.conf

# accepting EULA
[general]
acceptEULA = true

# Configuring Splunk output
[output.splunk]
url = https://hec.example.com:8088/services/collector/event/1.0
token = B5A79AAD-D822-46CC-80D1-819F80D7BFB0
insecure = true

# Overriding default indices
[input.system_stats]
index = docker_stats

[input.proc_stats]
index = docker_stats

[input.files]
index = docker_logs

[input.app_logs]
index = docker_logs

[input.files::syslog]
index = docker_logs

[input.files::logs]
index = docker_logs

[input.docker_events]
index = docker_logs

Create a Dockerfile

FROM outcoldsolutions/collectorfordocker:5.1

COPY 002-conf.conf /config/002-conf.conf

Build the image

docker build -t example.com/collectorfordocker:5.1 .

Use this image to start the collector with the instructions how we deploy the collector.

Overriding configuration with the environment variables

You can override configurations with the environment variables in format

--env "COLLECTOR__<ANYUNIQUENAME>=<section>__<key>=<value>"

Identical example to the file above

--env "COLLECTOR__EULA=general__acceptEULA=true" \
--env "COLLECTOR__SPLUNK_URL=output.splunk__url=https://hec.example.com:8088/services/collector/event/1.0" \
--env "COLLECTOR__SPLUNK_TOKEN=output.splunk__token=B5A79AAD-D822-46CC-80D1-819F80D7BFB0"  \
--env "COLLECTOR__SPLUNK_INSECURE=output.splunk__insecure=true"  \
--env "COLLECTOR__STATS_INDEX=system_stats__index=docker_stats" \
--env "COLLECTOR__PROCSTATS_INDEX=proc_stats__index=docker_stats" \
--env "COLLECTOR__CONTAINERLOGS_INDEX=input.files__index=docker_logs" \
--env "COLLECTOR__APPLICATIONLOGS_INDEX=input.app_logs__index=docker_logs" \
--env "COLLECTOR__SYSLOG_INDEX=input.files::syslog__index=docker_logs" \
--env "COLLECTOR__HOSTLOGS_INDEX=input.files::logs__index=docker_logs" \
--env "COLLECTOR__EVENTS_INDEX=input.docker_events__index=docker_logs"

Download 001-general.conf

collector.conf

curl

$ curl -O https://www.outcoldsolutions.com/docs/monitoring-docker/v5/configuration/collector.conf

wget

$ wget https://www.outcoldsolutions.com/docs/monitoring-docker/v5/configuration/collector.conf

Reference 001-general.conf

  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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
# collector configuration file
#
# Run collector with flag -conf and specify location of the configuration file.
#
# You can override all the values using environment variables with the format like
#   COLLECTOR__<ANYNAME>=<section>__<key>=<value>
# As an example you can set dataPath in [general] section as
#   COLLECTOR__DATAPATH=general__dataPath=C:\\some\\path\\data.db
# This parameter can be configured using -env-override, set it to empty string to disable this feature

[general]

# Please review EULA https://www.outcoldsolutions.com/docs/license-agreement/
# and accept eula by uncommenting this code and changing value to *true*
acceptEULA = false

# location for the database
# is used to store position of the files and internal state
dataPath = ./data/

# log level (trace, debug, info, warn, error, fatal)
logLevel = info

# http server gives access to two endpoints
# /healthz
# /metrics
httpServerBinding =

# telemetry report endpoint, set it to empty string to disable telemetry
telemetryEndpoint = https://license.outcold.solutions/telemetry/

# license check endpoint
licenseEndpoint = https://license.outcold.solutions/license/

# license server through proxy
licenseServerProxyUrl =

# license
license =

# docker daemon hostname is used by default as hostname
# use this configuration to override
hostname =

# Default buffer size for file input
fileInputBufferSize = 256b

# Maximum size of one line the file reader can read
fileInputLineMaxSize = 1mb

# Include custom fields to attach to every event, in example below every event sent to Splunk will hav
# indexed field my_environment=dev. Fields names should match to ^[a-z][_a-z0-9]*$
# Better way to configure that is to specify labels for Docker Hosts.
# ; fields.my_environment = dev


# connection to docker host
[general.docker]

# url for docker API, only unix socket is supported
url = unix:///rootfs/var/run/docker.sock

# path to docker root folder (can fallback to use folder structure to read docker metadata)
# used to discovery application logs
dockerRootFolder = /rootfs/var/lib/docker/

# (obsolete) In case if pod metadata was not retrievied. how often collector should retry to reload the pod metadata
# metadataFetchRetry = 5s

# (obsolete) In case if event is recent, how long pipeline should wait for the metadata to be available in Kubernetes API
# metadataFetchWait = 30s

# (obsolete) In case if collector does not see new events for specific container and with the last metadata refresh
# We have not found this container - fow how long we should keep this metadata in cache.
# metadataTTL = 5s

# Timeout for http responses to docker client. The streaming requests depend on this timeout.
timeout = 1m

# regex to find docker container cgroups (helps excluding other cgroups with matched ID)
containersCgroupFilter = ^(/([^/\s]+/)*(docker-|docker/)[0-9a-f]{64}(\.scope)?)$


# cgroup input
[input.system_stats]

# disable system level stats
disabled = false

# cgroups fs location
pathCgroups = /rootfs/sys/fs/cgroup

# proc location
pathProc = /rootfs/proc

# how often to collect cgroup stats
statsInterval = 30s

# override type
type = docker_stats

# specify Splunk index
index =


# proc input
[input.proc_stats]

# disable proc level stats
disabled = false

# proc location
pathProc = /rootfs/proc

# how often to collect proc stats
statsInterval = 30s

# override type
type = docker_proc_stats

# specify Splunk index
index =

# proc filesystem includes by default system threads (there can be over 100 of them)
# these stats do not help with the observability
# excluding them can reduce the size of the index, performance of the searches and usage of the collector
IncludeSystemThreads = false


# network stats
[input.net_stats]

# disable net stats
disabled = false

# proc path location
pathProc = /rootfs/proc

# how often to collect net stats
statsInterval = 30s

# override type
type = docker_net_stats

# specify Splunk index
index =


# network socket table
[input.net_socket_table]

# disable net stats
disabled = false

# proc path location
pathProc = /rootfs/proc

# how often to collect net stats
statsInterval = 30s

# override type
type = docker_net_socket_table

# specify Splunk index
index =


# Log files
[input.files]

# disable container logs monitoring
disabled = false

# root location of docker log files, expecting that this folder has a folder for each container,
# folder is the containerID
path = /rootfs/var/lib/docker/containers/

# (obsolete, ignored) glob matching pattern for log files
# glob = */*-json.log*

# files are read using polling schema, when reach the EOF how often to check if files got updated
pollingInterval = 250ms

# how often to look for the new files under logs path
walkingInterval = 5s

# include verbose fields in events (file offset)
verboseFields = false

# override type
type = docker_logs

# specify Splunk index
index =

# docker splits events when they are larger than 10-100k (depends on the docker version)
# we join them together by default and forward to Splunk as one event
joinPartialEvents = true

# In case if your containers report messages with terminal colors or other escape sequences
# you can enable strip for all the containers in one place.
# Better is to enable it only for required container with the label collectord.io/strip-terminal-escape-sequences=true
stripTerminalEscapeSequences = false
# Regexp used for stripping terminal colors, it does not stip all the escape sequences
# Read http://man7.org/linux/man-pages/man4/console_codes.4.html for more information
stripTerminalEscapeSequencesRegex = (\x1b\[\d{1,3}(;\d{1,3})*m)|(\x07)|(\x1b]\d+(\s\d)?;[^\x07]+\x07)|(.*\x1b\[K)


# Application Logs
[input.app_logs]

# disable container logs monitoring
disabled = false

# root location of mounts (applies to hostPath mounts only), , if the hostPath differs inside container from the path on host
root = /rootfs

# how often to review list of available volumes
syncInterval = 5s

# glob matching pattern for log files
glob = *.log*

# files are read using polling schema, when reach the EOF how often to check if files got updated
pollingInterval = 250ms

# how often to look for the new files under logs path
walkingInterval = 5s

# include verbose fields in events (file offset)
verboseFields = false

# override type
type = docker_logs

# specify Splunk index
index =

# we split files using new line character, with this configuration you can specify what defines the new event
# after new line
eventPatternRegex = ^[^\s]
# Maximum interval of messages in pipeline
eventPatternMaxInterval = 100ms
# Maximum time to wait for the messages in pipeline
eventPatternMaxWait = 1s
# Maximum message size
eventPatternMaxSize = 100kb


# Input syslog(.\d+)? files
[input.files::syslog]

# disable host level logs
disabled = false

# root location of log files
path = /rootfs/var/log/

# regex matching pattern
match = ^(syslog|messages)(.\d+)?$

# limit search only on one level
recursive = false

# files are read using polling schema, when reach the EOF how often to check if files got updated
pollingInterval = 250ms

# how often o look for the new files under logs path
walkingInterval = 5s

# include verbose fields in events (file offset)
verboseFields = false

# override type
type = docker_host_logs

# specify Splunk index
index =

# field extraction
extraction = ^(?P<timestamp>[A-Za-z]+\s+\d+\s\d+:\d+:\d+)\s(?P<syslog_hostname>[^\s]+)\s(?P<syslog_component>[^:\[]+)(\[(?P<syslog_pid>\d+)\])?: (.+)$

# timestamp field
timestampField = timestamp

# format for timestamp
# the layout defines the format by showing how the reference time, defined to be `Mon Jan 2 15:04:05 -0700 MST 2006`
timestampFormat = Jan 2 15:04:05

# Adjust date, if month/day aren't set in format
timestampSetMonth = false
timestampSetDay = false

# timestamp location (if not defined by format)
timestampLocation = Local


# Input all *.log(.\d+)? files
[input.files::logs]

# disable host level logs
disabled = false

# root location of log files
path = /rootfs/var/log/

# regex matching pattern
match = ^[\w\-.]+\.log(.\d+)?$

# files are read using polling schema, when reach the EOF how often to check if files got updated
pollingInterval = 250ms

# how often o look for the new files under logs path
walkingInterval = 5s

# include verbose fields in events (file offset)
verboseFields = false

# override type
type = docker_host_logs

# specify Splunk index
index =

# field extraction
extraction =

# timestamp field
timestampField =

# format for timestamp
# the layout defines the format by showing how the reference time, defined to be `Mon Jan 2 15:04:05 -0700 MST 2006`
timestampFormat =

# timestamp location (if not defined by format)
timestampLocation =


# Docker input (events)
[input.docker_events]

# disable docker events
disabled = false

# (obsolete) interval to poll for new events in docker
# docker events are streamed in realtime, recreating connections every ~docker.timeout
# eventsPollingInterval = 5s

# override type
type = docker_events

# specify Splunk index
index =


# Splunk output
[output.splunk]

# Splunk HTTP Event Collector url
url =
# You can specify muiltiple splunk URls with
#
# urls.0 = https://server1:8088/services/collector/event/1.0
# urls.1 = https://server1:8088/services/collector/event/1.0
# urls.2 = https://server1:8088/services/collector/event/1.0
#
# Limitations:
# * The urls cannot have different path.

# Specify how URL should be picked up (in case if multiple is used)
# urlSelection = random|round-robin|random-with-round-robin
# where:
# * random - choose random url on first selection and after each failure (connection or HTTP status code >= 500)
# * round-robin - choose url starting from first one and bump on each failure (connection or HTTP status code >= 500)
# * random-with-round-robin - choose random url on first selection and after that in round-robin on each
#                             failure (connection or HTTP status code >= 500)
urlSelection = random-with-round-robin

# Splunk HTTP Event Collector Token
token =

# Allow invalid SSL server certificate
insecure = false

# Path to CA cerificate
caPath =

# CA Name to verify
caName =

# path for client certificate (if required)
clientCertPath =

# path for client key (if required)
clientKeyPath =

# Events are batched with the maximum size set by batchSize and staying in pipeline for not longer
# than set by frequency
frequency = 5s
batchSize = 768K

# Splunk through proxy
proxyUrl =

# Splunk acknowledgement url (.../services/collector/ack)
ackUrl =
# You can specify muiltiple splunk URls for ackUrl
#
# ackUrls.0 = https://server1:8088/services/collector/ack
# ackUrls.1 = https://server1:8088/services/collector/ack
# ackUrls.2 = https://server1:8088/services/collector/ack
#
# Make sure that they in the same order as urls for url, to make sure that this Splunk instance will be
# able to acknowledge the payload.
#
# Limitations:
# * The urls cannot have different path.

# Enable index acknowledgment
ackEnabled = false

# Index acknowledgment timeout
ackTimeout = 3m

# Timeout specifies a time limit for requests made by collector.
# The timeout includes connection time, any
# redirects, and reading the response body.
timeout = 30s

# in case when pipeline can post to multiple indexes, we want to avoid posibility of blocking
# all pipelines, because just some events have incorrect index
dedicatedClientPerIndex = true
# in case if some indexes aren't used anymore, how often to destroy the dedicated client
dedicatedClientCleanPeriod = 24h
# possible values: RedirectToDefault, Drop, Retry
incorrectIndexBehavior = RedirectToDefault


# Pipe to join events (container logs only)
[pipe.join]

# disable joining event
disabled = false

# Maximum interval of messages in pipeline
maxInterval = 100ms

# Maximum time to wait for the messages in pipeline
maxWait = 1s

# Maximum message size
maxSize = 100K

# Default pattern to indicate new message (should start not from space)
patternRegex = ^[^\s]


# (depricated, use container annotations for settings up join rules)
# Define special event join patterns for matched events
# Section consist of [pipe.join::<name>]
# [pipe.join::my_app]
## Set match pattern for the fields
#; matchRegex.docker_container_image = my_app
#; matchRegex.docker_stream = stdout
## All events start from '[<digits>'
#; patternRegex = ^\[\d+

About Outcold Solutions

Outcold Solutions provides solutions for monitoring Kubernetes, OpenShift and Docker clusters in Splunk Enterprise and Splunk Cloud. We offer certified Splunk applications, which gives you insights across all containers environments. We are helping businesses reduce complexity related to logging and monitoring by providing easy-to-use and deploy solutions for Linux and Windows containers. We deliver applications, which helps developers monitor their applications and operators to keep their clusters healthy. With the power of Splunk Enterprise and Splunk Cloud, we offer one solution to help you keep all the metrics and logs in one place, allowing you to quickly address complex questions on container performance.