package containerd.api

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Check (grpc.health.v1.HealthCheckRequest, grpc.health.v1.HealthCheckResponse)

  api.proto:38

• rpc IsReady (grpc.health.v1.HealthCheckRequest, grpc.health.v1.HealthCheckResponse)

  api.proto:42

• rpc ListMetrics (ListMetricsRequest, ListMetricsResponse)

  api.proto:10

  message ListMetricsRequest

  api.proto:47

  (message has no fields)

• rpc RegisterCollectors (RegisterCollectorsRequest, RegisterCollectorsResponse)

  api.proto:14

  message RegisterCollectorsRequest

  api.proto:22

  • repeated Collector collectors = 1

  • string source = 2

  • string fromPod = 3

  message RegisterCollectorsResponse

  api.proto:33

  • repeated string ipAddresses = 1

• rpc PushMetrics (stream ListMetricsResponse, stream ConfigurePush)

  api.proto:120

  message ConfigurePush

  api.proto:124

  (message has no fields)

Used in: RegisterCollectorsRequest

• string ipAddress = 1

• string podName = 2

nextID: 39

Used in: ListMetricsResponse

• string containerID = 1

• string podUID = 2

• string containerName = 12

• string podName = 13

• string namespaceName = 14

• repeated int64 cpuCoresNanoSec = 3

• repeated int64 memoryBytes = 4

• repeated int64 cpuThrottledNanoSec = 7

• repeated float cpuPercentPeriodsThrottled = 8

• repeated int64 cpuPeriodsSec = 9

• repeated int64 cpuThrottledPeriodsSec = 10

• string nodeName = 11

• int64 avgCPUCoresNanoSec = 15

• int64 avgMemoryBytes = 16

• int64 oomCount = 17

• int64 oomKillCount = 18

• float avgCPUPercentPeriodsThrottled = 19

• int64 avgCPUThrottledNanoSec = 20

• int64 avgCPUPeriodsSec = 21

• int64 avgCPUThrottledPeriodsSec = 22

• repeated int64 networkRxBytes = 23

• repeated int64 networkRxPackets = 24

• repeated int64 networkRxErrors = 25

• repeated int64 networkRxDropped = 26

• repeated int64 networkTxBytes = 27

• repeated int64 networkTxPackets = 28

• repeated int64 networkTxErrors = 29

• repeated int64 networkTxDropped = 30

• int64 avgNetworkRxBytes = 31

• int64 avgNetworkRxPackets = 32

• int64 avgNetworkRxErrors = 33

• int64 avgNetworkRxDropped = 34

• int64 avgNetworkTxBytes = 35

• int64 avgNetworkTxPackets = 36

• int64 avgNetworkTxErrors = 37

• int64 avgNetworkTxDropped = 38

"repeated double bucketCounts" represents an array of N numbers from bucketCounts[0] to bucketCounts[N-1]. With i starting at 0, ending at N-1, BucketCounts defines N buckets, where bucket[i].startBound = base ^ (i + exponentOffset) bucket[i].endBound = base ^ (i + 1 + exponentOffset) bucket[i].count = bucketCounts[i]

Used in: ExponentialBuckets

• sint32 exponentOffset = 1

  offset may be negative.

• repeated int64 bucketCounts = 2

Used in: Metric

• double base = 1

• sint32 baseScale = 2

• int64 zeroCount = 3

  Count of values exactly at zero.

• double maxValue = 4

  Max value in this histogram

• optional ExponentialBucketCounts counts = 5

Used as request type in: MetricsCollector.PushMetrics

Used as response type in: Metrics.ListMetrics

• repeated ContainerMetrics containers = 1

• optional NodeMetrics node = 2

• string nodeName = 3

• string podName = 4

• optional google.protobuf.Timestamp timestamp = 5

• string reason = 6

Metric stores a metric sample for a single object + source type

Used in: Sample

• string source = 1

  source is the source of the metric data e.g. utilization, requests

• string resourceType = 2

  resourceType is the type of compute resource the values represent e.g. cpu, memory

• repeated double values = 3

  values are the sample values

• optional ExponentialBuckets histogram = 4

  use histogram instead of values

Used in: NodeMetrics

• string aggregationLevel = 1

• repeated int64 cpuCoresNanoSec = 2

• repeated int64 memoryBytes = 3

• int64 avgCPUCoresNanoSec = 4

• int64 avgMemoryBytes = 5

Used in: ListMetricsResponse

• repeated NodeAggregatedMetrics aggregatedMetrics = 1

Sample stores a set of capacity metric samples for a single object

Used in: SampleList

• map<string, string> labels = 2

  labels are the labels specific to object this sample is for e.g. the exported_container

• repeated Metric values = 3

  values are the metric values for different source types

• string level = 4

• string operation = 5

• string source = 6

SampleList stores a collection of capacity metric samples

Used in: ScrapeResult

• string type = 1

  type is the type of object the samples are for

• optional google.protobuf.Timestamp timestamp = 2

  timestamp is the time the samples were taken

• repeated Sample items = 3

  items are the samples for each object

• string name = 4

  name is set by aggregated metrics in the level retentionName field

• string metricName = 5

  metricName is set if this is from an aggregated metric exported to prometheus

• string clusterName = 6

  clusterName is the name of the cluster

• repeated SampleList items = 1