diff --git a/internal/collector/containermetricsreceiver/README.md b/internal/collector/containermetricsreceiver/README.md index ad09ab5822..b5dcec121f 100644 --- a/internal/collector/containermetricsreceiver/README.md +++ b/internal/collector/containermetricsreceiver/README.md @@ -16,3 +16,13 @@ containermetrics: collection_interval: # default = 1m initial_delay: # default = 1s ``` + +The available scrapers are: + +| Scraper | Supported OSs | Description | +| ------------ | ---------------------------- | ------------------------------------------------------ | +| [cpu] | All | CPU utilization metrics | +| [memory] | All | Memory utilization metrics | + +[cpu]: ./internal/scraper/cpuscraper/documentation.md +[memory]: ./internal/scraper/memoryscraper/documentation.md \ No newline at end of file diff --git a/internal/collector/containermetricsreceiver/documentation.md b/internal/collector/containermetricsreceiver/documentation.md deleted file mode 100644 index 90b182d765..0000000000 --- a/internal/collector/containermetricsreceiver/documentation.md +++ /dev/null @@ -1,33 +0,0 @@ -[comment]: <> (Code generated by mdatagen. DO NOT EDIT.) - -# containermetrics - -## Default Metrics - -The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: - -```yaml -metrics: - : - enabled: false -``` - -### system.memory.usage - -Bytes of memory in use. - -| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | -| ---- | ----------- | ---------- | ----------------------- | --------- | -| By | Sum | Int | Cumulative | false | - -#### Attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| state | Breakdown of memory usage by type. | Str: ``buffered``, ``cached``, ``inactive``, ``free``, ``slab_reclaimable``, ``slab_unreclaimable``, ``used`` | - -## Resource Attributes - -| Name | Description | Values | Enabled | -| ---- | ----------- | ------ | ------- | -| resource.id | The resource id. | Any Str | false |