docker / docker/docs

Unit of measure is missing for metrics endpoints

Open
#19,642 1 comment 0 reactions 1 assignee View on GitHub

@dvdksn is already working on this.

Since Mar 16, 2024.

area/api area/engine lifecycle/frozen status/triage
Dominant language
Markdown
Stars
4.7k
Forks
8.5k
Avg merge
2d 18h
Merged PRs (30d)
108

Description

Is this a docs issue?
  • My issue is about the documentation content or website
Type of issue

I can't find what I'm looking for

Description

I'm looking for the unit of measure used by many metrics endpoints exposed by the docker engine and used my metric streaming components like telegraf.

In telegraf's own documentation, here you can see an example

docker_container_cpu

tags:
engine_host
server_version
container_image
container_name
container_status
container_version
cpu
fields:
throttling_periods
throttling_throttled_periods
throttling_throttled_time
usage_in_kernelmode
usage_in_usermode
usage_system
usage_total
usage_percent
container_id

these usages are all missing their unit of measure, and when I query the DB I get numbers I can't make sense of.
I then looked into the docker engine api and I am more confused: the latest mention of the usage_in_usermode endpoint is in v1.24, I couldn't find any mention in any more recent version.

And even in 1.24 docs, there is no mention of the unit of measure.

Maybe I anm missing something obvious here?

Location

https://docs.docker.com/engine/api/v1.24/

Suggestion

Create a specific page for metrics with all endpoints and their unit of measure

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.