mirror of
https://github.com/zeek/zeek.git
synced 2025-10-14 04:28:20 +00:00
Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
This commit is contained in:
Tim Wojtulewicz
parent
83f1e74643
commit
ded98cd373
1074 changed files with 169319 additions and 0 deletions
|
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
policy/frameworks/storage/backend/redis/__load__.zeek
|
||||
=====================================================
|
||||
|
||||
|
||||
:Imports: :doc:`policy/frameworks/storage/backend/redis/main.zeek </scripts/policy/frameworks/storage/backend/redis/main.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
:orphan:
|
||||
|
||||
Package: policy/frameworks/storage/backend/redis
|
||||
================================================
|
||||
|
||||
|
||||
:doc:`/scripts/policy/frameworks/storage/backend/redis/__load__.zeek`
|
||||
|
||||
|
||||
:doc:`/scripts/policy/frameworks/storage/backend/redis/main.zeek`
|
||||
|
||||
Redis storage backend support
|
||||
|
||||
|
|
@ -0,0 +1,108 @@
|
|||
:tocdepth: 3
|
||||
|
||||
policy/frameworks/storage/backend/redis/main.zeek
|
||||
=================================================
|
||||
.. zeek:namespace:: Storage::Backend::Redis
|
||||
|
||||
Redis storage backend support
|
||||
|
||||
:Namespace: Storage::Backend::Redis
|
||||
:Imports: :doc:`base/frameworks/storage/main.zeek </scripts/base/frameworks/storage/main.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
======================================================================================================== ==============================================
|
||||
:zeek:id:`Storage::Backend::Redis::default_connect_timeout`: :zeek:type:`interval` :zeek:attr:`&redef` Default value for connection attempt timeouts.
|
||||
:zeek:id:`Storage::Backend::Redis::default_operation_timeout`: :zeek:type:`interval` :zeek:attr:`&redef` Default value for operation timeouts.
|
||||
======================================================================================================== ==============================================
|
||||
|
||||
Types
|
||||
#####
|
||||
================================================================== ==============================================
|
||||
:zeek:type:`Storage::Backend::Redis::Options`: :zeek:type:`record` Options record for the built-in Redis backend.
|
||||
================================================================== ==============================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
========================================================= =============================================================================
|
||||
:zeek:type:`Storage::BackendOptions`: :zeek:type:`record`
|
||||
|
||||
:New Fields: :zeek:type:`Storage::BackendOptions`
|
||||
|
||||
redis: :zeek:type:`Storage::Backend::Redis::Options` :zeek:attr:`&optional`
|
||||
========================================================= =============================================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. zeek:id:: Storage::Backend::Redis::default_connect_timeout
|
||||
:source-code: policy/frameworks/storage/backend/redis/main.zeek 10 10
|
||||
|
||||
:Type: :zeek:type:`interval`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``5.0 secs``
|
||||
|
||||
Default value for connection attempt timeouts. This can be overridden
|
||||
per-connection with the ``connect_timeout`` backend option.
|
||||
|
||||
.. zeek:id:: Storage::Backend::Redis::default_operation_timeout
|
||||
:source-code: policy/frameworks/storage/backend/redis/main.zeek 14 14
|
||||
|
||||
:Type: :zeek:type:`interval`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``5.0 secs``
|
||||
|
||||
Default value for operation timeouts. This can be overridden per-connection
|
||||
with the ``operation_timeout`` backend option.
|
||||
|
||||
Types
|
||||
#####
|
||||
.. zeek:type:: Storage::Backend::Redis::Options
|
||||
:source-code: policy/frameworks/storage/backend/redis/main.zeek 17 49
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
||||
.. zeek:field:: server_host :zeek:type:`string` :zeek:attr:`&optional`
|
||||
|
||||
|
||||
.. zeek:field:: server_port :zeek:type:`port` :zeek:attr:`&default` = ``6379/tcp`` :zeek:attr:`&optional`
|
||||
|
||||
|
||||
.. zeek:field:: server_unix_socket :zeek:type:`string` :zeek:attr:`&optional`
|
||||
|
||||
|
||||
.. zeek:field:: key_prefix :zeek:type:`string` :zeek:attr:`&default` = ``""`` :zeek:attr:`&optional`
|
||||
|
||||
|
||||
.. zeek:field:: connect_timeout :zeek:type:`interval` :zeek:attr:`&default` = :zeek:see:`Storage::Backend::Redis::default_connect_timeout` :zeek:attr:`&optional`
|
||||
|
||||
Timeout for connection attempts to the backend. Connection attempts
|
||||
that exceed this time will return
|
||||
:zeek:see:`Storage::CONNECTION_FAILED`.
|
||||
|
||||
|
||||
.. zeek:field:: operation_timeout :zeek:type:`interval` :zeek:attr:`&default` = :zeek:see:`Storage::Backend::Redis::default_operation_timeout` :zeek:attr:`&optional`
|
||||
|
||||
Timeout for operation requests sent to the backend. Operations that
|
||||
exceed this time will return :zeek:see:`Storage::TIMEOUT`.
|
||||
|
||||
|
||||
.. zeek:field:: username :zeek:type:`string` :zeek:attr:`&optional`
|
||||
|
||||
A username to use for authentication the server is protected by an ACL.
|
||||
|
||||
|
||||
.. zeek:field:: password :zeek:type:`string` :zeek:attr:`&optional`
|
||||
|
||||
A username to use for authentication the server is protected by an ACL
|
||||
or by a simple password.
|
||||
|
||||
|
||||
Options record for the built-in Redis backend.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
policy/frameworks/storage/backend/sqlite/__load__.zeek
|
||||
======================================================
|
||||
|
||||
|
||||
:Imports: :doc:`policy/frameworks/storage/backend/sqlite/main.zeek </scripts/policy/frameworks/storage/backend/sqlite/main.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
:orphan:
|
||||
|
||||
Package: policy/frameworks/storage/backend/sqlite
|
||||
=================================================
|
||||
|
||||
|
||||
:doc:`/scripts/policy/frameworks/storage/backend/sqlite/__load__.zeek`
|
||||
|
||||
|
||||
:doc:`/scripts/policy/frameworks/storage/backend/sqlite/main.zeek`
|
||||
|
||||
SQLite storage backend support
|
||||
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
:tocdepth: 3
|
||||
|
||||
policy/frameworks/storage/backend/sqlite/main.zeek
|
||||
==================================================
|
||||
.. zeek:namespace:: Storage::Backend::SQLite
|
||||
|
||||
SQLite storage backend support
|
||||
|
||||
:Namespace: Storage::Backend::SQLite
|
||||
:Imports: :doc:`base/frameworks/storage/main.zeek </scripts/base/frameworks/storage/main.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Types
|
||||
#####
|
||||
=================================================================== ===============================================
|
||||
:zeek:type:`Storage::Backend::SQLite::Options`: :zeek:type:`record` Options record for the built-in SQLite backend.
|
||||
=================================================================== ===============================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
========================================================= ===============================================================================
|
||||
:zeek:type:`Storage::BackendOptions`: :zeek:type:`record`
|
||||
|
||||
:New Fields: :zeek:type:`Storage::BackendOptions`
|
||||
|
||||
sqlite: :zeek:type:`Storage::Backend::SQLite::Options` :zeek:attr:`&optional`
|
||||
========================================================= ===============================================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Types
|
||||
#####
|
||||
.. zeek:type:: Storage::Backend::SQLite::Options
|
||||
:source-code: policy/frameworks/storage/backend/sqlite/main.zeek 9 50
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
||||
.. zeek:field:: database_path :zeek:type:`string`
|
||||
|
||||
Path to the database file on disk. Setting this to ":memory:" will tell
|
||||
SQLite to use an in-memory database. Relative paths will be opened
|
||||
relative to the directory where Zeek was started from. Zeek will not
|
||||
create intermediate directories if they do not already exist. See
|
||||
https://www.sqlite.org/c3ref/open.html for more rules on paths that can
|
||||
be passed here.
|
||||
|
||||
|
||||
.. zeek:field:: table_name :zeek:type:`string`
|
||||
|
||||
Name of the table used for storing data. It is possible to use the same
|
||||
database file for two separate tables, as long as the this value is
|
||||
different between the two.
|
||||
|
||||
|
||||
.. zeek:field:: busy_timeout :zeek:type:`interval` :zeek:attr:`&default` = ``5.0 secs`` :zeek:attr:`&optional`
|
||||
|
||||
The timeout for the connection to the database. This is set
|
||||
per-connection. It is equivalent to setting a ``busy_timeout`` pragma
|
||||
value, but that value will be ignored in favor of this field.
|
||||
|
||||
|
||||
.. zeek:field:: pragma_commands :zeek:type:`table` [:zeek:type:`string`] of :zeek:type:`string` :zeek:attr:`&ordered` :zeek:attr:`&default` = *...* :zeek:attr:`&optional`
|
||||
|
||||
Key/value table for passing pragma commands when opening the database.
|
||||
These must be pairs that can be passed to the ``pragma`` command in
|
||||
sqlite. The ``integrity_check`` pragma is run automatically and does
|
||||
not need to be included here. For pragmas without a second argument,
|
||||
set the value to an empty string. Setting the ``busy_timeout`` pragma
|
||||
here will be ignored.
|
||||
|
||||
|
||||
.. zeek:field:: pragma_timeout :zeek:type:`interval` :zeek:attr:`&default` = ``500.0 msecs`` :zeek:attr:`&optional`
|
||||
|
||||
The total amount of time that an SQLite backend will spend attempting
|
||||
to run an individual pragma command before giving up and returning an
|
||||
initialization error. Setting this to zero will result in the backend
|
||||
attempting forever until success.
|
||||
|
||||
|
||||
.. zeek:field:: pragma_wait_on_busy :zeek:type:`interval` :zeek:attr:`&default` = ``5.0 msecs`` :zeek:attr:`&optional`
|
||||
|
||||
The amount of time that at SQLite backend will wait between failures
|
||||
to run an individual pragma command.
|
||||
|
||||
|
||||
Options record for the built-in SQLite backend.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue