mirror of
https://github.com/zeek/zeek.git
synced 2025-10-16 13:38:19 +00:00
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.
This commit is contained in:
Jon Siwek
parent
9e5e9d04b7
commit
7e9d48f532
549 changed files with 89909 additions and 100 deletions
104
doc/scripts/base/frameworks/input/readers/ascii.bro.rst
Normal file
104
doc/scripts/base/frameworks/input/readers/ascii.bro.rst
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/input/readers/ascii.bro
|
||||
=======================================
|
||||
.. bro:namespace:: InputAscii
|
||||
|
||||
Interface for the ascii input reader.
|
||||
|
||||
The defaults are set to match Bro's ASCII output.
|
||||
|
||||
:Namespace: InputAscii
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
================================================================================ ===========================================
|
||||
:bro:id:`InputAscii::empty_field`: :bro:type:`string` :bro:attr:`&redef` String to use for empty fields.
|
||||
:bro:id:`InputAscii::fail_on_file_problem`: :bro:type:`bool` :bro:attr:`&redef` Fail on file read problems.
|
||||
:bro:id:`InputAscii::fail_on_invalid_lines`: :bro:type:`bool` :bro:attr:`&redef` Fail on invalid lines.
|
||||
:bro:id:`InputAscii::separator`: :bro:type:`string` :bro:attr:`&redef` Separator between fields.
|
||||
:bro:id:`InputAscii::set_separator`: :bro:type:`string` :bro:attr:`&redef` Separator between set and vector elements.
|
||||
:bro:id:`InputAscii::unset_field`: :bro:type:`string` :bro:attr:`&redef` String to use for an unset &optional field.
|
||||
================================================================================ ===========================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. bro:id:: InputAscii::empty_field
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``"(empty)"``
|
||||
|
||||
String to use for empty fields.
|
||||
|
||||
.. bro:id:: InputAscii::fail_on_file_problem
|
||||
|
||||
:Type: :bro:type:`bool`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``F``
|
||||
|
||||
Fail on file read problems. If set to true, the ascii
|
||||
input reader will fail when encountering any problems
|
||||
while reading a file different from invalid lines.
|
||||
Examples of such problems are permission problems, or
|
||||
missing files.
|
||||
When set to false, these problems will be ignored. This
|
||||
has an especially big effect for the REREAD mode, which will
|
||||
seamlessly recover from read errors when a file is
|
||||
only temporarily inaccessible. For MANUAL or STREAM files,
|
||||
errors will most likely still be fatal since no automatic
|
||||
re-reading of the file is attempted.
|
||||
Individual readers can use a different value using
|
||||
the $config table.
|
||||
fail_on_file_problem = T was the default behavior
|
||||
until Bro 2.6.
|
||||
|
||||
.. bro:id:: InputAscii::fail_on_invalid_lines
|
||||
|
||||
:Type: :bro:type:`bool`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``F``
|
||||
|
||||
Fail on invalid lines. If set to false, the ascii
|
||||
input reader will jump over invalid lines, reporting
|
||||
warnings in reporter.log. If set to true, errors in
|
||||
input lines will be handled as fatal errors for the
|
||||
reader thread; reading will abort immediately and
|
||||
an error will be logged to reporter.log.
|
||||
Individual readers can use a different value using
|
||||
the $config table.
|
||||
fail_on_invalid_lines = T was the default behavior
|
||||
until Bro 2.6.
|
||||
|
||||
.. bro:id:: InputAscii::separator
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``"\x09"``
|
||||
|
||||
Separator between fields.
|
||||
Please note that the separator has to be exactly one character long.
|
||||
|
||||
.. bro:id:: InputAscii::set_separator
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``","``
|
||||
|
||||
Separator between set and vector elements.
|
||||
Please note that the separator has to be exactly one character long.
|
||||
|
||||
.. bro:id:: InputAscii::unset_field
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``"-"``
|
||||
|
||||
String to use for an unset &optional field.
|
||||
|
||||
|
||||
77
doc/scripts/base/frameworks/input/readers/benchmark.bro.rst
Normal file
77
doc/scripts/base/frameworks/input/readers/benchmark.bro.rst
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/input/readers/benchmark.bro
|
||||
===========================================
|
||||
.. bro:namespace:: InputBenchmark
|
||||
|
||||
Interface for the benchmark input reader.
|
||||
|
||||
:Namespace: InputBenchmark
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
============================================================================ =========================================================
|
||||
:bro:id:`InputBenchmark::addfactor`: :bro:type:`count` :bro:attr:`&redef` Addition factor for each heartbeat.
|
||||
:bro:id:`InputBenchmark::autospread`: :bro:type:`double` :bro:attr:`&redef` Spreading where usleep = 1000000 / autospread * num_lines
|
||||
:bro:id:`InputBenchmark::factor`: :bro:type:`double` :bro:attr:`&redef` Multiplication factor for each second.
|
||||
:bro:id:`InputBenchmark::spread`: :bro:type:`count` :bro:attr:`&redef` Spread factor between lines.
|
||||
:bro:id:`InputBenchmark::stopspreadat`: :bro:type:`count` :bro:attr:`&redef` Stop spreading at x lines per heartbeat.
|
||||
:bro:id:`InputBenchmark::timedspread`: :bro:type:`double` :bro:attr:`&redef` 1 -> enable timed spreading.
|
||||
============================================================================ =========================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. bro:id:: InputBenchmark::addfactor
|
||||
|
||||
:Type: :bro:type:`count`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``0``
|
||||
|
||||
Addition factor for each heartbeat.
|
||||
|
||||
.. bro:id:: InputBenchmark::autospread
|
||||
|
||||
:Type: :bro:type:`double`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``0.0``
|
||||
|
||||
Spreading where usleep = 1000000 / autospread * num_lines
|
||||
|
||||
.. bro:id:: InputBenchmark::factor
|
||||
|
||||
:Type: :bro:type:`double`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``1.0``
|
||||
|
||||
Multiplication factor for each second.
|
||||
|
||||
.. bro:id:: InputBenchmark::spread
|
||||
|
||||
:Type: :bro:type:`count`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``0``
|
||||
|
||||
Spread factor between lines.
|
||||
|
||||
.. bro:id:: InputBenchmark::stopspreadat
|
||||
|
||||
:Type: :bro:type:`count`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``0``
|
||||
|
||||
Stop spreading at x lines per heartbeat.
|
||||
|
||||
.. bro:id:: InputBenchmark::timedspread
|
||||
|
||||
:Type: :bro:type:`double`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``0.0``
|
||||
|
||||
1 -> enable timed spreading.
|
||||
|
||||
|
||||
32
doc/scripts/base/frameworks/input/readers/binary.bro.rst
Normal file
32
doc/scripts/base/frameworks/input/readers/binary.bro.rst
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/input/readers/binary.bro
|
||||
========================================
|
||||
.. bro:namespace:: InputBinary
|
||||
|
||||
Interface for the binary input reader.
|
||||
|
||||
:Namespace: InputBinary
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
======================================================================= ==========================================================
|
||||
:bro:id:`InputBinary::chunk_size`: :bro:type:`count` :bro:attr:`&redef` Size of data chunks to read from the input file at a time.
|
||||
======================================================================= ==========================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. bro:id:: InputBinary::chunk_size
|
||||
|
||||
:Type: :bro:type:`count`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``1024``
|
||||
|
||||
Size of data chunks to read from the input file at a time.
|
||||
|
||||
|
||||
95
doc/scripts/base/frameworks/input/readers/config.bro.rst
Normal file
95
doc/scripts/base/frameworks/input/readers/config.bro.rst
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/input/readers/config.bro
|
||||
========================================
|
||||
.. bro:namespace:: InputConfig
|
||||
|
||||
Interface for the config input reader.
|
||||
|
||||
:Namespace: InputConfig
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
================================================================================ ==========================================
|
||||
:bro:id:`InputConfig::empty_field`: :bro:type:`string` :bro:attr:`&redef` String to use for empty fields.
|
||||
:bro:id:`InputConfig::fail_on_file_problem`: :bro:type:`bool` :bro:attr:`&redef` Fail on file read problems.
|
||||
:bro:id:`InputConfig::set_separator`: :bro:type:`string` :bro:attr:`&redef` Separator between set and vector elements.
|
||||
================================================================================ ==========================================
|
||||
|
||||
Events
|
||||
######
|
||||
=================================================== ==============================================================
|
||||
:bro:id:`InputConfig::new_value`: :bro:type:`event` Event that is called when a config option is added or changes.
|
||||
=================================================== ==============================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. bro:id:: InputConfig::empty_field
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``""``
|
||||
|
||||
String to use for empty fields.
|
||||
By default this is the empty string, meaning that an empty input field
|
||||
will result in an empty set.
|
||||
|
||||
.. bro:id:: InputConfig::fail_on_file_problem
|
||||
|
||||
:Type: :bro:type:`bool`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``F``
|
||||
|
||||
Fail on file read problems. If set to true, the config
|
||||
input reader will fail when encountering any problems
|
||||
while reading a file different from invalid lines.
|
||||
Examples of such problems are permission problems, or
|
||||
missing files.
|
||||
When set to false, these problems will be ignored. This
|
||||
has an especially big effect for the REREAD mode, which will
|
||||
seamlessly recover from read errors when a file is
|
||||
only temporarily inaccessible. For MANUAL or STREAM files,
|
||||
errors will most likely still be fatal since no automatic
|
||||
re-reading of the file is attempted.
|
||||
Individual readers can use a different value using
|
||||
the $config table.
|
||||
|
||||
.. bro:id:: InputConfig::set_separator
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``","``
|
||||
|
||||
Separator between set and vector elements.
|
||||
Please note that the separator has to be exactly one character long.
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: InputConfig::new_value
|
||||
|
||||
:Type: :bro:type:`event` (name: :bro:type:`string`, source: :bro:type:`string`, id: :bro:type:`string`, value: :bro:type:`any`)
|
||||
|
||||
Event that is called when a config option is added or changes.
|
||||
|
||||
Note - this does not track the reason for a change (new, changed),
|
||||
and also does not track removals. If you need this, combine the event
|
||||
with a table reader.
|
||||
|
||||
|
||||
:name: Name of the input stream.
|
||||
|
||||
|
||||
:source: Source of the input stream.
|
||||
|
||||
|
||||
:id: ID of the configuration option being set.
|
||||
|
||||
|
||||
:value: New value of the configuration option being set.
|
||||
|
||||
|
||||
58
doc/scripts/base/frameworks/input/readers/raw.bro.rst
Normal file
58
doc/scripts/base/frameworks/input/readers/raw.bro.rst
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/input/readers/raw.bro
|
||||
=====================================
|
||||
.. bro:namespace:: InputRaw
|
||||
|
||||
Interface for the raw input reader.
|
||||
|
||||
:Namespace: InputRaw
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
=========================================================================== ================================
|
||||
:bro:id:`InputRaw::record_separator`: :bro:type:`string` :bro:attr:`&redef` Separator between input records.
|
||||
=========================================================================== ================================
|
||||
|
||||
Events
|
||||
######
|
||||
======================================================= ====================================================================
|
||||
:bro:id:`InputRaw::process_finished`: :bro:type:`event` Event that is called when a process created by the raw reader exits.
|
||||
======================================================= ====================================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. bro:id:: InputRaw::record_separator
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``"\x0a"``
|
||||
|
||||
Separator between input records.
|
||||
Please note that the separator has to be exactly one character long.
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: InputRaw::process_finished
|
||||
|
||||
:Type: :bro:type:`event` (name: :bro:type:`string`, source: :bro:type:`string`, exit_code: :bro:type:`count`, signal_exit: :bro:type:`bool`)
|
||||
|
||||
Event that is called when a process created by the raw reader exits.
|
||||
|
||||
|
||||
:name: name of the input stream.
|
||||
|
||||
:source: source of the input stream.
|
||||
|
||||
:exit_code: exit code of the program, or number of the signal that forced
|
||||
the program to exit.
|
||||
|
||||
:signal_exit: false when program exited normally, true when program was
|
||||
forced to exit by a signal.
|
||||
|
||||
|
||||
59
doc/scripts/base/frameworks/input/readers/sqlite.bro.rst
Normal file
59
doc/scripts/base/frameworks/input/readers/sqlite.bro.rst
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/input/readers/sqlite.bro
|
||||
========================================
|
||||
.. bro:namespace:: InputSQLite
|
||||
|
||||
Interface for the SQLite input reader. Redefinable options are available
|
||||
to tweak the input format of the SQLite reader.
|
||||
|
||||
See :doc:`/frameworks/logging-input-sqlite` for an introduction on how to
|
||||
use the SQLite reader.
|
||||
|
||||
When using the SQLite reader, you have to specify the SQL query that returns
|
||||
the desired data by setting ``query`` in the ``config`` table. See the
|
||||
introduction mentioned above for an example.
|
||||
|
||||
:Namespace: InputSQLite
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
=========================================================================== ===========================================
|
||||
:bro:id:`InputSQLite::empty_field`: :bro:type:`string` :bro:attr:`&redef` String to use for empty fields.
|
||||
:bro:id:`InputSQLite::set_separator`: :bro:type:`string` :bro:attr:`&redef` Separator between set elements.
|
||||
:bro:id:`InputSQLite::unset_field`: :bro:type:`string` :bro:attr:`&redef` String to use for an unset &optional field.
|
||||
=========================================================================== ===========================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. bro:id:: InputSQLite::empty_field
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``"(empty)"``
|
||||
|
||||
String to use for empty fields.
|
||||
|
||||
.. bro:id:: InputSQLite::set_separator
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``","``
|
||||
|
||||
Separator between set elements.
|
||||
Please note that the separator has to be exactly one character long.
|
||||
|
||||
.. bro:id:: InputSQLite::unset_field
|
||||
|
||||
:Type: :bro:type:`string`
|
||||
:Attributes: :bro:attr:`&redef`
|
||||
:Default: ``"-"``
|
||||
|
||||
String to use for an unset &optional field.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue