mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +00:00
9967aea52c
Add a "broxygen" domain Sphinx extension w/ directives to allow on-the-fly documentation to be generated w/ Bro and included in files. This means all autogenerated reST docs are now done by Bro. The odd CMake/Python glue scipts which used to generate some portions are now gone. Bro and the Sphinx extension handle checking for outdated docs themselves. Parallel builds of `make doc` target should now work (mostly because I don't think there's any tasks that can be done in parallel anymore). Overall, this seems to simplify things and make the Broxygen-generated portions of the documentation visible/traceable from the main Sphinx source tree. The one odd thing still is that per-script documentation is rsync'd in to a shadow copy of the Sphinx source tree within the build dir. This is less elegant than using the new broxygen extension to make per-script docs, but rsync is faster and simpler. Simpler as in less code because it seems like, in the best case, I'd need to write a custom Sphinx Builder to be able to get that to even work.
42 lines
1.5 KiB
Text
42 lines
1.5 KiB
Text
##! This script provides infrastructure for logging devices for which Bro has
|
|
##! been able to determine the MAC address, and it logs them once per day (by
|
|
##! default). The log that is output provides an easy way to determine a count
|
|
##! of the devices in use on a network per day.
|
|
##!
|
|
##! .. note::
|
|
##!
|
|
##! This script will not generate any logs on its own, it needs to be
|
|
##! supplied with information from elsewhere, such as
|
|
##! :doc:`/scripts/policy/protocols/dhcp/known-devices-and-hostnames.bro`.
|
|
|
|
module Known;
|
|
|
|
export {
|
|
## The known-hosts logging stream identifier.
|
|
redef enum Log::ID += { DEVICES_LOG };
|
|
|
|
## The record type which contains the column fields of the known-devices
|
|
## log.
|
|
type DevicesInfo: record {
|
|
## The timestamp at which the host was detected.
|
|
ts: time &log;
|
|
## The MAC address that was detected.
|
|
mac: string &log;
|
|
};
|
|
|
|
## The set of all known MAC addresses. It can accessed from other
|
|
## scripts to add, and check for, addresses seen in use.
|
|
##
|
|
## We maintain each entry for 24 hours by default so that the existence
|
|
## of individual addresses is logged each day.
|
|
global known_devices: set[string] &create_expire=1day &synchronized &redef;
|
|
|
|
## An event that can be handled to access the :bro:type:`Known::DevicesInfo`
|
|
## record as it is sent on to the logging framework.
|
|
global log_known_devices: event(rec: DevicesInfo);
|
|
}
|
|
|
|
event bro_init()
|
|
{
|
|
Log::create_stream(Known::DEVICES_LOG, [$columns=DevicesInfo, $ev=log_known_devices]);
|
|
}
|