Skip to content

Commit

Permalink
Generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zeek-bot committed Jun 8, 2024
1 parent 39de6cb commit 5c377d2
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions scripts/base/frameworks/telemetry/options.zeek.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,31 @@ Summary
~~~~~~~
Redefinable Options
###################
==================================================================================== ==================================================================
==================================================================================== =====================================================================
:zeek:id:`Telemetry::metrics_address`: :zeek:type:`string` :zeek:attr:`&redef` Address used to make metric data available to Prometheus scrapers via
HTTP.
:zeek:id:`Telemetry::metrics_endpoint_name`: :zeek:type:`string` :zeek:attr:`&redef` ID for the metrics exporter.
:zeek:id:`Telemetry::metrics_port`: :zeek:type:`port` :zeek:attr:`&redef` Port used to make metric data available to Prometheus scrapers via
HTTP.
==================================================================================== ==================================================================
==================================================================================== =====================================================================


Detailed Interface
~~~~~~~~~~~~~~~~~~
Redefinable Options
###################
.. zeek:id:: Telemetry::metrics_address
:source-code: base/frameworks/telemetry/options.zeek 11 11

:Type: :zeek:type:`string`
:Attributes: :zeek:attr:`&redef`
:Default: ``""``

Address used to make metric data available to Prometheus scrapers via
HTTP.

.. zeek:id:: Telemetry::metrics_endpoint_name
:source-code: base/frameworks/telemetry/options.zeek 16 16
:source-code: base/frameworks/telemetry/options.zeek 20 20

:Type: :zeek:type:`string`
:Attributes: :zeek:attr:`&redef`
Expand All @@ -34,7 +46,7 @@ Redefinable Options
defaults to the name of the node in the cluster configuration.

.. zeek:id:: Telemetry::metrics_port
:source-code: base/frameworks/telemetry/options.zeek 11 11
:source-code: base/frameworks/telemetry/options.zeek 15 15

:Type: :zeek:type:`port`
:Attributes: :zeek:attr:`&redef`
Expand Down

0 comments on commit 5c377d2

Please sign in to comment.