Display CPU metrics and hide metrics when heapster not running

Author: bryk

package.json

@@ -61,6 +61,7 @@
     "q": "~1.4.1",
     "semver": "~5.1.0",
     "uglify-save-license": "~0.4.1",
+    "watchify": "^3.7.0",
     "webpack-stream": "~3.1.0",
     "wiredep": "~3.0.0",
     "wrench": "~1.5.8"

src/app/backend/apihandler.go

@@ -22,7 +22,6 @@ import (
 
 	restful "github.com/emicklei/go-restful"
 	client "k8s.io/kubernetes/pkg/client/unversioned"
-	unversioned "k8s.io/kubernetes/pkg/client/unversioned"
 )
 
 const (
@@ -56,7 +55,7 @@ func FormatResponseLog(resp *restful.Response, req *restful.Request) string {
 }
 
 // Creates a new HTTP handler that handles all requests to the API of the backend.
-func CreateHttpApiHandler(client *client.Client, heapsterClient *unversioned.RESTClient) http.Handler {
+func CreateHttpApiHandler(client *client.Client, heapsterClient HeapsterClient) http.Handler {
 	apiHandler := ApiHandler{client, heapsterClient}
 	wsContainer := restful.NewContainer()
 
@@ -181,7 +180,7 @@ func CreateHttpApiHandler(client *client.Client, heapsterClient *unversioned.RES
 
 type ApiHandler struct {
 	client         *client.Client
-	heapsterClient *unversioned.RESTClient
+	heapsterClient HeapsterClient
 }
 
 // Handles deploy API call.

src/app/backend/heapsterclient.go

@@ -15,19 +15,23 @@
 package main
 
 import (
+	"bytes"
 	"log"
 
-	"k8s.io/kubernetes/pkg/client/unversioned"
 	client "k8s.io/kubernetes/pkg/client/unversioned"
-
-	"bytes"
 )
 
+// Clients for making requests to a Heapster instance.
+type HeapsterClient interface {
+	// Creates a new GET http request to heapster.
+	Get() *client.Request
+}
+
 // Creates new Heapster REST client. When heapsterHost param is empty string the function
 // assumes that it is running inside a Kubernetes cluster and connects via service proxy.
 // heapsterHost param is in the format of protocol://address:port, e.g., http://localhost:8002.
 func CreateHeapsterRESTClient(heapsterHost string, apiclient *client.Client) (
-	*unversioned.RESTClient, error) {
+	HeapsterClient, error) {
 
 	cfg := client.Config{}
 

src/app/backend/replicasetcommon.go

@@ -46,7 +46,7 @@ type ReplicaSetPodInfo struct {
 }
 
 // Returns structure containing ReplicaSet and Pods for the given replica set.
-func getRawReplicaSetWithPods(client *client.Client, namespace, name string) (
+func getRawReplicaSetWithPods(client client.Interface, namespace, name string) (
 	*ReplicaSetWithPods, error) {
 	replicaSet, err := client.ReplicationControllers(namespace).Get(name)
 	if err != nil {
@@ -72,7 +72,7 @@ func getRawReplicaSetWithPods(client *client.Client, namespace, name string) (
 }
 
 // Retrieves Pod list that belongs to a Replica Set.
-func getRawReplicaSetPods(client *client.Client, namespace, name string) (*api.PodList, error) {
+func getRawReplicaSetPods(client client.Interface, namespace, name string) (*api.PodList, error) {
 	replicaSetAndPods, err := getRawReplicaSetWithPods(client, namespace, name)
 	if err != nil {
 		return nil, err

src/app/backend/replicasetdetail.go

@@ -21,7 +21,6 @@ import (
 	"k8s.io/kubernetes/pkg/api"
 	unversioned "k8s.io/kubernetes/pkg/api/unversioned"
 	client "k8s.io/kubernetes/pkg/client/unversioned"
-	unversionedClient "k8s.io/kubernetes/pkg/client/unversioned"
 	"k8s.io/kubernetes/pkg/fields"
 	"k8s.io/kubernetes/pkg/labels"
 )
@@ -51,6 +50,9 @@ type ReplicaSetDetail struct {
 
 	// Detailed information about service related to Replica Set.
 	Services []ServiceDetail `json:"services"`
+
+	// True when the data contains at least one pod with metrics information, false otherwise.
+	HasMetrics bool `json:"hasMetrics"`
 }
 
 // Detailed information about a Pod that belongs to a Replica Set.
@@ -74,7 +76,7 @@ type ReplicaSetPod struct {
 	RestartCount int `json:"restartCount"`
 
 	// Pod metrics.
-	Metrics PodMetrics `json:"metrics"`
+	Metrics *PodMetrics `json:"metrics"`
 }
 
 // Detailed information about a Service connected to Replica Set.
@@ -121,7 +123,7 @@ type ReplicaSetSpec struct {
 }
 
 // Returns detailed information about the given replica set in the given namespace.
-func GetReplicaSetDetail(client *client.Client, heapsterClient *unversionedClient.RESTClient,
+func GetReplicaSetDetail(client client.Interface, heapsterClient HeapsterClient,
 	namespace, name string) (*ReplicaSetDetail, error) {
 	log.Printf("Getting details of %s replica set in %s namespace", name, namespace)
 
@@ -134,7 +136,7 @@ func GetReplicaSetDetail(client *client.Client, heapsterClient *unversionedClien
 
 	replicaSetMetricsByPod, err := getReplicaSetPodsMetrics(pods, heapsterClient, namespace, name)
 	if err != nil {
-		return nil, err
+		log.Printf("Skipping Heapster metrics because of error: %s\n", err)
 	}
 
 	services, err := client.Services(namespace).List(unversioned.ListOptions{
@@ -172,7 +174,11 @@ func GetReplicaSetDetail(client *client.Client, heapsterClient *unversionedClien
 			PodIP:        pod.Status.PodIP,
 			NodeName:     pod.Spec.NodeName,
 			RestartCount: getRestartCount(pod),
-			Metrics:      replicaSetMetricsByPod.MetricsMap[pod.Name],
+		}
+		if replicaSetMetricsByPod != nil {
+			metric := replicaSetMetricsByPod.MetricsMap[pod.Name]
+			podDetail.Metrics = &metric
+			replicaSetDetail.HasMetrics = true
 		}
 		replicaSetDetail.Pods = append(replicaSetDetail.Pods, podDetail)
 	}
@@ -183,7 +189,7 @@ func GetReplicaSetDetail(client *client.Client, heapsterClient *unversionedClien
 // TODO(floreks): This should be transactional to make sure that RC will not be deleted without
 // TODO(floreks): Should related services be deleted also?
 // Deletes replica set with given name in given namespace and related pods
-func DeleteReplicaSetWithPods(client *client.Client, namespace, name string) error {
+func DeleteReplicaSetWithPods(client client.Interface, namespace, name string) error {
 	log.Printf("Deleting %s replica set from %s namespace", name, namespace)
 
 	pods, err := getRawReplicaSetPods(client, namespace, name)

src/app/backend/replicasetpodsmetrics.go

@@ -23,7 +23,6 @@ import (
 
 	heapster "k8s.io/heapster/api/v1/types"
 	"k8s.io/kubernetes/pkg/api"
-	unversioned "k8s.io/kubernetes/pkg/client/unversioned"
 )
 
 const (
@@ -40,19 +39,16 @@ type ReplicaSetMetricsByPod struct {
 // Pod metrics structure.
 type PodMetrics struct {
 	// Cumulative CPU usage on all cores in nanoseconds.
-	CpuUsage uint64 `json:"cpuUsage"`
+	CpuUsage *uint64 `json:"cpuUsage"`
 	// Pod memory usage in bytes.
-	MemoryUsage uint64 `json:"memoryUsage"`
+	MemoryUsage *uint64 `json:"memoryUsage"`
 }
 
 // Return Pods metrics for Replica Set or error when occurred.
-func getReplicaSetPodsMetrics(podList *api.PodList, heapsterClient *unversioned.RESTClient,
+func getReplicaSetPodsMetrics(podList *api.PodList, heapsterClient HeapsterClient,
 	namespace string, replicaSet string) (*ReplicaSetMetricsByPod, error) {
 	log.Printf("Getting Pods metrics for Replica Set %s in %s namespace", replicaSet, namespace)
 	podNames := make([]string, 0)
-	emptyMetrics := &ReplicaSetMetricsByPod{
-		MetricsMap: make(map[string]PodMetrics),
-	}
 
 	pods := podList.Items
 	for _, pod := range pods {
@@ -64,14 +60,12 @@ func getReplicaSetPodsMetrics(podList *api.PodList, heapsterClient *unversioned.
 
 	resultCpuUsageRaw, err := getRawMetrics(heapsterClient, metricCpuUsagePath)
 	if err != nil {
-		log.Print(err)
-		return emptyMetrics, nil
+		return nil, err
 	}
 
 	resultMemUsageRaw, err := getRawMetrics(heapsterClient, metricMemUsagePath)
 	if err != nil {
-		log.Print(err)
-		return emptyMetrics, nil
+		return nil, err
 	}
 
 	cpuMetricResult, err := unmarshalMetrics(resultCpuUsageRaw)
@@ -94,7 +88,7 @@ func createMetricPath(namespace string, podNames []string, metricName string) st
 }
 
 // Retrieves raw metrics from Heapster.
-func getRawMetrics(heapsterClient *unversioned.RESTClient, metricPath string) ([]byte, error) {
+func getRawMetrics(heapsterClient HeapsterClient, metricPath string) ([]byte, error) {
 
 	resultRaw, err := heapsterClient.Get().Suffix(metricPath).DoRaw()
 
@@ -121,15 +115,15 @@ func createResponse(cpuMetrics []heapster.MetricResult, memMetrics []heapster.Me
 
 	if len(cpuMetrics) == len(podNames) && len(memMetrics) == len(podNames) {
 		for iterator, podName := range podNames {
-			var memValue uint64
-			var cpuValue uint64
+			var memValue *uint64
+			var cpuValue *uint64
 			memMetricsList := memMetrics[iterator].Metrics
 			cpuMetricsList := cpuMetrics[iterator].Metrics
 			if len(memMetricsList) > 0 {
-				memValue = memMetricsList[0].Value
+				memValue = &memMetricsList[0].Value
 			}
 			if len(cpuMetricsList) > 0 {
-				cpuValue = cpuMetricsList[0].Value
+				cpuValue = &cpuMetricsList[0].Value
 			}
 			podResources := PodMetrics{
 				CpuUsage:    cpuValue,

src/app/externs/backendapi.js

@@ -133,7 +133,8 @@ backendApi.ReplicaSet;
  *   containerImages: !Array<string>,
  *   podInfo: !backendApi.ReplicaSetPodInfo,
  *   pods: !Array<!backendApi.ReplicaSetPod>,
- *   services: !Array<!backendApi.ServiceDetail>
+ *   services: !Array<!backendApi.ServiceDetail>,
+ *   hasMetrics: boolean
  * }}
  */
 backendApi.ReplicaSetDetail;
@@ -152,7 +153,8 @@ backendApi.ReplicaSetSpec;
  *   status: string,
  *   podIP: string,
  *   nodeName: string,
- *   restartCount: number
+ *   restartCount: number,
+ *   metrics: {cpuUsage: ?number, memoryUsage: ?number}
  * }}
  */
 backendApi.ReplicaSetPod;

src/app/frontend/common/filters/cores_filter.js

@@ -0,0 +1,46 @@
+// Copyright 2015 Google Inc. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/** Base for prefixes */
+const base = 1000;
+
+/** Names of the suffixes where I-th name is for base^I suffix. */
+const powerSuffixes = ['m', '', 'k', 'M', 'G'];
+
+/**
+ * Returns filter function that formats cores usage.
+ * @param {function(number): string} numberFilter
+ * @return {Function}
+ * @ngInject
+ */
+export default function coresFilter(numberFilter) {
+  /**
+   * Formats cores usage in millicores to a decimal prefix format, e.g., 321,20 kCPU.
+   * @param {number} value Value to be formatted in millicores.
+   * @return {string}
+   */
+  let formatCores = function(value) {
+    let divider = 1;
+    let power = 0;
+
+    while (value / divider > base && power < powerSuffixes.length - 1) {
+      divider *= base;
+      power += 1;
+    }
+    let formatted = numberFilter(value / divider);
+    return `${formatted} ${powerSuffixes[power]}CPU`;
+  };
+
+  return formatCores;
+}

src/app/frontend/common/filters/filters_module.js

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import coresFilter from './cores_filter';
 import memoryFilter from './memory_filter';
 import middleEllipsisFilter from './middleellipsis_filter';
 import relativeTimeFilter from './relativetime_filter';
@@ -27,4 +28,5 @@ export default angular
         ])
     .filter('middleEllipsis', middleEllipsisFilter)
     .filter('kdMemory', memoryFilter)
+    .filter('kdCores', coresFilter)
     .filter('relativeTime', relativeTimeFilter);