controller_metrics.go

// Copyright 2019 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.

package metrics

import (
	"go.opencensus.io/stats"
	"go.opencensus.io/stats/view"
	"go.opencensus.io/tag"
)

var (
	fleetsReplicasCountStats  = stats.Int64("fleets/replicas_count", "The count of replicas per fleet", "1")
	fasBufferLimitsCountStats = stats.Int64("fas/buffer_limits", "The buffer limits of autoscalers", "1")
	fasBufferSizeStats        = stats.Int64("fas/buffer_size", "The buffer size value of autoscalers", "1")
	fasCurrentReplicasStats   = stats.Int64("fas/current_replicas_count", "The current replicas cout as seen by autoscalers", "1")
	fasDesiredReplicasStats   = stats.Int64("fas/desired_replicas_count", "The desired replicas cout as seen by autoscalers", "1")
	fasAbleToScaleStats       = stats.Int64("fas/able_to_scale", "The fleet autoscaler can access the fleet to scale (0 indicates false, 1 indicates true)", "1")
	fasLimitedStats           = stats.Int64("fas/limited", "The fleet autoscaler is capped (0 indicates false, 1 indicates true)", "1")
	gameServerCountStats      = stats.Int64("gameservers/count", "The count of gameservers", "1")
	fleetAllocationCountStats = stats.Int64("fleet_allocations/count", "The count of fleet allocations", "1")
	gameServerTotalStats      = stats.Int64("gameservers/total", "The total of gameservers", "1")
	fleetAllocationTotalStats = stats.Int64("fleet_allocations/total", "The total of fleet allocations", "1")
	nodesCountStats           = stats.Int64("nodes/count", "The count of nodes in the cluster", "1")
	gsPerNodesCountStats      = stats.Int64("gameservers_node/count", "The count of gameservers per node in the cluster", "1")

	stateViews = []*view.View{
		&view.View{
			Name:        "fleets_replicas_count",
			Measure:     fleetsReplicasCountStats,
			Description: "The number of replicas per fleet",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyName, keyType},
		},
		&view.View{
			Name:        "fleet_autoscalers_buffer_limits",
			Measure:     fasBufferLimitsCountStats,
			Description: "The limits of buffer based fleet autoscalers",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyName, keyType, keyFleetName},
		},
		&view.View{
			Name:        "fleet_autoscalers_buffer_size",
			Measure:     fasBufferSizeStats,
			Description: "The buffer size of fleet autoscalers",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyName, keyType, keyFleetName},
		},
		&view.View{
			Name:        "fleet_autoscalers_current_replicas_count",
			Measure:     fasCurrentReplicasStats,
			Description: "The current replicas count as seen by autoscalers",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyName, keyFleetName},
		},
		&view.View{
			Name:        "fleet_autoscalers_desired_replicas_count",
			Measure:     fasDesiredReplicasStats,
			Description: "The desired replicas count as seen by autoscalers",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyName, keyFleetName},
		},
		&view.View{
			Name:        "fleet_autoscalers_able_to_scale",
			Measure:     fasAbleToScaleStats,
			Description: "The fleet autoscaler can access the fleet to scale",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyName, keyFleetName},
		},
		&view.View{
			Name:        "fleet_autoscalers_limited",
			Measure:     fasLimitedStats,
			Description: "The fleet autoscaler is capped",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyName, keyFleetName},
		},
		&view.View{
			Name:        "gameservers_count",
			Measure:     gameServerCountStats,
			Description: "The number of gameservers",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyType, keyFleetName},
		},
		&view.View{
			Name:        "fleet_allocations_count",
			Measure:     fleetAllocationCountStats,
			Description: "The number of fleet allocations",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyFleetName},
		},
		&view.View{
			Name:        "fleet_allocations_total",
			Measure:     fleetAllocationTotalStats,
			Description: "The total of fleet allocations",
			Aggregation: view.Count(),
			TagKeys:     []tag.Key{keyFleetName},
		},
		&view.View{
			Name:        "gameservers_total",
			Measure:     gameServerTotalStats,
			Description: "The total of gameservers",
			Aggregation: view.Count(),
			TagKeys:     []tag.Key{keyType, keyFleetName},
		},
		&view.View{
			Name:        "nodes_count",
			Measure:     nodesCountStats,
			Description: "The count of nodes in the cluster",
			Aggregation: view.LastValue(),
			TagKeys:     []tag.Key{keyEmpty},
		},
		&view.View{
			Name:        "gameservers_node_count",
			Measure:     gsPerNodesCountStats,
			Description: "The count of gameservers per node in the cluster",
			Aggregation: view.Distribution(0.00001, 1.00001, 2.00001, 3.00001, 4.00001, 5.00001, 6.00001, 7.00001, 8.00001, 9.00001, 10.00001, 11.00001, 12.00001, 13.00001, 14.00001, 15.00001, 16.00001, 32.00001, 40.00001, 50.00001, 60.00001, 70.00001, 80.00001, 90.00001, 100.00001, 110.00001, 120.00001),
		},
	}
)

// register all our state views to OpenCensus
func registerViews() {
	for _, v := range stateViews {
		if err := view.Register(v); err != nil {
			logger.WithError(err).Error("could not register view")
		}
	}
}

// unregister views, this is only useful for tests as it trigger reporting.
func unRegisterViews() {
	for _, v := range stateViews {
		view.Unregister(v)
	}
}