-
Notifications
You must be signed in to change notification settings - Fork 31
Expand file tree
/
Copy path.README.html
More file actions
1533 lines (1522 loc) · 157 KB
/
.README.html
File metadata and controls
1533 lines (1522 loc) · 157 KB
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
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<!--
==============================================================================
"GitHub HTML5 Pandoc Template" v2.2 — by Tristano Ajmone
==============================================================================
Copyright © Tristano Ajmone, 2017-2020, MIT License (MIT). Project's home:
- https://github.com/tajmone/pandoc-goodies
The CSS in this template reuses source code taken from the following projects:
- GitHub Markdown CSS: Copyright © Sindre Sorhus, MIT License (MIT):
https://github.com/sindresorhus/github-markdown-css
- Primer CSS: Copyright © 2016-2017 GitHub Inc., MIT License (MIT):
http://primercss.io/
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The MIT License
Copyright (c) Tristano Ajmone, 2017-2020 (github.com/tajmone/pandoc-goodies)
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
Copyright (c) 2017 GitHub Inc.
"GitHub Pandoc HTML5 Template" is Copyright (c) Tristano Ajmone, 2017-2020,
released under the MIT License (MIT); it contains readaptations of substantial
portions of the following third party softwares:
(1) "GitHub Markdown CSS", Copyright (c) Sindre Sorhus, MIT License (MIT).
(2) "Primer CSS", Copyright (c) 2016 GitHub Inc., MIT License (MIT).
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
==============================================================================-->
<html>
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>logging</title>
<style type="text/css">
@charset "UTF-8";.markdown-body{-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%;color:#24292e;font-family:-apple-system,system-ui,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";font-size:16px;line-height:1.5;word-wrap:break-word;box-sizing:border-box;min-width:200px;margin:0 auto;padding:45px}.markdown-body a{color:#0366d6;background-color:transparent;text-decoration:none;-webkit-text-decoration-skip:objects}.markdown-body a:active,.markdown-body a:hover{outline-width:0}.markdown-body a:hover{text-decoration:underline}.markdown-body a:not([href]){color:inherit;text-decoration:none}.markdown-body strong{font-weight:600}.markdown-body h1,.markdown-body h2,.markdown-body h3,.markdown-body h4,.markdown-body h5,.markdown-body h6{margin-top:24px;margin-bottom:16px;font-weight:600;line-height:1.25}.markdown-body h1{font-size:2em;margin:.67em 0;padding-bottom:.3em;border-bottom:1px solid #eaecef}.markdown-body h2{padding-bottom:.3em;font-size:1.5em;border-bottom:1px solid #eaecef}.markdown-body h3{font-size:1.25em}.markdown-body h4{font-size:1em}.markdown-body h5{font-size:.875em}.markdown-body h6{font-size:.85em;color:#6a737d}.markdown-body img{border-style:none}.markdown-body svg:not(:root){overflow:hidden}.markdown-body hr{box-sizing:content-box;height:.25em;margin:24px 0;padding:0;overflow:hidden;background-color:#e1e4e8;border:0}.markdown-body hr::before{display:table;content:""}.markdown-body hr::after{display:table;clear:both;content:""}.markdown-body input{margin:0;overflow:visible;font:inherit;font-family:inherit;font-size:inherit;line-height:inherit}.markdown-body [type=checkbox]{box-sizing:border-box;padding:0}.markdown-body *{box-sizing:border-box}.markdown-body blockquote{margin:0}.markdown-body ol,.markdown-body ul{padding-left:2em}.markdown-body ol ol,.markdown-body ul ol{list-style-type:lower-roman}.markdown-body ol ol,.markdown-body ol ul,.markdown-body ul ol,.markdown-body ul ul{margin-top:0;margin-bottom:0}.markdown-body ol ol ol,.markdown-body ol ul ol,.markdown-body ul ol ol,.markdown-body ul ul ol{list-style-type:lower-alpha}.markdown-body li>p{margin-top:16px}.markdown-body li+li{margin-top:.25em}.markdown-body dd{margin-left:0}.markdown-body dl{padding:0}.markdown-body dl dt{padding:0;margin-top:16px;font-size:1em;font-style:italic;font-weight:600}.markdown-body dl dd{padding:0 16px;margin-bottom:16px}.markdown-body code{font-family:SFMono-Regular,Consolas,"Liberation Mono",Menlo,Courier,monospace}.markdown-body pre{font:12px SFMono-Regular,Consolas,"Liberation Mono",Menlo,Courier,monospace;word-wrap:normal}.markdown-body blockquote,.markdown-body dl,.markdown-body ol,.markdown-body p,.markdown-body pre,.markdown-body table,.markdown-body ul{margin-top:0;margin-bottom:16px}.markdown-body blockquote{padding:0 1em;color:#6a737d;border-left:.25em solid #dfe2e5}.markdown-body blockquote>:first-child{margin-top:0}.markdown-body blockquote>:last-child{margin-bottom:0}.markdown-body table{display:block;width:100%;overflow:auto;border-spacing:0;border-collapse:collapse}.markdown-body table th{font-weight:600}.markdown-body table td,.markdown-body table th{padding:6px 13px;border:1px solid #dfe2e5}.markdown-body table tr{background-color:#fff;border-top:1px solid #c6cbd1}.markdown-body table tr:nth-child(2n){background-color:#f6f8fa}.markdown-body img{max-width:100%;box-sizing:content-box;background-color:#fff}.markdown-body code{padding:.2em 0;margin:0;font-size:85%;background-color:rgba(27,31,35,.05);border-radius:3px}.markdown-body code::after,.markdown-body code::before{letter-spacing:-.2em;content:" "}.markdown-body pre>code{padding:0;margin:0;font-size:100%;word-break:normal;white-space:pre;background:0 0;border:0}.markdown-body .highlight{margin-bottom:16px}.markdown-body .highlight pre{margin-bottom:0;word-break:normal}.markdown-body .highlight pre,.markdown-body pre{padding:16px;overflow:auto;font-size:85%;line-height:1.45;background-color:#f6f8fa;border-radius:3px}.markdown-body pre code{display:inline;max-width:auto;padding:0;margin:0;overflow:visible;line-height:inherit;word-wrap:normal;background-color:transparent;border:0}.markdown-body pre code::after,.markdown-body pre code::before{content:normal}.markdown-body .full-commit .btn-outline:not(:disabled):hover{color:#005cc5;border-color:#005cc5}.markdown-body kbd{box-shadow:inset 0 -1px 0 #959da5;display:inline-block;padding:3px 5px;font:11px/10px SFMono-Regular,Consolas,"Liberation Mono",Menlo,Courier,monospace;color:#444d56;vertical-align:middle;background-color:#fcfcfc;border:1px solid #c6cbd1;border-bottom-color:#959da5;border-radius:3px;box-shadow:inset 0 -1px 0 #959da5}.markdown-body :checked+.radio-label{position:relative;z-index:1;border-color:#0366d6}.markdown-body .task-list-item{list-style-type:none}.markdown-body .task-list-item+.task-list-item{margin-top:3px}.markdown-body .task-list-item input{margin:0 .2em .25em -1.6em;vertical-align:middle}.markdown-body::before{display:table;content:""}.markdown-body::after{display:table;clear:both;content:""}.markdown-body>:first-child{margin-top:0!important}.markdown-body>:last-child{margin-bottom:0!important}.Alert,.Error,.Note,.Success,.Warning{padding:11px;margin-bottom:24px;border-style:solid;border-width:1px;border-radius:4px}.Alert p,.Error p,.Note p,.Success p,.Warning p{margin-top:0}.Alert p:last-child,.Error p:last-child,.Note p:last-child,.Success p:last-child,.Warning p:last-child{margin-bottom:0}.Alert{color:#246;background-color:#e2eef9;border-color:#bac6d3}.Warning{color:#4c4a42;background-color:#fff9ea;border-color:#dfd8c2}.Error{color:#911;background-color:#fcdede;border-color:#d2b2b2}.Success{color:#22662c;background-color:#e2f9e5;border-color:#bad3be}.Note{color:#2f363d;background-color:#f6f8fa;border-color:#d5d8da}.Alert h1,.Alert h2,.Alert h3,.Alert h4,.Alert h5,.Alert h6{color:#246;margin-bottom:0}.Warning h1,.Warning h2,.Warning h3,.Warning h4,.Warning h5,.Warning h6{color:#4c4a42;margin-bottom:0}.Error h1,.Error h2,.Error h3,.Error h4,.Error h5,.Error h6{color:#911;margin-bottom:0}.Success h1,.Success h2,.Success h3,.Success h4,.Success h5,.Success h6{color:#22662c;margin-bottom:0}.Note h1,.Note h2,.Note h3,.Note h4,.Note h5,.Note h6{color:#2f363d;margin-bottom:0}.Alert h1:first-child,.Alert h2:first-child,.Alert h3:first-child,.Alert h4:first-child,.Alert h5:first-child,.Alert h6:first-child,.Error h1:first-child,.Error h2:first-child,.Error h3:first-child,.Error h4:first-child,.Error h5:first-child,.Error h6:first-child,.Note h1:first-child,.Note h2:first-child,.Note h3:first-child,.Note h4:first-child,.Note h5:first-child,.Note h6:first-child,.Success h1:first-child,.Success h2:first-child,.Success h3:first-child,.Success h4:first-child,.Success h5:first-child,.Success h6:first-child,.Warning h1:first-child,.Warning h2:first-child,.Warning h3:first-child,.Warning h4:first-child,.Warning h5:first-child,.Warning h6:first-child{margin-top:0}h1.title,p.subtitle{text-align:center}h1.title.followed-by-subtitle{margin-bottom:0}p.subtitle{font-size:1.5em;font-weight:600;line-height:1.25;margin-top:0;margin-bottom:16px;padding-bottom:.3em}div.line-block{white-space:pre-line}
</style>
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
html { -webkit-text-size-adjust: 100%; }
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { color: #008000; } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { color: #008000; font-weight: bold; } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
</style>
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<article class="markdown-body">
<header>
<h1 class="title">logging</h1>
</header>
<hr>
<nav id="TOC">
<h1 class="toc-title">Contents</h1>
<ul>
<li><a href="#background" id="toc-background">Background</a></li>
<li><a href="#requirements" id="toc-requirements">Requirements</a>
<ul>
<li><a href="#collection-requirements"
id="toc-collection-requirements">Collection requirements</a></li>
</ul></li>
<li><a href="#definitions" id="toc-definitions">Definitions</a></li>
<li><a href="#logging-configuration-overview"
id="toc-logging-configuration-overview">Logging Configuration
Overview</a></li>
<li><a href="#variables" id="toc-variables">Variables</a>
<ul>
<li><a href="#logging_inputs-options"
id="toc-logging_inputs-options">Logging_inputs options</a>
<ul>
<li><a href="#logging_inputs-common-keys"
id="toc-logging_inputs-common-keys">logging_inputs common keys</a></li>
<li><a href="#logging_inputs-basics-type"
id="toc-logging_inputs-basics-type">logging_inputs basics type</a></li>
<li><a href="#logging_inputs-files-type"
id="toc-logging_inputs-files-type">logging_inputs files type</a></li>
<li><a href="#logging_inputs-ovirt-type"
id="toc-logging_inputs-ovirt-type">logging_inputs ovirt type</a></li>
<li><a href="#logging_inputs-relp-type"
id="toc-logging_inputs-relp-type">logging_inputs relp type</a></li>
<li><a href="#logging_inputs-remote-type"
id="toc-logging_inputs-remote-type">logging_inputs remote type</a></li>
</ul></li>
<li><a href="#logging_custom_templates"
id="toc-logging_custom_templates">logging_custom_templates</a></li>
<li><a href="#logging_outputs-options"
id="toc-logging_outputs-options">Logging_outputs options</a>
<ul>
<li><a href="#logging_outputs-common-keys"
id="toc-logging_outputs-common-keys">logging_outputs common
keys</a></li>
<li><a href="#logging_outputs-general-queue-parameters"
id="toc-logging_outputs-general-queue-parameters">logging_outputs
general queue parameters</a></li>
<li><a href="#logging_outputs-general-action-parameters"
id="toc-logging_outputs-general-action-parameters">logging_outputs
general action parameters</a></li>
<li><a href="#logging_outputs-elasticsearch-type"
id="toc-logging_outputs-elasticsearch-type">logging_outputs
elasticsearch type</a></li>
<li><a href="#logging_outputs-files-type"
id="toc-logging_outputs-files-type">logging_outputs files type</a></li>
<li><a href="#logging_outputs-forwards-type"
id="toc-logging_outputs-forwards-type">logging_outputs forwards
type</a></li>
<li><a href="#logging_outputs-relp-type"
id="toc-logging_outputs-relp-type">logging_outputs relp type</a></li>
<li><a href="#logging_outputs-remote_files-type"
id="toc-logging_outputs-remote_files-type">logging_outputs remote_files
type</a></li>
</ul></li>
<li><a href="#logging_flows-options"
id="toc-logging_flows-options">Logging_flows options</a></li>
<li><a href="#security-options" id="toc-security-options">Security
options</a>
<ul>
<li><a href="#logging_pki_files"
id="toc-logging_pki_files">logging_pki_files</a></li>
<li><a href="#logging_domain"
id="toc-logging_domain">logging_domain</a></li>
</ul></li>
<li><a href="#server-performance-optimization-options"
id="toc-server-performance-optimization-options">Server performance
optimization options</a></li>
<li><a href="#other-options" id="toc-other-options">Other
options</a></li>
<li><a href="#update-and-delete" id="toc-update-and-delete">Update and
Delete</a></li>
</ul></li>
<li><a href="#configuration-examples"
id="toc-configuration-examples">Configuration Examples</a>
<ul>
<li><a href="#standalone-configuration"
id="toc-standalone-configuration">Standalone configuration</a></li>
<li><a href="#client-configuration" id="toc-client-configuration">Client
configuration</a></li>
<li><a href="#server-configuration" id="toc-server-configuration">Server
configuration</a></li>
<li><a href="#client-configuration-with-relp"
id="toc-client-configuration-with-relp">Client configuration with
Relp</a></li>
<li><a href="#server-configuration-with-relp"
id="toc-server-configuration-with-relp">Server configuration with
Relp</a></li>
<li><a href="#port-managed-by-firewall-and-selinux-role"
id="toc-port-managed-by-firewall-and-selinux-role">Port Managed by
Firewall and SELinux Role</a></li>
</ul></li>
<li><a href="#providers" id="toc-providers">Providers</a></li>
<li><a href="#tests" id="toc-tests">Tests</a></li>
<li><a href="#rpm-ostree" id="toc-rpm-ostree">rpm-ostree</a></li>
</ul>
</nav>
<hr>
<h1 id="background">Background</h1>
<p>Logging role is an abstract layer for provisioning and configuring
the logging system. Currently, rsyslog is the only supported
provider.</p>
<p>In the nature of logging, there are multiple ways to read logs and
multiple ways to output them. For instance, the logging system may read
logs from local files, or read them from systemd/journal, or receive
them from the other logging system over the network. Then, the logs may
be stored in the local files in the /var/log directory, or sent to
Elasticsearch, or forwarded to other logging system. The combination
between the inputs and the outputs needs to be flexible. For instance,
you may want to inputs from journal stored just in the local file, while
inputs read from files stored in the local log files as well as
forwarded to the other logging system.</p>
<p>To satisfy such requirements, logging role introduced 3 primary
variables <code>logging_inputs</code>, <code>logging_outputs</code>, and
<code>logging_flows</code>. The inputs are represented in the list of
<code>logging_inputs</code> dictionary, the outputs are in the list of
<code>logging_outputs</code> dictionary, and the relationship between
them are defined as a list of <code>logging_flows</code> dictionary. The
details are described in <a
href="#logging-configuration-overview">Logging Configuration
Overview</a>.</p>
<h1 id="requirements">Requirements</h1>
<p>This role is supported on RHEL-7+, CentOS Stream-8+ and Fedora
distributions.</p>
<h2 id="collection-requirements">Collection requirements</h2>
<p>The role requires the <code>firewall</code> role and the
<code>selinux</code> role from the
<code>fedora.linux_system_roles</code> collection, if
<code>logging_manage_firewall</code> and
<code>logging_manage_selinux</code> is set to true, respectively.
(Please see also the variables in the <a
href="#other-options"><code>Other options</code></a> section.)</p>
<p>If the <code>logging</code> is a role from the
<code>fedora.linux_system_roles</code> collection or from the Fedora RPM
package, the requirement is already satisfied.</p>
<p>The role requires external collections for management of
<code>rpm-ostree</code> nodes. These are listed in the
<code>meta/collection-requirements.yml</code>. You do not need them if
you do not want to manage <code>rpm-ostree</code> systems.</p>
<p>If you need to install additional collections based on the above,
please run:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">ansible-galaxy</span> collection install <span class="at">-r</span> meta/collection-requirements.yml</span></code></pre></div>
<h1 id="definitions">Definitions</h1>
<ul>
<li><code>logging_inputs</code> - List of logging inputs dictionary to
specify input types.
<ul>
<li><code>basics</code> - basic inputs configuring inputs from systemd
journal or unix socket.</li>
<li><code>files</code> - files inputs configuring inputs from local
files.</li>
<li><code>remote</code> - remote inputs configuring inputs from the
other logging system over network.</li>
<li><code>ovirt</code> - ovirt inputs configuring inputs from the oVirt
system.</li>
</ul></li>
<li><code>logging_outputs</code> - List of logging outputs dictionary to
specify output types.
<ul>
<li><code>elasticsearch</code> - elasticsearch outputs configuring
outputs to elasticsearch. It is available only when the input is
<code>ovirt</code>.</li>
<li><code>files</code> - files outputs configuring outputs to the local
files.</li>
<li><code>forwards</code> - forwards outputs configuring outputs to the
other logging system.</li>
<li><code>remote_files</code> - remote files outputs configuring outputs
from the other logging system to the local files.</li>
</ul></li>
<li><code>logging_flows</code> - List of logging flows dictionary to
define relationships between logging inputs and outputs.</li>
<li><a href="https://www.rsyslog.com/"><code>Rsyslog</code></a> - The
logging role default log provider used for log processing.</li>
<li><a href="https://www.elastic.co/"><code>Elasticsearch</code></a> -
Elasticsearch is a distributed, search and analytic engine for all types
of data. One of the supported outputs in the logging role.</li>
</ul>
<h1 id="logging-configuration-overview">Logging Configuration
Overview</h1>
<p>Logging role allows to have variables <code>logging_inputs</code>,
<code>logging_outputs</code>, and <code>logging_flows</code> with
additional options to configure logging system such as
<code>rsyslog</code>.</p>
<p>Currently, the logging role supports four types of logging inputs:
<code>basics</code>, <code>files</code>, <code>ovirt</code>, and
<code>remote</code>. And four types of outputs:
<code>elasticsearch</code>, <code>files</code>, <code>forwards</code>,
and <code>remote_files</code>. To deploy configuration files with these
inputs and outputs, specify the inputs as <code>logging_inputs</code>
and the outputs as <code>logging_outputs</code>. To define the flows
from inputs to outputs, use <code>logging_flows</code>. The
<code>logging_flows</code> has three keys <code>name</code>,
<code>inputs</code>, and <code>outputs</code>, where <code>inputs</code>
is a list of <code>logging_inputs name</code> values and
<code>outputs</code> is a list of <code>logging_outputs name</code>
values.</p>
<p>This is a schematic logging configuration to show log messages from
input_nameA are passed to output_name0 and output_name1; log messages
from input_nameB are passed only to output_name1.</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="pp">---</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> a schematic logging configuration</span></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">hosts</span><span class="kw">:</span><span class="at"> all</span></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">roles</span><span class="kw">:</span></span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> linux-system-roles.logging</span></span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">vars</span><span class="kw">:</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">logging_inputs</span><span class="kw">:</span></span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> input_nameA</span></span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> input_typeA</span></span>
<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> input_nameB</span></span>
<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> input_typeB</span></span>
<span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">logging_outputs</span><span class="kw">:</span></span>
<span id="cb2-13"><a href="#cb2-13" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> output_name0</span></span>
<span id="cb2-14"><a href="#cb2-14" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> output_type0</span></span>
<span id="cb2-15"><a href="#cb2-15" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> output_name1</span></span>
<span id="cb2-16"><a href="#cb2-16" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> output_type1</span></span>
<span id="cb2-17"><a href="#cb2-17" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">logging_flows</span><span class="kw">:</span></span>
<span id="cb2-18"><a href="#cb2-18" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> flow_nameX</span></span>
<span id="cb2-19"><a href="#cb2-19" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">inputs</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="at">input_nameA</span><span class="kw">]</span></span>
<span id="cb2-20"><a href="#cb2-20" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">outputs</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="at">output_name0</span><span class="kw">,</span><span class="at"> output_name1</span><span class="kw">]</span></span>
<span id="cb2-21"><a href="#cb2-21" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> flow_nameY</span></span>
<span id="cb2-22"><a href="#cb2-22" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">inputs</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="at">input_nameB</span><span class="kw">]</span></span>
<span id="cb2-23"><a href="#cb2-23" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">outputs</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="at">output_name1</span><span class="kw">]</span></span></code></pre></div>
<h1 id="variables">Variables</h1>
<h2 id="logging_inputs-options">Logging_inputs options</h2>
<p><code>logging_inputs</code>: A list of the following dictionaries to
configure inputs.</p>
<h3 id="logging_inputs-common-keys">logging_inputs common keys</h3>
<ul>
<li><code>name</code>: Unique name of the input. Used in the
<code>logging_flows</code> inputs list and a part of the generated
config filename.</li>
<li><code>type</code>: Type of the input element. Currently,
<code>basics</code>, <code>files</code>, <code>ovirt</code>, and
<code>remote</code> are supported. The <code>type</code> is used to
specify a task type which corresponds to a directory name in
roles/rsyslog/{tasks,vars}/inputs/.</li>
<li><code>state</code>: State of the configuration file.
<code>present</code> or <code>absent</code>. Default to
<code>present</code>.</li>
</ul>
<h3 id="logging_inputs-basics-type">logging_inputs basics type</h3>
<p><code>basics</code> input supports reading logs from systemd journal
or systemd unix socket.</p>
<p>Available options:</p>
<ul>
<li><code>kernel_message</code>: Load <code>imklog</code> if set to
<code>true</code>. Default to <code>false</code>.</li>
<li><code>use_imuxsock</code>: Use <code>imuxsock</code> instead of
<code>imjournal</code>. Default to <code>false</code>.</li>
<li><code>ratelimit_burst</code>: Maximum number of messages that can be
emitted within ratelimit_interval. Default to <code>20000</code> if
use_imuxsock is false. Default to <code>200</code> if use_imuxsock is
true.</li>
<li><code>ratelimit_interval</code>: Interval to evaluate
ratelimit_burst. Default to <code>600</code> seconds if use_imuxsock is
false. Default to <code>0</code> if use_imuxsock is true. 0 indicates
ratelimiting is turned off.</li>
<li><code>journal_persist_state_interval</code>: Journal state is
persisted every value messages. Default to <code>10</code>. Effective
only when use_imuxsock is false.</li>
</ul>
<h3 id="logging_inputs-files-type">logging_inputs files type</h3>
<p><code>files</code> input supports reading logs from the local
files.</p>
<p>Available options:</p>
<ul>
<li><code>input_log_path</code>: File name to be read by the imfile
plugin. The value should be full path. Wildcard '*' is allowed in the
path. No default - this parameter is mandatory.</li>
<li><code>facility</code>: Facility to filter the inputs from the
files.</li>
<li><code>severity</code>: Severity to filter the inputs from the
files.</li>
<li><code>startmsg_regex</code>: The regular expression that matches the
start part of a message.</li>
<li><code>endmsg_regex</code>: The regular expression that matches the
last part of a message.</li>
<li><code>reopen_on_truncate</code>: Tells rsyslog to reopen input file
when it was truncated (inode unchanged but file size on disk is less
than current offset in memory). Default is <code>false</code></li>
</ul>
<h3 id="logging_inputs-ovirt-type">logging_inputs ovirt type</h3>
<p><code>ovirt</code> input supports oVirt specific inputs.</p>
<p>Available options:</p>
<ul>
<li><code>subtype</code>: ovirt input subtype. Value is one of
<code>engine</code>, <code>collectd</code>, and <code>vdsm</code>.</li>
<li><code>ovirt_env_name</code>: ovirt environment name. Default to
<code>engine</code>.</li>
<li><code>ovirt_env_uuid</code>: ovirt uuid. Default to none.</li>
</ul>
<p>Available options for engine and vdsm:</p>
<ul>
<li><code>ovirt_elasticsearch_index_prefix</code>: Index prefix for
elasticsearch. Default to <code>project.ovirt-logs</code>.</li>
<li><code>ovirt_engine_fqdn</code>: ovirt engine fqdn. Default to
none.</li>
<li><code>ovirt_input_file</code>: ovirt input file. Default to
<code>/var/log/ovirt-engine/test-engine.log</code> for
<code>engine</code>; default to <code>/var/log/vdsm/vdsm.log</code> for
<code>vdsm</code>.</li>
<li><code>ovirt_vds_cluster_name</code>: vds cluster name. Default to
none.</li>
</ul>
<p>Available options for collectd:</p>
<ul>
<li><code>ovirt_collectd_port</code>: collectd port number. Default to
<code>44514</code>.</li>
<li><code>ovirt_elasticsearch_index_prefix</code>: Index prefix for
elasticsearch. Default to <code>project.ovirt-metrics</code>.</li>
</ul>
<h3 id="logging_inputs-relp-type">logging_inputs relp type</h3>
<p><code>relp</code> input supports receiving logs from the remote
logging system over the network using relp.</p>
<p>Available options:</p>
<ul>
<li><code>port</code>: Port number Relp is listening to. Default to
<code>20514</code>. See also <a
href="#port-managed-by-firewall-and-selinux-role">Port Managed by
Firewall and SELinux Role</a>.</li>
<li><code>tls</code>: If true, encrypt the connection with TLS. You must
provide key/certificates and triplets {<code>ca_cert</code>,
<code>cert</code>, <code>private_key</code>} and/or
{<code>ca_cert_src</code>, <code>cert_src</code>,
<code>private_key_src</code>}. Default to <code>true</code>.</li>
<li><code>ca_cert</code>: Path to CA cert to configure Relp with tls.
Default to <code>/etc/pki/tls/certs/basename of ca_cert_src</code>.</li>
<li><code>cert</code>: Path to cert to configure Relp with tls. Default
to <code>/etc/pki/tls/certs/basename of cert_src</code>.</li>
<li><code>private_key</code>: Path to key to configure Relp with tls.
Default to
<code>/etc/pki/tls/private/basename of private_key_src</code>.</li>
<li><code>ca_cert_src</code>: Local CA cert file path which is copied to
the target host. If <code>ca_cert</code> is specified, it is copied to
the location. Otherwise, to logging_config_dir.</li>
<li><code>cert_src</code>: Local cert file path which is copied to the
target host. If <code>cert</code> is specified, it is copied to the
location. Otherwise, to logging_config_dir.</li>
<li><code>private_key_src</code>: Local key file path which is copied to
the target host. If <code>private_key</code> is specified, it is copied
to the location. Otherwise, to logging_config_dir.</li>
<li><code>pki_authmode</code>: Specifying the authentication mode.
<code>name</code> or <code>fingerprint</code> is accepted. Default to
<code>name</code>.</li>
<li><code>permitted_clients</code>: List of hostnames, IP addresses,
fingerprints(sha1), and wildcard DNS domains which will be allowed by
the <code>logging</code> server to connect and send logs over TLS.
Default to <code>['*.{{ logging_domain }}']</code></li>
</ul>
<h3 id="logging_inputs-remote-type">logging_inputs remote type</h3>
<p><code>remote</code> input supports receiving logs from the remote
logging system over the network.</p>
<p>Available options:</p>
<ul>
<li><code>udp_ports</code>: List of UDP port numbers to listen. If set,
the <code>remote</code> input listens on the UDP ports. No defaults. If
both <code>udp_ports</code> and <code>tcp_ports</code> are set in a
<code>remote</code> input item, <code>udp_ports</code> is used and
<code>tcp_ports</code> is dropped. See also <a
href="#port-managed-by-firewall-and-selinux-role">Port Managed by
Firewall and SELinux Role</a>.</li>
<li><code>tcp_ports</code>: List of TCP port numbers to listen. If set,
the <code>remote</code> input listens on the TCP ports. Default to
<code>[514]</code>. If both <code>udp_ports</code> and
<code>tcp_ports</code> are set in a <code>remote</code> input item,
<code>udp_ports</code> is used and <code>tcp_ports</code> is dropped. If
both <code>udp_ports</code> and <code>tcp_ports</code> are not set in a
<code>remote</code> input item, <code>tcp_ports: [514]</code> is added
to the item. See also <a
href="#port-managed-by-firewall-and-selinux-role">Port Managed by
Firewall and SELinux Role</a>.</li>
<li><code>tls</code>: Set to <code>true</code> to encrypt the connection
using the default TLS implementation used by the provider. Default to
<code>false</code>.</li>
<li><code>pki_authmode</code>: Specifying the default network driver
authentication mode. <code>x509/name</code>,
<code>x509/fingerprint</code>, or <code>anon</code> is accepted. Default
to <code>x509/name</code>.</li>
<li><code>permitted_clients</code>: List of hostnames, IP addresses,
fingerprints(sha1), and wildcard DNS domains which will be allowed by
the <code>logging</code> server to connect and send logs over TLS.
Default to <code>['*.{{ logging_domain }}']</code></li>
</ul>
<p><strong>Note:</strong> There are 3 types of items in the remote type
- udp, plain tcp and tls tcp. The udp type configured using
<code>udp_ports</code>; the plain tcp type is configured using
<code>tcp_ports</code> without <code>tls</code> or with
<code>tls: false</code>; the tls tcp type is configured using
<code>tcp_ports</code> with <code>tls: true</code> at the same time.
Please note there might be only one instance of each of the three types.
E.g., if there are 2 <code>udp</code> type items, it fails to
deploy.</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="co"> # Valid configuration example</span></span>
<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> remote_udp</span></span>
<span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> remote</span></span>
<span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">udp_ports</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="dv">514</span><span class="kw">,</span><span class="at"> ...</span><span class="kw">]</span></span>
<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> remote_ptcp</span></span>
<span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> remote</span></span>
<span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tcp_ports</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="dv">514</span><span class="kw">,</span><span class="at"> ...</span><span class="kw">]</span></span>
<span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> remote_tcp</span></span>
<span id="cb3-9"><a href="#cb3-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> remote</span></span>
<span id="cb3-10"><a href="#cb3-10" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tcp_ports</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="dv">6514</span><span class="kw">,</span><span class="at"> ...</span><span class="kw">]</span></span>
<span id="cb3-11"><a href="#cb3-11" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tls</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
<span id="cb3-12"><a href="#cb3-12" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">pki_authmode</span><span class="kw">:</span><span class="at"> x509/name</span></span>
<span id="cb3-13"><a href="#cb3-13" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">permitted_clients</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="st">'*.example.com'</span><span class="kw">]</span></span></code></pre></div>
<div class="sourceCode" id="cb4"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="co"> # Invalid configuration example 1; duplicated udp</span></span>
<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> remote_udp0</span></span>
<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> remote</span></span>
<span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">udp_ports</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="dv">514</span><span class="kw">]</span></span>
<span id="cb4-5"><a href="#cb4-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> remote_udp1</span></span>
<span id="cb4-6"><a href="#cb4-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> remote</span></span>
<span id="cb4-7"><a href="#cb4-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">udp_ports</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="dv">1514</span><span class="kw">]</span></span></code></pre></div>
<div class="sourceCode" id="cb5"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="co"> # Invalid configuration example 2; duplicated tcp</span></span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> remote_implicit_tcp</span></span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> remote</span></span>
<span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> remote_tcp</span></span>
<span id="cb5-5"><a href="#cb5-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> remote</span></span>
<span id="cb5-6"><a href="#cb5-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">tcp_ports</span><span class="kw">:</span><span class="at"> </span><span class="kw">[</span><span class="dv">1514</span><span class="kw">]</span></span></code></pre></div>
<h2 id="logging_custom_templates">logging_custom_templates</h2>
<p><code>logging_custom_templates</code>: A list of custom template
definitions, for use with <code>logging_outputs</code> <code>type</code>
<code>files</code> and <code>type</code> <code>forwards</code>. You can
specify the template for a particular output to use by setting the
<code>template</code> field in a particular <code>logging_outputs</code>
specification, or by setting the default for all such outputs to use in
<code>logging_files_template_format</code> and
<code>logging_forwards_template_format</code>.</p>
<p>Specify custom templates like this, in either the legacy format or
the new style format:</p>
<div class="sourceCode" id="cb6"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="fu">logging_custom_templates</span><span class="kw">:</span></span>
<span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="kw"> - </span><span class="ch">|</span></span>
<span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a> template(name="tpl1" type="list") {</span>
<span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a> constant(value="Syslog MSG is: '")</span>
<span id="cb6-5"><a href="#cb6-5" aria-hidden="true" tabindex="-1"></a> property(name="msg")</span>
<span id="cb6-6"><a href="#cb6-6" aria-hidden="true" tabindex="-1"></a> constant(value="', ")</span>
<span id="cb6-7"><a href="#cb6-7" aria-hidden="true" tabindex="-1"></a> property(name="timereported" dateFormat="rfc3339" caseConversion="lower")</span>
<span id="cb6-8"><a href="#cb6-8" aria-hidden="true" tabindex="-1"></a> constant(value="\n")</span>
<span id="cb6-9"><a href="#cb6-9" aria-hidden="true" tabindex="-1"></a> }</span>
<span id="cb6-10"><a href="#cb6-10" aria-hidden="true" tabindex="-1"></a><span class="kw"> - </span><span class="ch">>-</span></span>
<span id="cb6-11"><a href="#cb6-11" aria-hidden="true" tabindex="-1"></a> $template precise,"%syslogpriority%,%syslogfacility%,%timegenerated::fulltime%,%HOSTNAME%,%syslogtag%,%msg%\n"</span></code></pre></div>
<p>Then use like this:</p>
<div class="sourceCode" id="cb7"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="fu">logging_outputs</span><span class="kw">:</span></span>
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> custom_file_output</span></span>
<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> files</span></span>
<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">path</span><span class="kw">:</span><span class="at"> /var/log/custom_file_output.log</span></span>
<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">template</span><span class="kw">:</span><span class="at"> tpl1</span><span class="co"> # override logging_files_template_format if set</span></span></code></pre></div>
<h2 id="logging_outputs-options">Logging_outputs options</h2>
<p><code>logging_outputs</code>: A list of following dictionary to
configure outputs.</p>
<h3 id="logging_outputs-common-keys">logging_outputs common keys</h3>
<ul>
<li><code>name</code>: Unique name of the output. Used in the
<code>logging_flows</code> outputs list and a part of the generated
config filename.</li>
<li><code>type</code>: Type of the output element. Currently,
<code>elasticsearch</code>, <code>files</code>, <code>forwards</code>,
and <code>remote_files</code> are supported. The <code>type</code> is
used to specify a task type which corresponds to a directory name in
roles/rsyslog/{tasks,vars}/outputs/.</li>
<li><code>state</code>: State of the configuration file.
<code>present</code> or <code>absent</code>. Default to
<code>present</code>.</li>
</ul>
<h3 id="logging_outputs-general-queue-parameters">logging_outputs
general queue parameters</h3>
<ul>
<li><code>queue</code>: A dict containing general queue parameters that
can be used by all output module types, see the official rsyslog
documentation for full list of parameters and their function.</li>
</ul>
<div class="sourceCode" id="cb8"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="fu">logging_outputs</span><span class="kw">:</span></span>
<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> files_output</span></span>
<span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> files</span></span>
<span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">queue</span><span class="kw">:</span></span>
<span id="cb8-5"><a href="#cb8-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">size</span><span class="kw">:</span><span class="at"> </span><span class="dv">100</span></span></code></pre></div>
<h3 id="logging_outputs-general-action-parameters">logging_outputs
general action parameters</h3>
<ul>
<li><code>action</code>: A dict containing general action parameters,
see the official rsyslog documentation for full list of parameters and
their function.</li>
</ul>
<div class="sourceCode" id="cb9"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="fu">logging_outputs</span><span class="kw">:</span></span>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> forwards_output</span></span>
<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">type</span><span class="kw">:</span><span class="at"> forwards</span></span>
<span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">target</span><span class="kw">:</span><span class="at"> your_target_host</span></span>
<span id="cb9-5"><a href="#cb9-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">action</span><span class="kw">:</span></span>
<span id="cb9-6"><a href="#cb9-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">writeallmarkmessages</span><span class="kw">:</span><span class="at"> </span><span class="st">"on"</span></span></code></pre></div>
<h3 id="logging_outputs-elasticsearch-type">logging_outputs
elasticsearch type</h3>
<p><code>elasticsearch</code> output supports sending logs to
Elasticsearch. It is available only when the input is
<code>ovirt</code>. Assuming Elasticsearch is already configured and
running.</p>
<p>Available options:</p>
<ul>
<li><code>server_host</code>: Host name Elasticsearch is running on. The
value is a single host or list of hosts. <strong>Required</strong>.</li>
<li><code>server_port</code>: Port number Elasticsearch is listening to.
Default to <code>9200</code>.</li>
<li><code>index_prefix</code>: Elasticsearch index prefix the particular
log will be indexed to. <strong>Required</strong>.</li>
<li><code>input_type</code>: Specifying the input type. Currently only
type <code>ovirt</code> is supported. Default to
<code>ovirt</code>.</li>
<li><code>retryfailures</code>: Specifying whether retries or not in
case of failure. Allowed value is <code>true</code> or
<code>false</code>. Default to <code>true</code>.</li>
<li><code>tls</code>: If true, encrypt the connection with TLS. You must
provide key/certificates and triplets {<code>ca_cert</code>,
<code>cert</code>, <code>private_key</code>} and/or
{<code>ca_cert_src</code>, <code>cert_src</code>,
<code>private_key_src</code>}. Default to <code>true</code>.</li>
<li><code>use_cert</code>: [DEPRECATED] If true, encrypt the connection
with TLS. You must provide key/certificates and triplets
{<code>ca_cert</code>, <code>cert</code>, <code>private_key</code>}
and/or {<code>ca_cert_src</code>, <code>cert_src</code>,
<code>private_key_src</code>}. Default to <code>true</code>. Option
<code>use_cert</code> is deprecated in favor of <code>tls</code> and
<code>use_cert</code> will be removed in the next minor release.</li>
<li><code>ca_cert</code>: Path to CA cert for Elasticsearch. Default to
<code>/etc/pki/tls/certs/basename of ca_cert_src</code>.</li>
<li><code>cert</code>: Path to cert to connect to Elasticsearch. Default
to <code>/etc/pki/tls/certs/basename of cert_src</code>.</li>
<li><code>private_key</code>: Path to key to connect to Elasticsearch.
Default to
<code>/etc/pki/tls/private/basename of private_key_src</code>.</li>
<li><code>ca_cert_src</code>: Local CA cert file path which is copied to
the target host. If <code>ca_cert</code> is specified, it is copied to
the location. Otherwise, to logging_config_dir.</li>
<li><code>cert_src</code>: Local cert file path which is copied to the
target host. If <code>cert</code> is specified, it is copied to the
location. Otherwise, to logging_config_dir.</li>
<li><code>private_key_src</code>: Local key file path which is copied to
the target host. If <code>private_key</code> is specified, it is copied
to the location. Otherwise, to logging_config_dir.</li>
<li><code>uid</code>: If basic HTTP authentication is deployed, the user
name is specified with this key.</li>
</ul>
<p>logging_elasticsearch_password: If basic HTTP authentication is
deployed, the password is specified with this global variable. Please be
careful that this <code>logging_elasticsearch_password</code> is a
global variable to be placed at the same level as
<code>logging_output</code>, <code>logging_input</code>, and
<code>logging_flows</code> are. Another things to be aware of are this
<code>logging_elasticsearch_password</code> is shared among all the
elasticsearch outputs. That is, the elasticsearch servers should share
one password if there are multiple of servers. Plus, the uid and
password are configured if both of them are found in the playbook. For
instance, if there are multiple elasticsearch outputs and one of them is
missing the <code>uid</code> key, then the configured output does not
have the uid and password.</p>
<h3 id="logging_outputs-files-type">logging_outputs files type</h3>
<p><code>files</code> output supports storing logs in the local files
usually in /var/log.</p>
<p>Available options:</p>
<ul>
<li><code>facility</code>: Facility in selector; default to
<code>*</code>.</li>
<li><code>severity</code>: Severity in selector; default to
<code>*</code>.</li>
<li><code>exclude</code>: Exclude list used in selector; default to
none.</li>
<li><code>property</code>: Property in property-based filter; no
default</li>
<li><code>property_op</code>: Operation in property-based filter; In
case of not <code>!</code>, put the <code>property_op</code> value in
quotes; default to <code>contains</code></li>
<li><code>property_value</code>: Value in property-based filter; default
to <code>error</code></li>
<li><code>path</code>: Path to the output file.</li>
<li>File/Directory properties - same as corresponding variables of the
Ansible <code>file</code> module:
<ul>
<li><code>mode</code> - sets the rsyslog <code>omfile</code> module
<code>FileCreateMode</code> parameter</li>
<li><code>owner</code> - sets the rsyslog <code>omfile</code> module
<code>fileOwner</code> or <code>fileOwnerNum</code> parameter. If the
value is an integer, set <code>fileOwnerNum</code>, otherwise, set
<code>fileOwner</code>.</li>
<li><code>group</code> - sets the rsyslog <code>omfile</code> module
<code>fileGroup</code> or <code>fileGroupNum</code> parameter. If the
value is an integer, set <code>fileGroupNum</code>, otherwise, set
<code>fileGroup</code>.</li>
<li><code>dir_mode</code> - sets the rsyslog <code>omfile</code> module
<code>DirCreateMode</code> parameter</li>
<li><code>dir_owner</code> - sets the rsyslog <code>omfile</code> module
<code>dirOwner</code> or <code>dirOwnerNum</code> parameter. If the
value is an integer, set <code>dirOwnerNum</code>, otherwise, set
<code>dirOwner</code>.</li>
<li><code>dir_group</code> - sets the rsyslog <code>omfile</code> module
<code>dirGroup</code> or <code>dirGroupNum</code> parameter. If the
value is an integer, set <code>dirGroupNum</code>, otherwise, set
<code>dirGroup</code>.</li>
</ul></li>
<li><code>template</code>: Template format for the particular files
output. Allowed values are <code>traditional</code>,
<code>syslog</code>, and <code>modern</code>, or one of the templates
defined in <code>logging_custom_templates</code>. Default to
<code>modern</code>.</li>
</ul>
<p>Global options:</p>
<p><code>logging_files_template_format</code>: Set default template for
the files output. Allowed values are <code>traditional</code>,
<code>syslog</code>, and <code>modern</code>, or one of the templates
defined in <code>logging_custom_templates</code>. Default to
<code>modern</code>.</p>
<p><strong>Note:</strong> Selector options and property-based filter
options are exclusive. If Property-based filter options are defined,
selector options will be ignored.</p>
<p><strong>Note:</strong> Unless the above options are given, these
local file outputs are configured.</p>
<div class="sourceCode" id="cb10"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a> <span class="ex">kern.*</span> /dev/console</span>
<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a> <span class="ex">*.info</span><span class="kw">;</span><span class="ex">mail.none</span><span class="kw">;</span><span class="ex">authpriv.none</span><span class="kw">;</span><span class="ex">cron.none</span> /var/log/messages</span>
<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a> <span class="ex">authpriv.*</span> /var/log/secure</span>
<span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a> <span class="ex">mail.*</span> <span class="at">-</span>/var/log/maillog</span>
<span id="cb10-5"><a href="#cb10-5" aria-hidden="true" tabindex="-1"></a> <span class="ex">cron.*</span> <span class="at">-</span>/var/log/cron</span>
<span id="cb10-6"><a href="#cb10-6" aria-hidden="true" tabindex="-1"></a> <span class="ex">*.emerg</span> :omusrmsg:<span class="pp">*</span></span>
<span id="cb10-7"><a href="#cb10-7" aria-hidden="true" tabindex="-1"></a> <span class="ex">uucp,news.crit</span> /var/log/spooler</span>
<span id="cb10-8"><a href="#cb10-8" aria-hidden="true" tabindex="-1"></a> <span class="ex">local7.*</span></span></code></pre></div>
<h3 id="logging_outputs-forwards-type">logging_outputs forwards
type</h3>
<p><code>forwards</code> output sends logs to the remote logging system
over the network.</p>
<p>Available options:</p>
<ul>
<li><code>facility</code>: Facility in selector; default to
<code>*</code>.</li>
<li><code>severity</code>: Severity in selector; default to
<code>*</code>.</li>
<li><code>exclude</code>: Exclude list used in selector; default to
none.</li>
<li><code>property</code>: Property in property-based filter; no
default</li>
<li><code>property_op</code>: Operation in property-based filter; In
case of not <code>!</code>, put the <code>property_op</code> value in
quotes; default to <code>contains</code></li>
<li><code>property_value</code>: Value in property-based filter; default
to <code>error</code></li>
<li><code>target</code>: Target host (fqdn).
<strong>Required</strong>.</li>
<li><code>udp_port</code>: UDP port number. Default to
<code>514</code>.</li>
<li><code>tcp_port</code>: TCP port number. Default to
<code>514</code>.</li>
<li><code>tls</code>: Set to <code>true</code> to encrypt the connection
using the default TLS implementation used by the provider. Default to
<code>false</code>.</li>
<li><code>pki_authmode</code>: Specifying the default network driver
authentication mode. <code>x509/name</code>,
<code>x509/fingerprint</code>, or <code>anon</code> is accepted. Default
to <code>x509/name</code>.</li>
<li><code>permitted_server</code>: Hostname, IP address,
fingerprint(sha1) or wildcard DNS domain of the server which this client
will be allowed to connect and send logs over TLS. Default to
<code>*.{{ logging_domain }}</code></li>
<li><code>template</code>: Template format for the particular forwards
output. Allowed values are <code>traditional</code>,
<code>syslog</code>, and <code>modern</code>, or one of the templates
defined in <code>logging_custom_templates</code>. Default to
<code>modern</code>.</li>
</ul>
<p>Global options:</p>
<p><code>logging_forwards_template_format</code>: Set default template
for the forwards output. Allowed values are <code>traditional</code>,
<code>syslog</code>, and <code>modern</code>, or one of the templates
defined in <code>logging_custom_templates</code>. Default to
<code>modern</code>.</p>
<p><strong>Note:</strong> Selector options and property-based filter
options are exclusive. If Property-based filter options are defined,
selector options will be ignored.</p>
<h3 id="logging_outputs-relp-type">logging_outputs relp type</h3>
<p><code>relp</code> output sends logs to the remote logging system over
the network using relp.</p>
<p>Available options:</p>
<ul>
<li><code>target</code>: Host name the remote logging system is running
on. <strong>Required</strong>.</li>
<li><code>port</code>: Port number the remote logging system is
listening to. Default to <code>20514</code>.</li>
<li><code>tls</code>: If true, encrypt the connection with TLS. You must
provide key/certificates and triplets {<code>ca_cert</code>,
<code>cert</code>, <code>private_key</code>} and/or
{<code>ca_cert_src</code>, <code>cert_src</code>,
<code>private_key_src</code>}. Default to <code>true</code>.</li>
<li><code>ca_cert</code>: Path to CA cert to configure Relp with tls.
Default to <code>/etc/pki/tls/certs/basename of ca_cert_src</code>.</li>
<li><code>cert</code>: Path to cert to configure Relp with tls. Default
to <code>/etc/pki/tls/certs/basename of cert_src</code>.</li>
<li><code>private_key</code>: Path to key to configure Relp with tls.
Default to
<code>/etc/pki/tls/private/basename of private_key_src</code>.</li>
<li><code>ca_cert_src</code>: Local CA cert file path which is copied to
the target host. If <code>ca_cert</code> is specified, it is copied to
the location. Otherwise, to logging_config_dir.</li>
<li><code>cert_src</code>: Local cert file path which is copied to the
target host. If <code>cert</code> is specified, it is copied to the
location. Otherwise, to logging_config_dir.</li>
<li><code>private_key_src</code>: Local key file path which is copied to
the target host. If <code>private_key</code> is specified, it is copied
to the location. Otherwise, to logging_config_dir.</li>
<li><code>pki_authmode</code>: Specifying the authentication mode.
<code>name</code> or <code>fingerprint</code> is accepted. Default to
<code>name</code>.</li>
<li><code>permitted_servers</code>: List of hostnames, IP addresses,
fingerprints(sha1), and wildcard DNS domains which will be allowed by
the <code>logging</code> client to connect and send logs over TLS.
Default to <code>['*.{{ logging_domain }}']</code></li>
</ul>
<h3 id="logging_outputs-remote_files-type">logging_outputs remote_files
type</h3>
<p><code>remote_files</code> output stores logs to the local files per
remote host and program name originated the logs.</p>
<p>Available options:</p>
<ul>
<li><code>facility</code>: Facility in selector; default to
<code>*</code>.</li>
<li><code>severity</code>: Severity in selector; default to
<code>*</code>.</li>
<li><code>exclude</code>: Exclude list used in selector; default to
none.</li>
<li><code>property</code>: Property in property-based filter; no
default</li>
<li><code>property_op</code>: Operation in property-based filter; In
case of not <code>!</code>, put the <code>property_op</code> value in
quotes; default to <code>contains</code></li>
<li><code>property_value</code>: Value in property-based filter; default
to <code>error</code></li>
<li><code>async_writing</code>: If set to <code>true</code>, the files
are written asynchronously. Allowed value is <code>true</code> or
<code>false</code>. Default to <code>false</code>.</li>
<li><code>client_count</code>: Count of client logging system supported
this rsyslog server. Default to <code>10</code>.</li>
<li><code>io_buffer_size</code>: Buffer size used to write output data.
Default to <code>65536</code> bytes.</li>
<li><code>remote_log_path</code>: Full path to store the filtered logs.
This is an example to support the per host output log files
<code>/path/to/output/dir/%FROMHOST%/%PROGRAMNAME:::secpath-replace%.log</code></li>
<li><code>remote_sub_path</code>: Relative path to
logging_system_log_dir to store the filtered logs.</li>
</ul>
<p><strong>Note:</strong> Selector options and property-based filter
options are exclusive. If Property-based filter options are defined,
selector options will be ignored.</p>
<p><strong>Note:</strong> If both <code>remote_log_path</code> and
<code>remote_sub_path</code> are <em>not</em> specified, the remote_file
output configured with the following settings.</p>
<div class="sourceCode" id="cb11"><pre
class="sourceCode java"><code class="sourceCode java"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a> <span class="fu">template</span><span class="op">(</span></span>
<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a> name<span class="op">=</span><span class="st">"RemoteMessage"</span></span>
<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a> type<span class="op">=</span><span class="st">"string"</span></span>
<span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> string<span class="op">=</span><span class="st">"/var/log/remote/msg/%FROMHOST%/%PROGRAMNAME:::secpath-replace%.log"</span></span>
<span id="cb11-5"><a href="#cb11-5" aria-hidden="true" tabindex="-1"></a> <span class="op">)</span></span>
<span id="cb11-6"><a href="#cb11-6" aria-hidden="true" tabindex="-1"></a> <span class="fu">template</span><span class="op">(</span></span>
<span id="cb11-7"><a href="#cb11-7" aria-hidden="true" tabindex="-1"></a> name<span class="op">=</span><span class="st">"RemoteHostAuthLog"</span></span>
<span id="cb11-8"><a href="#cb11-8" aria-hidden="true" tabindex="-1"></a> type<span class="op">=</span><span class="st">"string"</span></span>
<span id="cb11-9"><a href="#cb11-9" aria-hidden="true" tabindex="-1"></a> string<span class="op">=</span><span class="st">"/var/log/remote/auth/%FROMHOST%/%PROGRAMNAME:::secpath-replace%.log"</span></span>
<span id="cb11-10"><a href="#cb11-10" aria-hidden="true" tabindex="-1"></a> <span class="op">)</span></span>
<span id="cb11-11"><a href="#cb11-11" aria-hidden="true" tabindex="-1"></a> <span class="fu">template</span><span class="op">(</span></span>
<span id="cb11-12"><a href="#cb11-12" aria-hidden="true" tabindex="-1"></a> name<span class="op">=</span><span class="st">"RemoteHostCronLog"</span></span>
<span id="cb11-13"><a href="#cb11-13" aria-hidden="true" tabindex="-1"></a> type<span class="op">=</span><span class="st">"string"</span></span>
<span id="cb11-14"><a href="#cb11-14" aria-hidden="true" tabindex="-1"></a> string<span class="op">=</span><span class="st">"/var/log/remote/cron/%FROMHOST%/%PROGRAMNAME:::secpath-replace%.log"</span></span>
<span id="cb11-15"><a href="#cb11-15" aria-hidden="true" tabindex="-1"></a> <span class="op">)</span></span>
<span id="cb11-16"><a href="#cb11-16" aria-hidden="true" tabindex="-1"></a> <span class="fu">template</span><span class="op">(</span></span>
<span id="cb11-17"><a href="#cb11-17" aria-hidden="true" tabindex="-1"></a> name<span class="op">=</span><span class="st">"RemoteHostMailLog"</span></span>
<span id="cb11-18"><a href="#cb11-18" aria-hidden="true" tabindex="-1"></a> type<span class="op">=</span><span class="st">"string"</span></span>
<span id="cb11-19"><a href="#cb11-19" aria-hidden="true" tabindex="-1"></a> string<span class="op">=</span><span class="st">"/var/log/remote/mail/%FROMHOST%/%PROGRAMNAME:::secpath-replace%.log"</span></span>
<span id="cb11-20"><a href="#cb11-20" aria-hidden="true" tabindex="-1"></a> <span class="op">)</span></span>
<span id="cb11-21"><a href="#cb11-21" aria-hidden="true" tabindex="-1"></a> <span class="fu">ruleset</span><span class="op">(</span>name<span class="op">=</span><span class="st">"unique_remote_files_output_name"</span><span class="op">)</span> <span class="op">{</span></span>
<span id="cb11-22"><a href="#cb11-22" aria-hidden="true" tabindex="-1"></a> authpriv<span class="op">.*</span> <span class="fu">action</span><span class="op">(</span>name<span class="op">=</span><span class="st">"remote_authpriv_host_log"</span> type<span class="op">=</span><span class="st">"omfile"</span> DynaFile<span class="op">=</span><span class="st">"RemoteHostAuthLog"</span><span class="op">)</span></span>
<span id="cb11-23"><a href="#cb11-23" aria-hidden="true" tabindex="-1"></a> <span class="op">*.</span><span class="fu">info</span><span class="op">;</span>mail<span class="op">.</span><span class="fu">none</span><span class="op">;</span>authpriv<span class="op">.</span><span class="fu">none</span><span class="op">;</span>cron<span class="op">.</span><span class="fu">none</span> <span class="fu">action</span><span class="op">(</span>name<span class="op">=</span><span class="st">"remote_message"</span> type<span class="op">=</span><span class="st">"omfile"</span> DynaFile<span class="op">=</span><span class="st">"RemoteMessage"</span><span class="op">)</span></span>
<span id="cb11-24"><a href="#cb11-24" aria-hidden="true" tabindex="-1"></a> cron<span class="op">.*</span> <span class="fu">action</span><span class="op">(</span>name<span class="op">=</span><span class="st">"remote_cron_log"</span> type<span class="op">=</span><span class="st">"omfile"</span> DynaFile<span class="op">=</span><span class="st">"RemoteHostCronLog"</span><span class="op">)</span></span>
<span id="cb11-25"><a href="#cb11-25" aria-hidden="true" tabindex="-1"></a> mail<span class="op">.*</span> <span class="fu">action</span><span class="op">(</span>name<span class="op">=</span><span class="st">"remote_mail_service_log"</span> type<span class="op">=</span><span class="st">"omfile"</span> DynaFile<span class="op">=</span><span class="st">"RemoteHostMailLog"</span><span class="op">)</span></span>
<span id="cb11-26"><a href="#cb11-26" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span></code></pre></div>
<h2 id="logging_flows-options">Logging_flows options</h2>
<ul>
<li><code>name</code>: Unique name of the flow.</li>
<li><code>inputs</code>: A list of inputs, from which processing log
messages starts.</li>
<li><code>outputs</code>: A list of outputs. to which the log messages
are sent.</li>
</ul>
<h2 id="security-options">Security options</h2>
<p>These variables are set in the same level of the
<code>logging_inputs</code>, <code>logging_output</code>, and
<code>logging_flows</code>.</p>
<h3 id="logging_pki_files">logging_pki_files</h3>
<p>Specifying either of the paths of the ca_cert, cert, and key on the
control host or the paths of theirs on the managed host or both of them.
When TLS connection is configured, <code>ca_cert_src</code> and/or
<code>ca_cert</code> is required. To configure the certificate of the
logging system, <code>cert_src</code> and/or <code>cert</code> is
required. To configure the private key of the logging system,
<code>private_key_src</code> and/or <code>private_key</code> is
required.</p>
<ul>
<li><code>ca_cert_src</code>: location of the ca_cert on the control
host; if given, the file is copied to the managed host.</li>
<li><code>cert_src</code>: location of the cert on the control host; if
given, the file is copied to the managed host.</li>
<li><code>private_key_src</code>: location of the key on the control
host; if given, the file is copied to the managed host.</li>
<li><code>ca_cert</code>: path to be deployed on the managed host; the
path is also used in the rsyslog config. default to
/etc/pki/tls/certs/<ca_cert_src basename></li>
<li><code>cert</code>: ditto - default to
/etc/pki/tls/certs/<cert_src basename></li>
<li><code>private_key</code>: ditto - default to
/etc/pki/tls/private/<private_key_src basename></li>
</ul>
<h3 id="logging_domain">logging_domain</h3>
<p>The default DNS domain used to accept remote incoming logs from
remote hosts. Default to "{{ ansible_facts['domain'] if
ansible_facts['domain'] else ansible_facts['hostname'] }}"</p>
<h2 id="server-performance-optimization-options">Server performance
optimization options</h2>
<p>These variables are set in the same level of the
<code>logging_inputs</code>, <code>logging_output</code>, and
<code>logging_flows</code>.</p>
<ul>
<li><code>logging_tcp_threads</code>: Input thread count listening on
the plain tcp (ptcp) port. Default to <code>1</code>.</li>
<li><code>logging_udp_threads</code>: Input thread count listening on
the udp port. Default to <code>1</code>.</li>
<li><code>logging_udp_system_time_requery</code>: Every
<code>value</code> OS system calls, get the system time. Recommend not
to set above 10. Default to <code>2</code> times.</li>
<li><code>logging_udp_batch_size</code>: Maximum number of udp messages
per OS system call. Recommend not to set above 128. Default to
<code>32</code>.</li>
<li><code>logging_server_queue_type</code>: Type of queue.
<code>FixedArray</code> is available. Default to
<code>LinkedList</code>.</li>
<li><code>logging_server_queue_size</code>: Maximum number of messages
in the queue. Default to <code>50000</code>.</li>
<li><code>logging_server_threads</code>: Number of worker threads.
Default to <code>logging_tcp_threads</code> +
<code>logging_udp_threads</code>.</li>
</ul>
<h2 id="other-options">Other options</h2>
<p>These variables are set in the same level of the
<code>logging_inputs</code>, <code>logging_output</code>, and
<code>logging_flows</code>.</p>
<ul>
<li><p><code>logging_enabled</code>: When 'true', logging role will
deploy specified configuration file set. Default to 'true'.</p></li>
<li><p><code>logging_mark</code>: Mark message periodically by immark,
if set to <code>true</code>. Default to <code>false</code>.</p></li>
<li><p><code>logging_mark_interval</code>: Interval for
<code>logging_mark</code> in seconds. Default to
<code>3600</code>.</p></li>