Skip to main content

DockerDebugInfo

Struct DockerDebugInfo 

Source
pub struct DockerDebugInfo {
    pub all_containers: Result<String, String>,
    pub ssh_images: Result<String, String>,
    pub ssh_containers: Result<Vec<ContainerInfo>, String>,
    pub port_usage: Result<Vec<String>, String>,
    /* private fields */
}
Expand description

Debug information collected about Docker containers

This struct holds structured information about Docker state for troubleshooting SSH server container issues. Each field contains either successfully collected data or an error message explaining what went wrong.

Fields§

§all_containers: Result<String, String>

Output from docker ps -a listing all containers

§ssh_images: Result<String, String>

Docker images matching the SSH server image name

§ssh_containers: Result<Vec<ContainerInfo>, String>

Information about containers using the SSH server image

§port_usage: Result<Vec<String>, String>

Port usage information for the SSH port

Implementations§

Source§

impl DockerDebugInfo

Source

pub fn new( docker: Arc<DockerClient>, container_port: u16, image_name: &str, image_tag: &str, ) -> Self

Create a new DockerDebugInfo and collect all diagnostic information

This constructor runs various Docker commands to gather diagnostic information when SSH connectivity tests fail. It collects container status, logs, and port usage information.

§Arguments
  • docker - Docker client for executing commands
  • container_port - The host port that the SSH container is mapped to
  • image_name - Image name to filter by (e.g., “torrust-ssh-server”)
  • image_tag - Image tag to filter by (e.g., “latest”)
§Returns

A DockerDebugInfo struct containing all collected information. Each field is a Result that either contains the successfully collected data or an error message explaining what went wrong.

§Example
use std::sync::Arc;
use torrust_tracker_deployer_lib::adapters::docker::DockerClient;
use torrust_tracker_deployer_lib::testing::integration::ssh_server::DockerDebugInfo;

let docker = Arc::new(DockerClient::new());
let debug_info = DockerDebugInfo::new(docker, 2222, "torrust-ssh-server", "latest");
debug_info.print();
Source

pub fn docker(&self) -> &Arc<DockerClient>

Get a reference to the Docker client

This allows access to the underlying Docker client for additional operations if needed after debug info has been collected.

Source

pub fn print(&self)

Print the debug information in a formatted way

Prints all collected debug information to stdout in a human-readable format.

Trait Implementations§

Source§

impl Debug for DockerDebugInfo

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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<U> 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§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> IntoResult<T> for T

Source§

type Err = !

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more