doc/entropy: Describe unique names conf var

Discuss the new configuration variable that provides unique
names for entropy values in logging output: logging.entropy.make-unique

Issue: 7814
pull/14309/head
Jeff Lucovsky 1 year ago
parent 65f6d24e34
commit a0af50f188

@ -3063,6 +3063,25 @@ headers are encapsulated in the same number of headers.
Advanced Options
----------------
entropy
~~~~~~~
When a rule causes an entropy value to be calculated for a flow, output for the flow will include
the calculated entropy value. The log output contains the sticky buffer name for which the
entropy was calculated. Often, more context is needed and the configuration setting shown
below will amend the sticky buffer name with the signature id and instance number from the rule
that caused the entropy value calculation. The instance number changes for each ``entropy``
keyword usage within a rule. The default value is ``off``. We strongly recommend changing
the value to ``on``.
::
logging:
# Ensure that logged entropy values have unique names by appending the signature_id
# of the rule and other values where used
#entropy:
#make-unique: off
stacktrace
~~~~~~~~~~
Display diagnostic stacktraces when a signal unexpectedly terminates Suricata, e.g., such as

@ -744,9 +744,28 @@ the ``metadata`` section of an output log. The follow is an example that shows
the calculated entropy value with the buffer on which the value was computed::
"metadata": {
"entropy": {
"file_data": 4.265743301617466
"entropy":[
{
"buffer":"file_data",
"value":4.150007324019584
}
]
}
When ``logging.entropy.make-unique`` is enabled, the format is modified to
include the signature id, instance number (tracks which entropy keyword
was used in a rule in case there are multiple usages), buffer and
value::
"metadata": {
entropy": [
{
"sid": 1,
"buffer": "file_data",
"instance": 1,
"value": 4.137370175000773
}
]
}
The events where entropy is logged will depend largely on how it's used within a

Loading…
Cancel
Save