Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions modules/smart-agent_system-diskio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,32 @@ Check the [Related documentation](#related-documentation) section for more detai

System disk weighted io usage detector is disabled by default. It may be useful in some specific cases where system disk io usage detector show usage above 100% because of multi-queued IOs due to device or driver, please enable it only if you understand what it implies. See [Linux kernel documentation](https://docs.kernel.org/admin-guide/iostats.html).

You must explicitely enable collection of those metrics on Agent:
- system.disk.io_time
- system.disk.weighted_io_time
You must explicitely enable collection of those metrics on your agent:
- disk io_time (when using IO usage detector)
- disk weighted_io_time (when using weighted IO usage detector which is disabled by default)

Otel Collector example: edit agent_config.yaml such as:
```
receivers:
[...]
# <hostmetrics> is the receiver producing system.disk.io_time and system.disk.weighted_io_time metrics
hostmetrics:
collection_interval: 10s
scrapers:
disk:
[...]
exporters:
[...]
include_metrics:
- metric_name: system.disk.io_time
- metric_name: system.disk.weighted_io_time
[...]
service:
pipelines:
metrics:
receivers: [hostmetrics, ...]
[...]
```


### Metrics
Expand Down
29 changes: 26 additions & 3 deletions modules/smart-agent_system-diskio/conf/readme.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,29 @@
source_doc: |
System disk weighted io usage detector is disabled by default. It may be useful in some specific cases where system disk io usage detector show usage above 100% because of multi-queued IOs due to device or driver, please enable it only if you understand what it implies. See [Linux kernel documentation](https://docs.kernel.org/admin-guide/iostats.html).

You must explicitely enable collection of those metrics on Agent:
- system.disk.io_time
- system.disk.weighted_io_time
You must explicitely enable collection of those metrics on your agent:
- disk io_time (when using IO usage detector)
- disk weighted_io_time (when using weighted IO usage detector which is disabled by default)

Otel Collector example: edit agent_config.yaml such as:
```
receivers:
[...]
# <hostmetrics> is the receiver producing system.disk.io_time and system.disk.weighted_io_time metrics
hostmetrics:
collection_interval: 10s
scrapers:
disk:
[...]
exporters:
[...]
include_metrics:
- metric_name: system.disk.io_time
- metric_name: system.disk.weighted_io_time
[...]
service:
pipelines:
metrics:
receivers: [hostmetrics, ...]
[...]
```
Loading