f5fbad23ff
This implements basic tracking of each peering's current fill level, the maximum level over a recent time interval (via a new Broker::buffer_stats_reset_interval tunable, defaulting to 1min), and the number of times a buffer overflows. For the disconnect policy this is the number of depeerings, but for drop_newest and drop_oldest it implies the number of messages lost. This doesn't use "proper" telemetry metrics for a few reasons: this tracking is Broker-specific, so we need to track each peering via endpoint_ids, while we want the metrics to use Cluster node name labels, and the latter live in the script layer. Using broker::endpoint_id directly as keys also means we rely on their ability to hash in STL containers, which should be fast. This does not track the buffer levels for Broker "clients" (as opposed to "peers"), i.e. WebSockets, since we currently don't have a way to name these, and we don't want to use ephemeral Broker IDs in their telemetry. To make the stats accessible to the script layer the Broker manager (via a new helper class that lives in the event_observer) maintains a TableVal mapping Broker IDs to a new BrokerPeeringStats record. The table's members get updated every time that table is requested. This minimizes new val instantiation and allows the script layer to customize the BrokerPeeringStats record by redefing, updating fields, etc. Since we can't use Zeek vals outside the main thread, this requires some care so all table updates happen only in the Zeek-side table updater, PeerBufferState::GetPeeringStatsTable(). |
||
|---|---|---|
| .github/workflows | ||
| auxil | ||
| ci | ||
| cmake@fd0696f907 | ||
| cmake_templates | ||
| doc@d583c2abfe | ||
| docker | ||
| man | ||
| scripts | ||
| src | ||
| testing | ||
| .cirrus.yml | ||
| .clang-format | ||
| .clang-tidy | ||
| .cmake-format.json | ||
| .dockerignore | ||
| .git-blame-ignore-revs | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .pre-commit-config.yaml | ||
| .typos.toml | ||
| .update-changes.cfg | ||
| CHANGES | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| configure | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| COPYING-3rdparty | ||
| INSTALL | ||
| Makefile | ||
| NEWS | ||
| README | ||
| README.md | ||
| ruff.toml | ||
| SECURITY.md | ||
| vcpkg.json | ||
| VERSION | ||
| zeek-path-dev.in | ||
The Zeek Network Security Monitor
A powerful framework for network traffic analysis and security monitoring.
Key Features — Documentation — Getting Started — Development — License
Follow us on Twitter at @zeekurity.
Key Features
-
In-depth Analysis Zeek ships with analyzers for many protocols, enabling high-level semantic analysis at the application layer.
-
Adaptable and Flexible Zeek's domain-specific scripting language enables site-specific monitoring policies and means that it is not restricted to any particular detection approach.
-
Efficient Zeek targets high-performance networks and is used operationally at a variety of large sites.
-
Highly Stateful Zeek keeps extensive application-layer state about the network it monitors and provides a high-level archive of a network's activity.
Getting Started
The best place to find information about getting started with Zeek is our web site www.zeek.org, specifically the documentation section there. On the web site you can also find downloads for stable releases, tutorials on getting Zeek set up, and many other useful resources.
You can find release notes in NEWS, and a complete record of all changes in CHANGES.
To work with the most recent code from the development branch of Zeek, clone the master git repository:
git clone --recursive https://github.com/zeek/zeek
With all dependencies in place, build and install:
./configure && make && sudo make install
Write your first Zeek script:
# File "hello.zeek"
event zeek_init()
{
print "Hello World!";
}
And run it:
zeek hello.zeek
For learning more about the Zeek scripting language, try.zeek.org is a great resource.
Development
Zeek is developed on GitHub by its community. We welcome contributions. Working on an open source project like Zeek can be an incredibly rewarding experience and, packet by packet, makes the Internet a little safer. Today, as a result of countless contributions, Zeek is used operationally around the world by major companies and educational and scientific institutions alike for securing their cyber infrastructure.
If you're interested in getting involved, we collect feature requests and issues on GitHub here and you might find these to be a good place to get started. More information on Zeek's development can be found here, and information about its community and mailing lists (which are fairly active) can be found here.
License
Zeek comes with a BSD license, allowing for free use with virtually no restrictions. You can find it here.
Tooling
We use the following tooling to help discover issues to fix, amongst a number of others.
- Clang-Tidy
- Coverity
- PVS-Studio - static analyzer for C, C++, C#, and Java code.