Documentation

ContainerStats extends BaseEndpoint implements Endpoint Uses EndpointTrait

Interfaces, Classes and Traits

Endpoint

Table of Contents

$body  : mixed
$headerParameters  : mixed
$id  : mixed
$queryParameters  : mixed
__construct()  : mixed
This endpoint returns a live stream of a container’s resource usage.
getAuthenticationScopes()  : array<string|int, mixed>
Get security scopes of an endpoint.
getBody()  : array<string|int, mixed>
Get body for an endpoint.
getExtraHeaders()  : array<string|int, mixed>
getHeaders()  : array<string|int, mixed>
Get the headers of an endpoint.
getMethod()  : string
Get the HTTP method of an endpoint (like GET, POST, ...).
getQueryString()  : string
Get the query string of an endpoint without the starting ? (like foo=foo&bar=bar).
getUri()  : string
Get the URI of an endpoint (like /foo-uri).
parseResponse()  : mixed
getFormBody()  : array<string|int, mixed>
getFormOptionsResolver()  : OptionsResolver
getHeadersOptionsResolver()  : OptionsResolver
getMultipartBody()  : array<string|int, mixed>
getQueryOptionsResolver()  : OptionsResolver
getSerializedBody()  : array<string|int, mixed>
transformResponseBody()  : null

Properties

$headerParameters

protected mixed $headerParameters = []

Methods

__construct()

This endpoint returns a live stream of a container’s resource usage.

public __construct(string $id[, array<string|int, mixed> $queryParameters = [] ]) : mixed

statistics.

The precpu_stats is the CPU statistic of the previous read, and is used to calculate the CPU usage percentage. It is not an exact copy of the cpu_stats field.

If either precpu_stats.online_cpus or cpu_stats.online_cpus is nil then for compatibility with older daemons the length of the corresponding cpu_usage.percpu_usage array should be used.

To calculate the values shown by the stats command of the docker cli tool the following formulas can be used: used_memory = memory_stats.usage - memory_stats.stats.cache available_memory = memory_stats.limit Memory usage % = (used_memory / available_memory) * 100.0 cpu_delta = cpu_stats.cpu_usage.total_usage - precpu_stats.cpu_usage.total_usage system_cpu_delta = cpu_stats.system_cpu_usage - precpu_stats.system_cpu_usage number_cpus = lenght(cpu_stats.cpu_usage.percpu_usage) or cpu_stats.online_cpus CPU usage % = (cpu_delta / system_cpu_delta) * number_cpus * 100.0

Parameters
$id : string

ID or name of the container

$queryParameters : array<string|int, mixed> = []

{

@var bool $stream Stream the output. If false, the stats will be output once and then

it will disconnect.

}

Return values
mixed —

getAuthenticationScopes()

Get security scopes of an endpoint.

public getAuthenticationScopes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getBody()

Get body for an endpoint.

public getBody(SerializerInterface $serializer[, mixed $streamFactory = null ]) : array<string|int, mixed>

Return value consist of an array where the first item will be a list of headers to add on the request (like the Content Type) And the second value consist of the body object.

Parameters
$serializer : SerializerInterface
$streamFactory : mixed = null
Return values
array<string|int, mixed> —

getExtraHeaders()

public getExtraHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getHeaders()

Get the headers of an endpoint.

public getHeaders([array<string|int, mixed> $baseHeaders = [] ]) : array<string|int, mixed>
Parameters
$baseHeaders : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getMethod()

Get the HTTP method of an endpoint (like GET, POST, ...).

public getMethod() : string
Return values
string —

getQueryString()

Get the query string of an endpoint without the starting ? (like foo=foo&bar=bar).

public getQueryString() : string
Return values
string —

getUri()

Get the URI of an endpoint (like /foo-uri).

public getUri() : string
Return values
string —

parseResponse()

public parseResponse(ResponseInterface $response, SerializerInterface $serializer[, string $fetchMode = Client::FETCH_OBJECT ]) : mixed
Parameters
$response : ResponseInterface
$serializer : SerializerInterface
$fetchMode : string = Client::FETCH_OBJECT
Return values
mixed —

getFormBody()

protected getFormBody() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getFormOptionsResolver()

protected getFormOptionsResolver() : OptionsResolver
Return values
OptionsResolver —

getHeadersOptionsResolver()

protected getHeadersOptionsResolver() : OptionsResolver
Return values
OptionsResolver —

getMultipartBody()

protected getMultipartBody([mixed $streamFactory = null ]) : array<string|int, mixed>
Parameters
$streamFactory : mixed = null
Return values
array<string|int, mixed> —

getQueryOptionsResolver()

protected getQueryOptionsResolver() : OptionsResolver
Return values
OptionsResolver —

getSerializedBody()

protected getSerializedBody(SerializerInterface $serializer) : array<string|int, mixed>
Parameters
$serializer : SerializerInterface
Return values
array<string|int, mixed> —

Search results