docs(receiver/hostmetrics/process): update descriptions of OS-specifi…

…c metrics (#18051) The two metrics are Linux-only (not supported on Windows) but there was no mention of this in the documentation: - process.open_file_descriptors - process.context_switches I have added "This metric is only available on Linux" similar to what other Linux-only metrics have.
open-telemetry · Feb 24, 2023 · 4853ffa · 4853ffa
1 parent 13ca52d
commit 4853ffa
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 8 deletions.
diff --git a/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md
@@ -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 |
@@ -120,13 +122,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 |
 | ---- | ----------- | ---------- | ----------------------- | --------- |
@@ -140,7 +146,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 |
 | ---- | ----------- | ---------- | ----------------------- | --------- |

diff --git a/...ostmetricsreceiver/internal/scraper/processscraper/internal/metadata/generated_metrics.go b/...ostmetricsreceiver/internal/scraper/processscraper/internal/metadata/generated_metrics.go
diff --git a/...tricsreceiver/internal/scraper/processscraper/internal/metadata/generated_metrics_test.go b/...tricsreceiver/internal/scraper/processscraper/internal/metadata/generated_metrics_test.go
diff --git a/receiver/hostmetricsreceiver/internal/scraper/processscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/processscraper/metadata.yaml
@@ -127,7 +127,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
@@ -137,7 +138,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
@@ -156,6 +158,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
@@ -165,6 +168,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