zeek/doc/scripts/base/frameworks/sumstats/index.rst
Jon Siwek 7e9d48f532 Remove broxygen Sphinx integration
The broxygen-generated files now live in the git repo, have tests
that check that they are up-to-date, and a script to re-generate
them on-demand.
2018-12-18 10:15:22 -06:00

67 lines
1.6 KiB
ReStructuredText

:orphan:
Package: base/frameworks/sumstats
=================================
The summary statistics framework provides a way to summarize large streams
of data into simple reduced measurements.
:doc:`/scripts/base/frameworks/sumstats/__load__.bro`
:doc:`/scripts/base/frameworks/sumstats/main.bro`
The summary statistics framework provides a way to
summarize large streams of data into simple reduced
measurements.
:doc:`/scripts/base/frameworks/sumstats/plugins/__load__.bro`
:doc:`/scripts/base/frameworks/sumstats/plugins/average.bro`
Calculate the average.
:doc:`/scripts/base/frameworks/sumstats/plugins/hll_unique.bro`
Calculate the number of unique values (using the HyperLogLog algorithm).
:doc:`/scripts/base/frameworks/sumstats/plugins/last.bro`
Keep the last X observations.
:doc:`/scripts/base/frameworks/sumstats/plugins/max.bro`
Find the maximum value.
:doc:`/scripts/base/frameworks/sumstats/plugins/min.bro`
Find the minimum value.
:doc:`/scripts/base/frameworks/sumstats/plugins/sample.bro`
Keep a random sample of values.
:doc:`/scripts/base/frameworks/sumstats/plugins/std-dev.bro`
Calculate the standard deviation.
:doc:`/scripts/base/frameworks/sumstats/plugins/variance.bro`
Calculate the variance.
:doc:`/scripts/base/frameworks/sumstats/plugins/sum.bro`
Calculate the sum.
:doc:`/scripts/base/frameworks/sumstats/plugins/topk.bro`
Keep the top-k (i.e., most frequently occurring) observations.
:doc:`/scripts/base/frameworks/sumstats/plugins/unique.bro`
Calculate the number of unique values.
:doc:`/scripts/base/frameworks/sumstats/non-cluster.bro`