Struct PrometheusConfig 

pub struct PrometheusConfig { /* private fields */ }

Prometheus metrics collection configuration

Configures how Prometheus scrapes metrics from the tracker. When present in environment configuration, Prometheus service is enabled. When absent, Prometheus service is disabled.

Example

use std::num::NonZeroU32;
use torrust_tracker_deployer_lib::domain::prometheus::PrometheusConfig;

let interval = NonZeroU32::new(15).expect("15 is non-zero");
let config = PrometheusConfig::new(interval);

Default Behavior

• Default scrape interval: 15 seconds
• Minimum: 1 second (to avoid zero or negative values)

Implementations

impl PrometheusConfig

pub const fn new(scrape_interval_in_secs: NonZeroU32) -> Self

Creates a new Prometheus configuration with the specified scrape interval

Arguments

• scrape_interval_in_secs - Non-zero interval in seconds

Examples

use std::num::NonZeroU32;
use torrust_tracker_deployer_lib::domain::prometheus::PrometheusConfig;

let interval = NonZeroU32::new(30).expect("30 is non-zero");
let config = PrometheusConfig::new(interval);
assert_eq!(config.scrape_interval_in_secs(), 30);

pub fn scrape_interval_in_secs(&self) -> u32

Returns the scrape interval in seconds

The value is guaranteed to be non-zero.

pub fn docker_image() -> DockerImage

Returns the Docker image used for the Prometheus service.

This is a pinned constant — not user-configurable.

Examples

use torrust_tracker_deployer_lib::domain::prometheus::PrometheusConfig;

let image = PrometheusConfig::docker_image();
assert_eq!(image.full_reference(), "prom/prometheus:v3.11.2");

Trait Implementations

impl Clone for PrometheusConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrometheusConfig

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

Formats the value using the given formatter.

impl Default for PrometheusConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PrometheusConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PrometheusConfig

impl NetworkDerivation for PrometheusConfig

fn derive_networks(&self, enabled_services: &EnabledServices) -> Vec<Network>

Derives network assignments for the Prometheus service

Implements NET-04 and NET-05:

• NET-04: Metrics network always (to scrape tracker)
• NET-05: Visualization network if Grafana enabled

impl PartialEq for PrometheusConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PortDerivation for PrometheusConfig

fn derive_ports(&self) -> Vec<PortBinding>

Derives port bindings for Prometheus

Implements PORT-10: Prometheus 9090 on localhost only

Prometheus is bound to localhost to prevent external access. Grafana accesses it via Docker network (http://prometheus:9090).

impl Serialize for PrometheusConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PrometheusConfig

impl TryFrom<PrometheusSection> for PrometheusConfig

type Error = CreateConfigError

The type returned in the event of a conversion error.

fn try_from(section: PrometheusSection) -> Result<Self, Self::Error>

Performs the conversion.