Skip to content

Commit

Permalink
[docs] Add status header for dockerstats receiver (#10451)
Browse files Browse the repository at this point in the history
* Add status header for dockerstats receiver

* apply reviewer's suggestion
  • Loading branch information
Frapschen authored Jun 17, 2022
1 parent 14366bf commit 9c4039e
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions receiver/dockerstatsreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# Docker Stats Receiver

| Status | |
| ------------------------ |-----------|
| Stability | [alpha] |
| Supported pipeline types | metrics |
| Distributions | [contrib] |

The Docker Stats receiver queries the local Docker daemon's container stats API for
all desired running containers on a configured interval. These stats are for container
resource usage of cpu, memory, network, and the
[blkio controller](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt).

Supported pipeline types: metrics

> :information_source: Requires Docker API version 1.22+ and only Linux is supported.
## Configuration
Expand Down Expand Up @@ -58,3 +62,6 @@ receivers:
The full list of settings exposed for this receiver are documented [here](./config.go)
with detailed sample configurations [here](./testdata/config.yaml).
[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

0 comments on commit 9c4039e

Please sign in to comment.