Metrics store entry which contains the gathered data. More...

#include "metrics_common.h"
#include <string.h>
#include "orconfig.h"
#include "lib/container/smartlist.h"
#include "lib/log/util_bug.h"
#include "lib/malloc/malloc.h"
#include "lib/metrics/metrics_store_entry.h"

Functions
metrics_store_entry_t *	metrics_store_entry_new (const metrics_type_t type, const char name, const char help, size_t bucket_count, const int64_t *buckets)

void	metrics_store_entry_free_ (metrics_store_entry_t *entry)

void	metrics_store_entry_update (metrics_store_entry_t *entry, const int64_t value)

void	metrics_store_hist_entry_update (metrics_store_entry_t *entry, const int64_t value, const int64_t obs)

void	metrics_store_entry_reset (metrics_store_entry_t *entry)

int64_t	metrics_store_entry_get_value (const metrics_store_entry_t *entry)

uint64_t	metrics_store_hist_entry_get_value (const metrics_store_entry_t *entry, const int64_t bucket)

void	metrics_store_entry_add_label (metrics_store_entry_t entry, const char label)

bool	metrics_store_entry_has_label (const metrics_store_entry_t entry, const char label)

metrics_store_entry_t *	metrics_store_find_entry_with_label (const smartlist_t entries, const char label)

bool	metrics_store_entry_is_histogram (const metrics_store_entry_t *entry)

uint64_t	metrics_store_hist_entry_get_count (const metrics_store_entry_t *entry)

int64_t	metrics_store_hist_entry_get_sum (const metrics_store_entry_t *entry)

Detailed Description

Metrics store entry which contains the gathered data.

Definition in file metrics_store_entry.c.

Macro Definition Documentation

◆ METRICS_STORE_ENTRY_PRIVATE

#define METRICS_STORE_ENTRY_PRIVATE

Definition at line 10 of file metrics_store_entry.c.

Function Documentation

◆ metrics_store_entry_add_label()

void metrics_store_entry_add_label	(	metrics_store_entry_t *	entry,
		const char *	label
	)

Add a label into the given entry.

Definition at line 223 of file metrics_store_entry.c.

Referenced by fill_cc_counters_values(), fill_cc_gauges_values(), fill_circuits_values(), fill_dos_values(), fill_global_bw_limit_values(), fill_oom_values(), fill_relay_flags(), fill_single_connection_value(), fill_single_stream_value(), fill_socket_values(), and fill_traffic_values().

◆ metrics_store_entry_free_()

void metrics_store_entry_free_ ( metrics_store_entry_t * entry )

Free a store entry.

Definition at line 60 of file metrics_store_entry.c.

◆ metrics_store_entry_get_value()

int64_t metrics_store_entry_get_value ( const metrics_store_entry_t * entry )

Return store entry value.

Definition at line 165 of file metrics_store_entry.c.

◆ metrics_store_entry_has_label()

bool metrics_store_entry_has_label	(	const metrics_store_entry_t *	entry,
		const char *	label
	)

Return true iff the given entry has the given label.

Definition at line 234 of file metrics_store_entry.c.

◆ metrics_store_entry_is_histogram()

bool metrics_store_entry_is_histogram ( const metrics_store_entry_t * entry )

Return true iff the specified entry is a histogram.

Definition at line 265 of file metrics_store_entry.c.

◆ metrics_store_entry_new()

metrics_store_entry_t * metrics_store_entry_new	(	const metrics_type_t	type,
		const char *	name,
		const char *	help,
		size_t	bucket_count,
		const int64_t *	buckets
	)

Return newly allocated store entry of the specified type.

Definition at line 28 of file metrics_store_entry.c.

◆ metrics_store_entry_reset()

void metrics_store_entry_reset ( metrics_store_entry_t * entry )

Reset a store entry that is set its metric data to 0.

Definition at line 142 of file metrics_store_entry.c.

◆ metrics_store_entry_update()

void metrics_store_entry_update	(	metrics_store_entry_t *	entry,
		const int64_t	value
	)

Update a store entry with value.

Definition at line 79 of file metrics_store_entry.c.

Referenced by fill_cc_counters_values(), fill_cc_gauges_values(), fill_circuits_values(), fill_dos_values(), fill_global_bw_limit_values(), fill_oom_values(), fill_relay_circ_proto_violation(), fill_relay_destroy_cell(), fill_relay_drop_cell(), fill_relay_flags(), fill_single_connection_value(), fill_single_stream_value(), fill_socket_values(), fill_tcp_exhaustion_values(), and fill_traffic_values().

◆ metrics_store_find_entry_with_label()

metrics_store_entry_t * metrics_store_find_entry_with_label	(	const smartlist_t *	entries,
		const char *	label
	)

Return the first entry that has the given label, or NULL if none of the entries have the label.

Definition at line 246 of file metrics_store_entry.c.

◆ metrics_store_hist_entry_get_count()

uint64_t metrics_store_hist_entry_get_count ( const metrics_store_entry_t * entry )

Return the total number of observations for the specified histogram.

Definition at line 276 of file metrics_store_entry.c.

◆ metrics_store_hist_entry_get_sum()

int64_t metrics_store_hist_entry_get_sum ( const metrics_store_entry_t * entry )

Return the sum of all observations for the specified histogram.

Definition at line 289 of file metrics_store_entry.c.

◆ metrics_store_hist_entry_get_value()

uint64_t metrics_store_hist_entry_get_value	(	const metrics_store_entry_t *	entry,
		const int64_t	bucket
	)

Return store entry value for the specified bucket.

Note: entry must be a histogram.

Definition at line 196 of file metrics_store_entry.c.

◆ metrics_store_hist_entry_update()

void metrics_store_hist_entry_update	(	metrics_store_entry_t *	entry,
		const int64_t	value,
		const int64_t	obs
	)

Update a store entry with value for the specified observation obs.