Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MoessnerFabian(Group) committed Oct 28, 2024
1 parent 6675c41 commit 308482d
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion logprep/filter/lucene_filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,18 @@
------------
It is possible use regex expressions to match values.
For this, the field with the regex pattern must be added to the optional field
To be recognized as a regular expression the filter field has to be start and end with
:code:`/`.
.. code-block:: yaml
:linenos:
:caption: Example
filter: 'ip_address: "/192\.168\.0\..*/"'
[Deprecated, but still functional] The field with the regex pattern must be added to the optional field
:code:`regex_fields` in the rule definition.
In the following example the field :code:`ip_address` is defined as regex field.
Expand Down

0 comments on commit 308482d

Please sign in to comment.