review comments for doc

opsramp · Dec 12, 2024 · fee8075 · fee8075
1 parent 4a52368
commit fee8075
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 92 deletions.
diff --git a/deploy.yaml b/deploy.yaml
@@ -13,62 +13,62 @@ metadata:
   labels:
     app: otelcontribcol
 rules:
-- apiGroups:
-  - ""
-  resources:
-  - events
-  - namespaces
-  - namespaces/status
-  - nodes
-  - nodes/spec
-  - pods
-  - pods/status
-  - replicationcontrollers
-  - replicationcontrollers/status
-  - resourcequotas
-  - services
-  verbs:
-  - get
-  - list
-  - watch
-- apiGroups:
-  - apps
-  resources:
-  - daemonsets
-  - deployments
-  - replicasets
-  - statefulsets
-  verbs:
-  - get
-  - list
-  - watch
-- apiGroups:
-  - extensions
-  resources:
-  - daemonsets
-  - deployments
-  - replicasets
-  verbs:
-  - get
-  - list
-  - watch
-- apiGroups:
-  - batch
-  resources:
-  - jobs
-  - cronjobs
-  verbs:
-  - get
-  - list
-  - watch
-- apiGroups:
-    - autoscaling
-  resources:
-    - horizontalpodautoscalers
-  verbs:
-    - get
-    - list
-    - watch
+  - apiGroups:
+      - ""
+    resources:
+      - events
+      - namespaces
+      - namespaces/status
+      - nodes
+      - nodes/spec
+      - pods
+      - pods/status
+      - replicationcontrollers
+      - replicationcontrollers/status
+      - resourcequotas
+      - services
+    verbs:
+      - get
+      - list
+      - watch
+  - apiGroups:
+      - apps
+    resources:
+      - daemonsets
+      - deployments
+      - replicasets
+      - statefulsets
+    verbs:
+      - get
+      - list
+      - watch
+  - apiGroups:
+      - extensions
+    resources:
+      - daemonsets
+      - deployments
+      - replicasets
+    verbs:
+      - get
+      - list
+      - watch
+  - apiGroups:
+      - batch
+    resources:
+      - jobs
+      - cronjobs
+    verbs:
+      - get
+      - list
+      - watch
+  - apiGroups:
+      - autoscaling
+    resources:
+      - horizontalpodautoscalers
+    verbs:
+      - get
+      - list
+      - watch
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding
@@ -81,9 +81,9 @@ roleRef:
   kind: ClusterRole
   name: otelcontribcol
 subjects:
-- kind: ServiceAccount
-  name: otelcontribcol
-  namespace: default
+  - kind: ServiceAccount
+    name: otelcontribcol
+    namespace: default
 ---
 apiVersion: apps/v1
 kind: Deployment
@@ -101,24 +101,15 @@ spec:
       labels:
         app: otelcontribcol
     spec:
-      volumes:
-        - name: host-proc
-          hostPath:
-            path: /proc
-            type: Directory
-      hostPID: true
       serviceAccountName: otelcontribcol
       containers:
-      - name: otelcontribcol
-        image: docker.io/mithunbs/otelcontibcol
-        imagePullPolicy: IfNotPresent
-        ports:
-        - containerPort: 4317
-        - containerPort: 4318
-        - containerPort: 55680
-        - containerPort: 8888
-        command: ["/usr/bin/tail"]
-        args: ["-f", "/dev/null"]
-        volumeMounts:
-          - name: host-proc
-            mountPath: /host/proc
+        - name: otelcontribcol
+          image: docker.io/mithunbs/otelcontibcol
+          imagePullPolicy: IfNotPresent
+          ports:
+            - containerPort: 4317
+            - containerPort: 4318
+            - containerPort: 55680
+            - containerPort: 8888
+          command: ["/usr/bin/tail"]
+          args: ["-f", "/dev/null"]
diff --git a/receiver/hostmetricsreceiver/README.md b/receiver/hostmetricsreceiver/README.md
@@ -38,19 +38,19 @@ hostmetrics:
 
 The available scrapers are:
 
-| Scraper        | Supported OSs                | Description                                            |
-|----------------| ---------------------------- |--------------------------------------------------------|
-| [cpu]          | All except Mac<sup>[1]</sup> | CPU utilization metrics                                |
-| [disk]         | All except Mac<sup>[1]</sup> | Disk I/O metrics                                       |
-| [load]         | All                          | CPU load metrics                                       |
-| [filesystem]   | All                          | File System utilization metrics                        |
-| [memory]       | All                          | Memory utilization metrics                             |
-| [network]      | All                          | Network interface I/O metrics & TCP connection metrics |
-| [paging]       | All                          | Paging/Swap space utilization and I/O metrics          |
-| [processes]    | Linux, Mac                   | Process count metrics                                  |
-| [process]      | Linux, Windows, Mac          | Per process CPU, Memory, and Disk I/O metrics          |
-| [system]       | Linux, Windows, Mac          | Miscellaneous system metrics                           |
-| [groupprocess] | Linux, Windows, Mac          | Per process group CPU, Memory, and Disk I/O metrics    |
+| Scraper        | Supported OSs                | Description                                                                                 |
+|----------------| ---------------------------- |---------------------------------------------------------------------------------------------|
+| [cpu]          | All except Mac<sup>[1]</sup> | CPU utilization metrics                                                                     |
+| [disk]         | All except Mac<sup>[1]</sup> | Disk I/O metrics                                                                            |
+| [load]         | All                          | CPU load metrics                                                                            |
+| [filesystem]   | All                          | File System utilization metrics                                                             |
+| [memory]       | All                          | Memory utilization metrics                                                                  |
+| [network]      | All                          | Network interface I/O metrics & TCP connection metrics                                      |
+| [paging]       | All                          | Paging/Swap space utilization and I/O metrics                                               |
+| [processes]    | Linux, Mac                   | Process count metrics                                                                       |
+| [process]      | Linux, Windows, Mac          | Per process CPU, Memory, and Disk I/O metrics                                               |
+| [system]       | Linux, Windows, Mac          | Miscellaneous system metrics                                                                |
+| [groupprocess] | Linux, Windows, Mac          | Aggregated metrics of all processes of group - CPU, Memory, Threads, Open FD, Process Count |
 
 [cpu]: ./internal/scraper/cpuscraper/documentation.md
 [disk]: ./internal/scraper/diskscraper/documentation.md
@@ -162,7 +162,9 @@ receivers:
 ```
 In this example, the groupprocessscraper is configured to scrape metrics for processes that match the specified comm, exe, and cmdline criteria. The group_name is used to identify the group of processes being monitored.
 For `comm` and `exe`, the list of strings is an `OR`, meaning any process matching any of the strings will be added to the process group.
-For `cmdline`, the list of regexes is an `AND`, meaning they all must match.
+For `cmdline`, the list of regexes is an `AND`, meaning they all must match. <br />
+
+**Note:** If more than one out of `comm`, `exe` and `cmdline` selectors are given then all of them has to match. If a process matches to one group, the same process will not be part of other groups.
 
 ## Advanced Configuration