Struct RiPrometheusExporter

Source

pub struct RiPrometheusExporter { /* private fields */ }

Expand description

Prometheus exporter for managing metrics and generating Grafana dashboards.

This struct provides methods for registering and updating Prometheus metrics, as well as generating Grafana dashboards from these metrics.

Implementations§

Source §

impl RiPrometheusExporter

Source

pub fn new() -> RiResult<Self>

Creates a new Prometheus exporter instance.

§Returns

A new RiPrometheusExporter instance wrapped in RiResult

Source

pub fn register_counter(&self, name: &str, help: &str) -> RiResult<()>

Registers a new counter metric.

§Parameters

name: The name of the counter metric
help: Help text describing the counter

§Returns

RiResult indicating success or failure

Source

pub fn increment_counter(&self, name: &str, value: f64) -> RiResult<()>

Increments a counter metric by the specified value.

§Parameters

name: The name of the counter metric
value: The value to increment by

§Returns

RiResult indicating success or failure

Source

pub fn register_gauge(&self, name: &str, help: &str) -> RiResult<()>

Registers a new gauge metric.

§Parameters

name: The name of the gauge metric
help: Help text describing the gauge

§Returns

RiResult indicating success or failure

Source

pub fn set_gauge(&self, name: &str, value: f64) -> RiResult<()>

Sets a gauge metric to the specified value.

§Parameters

name: The name of the gauge metric
value: The value to set

§Returns

RiResult indicating success or failure

Source

pub fn register_histogram( &self, name: &str, help: &str, buckets: Vec<f64>, ) -> RiResult<()>

Registers a new histogram metric.

§Parameters

name: The name of the histogram metric
help: Help text describing the histogram
buckets: The histogram buckets

§Returns

RiResult indicating success or failure

Source

pub fn observe_histogram(&self, name: &str, value: f64) -> RiResult<()>

Observes a value in a histogram metric.

§Parameters

name: The name of the histogram metric
value: The value to observe

§Returns

RiResult indicating success or failure

Source

pub fn render(&self) -> RiResult<String>

Renders all metrics in Prometheus text format.

§Returns

A string containing all metrics in Prometheus text format wrapped in RiResult

Source

pub fn add_counter_panel( &self, dashboard: &mut RiGrafanaDashboard, title: &str, query: &str, ) -> RiResult<()>

Adds a counter panel to a Grafana dashboard.

§Parameters

dashboard: The Grafana dashboard to add the panel to
title: The title of the panel
query: The Prometheus query for the panel

§Returns

RiResult indicating success or failure

Source

pub fn add_gauge_panel( &self, dashboard: &mut RiGrafanaDashboard, title: &str, query: &str, ) -> RiResult<()>

Adds a gauge panel to a Grafana dashboard.

§Parameters

dashboard: The Grafana dashboard to add the panel to
title: The title of the panel
query: The Prometheus query for the panel

§Returns

RiResult indicating success or failure

Source

pub fn add_stat_panel( &self, dashboard: &mut RiGrafanaDashboard, title: &str, query: &str, ) -> RiResult<()>

Adds a stat panel to a Grafana dashboard.

§Parameters

dashboard: The Grafana dashboard to add the panel to
title: The title of the panel
query: The Prometheus query for the panel

§Returns

RiResult indicating success or failure

Source

pub fn generate_dashboard(&self, title: &str) -> RiResult<RiGrafanaDashboard>

Generates a Grafana dashboard with default panels.

§Parameters

title: The title of the dashboard

§Returns

A Grafana dashboard with default panels wrapped in RiResult

Source

pub fn generate_default_dashboard(&self) -> RiResult<RiGrafanaDashboard>

Generates a default Grafana dashboard with “Ri Metrics Dashboard” title.

§Returns

A default Grafana dashboard wrapped in RiResult

Trait Implementations§

Source §

impl Clone for RiPrometheusExporter

Source §

fn clone(&self) -> RiPrometheusExporter

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Source §

impl Debug for RiPrometheusExporter

Source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for RiPrometheusExporter

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §