zeek/doc/scripts/base/frameworks/telemetry/index.rst
Tim Wojtulewicz ded98cd373 Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
2025-09-26 02:58:29 +00:00

25 lines
767 B
ReStructuredText

:orphan:
Package: base/frameworks/telemetry
==================================
:doc:`/scripts/base/frameworks/telemetry/options.zeek`
Configurable settings for the Telemetry framework.
These reside separately from the main framework so that they can be loaded
in bare mode without all of the framework. This allows things like the
plugins.hooks test to see the options without needing the rest.
:doc:`/scripts/base/frameworks/telemetry/__load__.zeek`
:doc:`/scripts/base/frameworks/telemetry/main.zeek`
Module for recording and querying metrics. This modules wraps
the lower-level telemetry.bif functions.
Metrics will be exposed through a Prometheus HTTP endpoint when
enabled by setting :zeek:see:`Telemetry::metrics_port`.