Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(receiver/hostmetrics/process): update descriptions of OS-specific metrics #18051

Merged
merged 1 commit into from
Feb 24, 2023
Merged

docs(receiver/hostmetrics/process): update descriptions of OS-specific metrics #18051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ metrics:

Number of times the process has been context switched.

This metric is only available on Linux.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {count} | Sum | Int | Cumulative | true |
Expand Down Expand Up @@ -136,13 +138,17 @@ Percentage of total physical memory that is used by the process.

Number of file descriptors in use by the process.

This metric is only available on Linux.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {count} | Sum | Int | Cumulative | false |

### process.paging.faults

Number of page faults the process has made. This metric is only available on Linux.
Number of page faults the process has made.

This metric is only available on Linux.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
Expand All @@ -156,7 +162,9 @@ Number of page faults the process has made. This metric is only available on Lin

### process.signals_pending

Number of pending signals for the process. This metric is only available on Linux.
Number of pending signals for the process.

This metric is only available on Linux.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
Expand Down
4 changes: 2 additions & 2 deletions ...ostmetricsreceiver/internal/scraper/processscraper/internal/metadata/generated_metrics.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions ...tricsreceiver/internal/scraper/processscraper/internal/metadata/generated_metrics_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions receiver/hostmetricsreceiver/internal/scraper/processscraper/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,8 @@ metrics:

process.paging.faults:
enabled: false
description: Number of page faults the process has made. This metric is only available on Linux.
description: Number of page faults the process has made.
extended_documentation: This metric is only available on Linux.
unit: "{faults}"
sum:
value_type: int
Expand All @@ -165,7 +166,8 @@ metrics:

process.signals_pending:
enabled: false
description: Number of pending signals for the process. This metric is only available on Linux.
description: Number of pending signals for the process.
extended_documentation: This metric is only available on Linux.
unit: "{signals}"
sum:
value_type: int
Expand All @@ -184,6 +186,7 @@ metrics:
process.open_file_descriptors:
enabled: false
description: Number of file descriptors in use by the process.
extended_documentation: This metric is only available on Linux.
unit: '{count}'
sum:
value_type: int
Expand All @@ -193,6 +196,7 @@ metrics:
process.context_switches:
enabled: false
description: Number of times the process has been context switched.
extended_documentation: This metric is only available on Linux.
unit: '{count}'
sum:
value_type: int
Expand Down