telemetry.bif.zeek

GLOBAL

Telemetry

Functions for accessing counter metrics from script land.

Namespaces: GLOBAL, Telemetry

Summary

Types

Telemetry::MetricType: enum

Functions

`Telemetry::__collect_histogram_metrics`: `function`
`Telemetry::__collect_metrics`: `function`
`Telemetry::__dbl_counter_family`: `function`
`Telemetry::__dbl_counter_inc`: `function`
`Telemetry::__dbl_counter_metric_get_or_add`: `function`
`Telemetry::__dbl_counter_value`: `function`
`Telemetry::__dbl_gauge_dec`: `function`
`Telemetry::__dbl_gauge_family`: `function`
`Telemetry::__dbl_gauge_inc`: `function`
`Telemetry::__dbl_gauge_metric_get_or_add`: `function`
`Telemetry::__dbl_gauge_value`: `function`
`Telemetry::__dbl_histogram_family`: `function`
`Telemetry::__dbl_histogram_metric_get_or_add`: `function`
`Telemetry::__dbl_histogram_observe`: `function`
`Telemetry::__dbl_histogram_sum`: `function`
`Telemetry::__int_counter_family`: `function`
`Telemetry::__int_counter_inc`: `function`
`Telemetry::__int_counter_metric_get_or_add`: `function`
`Telemetry::__int_counter_value`: `function`
`Telemetry::__int_gauge_dec`: `function`
`Telemetry::__int_gauge_family`: `function`
`Telemetry::__int_gauge_inc`: `function`
`Telemetry::__int_gauge_metric_get_or_add`: `function`
`Telemetry::__int_gauge_value`: `function`
`Telemetry::__int_histogram_family`: `function`
`Telemetry::__int_histogram_metric_get_or_add`: `function`
`Telemetry::__int_histogram_observe`: `function`
`Telemetry::__int_histogram_sum`: `function`

Detailed Interface

Types

Telemetry::MetricType

Type

enum

Telemetry::DOUBLE_COUNTER

Telemetry::INT_COUNTER

Telemetry::DOUBLE_GAUGE

Telemetry::INT_GAUGE

Telemetry::DOUBLE_HISTOGRAM

Telemetry::INT_HISTOGRAM

Functions

Telemetry::__collect_histogram_metrics

Type: function (prefix: string, name: string) : any_vec

Telemetry::__collect_metrics

Type: function (prefix: string, name: string) : any_vec

Telemetry::__dbl_counter_family

Type: function (prefix: string, name: string, labels: string_vec, helptext: string &default = "Zeek Script Metric" &optional, unit: string &default = "1" &optional, is_sum: bool &default = F &optional) : opaque of dbl_counter_metric_family

Telemetry::__dbl_counter_inc

Type: function (val: opaque of dbl_counter_metric, amount: double &default = 1.0 &optional) : bool

Telemetry::__dbl_counter_metric_get_or_add

Type: function (family: opaque of dbl_counter_metric_family, labels: table_string_of_string) : opaque of dbl_counter_metric

Telemetry::__dbl_counter_value

Type: function (val: opaque of dbl_counter_metric) : double

Telemetry::__dbl_gauge_dec

Type: function (val: opaque of dbl_gauge_metric, amount: double &default = 1.0 &optional) : bool

Telemetry::__dbl_gauge_family

Type: function (prefix: string, name: string, labels: string_vec, helptext: string &default = "Zeek Script Metric" &optional, unit: string &default = "1" &optional, is_sum: bool &default = F &optional) : opaque of dbl_gauge_metric_family

Telemetry::__dbl_gauge_inc

Type: function (val: opaque of dbl_gauge_metric, amount: double &default = 1.0 &optional) : bool

Telemetry::__dbl_gauge_metric_get_or_add

Type: function (family: opaque of dbl_gauge_metric_family, labels: table_string_of_string) : opaque of dbl_gauge_metric

Telemetry::__dbl_gauge_value

Type: function (val: opaque of dbl_gauge_metric) : double

Telemetry::__dbl_histogram_family

Type: function (prefix: string, name: string, labels: string_vec, bounds: double_vec, helptext: string &default = "Zeek Script Metric" &optional, unit: string &default = "1" &optional, is_sum: bool &default = F &optional) : opaque of dbl_histogram_metric_family

Telemetry::__dbl_histogram_metric_get_or_add

Type: function (family: opaque of dbl_histogram_metric_family, labels: table_string_of_string) : opaque of dbl_histogram_metric

Telemetry::__dbl_histogram_observe

Type: function (val: opaque of dbl_histogram_metric, measurement: double) : bool

Telemetry::__dbl_histogram_sum

Type: function (val: opaque of dbl_histogram_metric) : double

Telemetry::__int_counter_family

Type: function (prefix: string, name: string, labels: string_vec, helptext: string &default = "Zeek Script Metric" &optional, unit: string &default = "1" &optional, is_sum: bool &default = F &optional) : opaque of int_counter_metric_family

Telemetry::__int_counter_inc

Type: function (val: opaque of int_counter_metric, amount: int &default = 1 &optional) : bool

Telemetry::__int_counter_metric_get_or_add

Type: function (family: opaque of int_counter_metric_family, labels: table_string_of_string) : opaque of int_counter_metric

Telemetry::__int_counter_value

Type: function (val: opaque of int_counter_metric) : int

Telemetry::__int_gauge_dec

Type: function (val: opaque of int_gauge_metric, amount: int &default = 1 &optional) : bool

Telemetry::__int_gauge_family

Type: function (prefix: string, name: string, labels: string_vec, helptext: string &default = "Zeek Script Metric" &optional, unit: string &default = "1" &optional, is_sum: bool &default = F &optional) : opaque of int_gauge_metric_family

Telemetry::__int_gauge_inc

Type: function (val: opaque of int_gauge_metric, amount: int &default = 1 &optional) : bool

Telemetry::__int_gauge_metric_get_or_add

Type: function (family: opaque of int_gauge_metric_family, labels: table_string_of_string) : opaque of int_gauge_metric

Telemetry::__int_gauge_value

Type: function (val: opaque of int_gauge_metric) : int

Telemetry::__int_histogram_family

Type: function (prefix: string, name: string, labels: string_vec, bounds: int_vec, helptext: string &default = "Zeek Script Metric" &optional, unit: string &default = "1" &optional, is_sum: bool &default = F &optional) : opaque of int_histogram_metric_family

Telemetry::__int_histogram_metric_get_or_add

Type: function (family: opaque of int_histogram_metric_family, labels: table_string_of_string) : opaque of int_histogram_metric

Telemetry::__int_histogram_observe

Type: function (val: opaque of int_histogram_metric, measurement: int) : bool

Telemetry::__int_histogram_sum

Type: function (val: opaque of int_histogram_metric) : int