Skip to content

Commit 85e6a99

Browse files
Improve documentation of collected data (#10)
1 parent e2797a4 commit 85e6a99

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

cmd/envcheckctl/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,38 +45,38 @@ agentRestarts
4545
agentStatus
4646
- "Running"=13
4747

48-
# Lists the distribution of helm chart versions and number of pods
48+
# Chart versions indicates the distribution of chart versions throughout the cluster. A discrepancy in this can be indicative of an incomplete rollout and explain inconsistencies in collection across hosts.
4949
chartVersions
5050
- "1.2.45"=13
5151

52-
# Distribution of cniPlugin
53-
cniPlugins
52+
# CNI Plugins can indicate potential factors that impact network routing and policy. In particular this can effect the routing of trace to local agents and the collection of various metrics by agent.
53+
cniPlugins
5454
- "cilium"=19
5555

56-
# Distribution of container Runtimes
56+
# Container runtimes provides insight into what container runtimes are in use in the cluster and can be used as a point of investigation relating to container metrics.
5757
containerRuntimes
5858
- "containerd://1.6.6"=19
5959

60-
# Distribution of nodes types
60+
# Node types provides insight into the size of nodes used in the cluster. Particularly small nodes (e.g. 4-8GB) can be an indicator as to why the agent may not be running or has a high restart rate due to OOMKill.
6161
instanceTypes
6262
- "c5.12xlarge"=4
6363
- "m5.4xlarge"=9
6464
- "m5.large"=3
6565
- "m5.xlarge"=3
6666

67-
# Distribution of kernels on nodes
67+
# Kernel versions can provide insights into potential known issues such as container throttling behaviour.
6868
kernels
6969
- "5.4.231-137.341.amzn2.x86_64"=19
7070

71-
# Distribution of kubelets on nodes
71+
# Kubelet lets us know that the cluster is aligned and consistent in it's release.
7272
kubelet
7373
- "v1.22.17-eks-48e63af"=19
7474

75-
# Distribution of os images on nodes
75+
# OS Images informs us on the OS and can indicate packages and standard security configuration.
7676
osImages
7777
- "Amazon Linux 2"=19
7878

79-
# Distribution of pods statuses
79+
# Pods statuses inform us how many pods are not in a state other than running
8080
podStatus
8181
- "Running"=256
8282

@@ -90,11 +90,11 @@ zones
9090
- "eu-central-1b"=5
9191
- "eu-central-1c"=8
9292

93-
# Distribution of configmaps linked to pods
93+
# Configmaps linked to pods informs if pods are appropriately linked to pods
9494
linkedConfigMaps
9595
- "instana-agent/instana-agent"=13
9696

97-
# Distribution of pods to owner types
97+
# Pod owners can give insights into pods not properly linked to workflows or discrepancy of number of replicas
9898
owners
9999
- "DaemonSet"=155
100100
- "ReplicaSet"=88

0 commit comments

Comments
 (0)