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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
|
********************************************
omelasticsearch: Elasticsearch Output Module
********************************************
=========================== ===========================================================================
**Module Name:** **omelasticsearch**
**Author:** `Rainer Gerhards <https://rainer.gerhards.net/>`_ <rgerhards@adiscon.com>
=========================== ===========================================================================
Purpose
=======
This module provides native support for logging to
`Elasticsearch <http://www.elasticsearch.org/>`_.
Notable Features
================
- :ref:`omelasticsearch-statistic-counter`
Configuration Parameters
========================
.. note::
Parameter names are case-insensitive.
Action Parameters
-----------------
Server
^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"array", "none", "no", "none"
An array of Elasticsearch servers in the specified format. If no scheme
is specified, it will be chosen according to usehttps_. If no port is
specified, serverport_ will be used. Defaults to "localhost".
Requests to Elasticsearch will be load-balanced between all servers in
round-robin fashion.
.. code-block:: none
Examples:
server="localhost:9200"
server=["elasticsearch1", "elasticsearch2"]
.. _serverport:
Serverport
^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"integer", "9200", "no", "none"
Default HTTP port to use to connect to Elasticsearch if none is specified
on a server_. Defaults to 9200
.. _healthchecktimeout:
HealthCheckTimeout
^^^^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"integer", "3500", "no", "none"
Specifies the number of milliseconds to wait for a successful health check
on a server_. Before trying to submit events to Elasticsearch, rsyslog will
execute an *HTTP HEAD* to ``/_cat/health`` and expect an *HTTP OK* within
this timeframe. Defaults to 3500.
*Note, the health check is verifying connectivity only, not the state of
the Elasticsearch cluster.*
.. _esVersion_major:
esVersion.major
^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"integer", "0", "no", "none"
ElasticSearch is notoriously bad at maintaining backwards compatibility. For this
reason, the setting can be used to configure the server's major version number (e.g. 7, 8, ...).
As far as we know breaking changes only happen with major version changes.
As of now, only value 8 triggers API changes. All other values select
pre-version-8 API usage.
.. _searchIndex:
searchIndex
^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
`Elasticsearch
index <http://www.elasticsearch.org/guide/appendix/glossary.html#index>`_
to send your logs to. Defaults to "system"
.. _dynSearchIndex:
dynSearchIndex
^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
Whether the string provided for searchIndex_ should be taken as a
`rsyslog template <http://www.rsyslog.com/doc/rsyslog_conf_templates.html>`_.
Defaults to "off", which means the index name will be taken
literally. Otherwise, it will look for a template with that name, and
the resulting string will be the index name. For example, let's
assume you define a template named "date-days" containing
"%timereported:1:10:date-rfc3339%". Then, with dynSearchIndex="on",
if you say searchIndex="date-days", each log will be sent to and
index named after the first 10 characters of the timestamp, like
"2013-03-22".
.. _searchType:
searchType
^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
`Elasticsearch
type <http://www.elasticsearch.org/guide/appendix/glossary.html#type>`_
to send your index to. Defaults to "events".
Setting this parameter to an empty string will cause the type to be omitted,
which is required since Elasticsearch 7.0. See
`Elasticsearch documentation <https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html>`_
for more information.
.. _dynSearchType:
dynSearchType
^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
Like dynSearchIndex_, it allows you to specify a
`rsyslog template <http://www.rsyslog.com/doc/rsyslog_conf_templates.html>`_
for searchType_, instead of a static string.
.. _pipelineName:
pipelineName
^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
The `ingest node <https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html>`_
pipeline name to be included in the request. This allows pre processing
of events before indexing them. By default, events are not send to a pipeline.
.. _dynPipelineName:
dynPipelineName
^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
Like dynSearchIndex_, it allows you to specify a
`rsyslog template <http://www.rsyslog.com/doc/rsyslog_conf_templates.html>`_
for pipelineName_, instead of a static string.
.. _skipPipelineIfEmpty:
skipPipelineIfEmpty
^^^^^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
When POST'ing a document, Elasticsearch does not allow an empty pipeline
parameter value. If boolean option skipPipelineIfEmpty is set to `"on"`, the
pipeline parameter won't be posted. Default is `"off"`.
.. _asyncrepl:
asyncrepl
^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
No longer supported as ElasticSearch no longer supports it.
.. _usehttps:
usehttps
^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
Default scheme to use when sending events to Elasticsearch if none is
specified on a server_. Good for when you have
Elasticsearch behind Apache or something else that can add HTTPS.
Note that if you have a self-signed certificate, you'd need to install
it first. This is done by copying the certificate to a trusted path
and then running *update-ca-certificates*. That trusted path is
typically */usr/local/share/ca-certificates* but check the man page of
*update-ca-certificates* for the default path of your distro
.. _timeout:
timeout
^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "1m", "no", "none"
How long Elasticsearch will wait for a primary shard to be available
for indexing your log before sending back an error. Defaults to "1m".
.. _indextimeout:
indexTimeout
^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"integer", "0", "no", "none"
.. versionadded:: 8.2204.0
Specifies the number of milliseconds to wait for a successful log indexing
request on a server_. By default there is no timeout.
.. _template:
template
^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "see below", "no", "none"
This is the JSON document that will be indexed in Elasticsearch. The
resulting string needs to be a valid JSON, otherwise Elasticsearch
will return an error. Defaults to:
.. code-block:: none
$template StdJSONFmt, "{\"message\":\"%msg:::json%\",\"fromhost\":\"%HOSTNAME:::json%\",\"facility\":\"%syslogfacility-text%\",\"priority\":\"%syslogpriority-text%\",\"timereported\":\"%timereported:::date-rfc3339%\",\"timegenerated\":\"%timegenerated:::date-rfc3339%\"}"
Which will produce this sort of documents (pretty-printed here for
readability):
.. code-block:: none
{
"message": " this is a test message",
"fromhost": "test-host",
"facility": "user",
"priority": "info",
"timereported": "2013-03-12T18:05:01.344864+02:00",
"timegenerated": "2013-03-12T18:05:01.344864+02:00"
}
Another template, FullJSONFmt, is available that includes more fields including programname, PROCID (usually the process ID), and MSGID.
.. _bulkmode:
bulkmode
^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
The default "off" setting means logs are shipped one by one. Each in
its own HTTP request, using the `Index
API <http://www.elasticsearch.org/guide/reference/api/index_.html>`_.
Set it to "on" and it will use Elasticsearch's `Bulk
API <http://www.elasticsearch.org/guide/reference/api/bulk.html>`_ to
send multiple logs in the same request. The maximum number of logs
sent in a single bulk request depends on your maxbytes_
and queue settings -
usually limited by the `dequeue batch
size <http://www.rsyslog.com/doc/node35.html>`_. More information
about queues can be found
`here <http://www.rsyslog.com/doc/node32.html>`_.
.. _maxbytes:
maxbytes
^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "100m", "no", "none"
.. versionadded:: 8.23.0
When shipping logs with bulkmode_ **on**, maxbytes specifies the maximum
size of the request body sent to Elasticsearch. Logs are batched until
either the buffer reaches maxbytes or the `dequeue batch
size <http://www.rsyslog.com/doc/node35.html>`_ is reached. In order to
ensure Elasticsearch does not reject requests due to content length, verify
this value is set according to the `http.max_content_length
<https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-http.html>`_
setting in Elasticsearch. Defaults to 100m.
.. _parent:
parent
^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
Specifying a string here will index your logs with that string the
parent ID of those logs. Please note that you need to define the
`parent
field <http://www.elasticsearch.org/guide/reference/mapping/parent-field.html>`_
in your
`mapping <http://www.elasticsearch.org/guide/reference/mapping/>`_
for that to work. By default, logs are indexed without a parent.
.. _dynParent:
dynParent
^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
Using the same parent for all the logs sent in the same action is
quite unlikely. So you'd probably want to turn this "on" and specify
a
`rsyslog template <http://www.rsyslog.com/doc/rsyslog_conf_templates.html>`_
that will provide meaningful parent IDs for your logs.
.. _uid:
uid
^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
If you have basic HTTP authentication deployed (eg through the
`elasticsearch-basic
plugin <https://github.com/Asquera/elasticsearch-http-basic>`_), you
can specify your user-name here.
.. _pwd:
pwd
^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
Password for basic authentication.
.. _errorfile:
errorFile
^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
If specified, records failed in bulk mode are written to this file, including
their error cause. Rsyslog itself does not process the file any more, but the
idea behind that mechanism is that the user can create a script to periodically
inspect the error file and react appropriately. As the complete request is
included, it is possible to simply resubmit messages from that script.
*Please note:* when rsyslog has problems connecting to elasticsearch, a general
error is assumed and the submit is retried. However, if we receive negative
responses during batch processing, we assume an error in the data itself
(like a mandatory field is not filled in, a format error or something along
those lines). Such errors cannot be solved by simply resubmitting the record.
As such, they are written to the error file so that the user (script) can
examine them and act appropriately. Note that e.g. after search index
reconfiguration (e.g. dropping the mandatory attribute) a resubmit may
be successful.
.. _omelasticsearch-tls.cacert:
tls.cacert
^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
This is the full path and file name of the file containing the CA cert for the
CA that issued the Elasticsearch server cert. This file is in PEM format. For
example: `/etc/rsyslog.d/es-ca.crt`
.. _tls.mycert:
tls.mycert
^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
This is the full path and file name of the file containing the client cert for
doing client cert auth against Elasticsearch. This file is in PEM format. For
example: `/etc/rsyslog.d/es-client-cert.pem`
.. _tls.myprivkey:
tls.myprivkey
^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
This is the full path and file name of the file containing the private key
corresponding to the cert `tls.mycert` used for doing client cert auth against
Elasticsearch. This file is in PEM format, and must be unencrypted, so take
care to secure it properly. For example: `/etc/rsyslog.d/es-client-key.pem`
.. _omelasticsearch-allowunsignedcerts:
allowunsignedcerts
^^^^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"boolean", "off", "no", "none"
If `"on"`, this will set the curl `CURLOPT_SSL_VERIFYPEER` option to
`0`. You are strongly discouraged to set this to `"on"`. It is
primarily useful only for debugging or testing.
.. _omelasticsearch-skipverifyhost:
skipverifyhost
^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"boolean", "off", "no", "none"
If `"on"`, this will set the curl `CURLOPT_SSL_VERIFYHOST` option to
`0`. You are strongly discouraged to set this to `"on"`. It is
primarily useful only for debugging or testing.
.. _omelasticsearch-bulkid:
bulkid
^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "none", "no", "none"
This is the unique id to assign to the record. The `bulk` part is misleading - this
can be used in both bulk mode :ref:`bulkmode` or in index
(record at a time) mode. Although you can specify a static value for this
parameter, you will almost always want to specify a *template* for the value of
this parameter, and set `dynbulkid="on"` :ref:`omelasticsearch-dynbulkid`. NOTE:
you must use `bulkid` and `dynbulkid` in order to use `writeoperation="create"`
:ref:`omelasticsearch-writeoperation`.
.. _omelasticsearch-dynbulkid:
dynbulkid
^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
If this parameter is set to `"on"`, then the `bulkid` parameter :ref:`omelasticsearch-bulkid`
specifies a *template* to use to generate the unique id value to assign to the record. If
using `bulkid` you will almost always want to set this parameter to `"on"` to assign
a different unique id value to each record. NOTE:
you must use `bulkid` and `dynbulkid` in order to use `writeoperation="create"`
:ref:`omelasticsearch-writeoperation`.
.. _omelasticsearch-writeoperation:
writeoperation
^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "index", "no", "none"
The value of this parameter is either `"index"` (the default) or `"create"`. If `"create"` is
used, this means the bulk action/operation will be `create` - create a document only if the
document does not already exist. The record must have a unique id in order to use `create`.
See :ref:`omelasticsearch-bulkid` and :ref:`omelasticsearch-dynbulkid`. See
:ref:`omelasticsearch-writeoperation-example` for an example.
.. _omelasticsearch-retryfailures:
retryfailures
^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"binary", "off", "no", "none"
If this parameter is set to `"on"`, then the module will look for an
`"errors":true` in the bulk index response. If found, each element in the
response will be parsed to look for errors, since a bulk request may have some
records which are successful and some which are failures. Failed requests will
be converted back into records and resubmitted back to rsyslog for
reprocessing. Each failed request will be resubmitted with a local variable
called `$.omes`. This is a hash consisting of the fields from the metadata
header in the original request, and the fields from the response. If the same
field is in the request and response, the value from the field in the *request*
will be used, to facilitate retries that want to send the exact same request,
and want to know exactly what was sent.
See below :ref:`omelasticsearch-retry-example` for an example of how retry
processing works.
*NOTE* The retried record will be resubmitted at the "top" of your processing
pipeline. If your processing pipeline is not idempotent (that is, your
processing pipeline expects "raw" records), then you can specify a ruleset to
redirect retries to. See :ref:`omelasticsearch-retryruleset` below.
`$.omes` fields:
* writeoperation - the operation used to submit the request - for rsyslog
omelasticsearch this currently means either `"index"` or `"create"`
* status - the HTTP status code - typically an error will have a `4xx` or `5xx`
code - of particular note is `429` - this means Elasticsearch was unable to
process this bulk record request due to a temporary condition e.g. the bulk
index thread pool queue is full, and rsyslog should retry the operation.
* _index, _type, _id, pipeline, _parent - the metadata associated with the
request - not all of these fields will be present with every request - for
example, if you do not use `"pipelinename"` or `"dynpipelinename"`, there
will be no `$.omes!pipeline` field.
* error - a hash containing one or more, possibly nested, fields containing
more detailed information about a failure. Typically there will be fields
`$.omes!error!type` (a keyword) and `$.omes!error!reason` (a longer string)
with more detailed information about the rejection. NOTE: The format is
apparently not described in great detail, so code must not make any
assumption about the availability of `error` or any specific sub-field.
There may be other fields too - the code just copies everything in the
response. Here is an example of a detailed error response, in JSON format, from
Elasticsearch 5.6.9:
.. code-block:: json
{"omes":
{"writeoperation": "create",
"_index": "rsyslog_testbench",
"_type": "test-type",
"_id": "92BE7AF79CD44305914C7658AF846A08",
"status": 400,
"error":
{"type": "mapper_parsing_exception",
"reason": "failed to parse [msgnum]",
"caused_by":
{"type": "number_format_exception",
"reason": "For input string: \"x00000025\""}}}}
Reference: https://www.elastic.co/guide/en/elasticsearch/guide/current/bulk.html#bulk
.. _omelasticsearch-retryruleset:
retryruleset
^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"word", "", "no", "none"
If `retryfailures` is not `"on"` (:ref:`omelasticsearch-retryfailures`) then
this parameter has no effect. This parameter specifies the name of a ruleset
to use to route retries. This is useful if you do not want retried messages to
be processed starting from the top of your processing pipeline, or if you have
multiple outputs but do not want to send retried Elasticsearch failures to all
of your outputs, and you do not want to clutter your processing pipeline with a
lot of conditionals. See below :ref:`omelasticsearch-retry-example` for an
example of how retry processing works.
.. _omelasticsearch-ratelimit.interval:
ratelimit.interval
^^^^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"integer", "600", "no", "none"
If `retryfailures` is not `"on"` (:ref:`omelasticsearch-retryfailures`) then
this parameter has no effect. Specifies the interval in seconds onto which
rate-limiting is to be applied. If more than ratelimit.burst messages are read
during that interval, further messages up to the end of the interval are
discarded. The number of messages discarded is emitted at the end of the
interval (if there were any discards).
Setting this to value zero turns off ratelimiting.
.. _omelasticsearch-ratelimit.burst:
ratelimit.burst
^^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"integer", "20000", "no", "none"
If `retryfailures` is not `"on"` (:ref:`omelasticsearch-retryfailures`) then
this parameter has no effect. Specifies the maximum number of messages that
can be emitted within the ratelimit.interval interval. For further information,
see description there.
.. _omelasticsearch-rebindinterval:
rebindinterval
^^^^^^^^^^^^^^
.. csv-table::
:header: "type", "default", "mandatory", "|FmtObsoleteName| directive"
:widths: auto
:class: parameter-table
"integer", "-1", "no", "none"
This parameter tells omelasticsearch to close the connection and reconnect
to Elasticsearch after this many operations have been submitted. The default
value `-1` means that omelasticsearch will not reconnect. A value greater
than `-1` tells omelasticsearch, after this many operations have been
submitted to Elasticsearch, to drop the connection and establish a new
connection. This is useful when rsyslog connects to multiple Elasticsearch
nodes through a router or load balancer, and you need to periodically drop
and reestablish connections to help the router balance the connections. Use
the counter `rebinds` to monitor the number of times this has happened.
.. _omelasticsearch-statistic-counter:
Statistic Counter
=================
This plugin maintains global :doc:`statistics <../rsyslog_statistic_counter>`,
which accumulate all action instances. The statistic is named "omelasticsearch".
Parameters are:
- **submitted** - number of messages submitted for processing (with both
success and error result)
- **fail.httprequests** - the number of times a http request failed. Note
that a single http request may be used to submit multiple messages, so this
number may be (much) lower than fail.http.
- **fail.http** - number of message failures due to connection like-problems
(things like remote server down, broken link etc)
- **fail.es** - number of failures due to elasticsearch error reply; Note that
this counter does NOT count the number of failed messages but the number of
times a failure occurred (a potentially much smaller number). Counting messages
would be quite performance-intense and is thus not done.
The following counters are available when `retryfailures="on"` is used:
- **response.success** - number of records successfully sent in bulk index
requests - counts the number of successful responses
- **response.bad** - number of times omelasticsearch received a response in a
bulk index response that was unrecognized or unable to be parsed. This may
indicate that omelasticsearch is attempting to communicate with a version of
Elasticsearch that is incompatible, or is otherwise sending back data in the
response that cannot be handled
- **response.duplicate** - number of records in the bulk index request that
were duplicates of already existing records - this will only be reported if
using `writeoperation="create"` and `bulkid` to assign each record a unique
ID
- **response.badargument** - number of times omelasticsearch received a
response that had a status indicating omelasticsearch sent bad data to
Elasticsearch. For example, status `400` and an error message indicating
omelasticsearch attempted to store a non-numeric string value in a numeric
field.
- **response.bulkrejection** - number of times omelasticsearch received a
response that had a status indicating Elasticsearch was unable to process
the record at this time - status `429`. The record can be retried.
- **response.other** - number of times omelasticsearch received a
response not recognized as one of the above responses, typically some other
`4xx` or `5xx` http status.
- **rebinds** - if using `rebindinterval` this will be the number of
times omelasticsearch has reconnected to Elasticsearch
**The fail.httprequests and fail.http counters reflect only failures that
omelasticsearch detected.** Once it detects problems, it (usually, depends on
circumstances) tell the rsyslog core that it wants to be suspended until the
situation clears (this is a requirement for rsyslog output modules). Once it is
suspended, it does NOT receive any further messages. Depending on the user
configuration, messages will be lost during this period. Those lost messages will
NOT be counted by impstats (as it does not see them).
Note that some previous (pre 7.4.5) versions of this plugin had different counters.
These were experimental and confusing. The only ones really used were "submits",
which were the number of successfully processed messages and "connfail" which were
equivalent to "failed.http".
How Retries Are Handled
=======================
When using `retryfailures="on"` (:ref:`omelasticsearch-retryfailures`), the
original `Message` object (that is, the original `smsg_t *msg` object) **is not
available**. This means none of the metadata associated with that object, such
as various timestamps, hosts/ip addresses, etc. are not available for the retry
operation. The only thing available are the metadata header (_index, _type,
_id, pipeline, _parent) and original JSON string sent in the original request,
and whatever data is returned in the error response. All of these are made
available in the `$.omes` fields. If the same field name exists in the request
metadata and the response, the field from the request will be used, in order to
facilitate retrying the exact same request. For the message to retry, the code
will take the original JSON string and parse it back into an internal `Message`
object. This means you **may need to use a different template** to output
messages for your retry ruleset. For example, if you used the following
template to format the Elasticsearch message for the initial submission:
.. code-block:: none
template(name="es_output_template"
type="list"
option.json="on") {
constant(value="{")
constant(value="\"timestamp\":\"") property(name="timereported" dateFormat="rfc3339")
constant(value="\",\"message\":\"") property(name="msg")
constant(value="\",\"host\":\"") property(name="hostname")
constant(value="\",\"severity\":\"") property(name="syslogseverity-text")
constant(value="\",\"facility\":\"") property(name="syslogfacility-text")
constant(value="\",\"syslogtag\":\"") property(name="syslogtag")
constant(value="\"}")
}
You would have to use a different template for the retry, since none of the
`timereported`, `msg`, etc. fields will have the same values for the retry as
for the initial try.
Same with the other omelasticsearch parameters which can be constructed with
templates, such as `"dynpipelinename"`, `"dynsearchindex"`, `"dynsearchtype"`,
`"dynparent"`, and `"dynbulkid"`. For example, if you generate the `_id` to
use in the request, you will want to reuse the same `_id` for each subsequent
retry:
.. code-block:: none
template(name="id-template" type="string" string="%$.es_msg_id%")
if strlen($.omes!_id) > 0 then {
set $.es_msg_id = $.omes!_id;
} else {
# NOTE: depends on rsyslog being compiled with --enable-uuid
set $.es_msg_id = $uuid;
}
action(type="omelasticsearch" bulkid="id-template" ...)
That is, if this is a retry, `$.omes!_id` will be set, so use that value for
the bulk id for this record, otherwise, generate a new one with `$uuid`. Note
that the template uses the temporary variable `$.es_msg_id` which must be set
each time, to either `$.omes!_id` or `$uuid`.
The `rawmsg` field is a special case. If the original request had a field
called `message`, then when constructing the new message from the original to
retry, the `rawmsg` message property will be set to the value of the `message`
field. Otherwise, the `rawmsg` property value will be set to the entire
original request - the data part, not the metadata. In previous versions,
without the `message` field, the `rawmsg` property was set to the value of the
data plus the Elasticsearch metadata, which caused problems with retries. See
`rsyslog issue 3573 <https://github.com/rsyslog/rsyslog/issues/3573>`_
Examples
========
Example 1
---------
The following sample does the following:
- loads the omelasticsearch module
- outputs all logs to Elasticsearch using the default settings
.. code-block:: none
module(load="omelasticsearch")
*.* action(type="omelasticsearch")
Example 2
---------
The following sample does the following:
- loads the omelasticsearch module
- outputs all logs to Elasticsearch using the full JSON logging template including program name
.. code-block:: none
module(load="omelasticsearch")
*.* action(type="omelasticsearch" template="FullJSONFmt")
Example 3
---------
The following sample does the following:
- loads the omelasticsearch module
- defines a template that will make the JSON contain the following
properties
- RFC-3339 timestamp when the event was generated
- the message part of the event
- hostname of the system that generated the message
- severity of the event, as a string
- facility, as a string
- the tag of the event
- outputs to Elasticsearch with the following settings
- host name of the server is myserver.local
- port is 9200
- JSON docs will look as defined in the template above
- index will be "test-index"
- type will be "test-type"
- activate bulk mode. For that to work effectively, we use an
in-memory queue that can hold up to 5000 events. The maximum bulk
size will be 300
- retry indefinitely if the HTTP request failed (eg: if the target
server is down)
.. code-block:: none
module(load="omelasticsearch")
template(name="testTemplate"
type="list"
option.json="on") {
constant(value="{")
constant(value="\"timestamp\":\"") property(name="timereported" dateFormat="rfc3339")
constant(value="\",\"message\":\"") property(name="msg")
constant(value="\",\"host\":\"") property(name="hostname")
constant(value="\",\"severity\":\"") property(name="syslogseverity-text")
constant(value="\",\"facility\":\"") property(name="syslogfacility-text")
constant(value="\",\"syslogtag\":\"") property(name="syslogtag")
constant(value="\"}")
}
action(type="omelasticsearch"
server="myserver.local"
serverport="9200"
template="testTemplate"
searchIndex="test-index"
searchType="test-type"
bulkmode="on"
maxbytes="100m"
queue.type="linkedlist"
queue.size="5000"
queue.dequeuebatchsize="300"
action.resumeretrycount="-1")
.. _omelasticsearch-writeoperation-example:
Example 4
---------
The following sample shows how to use :ref:`omelasticsearch-writeoperation`
with :ref:`omelasticsearch-dynbulkid` and :ref:`omelasticsearch-bulkid`. For
simplicity, it assumes rsyslog has been built with `--enable-libuuid` which
provides the `uuid` property for each record:
.. code-block:: none
module(load="omelasticsearch")
set $!es_record_id = $uuid;
template(name="bulkid-template" type="list") { property(name="$!es_record_id") }
action(type="omelasticsearch"
...
bulkmode="on"
bulkid="bulkid-template"
dynbulkid="on"
writeoperation="create")
.. _omelasticsearch-retry-example:
Example 5
---------
The following sample shows how to use :ref:`omelasticsearch-retryfailures` to
process, discard, or retry failed operations. This uses
`writeoperation="create"` with a unique `bulkid` so that we can check for and
discard duplicate messages as successful. The `try_es` ruleset is used both
for the initial attempt and any subsequent retries. The code in the ruleset
assumes that if `$.omes!status` is set and is non-zero, this is a retry for a
previously failed operation. If the status was successful, or Elasticsearch
said this was a duplicate, the record is already in Elasticsearch, so we can
drop the record. If there was some error processing the response
e.g. Elasticsearch sent a response formatted in some way that we did not know
how to process, then submit the record to the `error_es` ruleset. If the
response was a "hard" error like `400`, then submit the record to the
`error_es` ruleset. In any other case, such as a status `429` or `5xx`, the
record will be resubmitted to Elasticsearch. In the example, the `error_es`
ruleset just dumps the records to a file.
.. code-block:: none
module(load="omelasticsearch")
module(load="omfile")
template(name="bulkid-template" type="list") { property(name="$.es_record_id") }
ruleset(name="error_es") {
action(type="omfile" template="RSYSLOG_DebugFormat" file="es-bulk-errors.log")
}
ruleset(name="try_es") {
if strlen($.omes!status) > 0 then {
# retry case
if ($.omes!status == 200) or ($.omes!status == 201) or (($.omes!status == 409) and ($.omes!writeoperation == "create")) then {
stop # successful
}
if ($.omes!writeoperation == "unknown") or (strlen($.omes!error!type) == 0) or (strlen($.omes!error!reason) == 0) then {
call error_es
stop
}
if ($.omes!status == 400) or ($.omes!status < 200) then {
call error_es
stop
}
# else fall through to retry operation
}
if strlen($.omes!_id) > 0 then {
set $.es_record_id = $.omes!_id;
} else {
# NOTE: depends on rsyslog being compiled with --enable-uuid
set $.es_record_id = $uuid;
}
action(type="omelasticsearch"
...
bulkmode="on"
bulkid="bulkid-template"
dynbulkid="on"
writeoperation="create"
retryfailures="on"
retryruleset="try_es")
}
call try_es
|