Skip to content

Pushers

Classes

PusherCarbon

PusherCarbon(
    address: Strlist, 
    node_realm: str | None = None, 
    node_root: str | None = None, 
    push_interval: int | None = None, 
    idle_avg_source: str | None = None, 
    use_metrics: bool | None = None, 
    no_workers: bool | None = None, 
    timeout: int | None = None, 
    retries: int | None = None, 
    retries_delay: int | None = None, 
    hostname_dots_replacer: str | None = None
)

Pusher

Push metrics to a Carbon server of Graphite.

Metric node format: <node_root>.hostname.<node_realm>.metrics_data.


alias

.alias: str = ''

Alias to address this value.


name_separator

.name_separator: str = ':'

Separator to add after name portion.


name_separator_strip

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.


PusherFile

1
2
3
4
5
PusherFile(
    fpath: str | None = None, 
    separator: str | None = None, 
    push_interval: int | None = None
)

Pusher

Stores stats JSON into a file.

Note

Mainly for demonstration purposes.


alias

.alias: str = ''

Alias to address this value.


name_separator

.name_separator: str = ':'

Separator to add after name portion.


name_separator_strip

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.


opt_key

.opt_key: str | None = None

Allows swapping default option key with custom value.


PusherMongo

1
2
3
4
5
PusherMongo(
    address: str | None = None, 
    collection: str | None = None, 
    push_interval: int | None = None
)

Pusher

Push statistics (as JSON) the the specified MongoDB database.


alias

.alias: str = ''

Alias to address this value.


name_separator

.name_separator: str = ':'

Separator to add after name portion.


name_separator_strip

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.


opt_key

.opt_key: str | None = None

Allows swapping default option key with custom value.


PusherRrdtool

1
2
3
4
5
PusherRrdtool(
    target_dir: str, 
    library: str | None = None, 
    push_interval: int | None = None
)

Pusher

This will store an rrd file for each metric in the specified directory.

Each rrd file has a single data source named "metric".


alias

.alias: str = ''

Alias to address this value.


name_separator

.name_separator: str = ':'

Separator to add after name portion.


name_separator_strip

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.


opt_key

.opt_key: str | None = None

Allows swapping default option key with custom value.


PusherSocket

PusherSocket(address: str, prefix: str | None = None)

Pusher

Push metrics to a UDP server.

Uses the following format: <metric> <type> <value> <type> - is in the numeric form of metric type.


alias

.alias: str = ''

Alias to address this value.


name_separator

.name_separator: str = ':'

Separator to add after name portion.


name_separator_strip

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.


opt_key

.opt_key: str | None = None

Allows swapping default option key with custom value.


PusherStatsd

1
2
3
4
5
6
PusherStatsd(
    address: str, 
    prefix: str | None = None, 
    no_workers: bool | None = None, 
    all_gauges: bool | None = None
)

Pusher

Push metrics to a statsd server.


alias

.alias: str = ''

Alias to address this value.


name_separator

.name_separator: str = ':'

Separator to add after name portion.


name_separator_strip

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.


opt_key

.opt_key: str | None = None

Allows swapping default option key with custom value.


PusherZabbix

1
2
3
4
5
PusherZabbix(
    address: str, 
    prefix: str | None = None, 
    template: str | None = None
)

Pusher

Push metrics to a zabbix server.


alias

.alias: str = ''

Alias to address this value.


name_separator

.name_separator: str = ':'

Separator to add after name portion.


name_separator_strip

.name_separator_strip: bool = False

Strip leading and trailing name separator from the result.


opt_key

.opt_key: str | None = None

Allows swapping default option key with custom value.