Struct testcontainers_modules::victoria_metrics::VictoriaMetrics

pub struct VictoriaMetrics;

Available on crate feature victoria_metrics only.

Module to work with VictoriaMetrics inside of tests.

Starts an instance of single-node VictoriaMetrics.

This module is based on the official VictoriaMetrics docker image.

Example

use testcontainers_modules::{victoria_metrics, testcontainers::runners::SyncRunner};

let victoria_metrics_instance = victoria_metrics::VictoriaMetrics.start().unwrap();

let import_url = format!("http://127.0.0.1:{}/api/v1/import", victoria_metrics_instance.get_host_port_ipv4(8428).unwrap());
let export_url = format!("http://127.0.0.1:{}/api/v1/export", victoria_metrics_instance.get_host_port_ipv4(8428).unwrap());

// operate on the import and export URLs..

Trait Implementations

impl Debug for VictoriaMetrics

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

Formats the value using the given formatter.

impl Default for VictoriaMetrics

fn default() -> VictoriaMetrics

Returns the “default value” for a type.

impl Image for VictoriaMetrics

type Args = ()

A type representing the arguments for an Image.

fn name(&self) -> String

The name of the docker image to pull from the Docker Hub registry.

fn tag(&self) -> String

Implementations are encouraged to include a tag that will not change (i.e. NOT latest) in order to prevent test code from randomly breaking because the underlying docker suddenly changed.

fn ready_conditions(&self) -> Vec<WaitFor>

Returns a list of conditions that need to be met before a started container is considered ready.

fn env_vars(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_>

There are a couple of things regarding the environment variables of images:

fn mounts(&self) -> Box<dyn Iterator<Item = &Mount> + '_>

There are a couple of things regarding the mounts of images:

fn entrypoint(&self) -> Option<String>

Returns the entrypoint this instance was created with.

fn expose_ports(&self) -> Vec<u16>

Returns the ports that needs to be exposed when a container is created.

fn exec_after_start( &self, cs: ContainerState ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns the commands that needs to be executed after a container is started i.e. commands to be run in a running container.