You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wa...@apache.org on 2022/04/10 04:50:20 UTC
[skywalking] branch master updated: Update doc and fix some UI nits (#8842)
This is an automated email from the ASF dual-hosted git repository.
wankai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new f4c401529c Update doc and fix some UI nits (#8842)
f4c401529c is described below
commit f4c401529c10e66319d1e317c01df7e58b8d4988
Author: Wan Kai <wa...@foxmail.com>
AuthorDate: Sun Apr 10 12:50:13 2022 +0800
Update doc and fix some UI nits (#8842)
---
docs/en/changes/changes.md | 2 +-
docs/en/setup/backend/backend-k8s-monitoring.md | 14 +--
docs/en/setup/backend/backend-telemetry.md | 4 +-
.../general/general-instance.json | 102 +++++++++------------
4 files changed, 54 insertions(+), 68 deletions(-)
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index 2cb32248eb..6016ca19b4 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -7,7 +7,7 @@
#### UI
-
+* General service instance: move `Thread Pool` from JVM to Overview, fix `JVM GC Count` calculation.
#### Documentation
diff --git a/docs/en/setup/backend/backend-k8s-monitoring.md b/docs/en/setup/backend/backend-k8s-monitoring.md
index 3785ff585e..b1bf085c07 100644
--- a/docs/en/setup/backend/backend-k8s-monitoring.md
+++ b/docs/en/setup/backend/backend-k8s-monitoring.md
@@ -1,4 +1,4 @@
-# K8s monitoring
+# Kubernetes (K8s) monitoring
SkyWalking leverages K8s kube-state-metrics and cAdvisor for collecting metrics data from K8s, and leverages OpenTelemetry Collector to transfer the metrics to
[OpenTelemetry receiver](opentelemetry-receiver.md) and into the [Meter System](./../../concepts-and-designs/meter.md). This feature requires authorizing the OAP Server to access K8s's `API Server`.
@@ -14,11 +14,11 @@ SkyWalking leverages K8s kube-state-metrics and cAdvisor for collecting metrics
For a quick start, we have provided a full example of configuration and recommended version , you can refer to [showcase](https://github.com/apache/skywalking-showcase/tree/main/deploy/platform/kubernetes/feature-kubernetes-monitor).
4. Config SkyWalking [OpenTelemetry receiver](opentelemetry-receiver.md).
-## K8s Cluster Monitoring
-K8s cluster monitoring provide monitoring of the status and resources of the K8S Cluster, including the whole
+## Kubernetes Cluster Monitoring
+K8s cluster monitoring provide monitoring of the status and resources of the K8s Cluster, including the whole
cluster and each node. K8s cluster as a `Service` in OAP, K8s node as a `Instance` in OAP, and land on the `Layer: K8S`.
-### K8s Cluster Supported Metrics
+### Kubernetes Cluster Supported Metrics
| Monitoring Panel | Unit | Metric Name | Description | Data Source |
|-----|------|-----|-----|-----|
| Node Total | | k8s_cluster_node_total | The number of nodes | K8s kube-state-metrics|
@@ -38,7 +38,7 @@ cluster and each node. K8s cluster as a `Service` in OAP, K8s node as a `Instanc
| Pod Status Waiting | | k8s_cluster_pod_status_waiting | The pods and containers which are currently in the waiting status, with reasons shown | K8s kube-state-metrics|
| Pod Status Terminated | | k8s_cluster_container_status_terminated | The pods and containers which are currently in the terminated status, with reasons shown | K8s kube-state-metrics|
-### K8s Cluster Node Supported Metrics
+### Kubernetes Cluster Node Supported Metrics
| Monitoring Panel | Unit | Metric Name | Description | Data Source |
|-----|------|-----|-----|-----|
| Pod Total | | k8s_node_pod_total | The number of pods in this node | K8s kube-state-metrics |
@@ -50,11 +50,11 @@ cluster and each node. K8s cluster as a `Service` in OAP, K8s node as a `Instanc
| Memory Usage | Gi | k8s_node_memory_usage | The totaly memory usage | cAdvisor |
| Network I/O| KB/s | k8s_node_network_receive<br />k8s_node_network_transmit | The network receive and transmit | cAdvisor |
-## K8s Service Monitoring
+## Kubernetes Service Monitoring
K8s Service Monitoring provide observe service status and resources from Kubernetes.
K8s Service as a `Service` in OAP and land on the `Layer: K8S_SERVICE`.
-### K8s Service Supported Metrics
+### Kubernetes Service Supported Metrics
| Monitoring Panel | Unit | Metric Name | Description | Data Source |
|-----|-----|-----|-----|-----|
| Service Pod Total | | k8s_service_pod_total | The number of pods | K8s kube-state-metrics |
diff --git a/docs/en/setup/backend/backend-telemetry.md b/docs/en/setup/backend/backend-telemetry.md
index 06178952d9..bc57a6ee94 100644
--- a/docs/en/setup/backend/backend-telemetry.md
+++ b/docs/en/setup/backend/backend-telemetry.md
@@ -90,8 +90,8 @@ staticConfig:
service: oap-server
...
```
-### Service discovery (k8s)
-If you deploy an oap-server cluster on k8s, the oap-server instance (pod) would not have a static IP or hostname. We can leverage [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) to discover the oap-server instance, and scrape & transfer the metrics to OAP [OpenTelemetry receiver](opentelemetry-receiver.md).
+### Service discovery on Kubernetes
+If you deploy an oap-server cluster on Kubernetes, the oap-server instance (pod) would not have a static IP or hostname. We can leverage [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/getting-started/#kubernetes) to discover the oap-server instance, and scrape & transfer the metrics to OAP [OpenTelemetry receiver](opentelemetry-receiver.md).
On how to install SkyWalking on k8s, you can refer to [Apache SkyWalking Kubernetes](https://github.com/apache/skywalking-kubernetes).
diff --git a/oap-server/server-starter/src/main/resources/ui-initialized-templates/general/general-instance.json b/oap-server/server-starter/src/main/resources/ui-initialized-templates/general/general-instance.json
index e159f7dccb..8432eb46df 100644
--- a/oap-server/server-starter/src/main/resources/ui-initialized-templates/general/general-instance.json
+++ b/oap-server/server-starter/src/main/resources/ui-initialized-templates/general/general-instance.json
@@ -37,7 +37,7 @@
"metricTypes": [
""
],
- "activedTabIndex": 4,
+ "activedTabIndex": 3,
"children": [
{
"name": "Overview",
@@ -151,6 +151,32 @@
"readLabeledMetricsValues"
],
"moved": false
+ },
+ {
+ "x": 0,
+ "y": 27,
+ "w": 12,
+ "h": 14,
+ "i": "16",
+ "type": "Widget",
+ "widget": {
+ "title": "Thread Pool"
+ },
+ "graph": {
+ "type": "Line",
+ "step": false,
+ "smooth": false,
+ "showSymbol": false,
+ "showXAxis": true,
+ "showYAxis": true
+ },
+ "metrics": [
+ "meter_thread_pool"
+ ],
+ "metricTypes": [
+ "readLabeledMetricsValues"
+ ],
+ "moved": false
}
]
},
@@ -206,9 +232,9 @@
"name": "JVM",
"children": [
{
- "x": 6,
+ "x": 8,
"y": 0,
- "w": 6,
+ "w": 8,
"h": 13,
"i": "5",
"type": "Widget",
@@ -252,35 +278,9 @@
]
},
{
- "x": 18,
+ "x": 8,
"y": 13,
- "w": 6,
- "h": 13,
- "i": "16",
- "type": "Widget",
- "widget": {
- "title": "Thread Pool"
- },
- "graph": {
- "type": "Line",
- "step": false,
- "smooth": false,
- "showSymbol": false,
- "showXAxis": true,
- "showYAxis": true
- },
- "metrics": [
- "meter_thread_pool"
- ],
- "metricTypes": [
- "readLabeledMetricsValues"
- ],
- "moved": false
- },
- {
- "x": 0,
- "y": 13,
- "w": 6,
+ "w": 8,
"h": 13,
"i": "12",
"type": "Widget",
@@ -308,9 +308,9 @@
"moved": false
},
{
- "x": 6,
+ "x": 16,
"y": 13,
- "w": 6,
+ "w": 8,
"h": 13,
"i": "13",
"type": "Widget",
@@ -321,7 +321,6 @@
"type": "Bar",
"showBackground": true
},
- "standard": {},
"metrics": [
"instance_jvm_thread_timed_waiting_state_thread_count",
"instance_jvm_thread_blocked_state_thread_count",
@@ -339,7 +338,7 @@
{
"x": 0,
"y": 0,
- "w": 6,
+ "w": 8,
"h": 13,
"i": "14",
"type": "Widget",
@@ -363,10 +362,10 @@
"moved": false
},
{
- "x": 12,
- "y": 13,
- "w": 6,
- "h": 13,
+ "x": 0,
+ "y": 26,
+ "w": 8,
+ "h": 12,
"i": "15",
"type": "Widget",
"widget": {
@@ -378,7 +377,6 @@
"showXAxis": true,
"showYAxis": true
},
- "standard": {},
"metrics": [
"instance_jvm_class_loaded_class_count",
"instance_jvm_class_total_loaded_class_count",
@@ -392,9 +390,9 @@
"moved": false
},
{
- "x": 12,
+ "x": 16,
"y": 0,
- "w": 6,
+ "w": 8,
"h": 13,
"i": "6",
"type": "Widget",
@@ -422,9 +420,9 @@
"moved": false
},
{
- "x": 18,
- "y": 0,
- "w": 6,
+ "x": 0,
+ "y": 13,
+ "w": 8,
"h": 13,
"i": "7",
"type": "Widget",
@@ -445,18 +443,7 @@
"readMetricsValues",
"readMetricsValues"
],
- "moved": false,
- "metricConfig": [
- {
- "calculation": "byteToMB"
- },
- {
- "calculation": "byteToMB"
- },
- {
- "calculation": "byteToMB"
- }
- ]
+ "moved": false
}
]
},
@@ -538,7 +525,6 @@
"type": "Bar",
"showBackground": true
},
- "standard": {},
"metrics": [
"instance_clr_gen1_collect_count",
"instance_clr_gen0_collect_count",