Sysdig Documentation

Containers

container.count

The number of containers in the infrastructure.

Metadata

Description

Metric Type

Gauge

Value Type

Integer

Segment By

Host, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider

Default Time Aggregation

Rate

Available Time Aggregation Formats

Avg, Rate, Sum, Min, Max

Default Group Aggregation

Average

Available Time Aggregation Formats

Avg, Sum, Min, Max

container.id

The container's identifier.

Note

For Docker containers, this value is a 12 digit hex number.

Metadata

Description

Metric Type

Gauge

Value Type

String

Segment By

Container

Default Time Aggregation

N/A

Available Time Aggregation Formats

N/A

Default Group Aggregation

N/A

Available Time Aggregation Formats

N/A

container.image

The name of the image used to run the container.

Metadata

Description

Metric Type

Gauge

Value Type

String

Segment By

Container

Default Time Aggregation

N/A

Available Time Aggregation Formats

N/A

Default Group Aggregation

N/A

Available Time Aggregation Formats

N/A

container.name

The name of the container.

Metadata

Description

Metric Type

Gauge

Value Type

String

Segment By

Container

Default Time Aggregation

N/A

Available Time Aggregation Formats

N/A

Default Group Aggregation

N/A

Available Time Aggregation Formats

N/A

container.type

The type of container (for example, Docker, LXC, or Mesos).

Metadata

Description

Metric Type

Gauge

Value Type

String

Segment By

Container

Default Time Aggregation

N/A

Available Time Aggregation Formats

N/A

Default Group Aggregation

N/A

Available Time Aggregation Formats

N/A

cpu.quota.used.percent

The percentage of CPU quota a container actually used over a defined period of time.

Note

A container can only spend its quota of time on CPU cycles across a given time period. The default time period is 100ms.

Note

CPU quotas are a common way of creating a CPU limit for a container.

Note

Unlike CPU shares, CPU quota is a hard limit for the amount of CPU the container can use. For this reason, the CPU quota should not exceed 100%.

Metadata

Description

Metric Type

Gauge

Value Type

%

Segment By

Host, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider

Default Time Aggregation

Average

Available Time Aggregation Formats

Avg, Rate, Sum, Min, Max

Default Group Aggregation

Average

Available Time Aggregation Formats

Avg, Sum, Min, Max

cpu.shares.count

The amount of CPU shares assigned to the container's cgroup. CPU shares represent a relative weight used by the kernel to distribute CPU cycles across different containers. Each container receives its own allocation of CPU cycles, based on the ratio of share allocation for the container versus the total share allocation for all containers. For example, if an environment has three containers, each with 1024 shares, then each will receive 1/3 of the CPU cycles.

Note

The default value for a container is 1024.

Note

Defining a CPU shares count is a common way to create a CPU limit for a container.

Note

The CPU shares count is not a hard limit. A container can consume more than its allocation, as long as the CPU has cycles that are not being consumed by the container they were originally allocated to.

Metadata

Description

Metric Type

Gauge

Value Type

Integer

Segment By

Host, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider

Default Time Aggregation

Rate

Available Time Aggregation Formats

Avg, Rate, Sum, Min, Max

Default Group Aggregation

Average

Available Time Aggregation Formats

Avg, Sum, Min, Max

cpu.shares.used.percent

The percentage of a container's allocated CPU shares that are used. CPU shares are a common way of creating a CPU limit for a container, as they represent a relative weight used by the kernel to distribute CPU cycles across different containers. Each container receives its own allocation of CPU cycles, according to the ratio of share count vs the total number of shares claimed by all containers. For example, in an infrastructure with three containers, each with 1024 shares, each container receives 1/3 of the CPU cycles.

Note

A container can use more CPU cycles than allocated, if the CPU has cycles that are not being consumed by the container they were originally allocated to. This means that the value of cpu.shares.used.percent can exceed 100%.

Note

The default value for a container is 1024.

Metadata

Description

Metric Type

Gauge

Value Type

%

Segment By

Host, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider

Default Time Aggregation

Average

Available Time Aggregation Formats

Avg, Rate, Sum, Min, Max

Default Group Aggregation

Average

Available Time Aggregation Formats

Avg, Sum, Min, Max

memory.limit.bytes

The RAM limit assigned to a container. The default value is 0.

Metadata

Description

Metric Type

Gauge

Value Type

Byte

Segment By

Host, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider

Default Time Aggregation

Rate

Available Time Aggregation Formats

Avg, Rate, Sum, Min, Max

Default Group Aggregation

Average

Available Time Aggregation Formats

Avg, Sum, Min, Max

memory.limit.used.percent

The percentage of the memory limit used by a container.

Metadata

Description

Metric Type

Gauge

Value Type

%

Segment By

Host, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider

Default Time Aggregation

Average

Available Time Aggregation Formats

Avg, Rate, Sum, Min, Max

Default Group Aggregation

Average

Available Time Aggregation Formats

Avg, Sum, Min, Max

swap.limit.bytes

The swap limit assigned to a container.

Metadata

Description

Metric Type

Gauge

Value Type

Byte

Segment By

Host, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider

Default Time Aggregation

Rate

Available Time Aggregation Formats

Avg, Rate, Sum, Min, Max

Default Group Aggregation

Average

Available Time Aggregation Formats

Avg, Sum, Min, Max

swap.limit.used.percent

The percentage of swap limit used by the container.

Metadata

Description

Metric Type

Gauge

Value Type

%

Segment By

Host, Container, Process, Kubernetes, Mesos, Swarm, CloudProvider

Default Time Aggregation

Average

Available Time Aggregation Formats

Avg, Rate, Sum, Min, Max

Default Group Aggregation

Average

Available Time Aggregation Formats

Avg, Sum, Min, Max