metrics.go

package controller

import (
	"fmt"
	"sync"

	apierrs "k8s.io/apimachinery/pkg/api/errors"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	utilruntime "k8s.io/apimachinery/pkg/util/runtime"

	imageapi "github.com/openshift/origin/pkg/image/apis/image"
	metrics "github.com/openshift/origin/pkg/image/metrics/prometheus"
)

const reasonUnknown = "Unknown"
const reasonInvalidImageReference = "InvalidImageReference"

// ImportMetricCounter counts numbers of successful and failed imports for the purpose of metrics collection.
type ImportMetricCounter struct {
	counterMutex        sync.Mutex
	importSuccessCounts metrics.ImportSuccessCounts
	importErrorCounts   metrics.ImportErrorCounts
}

// NewImportMetricCounter returns a new ImportMetricCounter
func NewImportMetricCounter() *ImportMetricCounter {
	return &ImportMetricCounter{
		importSuccessCounts: make(metrics.ImportSuccessCounts),
		importErrorCounts:   make(metrics.ImportErrorCounts),
	}
}

// Increment processes the given image stream import object as a result of successful or failed import and
// increments the counters. The given error will be used to construct reason of the error_count metric unless
// any reason is found in the image stream import object. It's safe to call this method with any of the
// parameters nil.
func (c *ImportMetricCounter) Increment(isi *imageapi.ImageStreamImport, err error) {
	if isi == nil {
		if err == nil {
			return
		}

		c.counterMutex.Lock()
		defer c.counterMutex.Unlock()
		info := defaultErrorInfoReason(&metrics.ImportErrorInfo{}, err)
		c.importErrorCounts[*info]++
		return
	}

	c.countRepositoryImport(isi, err)

	if len(isi.Status.Images) == 0 {
		return
	}

	c.counterMutex.Lock()
	defer c.counterMutex.Unlock()

	enumerateIsImportStatuses(isi, func(info *metrics.ImportErrorInfo) {
		if len(info.Reason) == 0 {
			c.importSuccessCounts[info.Registry]++
		} else {
			c.importErrorCounts[*defaultErrorInfoReason(info, err)]++
		}
	})
}

// countRepositoryImport increments either success or error counter if the isimport contains repository
// request.
func (c *ImportMetricCounter) countRepositoryImport(isi *imageapi.ImageStreamImport, err error) {
	errInfo := getIsImportRepositoryInfo(isi)
	if errInfo == nil {
		return
	}

	c.counterMutex.Lock()
	defer c.counterMutex.Unlock()

	if len(errInfo.Reason) == 0 {
		c.importSuccessCounts[errInfo.Registry]++
	} else {
		c.importErrorCounts[*defaultErrorInfoReason(errInfo, err)]++
	}
}

// Collect is supposed to be called by the metrics collector. It returns the actual state of counters.
func (c *ImportMetricCounter) Collect() (metrics.ImportSuccessCounts, metrics.ImportErrorCounts, error) {
	c.counterMutex.Lock()
	defer c.counterMutex.Unlock()

	success := metrics.ImportSuccessCounts{}
	for registry, count := range c.importSuccessCounts {
		success[registry] = count
	}

	failures := metrics.ImportErrorCounts{}
	for info, count := range c.importErrorCounts {
		failures[info] = count
	}

	return success, failures, nil
}

// getIsImportRepositoryInfo returns an import error info if the given isi contains repository request.
// If the request succeeded, its Reason will be empty.
func getIsImportRepositoryInfo(isi *imageapi.ImageStreamImport) *metrics.ImportErrorInfo {
	if isi.Status.Repository == nil || isi.Spec.Repository == nil {
		return nil
	}
	ref := isi.Spec.Repository.From
	if ref.Kind != "DockerImage" {
		return nil
	}
	imgRef, err := imageapi.ParseDockerImageReference(ref.Name)
	if err != nil {
		utilruntime.HandleError(fmt.Errorf(
			"failed to parse isi.spec.repository.from.name %q: %v",
			ref.Name, err))
		return nil
	}

	info := mkImportInfo(imgRef.DockerClientDefaults().Registry, &isi.Status.Repository.Status)
	return &info
}

// enumerateIsImportStatuses iterates over images of the given image stream import. For any valid recorded
// import the cb callback will be colled with the obtains information.
// If the image import is successful, the object passed to the cb will contain empty Reason.
func enumerateIsImportStatuses(isi *imageapi.ImageStreamImport, cb func(*metrics.ImportErrorInfo)) {
	if len(isi.Status.Images) == 0 {
		return
	}

	for i, status := range isi.Status.Images {
		var registry string

		imgRef, err := getImageDockerReferenceForImage(isi, i)
		if err != nil {
			utilruntime.HandleError(err)
		} else {
			if imgRef == nil {
				continue
			}
			registry = imgRef.DockerClientDefaults().Registry
		}

		info := mkImportInfo(registry, &status.Status)
		if err != nil {
			info.Reason = reasonInvalidImageReference
		}
		cb(&info)
	}
}

func getImageDockerReferenceForImage(
	isi *imageapi.ImageStreamImport,
	index int,
) (*imageapi.DockerImageReference, error) {
	var (
		imgRef imageapi.DockerImageReference
		err    error
	)

	// prefer the specification as the source of truth because the reference in status may belong to an
	// older image imported from somewhere else
	if index >= 0 && index < len(isi.Spec.Images) {
		imgSpec := &isi.Spec.Images[index]
		if imgSpec.From.Kind == "DockerImage" {
			imgRef, err = imageapi.ParseDockerImageReference(imgSpec.From.Name)
			if err == nil {
				return &imgRef, nil
			}
			err = fmt.Errorf("failed to parse isi.spec.images[%d].from.name %q: %v",
				index, imgSpec.From.Name, err)
		}
	}

	// fall-back to the image in status
	if index < 0 || index >= len(isi.Status.Images) {
		return nil, err
	}

	img := isi.Status.Images[index].Image
	if img == nil {
		return nil, err
	}

	imgRef, err = imageapi.ParseDockerImageReference(img.DockerImageReference)
	if err != nil {
		return nil, fmt.Errorf(
			"failed to parse isi.status.images[%d].image.dockerImageReference %q: %v",
			index, img.DockerImageReference, err)
	}

	return &imgRef, nil
}

// mkImportInfo returns an import error info for the given status. If the import succeeded, the Reason field
// will be empty.
func mkImportInfo(registry string, status *metav1.Status) metrics.ImportErrorInfo {
	var reason string
	if status.Status != metav1.StatusSuccess {
		reason = string(status.Reason)
		if len(reason) == 0 {
			reason = reasonUnknown
		}
	}
	return metrics.ImportErrorInfo{
		Registry: registry,
		Reason:   reason,
	}
}

// defaultErrorInfoReason fills the Reason field of the import error info from the given error unless already
// set.
func defaultErrorInfoReason(info *metrics.ImportErrorInfo, err error) *metrics.ImportErrorInfo {
	if len(info.Reason) == 0 && err != nil {
		info.Reason = string(apierrs.ReasonForError(err))
		if len(info.Reason) == 0 {
			info.Reason = reasonUnknown
		}
	}
	return info
}