mirror of
https://github.com/zeek/zeek.git
synced 2025-10-08 01: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
|
||||
|
||||
base/frameworks/logging/postprocessors/__load__.zeek
|
||||
====================================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/frameworks/logging/postprocessors/scp.zeek </scripts/base/frameworks/logging/postprocessors/scp.zeek>`, :doc:`base/frameworks/logging/postprocessors/sftp.zeek </scripts/base/frameworks/logging/postprocessors/sftp.zeek>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
44
doc/scripts/base/frameworks/logging/postprocessors/index.rst
Normal file
44
doc/scripts/base/frameworks/logging/postprocessors/index.rst
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/frameworks/logging/postprocessors
|
||||
===============================================
|
||||
|
||||
Support for postprocessors in the logging framework.
|
||||
|
||||
:doc:`/scripts/base/frameworks/logging/postprocessors/__load__.zeek`
|
||||
|
||||
|
||||
:doc:`/scripts/base/frameworks/logging/postprocessors/scp.zeek`
|
||||
|
||||
This script defines a postprocessing function that can be applied
|
||||
to a logging filter in order to automatically SCP (secure copy)
|
||||
a log stream (or a subset of it) to a remote host at configurable
|
||||
rotation time intervals. Generally, to use this functionality
|
||||
you must handle the :zeek:id:`zeek_init` event and do the following
|
||||
in your handler:
|
||||
|
||||
1) Create a new :zeek:type:`Log::Filter` record that defines a name/path,
|
||||
rotation interval, and set the ``postprocessor`` to
|
||||
:zeek:id:`Log::scp_postprocessor`.
|
||||
2) Add the filter to a logging stream using :zeek:id:`Log::add_filter`.
|
||||
3) Add a table entry to :zeek:id:`Log::scp_destinations` for the filter's
|
||||
writer/path pair which defines a set of :zeek:type:`Log::SCPDestination`
|
||||
records.
|
||||
|
||||
:doc:`/scripts/base/frameworks/logging/postprocessors/sftp.zeek`
|
||||
|
||||
This script defines a postprocessing function that can be applied
|
||||
to a logging filter in order to automatically SFTP
|
||||
a log stream (or a subset of it) to a remote host at configurable
|
||||
rotation time intervals. Generally, to use this functionality
|
||||
you must handle the :zeek:id:`zeek_init` event and do the following
|
||||
in your handler:
|
||||
|
||||
1) Create a new :zeek:type:`Log::Filter` record that defines a name/path,
|
||||
rotation interval, and set the ``postprocessor`` to
|
||||
:zeek:id:`Log::sftp_postprocessor`.
|
||||
2) Add the filter to a logging stream using :zeek:id:`Log::add_filter`.
|
||||
3) Add a table entry to :zeek:id:`Log::sftp_destinations` for the filter's
|
||||
writer/path pair which defines a set of :zeek:type:`Log::SFTPDestination`
|
||||
records.
|
||||
|
||||
132
doc/scripts/base/frameworks/logging/postprocessors/scp.zeek.rst
Normal file
132
doc/scripts/base/frameworks/logging/postprocessors/scp.zeek.rst
Normal file
|
|
@ -0,0 +1,132 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/logging/postprocessors/scp.zeek
|
||||
===============================================
|
||||
.. zeek:namespace:: Log
|
||||
|
||||
This script defines a postprocessing function that can be applied
|
||||
to a logging filter in order to automatically SCP (secure copy)
|
||||
a log stream (or a subset of it) to a remote host at configurable
|
||||
rotation time intervals. Generally, to use this functionality
|
||||
you must handle the :zeek:id:`zeek_init` event and do the following
|
||||
in your handler:
|
||||
|
||||
1) Create a new :zeek:type:`Log::Filter` record that defines a name/path,
|
||||
rotation interval, and set the ``postprocessor`` to
|
||||
:zeek:id:`Log::scp_postprocessor`.
|
||||
2) Add the filter to a logging stream using :zeek:id:`Log::add_filter`.
|
||||
3) Add a table entry to :zeek:id:`Log::scp_destinations` for the filter's
|
||||
writer/path pair which defines a set of :zeek:type:`Log::SCPDestination`
|
||||
records.
|
||||
|
||||
:Namespace: Log
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
================================================================================= ================================================================
|
||||
:zeek:id:`Log::scp_rotation_date_format`: :zeek:type:`string` :zeek:attr:`&redef` Default naming format for timestamps embedded into log filenames
|
||||
that use the SCP rotator.
|
||||
================================================================================= ================================================================
|
||||
|
||||
State Variables
|
||||
###############
|
||||
==================================================== =======================================================================
|
||||
:zeek:id:`Log::scp_destinations`: :zeek:type:`table` A table indexed by a particular log writer and filter path, that yields
|
||||
a set of remote destinations.
|
||||
==================================================== =======================================================================
|
||||
|
||||
Types
|
||||
#####
|
||||
===================================================== =====================================================================
|
||||
:zeek:type:`Log::SCPDestination`: :zeek:type:`record` A container that describes the remote destination for the SCP command
|
||||
argument as ``user@host:path``.
|
||||
===================================================== =====================================================================
|
||||
|
||||
Functions
|
||||
#########
|
||||
======================================================== ============================================================
|
||||
:zeek:id:`Log::scp_postprocessor`: :zeek:type:`function` Secure-copies the rotated log to all the remote hosts
|
||||
defined in :zeek:id:`Log::scp_destinations` and then deletes
|
||||
the local copy of the rotated log.
|
||||
======================================================== ============================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. zeek:id:: Log::scp_rotation_date_format
|
||||
:source-code: base/frameworks/logging/postprocessors/scp.zeek 53 53
|
||||
|
||||
:Type: :zeek:type:`string`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``"%Y-%m-%d-%H-%M-%S"``
|
||||
|
||||
Default naming format for timestamps embedded into log filenames
|
||||
that use the SCP rotator.
|
||||
|
||||
State Variables
|
||||
###############
|
||||
.. zeek:id:: Log::scp_destinations
|
||||
:source-code: base/frameworks/logging/postprocessors/scp.zeek 49 49
|
||||
|
||||
:Type: :zeek:type:`table` [:zeek:type:`Log::Writer`, :zeek:type:`string`] of :zeek:type:`set` [:zeek:type:`Log::SCPDestination`]
|
||||
:Default: ``{}``
|
||||
|
||||
A table indexed by a particular log writer and filter path, that yields
|
||||
a set of remote destinations. The :zeek:id:`Log::scp_postprocessor`
|
||||
function queries this table upon log rotation and performs a secure
|
||||
copy of the rotated log to each destination in the set. This
|
||||
table can be modified at run-time.
|
||||
|
||||
Types
|
||||
#####
|
||||
.. zeek:type:: Log::SCPDestination
|
||||
:source-code: base/frameworks/logging/postprocessors/scp.zeek 34 42
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
||||
.. zeek:field:: user :zeek:type:`string`
|
||||
|
||||
The remote user to log in as. A trust mechanism should be
|
||||
pre-established.
|
||||
|
||||
|
||||
.. zeek:field:: host :zeek:type:`string`
|
||||
|
||||
The remote host to which to transfer logs.
|
||||
|
||||
|
||||
.. zeek:field:: path :zeek:type:`string`
|
||||
|
||||
The path/directory on the remote host to send logs.
|
||||
|
||||
|
||||
A container that describes the remote destination for the SCP command
|
||||
argument as ``user@host:path``.
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. zeek:id:: Log::scp_postprocessor
|
||||
:source-code: base/frameworks/logging/postprocessors/scp.zeek 56 72
|
||||
|
||||
:Type: :zeek:type:`function` (info: :zeek:type:`Log::RotationInfo`) : :zeek:type:`bool`
|
||||
|
||||
Secure-copies the rotated log to all the remote hosts
|
||||
defined in :zeek:id:`Log::scp_destinations` and then deletes
|
||||
the local copy of the rotated log. It's not active when
|
||||
reading from trace files.
|
||||
|
||||
|
||||
:param info: A record holding meta-information about the log file to be
|
||||
postprocessed.
|
||||
|
||||
|
||||
:returns: True if secure-copy system command was initiated or
|
||||
if no destination was configured for the log as described
|
||||
by *info*.
|
||||
|
||||
|
||||
137
doc/scripts/base/frameworks/logging/postprocessors/sftp.zeek.rst
Normal file
137
doc/scripts/base/frameworks/logging/postprocessors/sftp.zeek.rst
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/logging/postprocessors/sftp.zeek
|
||||
================================================
|
||||
.. zeek:namespace:: Log
|
||||
|
||||
This script defines a postprocessing function that can be applied
|
||||
to a logging filter in order to automatically SFTP
|
||||
a log stream (or a subset of it) to a remote host at configurable
|
||||
rotation time intervals. Generally, to use this functionality
|
||||
you must handle the :zeek:id:`zeek_init` event and do the following
|
||||
in your handler:
|
||||
|
||||
1) Create a new :zeek:type:`Log::Filter` record that defines a name/path,
|
||||
rotation interval, and set the ``postprocessor`` to
|
||||
:zeek:id:`Log::sftp_postprocessor`.
|
||||
2) Add the filter to a logging stream using :zeek:id:`Log::add_filter`.
|
||||
3) Add a table entry to :zeek:id:`Log::sftp_destinations` for the filter's
|
||||
writer/path pair which defines a set of :zeek:type:`Log::SFTPDestination`
|
||||
records.
|
||||
|
||||
:Namespace: Log
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
================================================================================== ================================================================
|
||||
:zeek:id:`Log::sftp_rotation_date_format`: :zeek:type:`string` :zeek:attr:`&redef` Default naming format for timestamps embedded into log filenames
|
||||
that use the SFTP rotator.
|
||||
================================================================================== ================================================================
|
||||
|
||||
State Variables
|
||||
###############
|
||||
===================================================== =======================================================================
|
||||
:zeek:id:`Log::sftp_destinations`: :zeek:type:`table` A table indexed by a particular log writer and filter path, that yields
|
||||
a set of remote destinations.
|
||||
===================================================== =======================================================================
|
||||
|
||||
Types
|
||||
#####
|
||||
====================================================== =======================================================================
|
||||
:zeek:type:`Log::SFTPDestination`: :zeek:type:`record` A container that describes the remote destination for the SFTP command,
|
||||
comprised of the username, host, and path at which to upload the file.
|
||||
====================================================== =======================================================================
|
||||
|
||||
Functions
|
||||
#########
|
||||
========================================================= =============================================================
|
||||
:zeek:id:`Log::sftp_postprocessor`: :zeek:type:`function` Securely transfers the rotated log to all the remote hosts
|
||||
defined in :zeek:id:`Log::sftp_destinations` and then deletes
|
||||
the local copy of the rotated log.
|
||||
========================================================= =============================================================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Redefinable Options
|
||||
###################
|
||||
.. zeek:id:: Log::sftp_rotation_date_format
|
||||
:source-code: base/frameworks/logging/postprocessors/sftp.zeek 55 55
|
||||
|
||||
:Type: :zeek:type:`string`
|
||||
:Attributes: :zeek:attr:`&redef`
|
||||
:Default: ``"%Y-%m-%d-%H-%M-%S"``
|
||||
|
||||
Default naming format for timestamps embedded into log filenames
|
||||
that use the SFTP rotator.
|
||||
|
||||
State Variables
|
||||
###############
|
||||
.. zeek:id:: Log::sftp_destinations
|
||||
:source-code: base/frameworks/logging/postprocessors/sftp.zeek 51 51
|
||||
|
||||
:Type: :zeek:type:`table` [:zeek:type:`Log::Writer`, :zeek:type:`string`] of :zeek:type:`set` [:zeek:type:`Log::SFTPDestination`]
|
||||
:Default: ``{}``
|
||||
|
||||
A table indexed by a particular log writer and filter path, that yields
|
||||
a set of remote destinations. The :zeek:id:`Log::sftp_postprocessor`
|
||||
function queries this table upon log rotation and performs a secure
|
||||
transfer of the rotated log to each destination in the set. This
|
||||
table can be modified at run-time.
|
||||
|
||||
Types
|
||||
#####
|
||||
.. zeek:type:: Log::SFTPDestination
|
||||
:source-code: base/frameworks/logging/postprocessors/sftp.zeek 34 44
|
||||
|
||||
:Type: :zeek:type:`record`
|
||||
|
||||
|
||||
.. zeek:field:: user :zeek:type:`string`
|
||||
|
||||
The remote user to log in as. A trust mechanism should be
|
||||
pre-established.
|
||||
|
||||
|
||||
.. zeek:field:: host :zeek:type:`string`
|
||||
|
||||
The remote host to which to transfer logs.
|
||||
|
||||
|
||||
.. zeek:field:: host_port :zeek:type:`count` :zeek:attr:`&default` = ``22`` :zeek:attr:`&optional`
|
||||
|
||||
The port to connect to. Defaults to 22
|
||||
|
||||
|
||||
.. zeek:field:: path :zeek:type:`string`
|
||||
|
||||
The path/directory on the remote host to send logs.
|
||||
|
||||
|
||||
A container that describes the remote destination for the SFTP command,
|
||||
comprised of the username, host, and path at which to upload the file.
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. zeek:id:: Log::sftp_postprocessor
|
||||
:source-code: base/frameworks/logging/postprocessors/sftp.zeek 58 75
|
||||
|
||||
:Type: :zeek:type:`function` (info: :zeek:type:`Log::RotationInfo`) : :zeek:type:`bool`
|
||||
|
||||
Securely transfers the rotated log to all the remote hosts
|
||||
defined in :zeek:id:`Log::sftp_destinations` and then deletes
|
||||
the local copy of the rotated log. It's not active when
|
||||
reading from trace files.
|
||||
|
||||
|
||||
:param info: A record holding meta-information about the log file to be
|
||||
postprocessed.
|
||||
|
||||
|
||||
:returns: True if sftp system command was initiated or
|
||||
if no destination was configured for the log as described
|
||||
by *info*.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue