cmd/cni-metrics-helper/metrics/cni_metrics.go

// Copyright Amazon.com Inc. or its affiliates. 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. A copy of the
// License is located at
//
//     http://aws.amazon.com/apache2.0/
//
// or in the "license" file accompanying this file. This file 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 handles the processing of all metrics. This file handles metrics for ipamd
package metrics

import (
	"github.com/aws/amazon-vpc-cni-k8s/pkg/utils/logger"
	"golang.org/x/net/context"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/client-go/kubernetes"

	"github.com/aws/amazon-vpc-cni-k8s/pkg/publisher"
)

// Port where prometheus metrics are published.
const metricsPort = 61678

// InterestingCNIMetrics defines metrics parsing definition for kube-state-metrics
var InterestingCNIMetrics = map[string]metricsConvert{
	"awscni_assigned_ip_addresses": {
		actions: []metricsAction{
			{cwMetricName: "assignIPAddresses",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{}}}},
	"awscni_total_ip_addresses": {
		actions: []metricsAction{
			{cwMetricName: "totalIPAddresses",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{}}}},
	"awscni_total_ipv4_prefixes": {
		actions: []metricsAction{
			{cwMetricName: "totalIPv4Prefixes",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{}}}},
	"awscni_assigned_ip_per_cidr": {
		actions: []metricsAction{
			{cwMetricName: "totalAssignedIPv4sPerCidr",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{}}}},
	"awscni_eni_allocated": {
		actions: []metricsAction{
			{cwMetricName: "eniAllocated",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{}}}},
	"awscni_eni_max": {
		actions: []metricsAction{
			{cwMetricName: "eniMaxAvailable",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{}}}},
	"awscni_ip_max": {
		actions: []metricsAction{
			{cwMetricName: "maxIPAddresses",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{}}}},
	"awscni_aws_api_latency_ms": {
		actions: []metricsAction{
			{cwMetricName: "awsAPILatency",
				matchFunc:  matchAny,
				actionFunc: metricsMax,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_aws_api_error_count": {
		actions: []metricsAction{
			{cwMetricName: "awsAPIErr",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_aws_utils_error_count": {
		actions: []metricsAction{
			{cwMetricName: "awsUtilErr",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_ipamd_error_count": {
		actions: []metricsAction{
			{cwMetricName: "ipamdErr",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_force_removed_enis": {
		actions: []metricsAction{
			{cwMetricName: "forceRemoveENI",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_force_removed_ips": {
		actions: []metricsAction{
			{cwMetricName: "forceRemoveIPs",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_ipamd_action_inprogress": {
		actions: []metricsAction{
			{cwMetricName: "ipamdActionInProgress",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_reconcile_count": {
		actions: []metricsAction{
			{cwMetricName: "reconcileCount",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_add_ip_req_count": {
		actions: []metricsAction{
			{cwMetricName: "addReqCount",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_del_ip_req_count": {
		actions: []metricsAction{
			{cwMetricName: "delReqCount",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_pod_eni_error_count": {
		actions: []metricsAction{
			{cwMetricName: "podENIErr",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_ec2api_req_count": {
		actions: []metricsAction{
			{cwMetricName: "ec2ApiReqCount",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
	"awscni_ec2api_error_count": {
		actions: []metricsAction{
			{cwMetricName: "ec2ApiErrCount",
				matchFunc:  matchAny,
				actionFunc: metricsAdd,
				data:       &dataPoints{},
				logToFile:  true}}},
}

// CNIMetricsTarget defines data structure for kube-state-metric target
type CNIMetricsTarget struct {
	interestingMetrics      map[string]metricsConvert
	cwMetricsPublisher      publisher.Publisher
	kubeClient              kubernetes.Interface
	podWatcher              *defaultPodWatcher
	submitCW                bool
	submitPrometheusMetrics bool
	log                     logger.Logger
}

// CNIMetricsNew creates a new metricsTarget
func CNIMetricsNew(k8sClient kubernetes.Interface, cw publisher.Publisher, submitCW bool, submitPrometheus bool, l logger.Logger,
	watcher *defaultPodWatcher) *CNIMetricsTarget {
	return &CNIMetricsTarget{
		interestingMetrics:      InterestingCNIMetrics,
		cwMetricsPublisher:      cw,
		kubeClient:              k8sClient,
		podWatcher:              watcher,
		submitCW:                submitCW,
		submitPrometheusMetrics: submitPrometheus,
		log:                     l,
	}
}

func (t *CNIMetricsTarget) grabMetricsFromTarget(ctx context.Context, cniPod string) ([]byte, error) {
	output, err := getMetricsFromPod(ctx, t.kubeClient, cniPod, metav1.NamespaceSystem, metricsPort)
	if err != nil {
		t.log.Errorf("grabMetricsFromTarget: Failed to grab CNI endpoint: %v", err)
		return nil, err
	}

	t.log.Debugf("cni-metrics text output: %s", string(output))
	return output, nil
}

func (t *CNIMetricsTarget) getInterestingMetrics() map[string]metricsConvert {
	return InterestingCNIMetrics
}

func (t *CNIMetricsTarget) getCWMetricsPublisher() publisher.Publisher {
	return t.cwMetricsPublisher
}

func (t *CNIMetricsTarget) getTargetList(ctx context.Context) ([]string, error) {
	pods, err := t.podWatcher.GetCNIPods(ctx)
	if err != nil {
		return pods, err
	}
	return pods, nil
}

func (t *CNIMetricsTarget) submitCloudWatch() bool {
	return t.submitCW
}

func (t *CNIMetricsTarget) getLogger() logger.Logger {
	return t.log
}

func (t *CNIMetricsTarget) submitPrometheus() bool {
	return t.submitPrometheusMetrics
}