Documentation

Index

Constants

View Source
const (
	// SchedulerSubsystem - subsystem name used by scheduler
	SchedulerSubsystem = "scheduler"

	// OperationLabel - operation label name
	OperationLabel = "operation"

	// PreemptionEvaluation - preemption evaluation operation label value (occurs in case of scheduling fitError).
	PreemptionEvaluation = "preemption_evaluation"
	// Binding - binding operation label value
	Binding = "binding"
)

Variables

View Source
var (
	SchedulingAlgorithmLatency = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem:      SchedulerSubsystem,
			Name:           "scheduling_algorithm_duration_seconds",
			Help:           "Scheduling algorithm latency in seconds",
			Buckets:        metrics.ExponentialBuckets(0.001, 2, 15),
			StabilityLevel: metrics.ALPHA,
		},
	)
	DeprecatedSchedulingAlgorithmPreemptionEvaluationDuration = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem:         SchedulerSubsystem,
			Name:              "scheduling_algorithm_preemption_evaluation_seconds",
			Help:              "Scheduling algorithm preemption evaluation duration in seconds",
			Buckets:           metrics.ExponentialBuckets(0.001, 2, 15),
			StabilityLevel:    metrics.ALPHA,
			DeprecatedVersion: "1.20.0",
		},
	)
	DeprecatedBindingLatency = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem:         SchedulerSubsystem,
			Name:              "binding_duration_seconds",
			Help:              "Binding latency in seconds",
			Buckets:           metrics.ExponentialBuckets(0.001, 2, 15),
			StabilityLevel:    metrics.ALPHA,
			DeprecatedVersion: "1.20.0",
		},
	)
	PreemptionVictims = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem: SchedulerSubsystem,
			Name:      "preemption_victims",
			Help:      "Number of selected preemption victims",

			Buckets:        metrics.LinearBuckets(5, 5, 10),
			StabilityLevel: metrics.ALPHA,
		})
	PreemptionAttempts = metrics.NewCounter(
		&metrics.CounterOpts{
			Subsystem:      SchedulerSubsystem,
			Name:           "preemption_attempts_total",
			Help:           "Total preemption attempts in the cluster till now",
			StabilityLevel: metrics.ALPHA,
		})

	SchedulerGoroutines = metrics.NewGaugeVec(
		&metrics.GaugeOpts{
			Subsystem:      SchedulerSubsystem,
			Name:           "scheduler_goroutines",
			Help:           "Number of running goroutines split by the work they do such as binding.",
			StabilityLevel: metrics.ALPHA,
		}, []string{"work"})

	PodSchedulingDuration = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem: SchedulerSubsystem,
			Name:      "pod_scheduling_duration_seconds",
			Help:      "E2e latency for a pod being scheduled which may include multiple scheduling attempts.",

			Buckets:        metrics.ExponentialBuckets(0.01, 2, 20),
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"attempts"})

	PodSchedulingAttempts = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem:      SchedulerSubsystem,
			Name:           "pod_scheduling_attempts",
			Help:           "Number of attempts to successfully schedule a pod.",
			Buckets:        metrics.ExponentialBuckets(1, 2, 5),
			StabilityLevel: metrics.ALPHA,
		})

	FrameworkExtensionPointDuration = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem: SchedulerSubsystem,
			Name:      "framework_extension_point_duration_seconds",
			Help:      "Latency for running all plugins of a specific extension point.",

			Buckets:        metrics.ExponentialBuckets(0.0001, 2, 12),
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"extension_point", "status", "profile"})

	PluginExecutionDuration = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem: SchedulerSubsystem,
			Name:      "plugin_execution_duration_seconds",
			Help:      "Duration for running a plugin at a specific extension point.",

			Buckets:        metrics.ExponentialBuckets(0.00001, 1.5, 20),
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"plugin", "extension_point", "status"})

	SchedulerQueueIncomingPods = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      SchedulerSubsystem,
			Name:           "queue_incoming_pods_total",
			Help:           "Number of pods added to scheduling queues by event and queue type.",
			StabilityLevel: metrics.ALPHA,
		}, []string{"queue", "event"})

	PermitWaitDuration = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem:      SchedulerSubsystem,
			Name:           "permit_wait_duration_seconds",
			Help:           "Duration of waiting on permit.",
			Buckets:        metrics.ExponentialBuckets(0.001, 2, 15),
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"result"})

	CacheSize = metrics.NewGaugeVec(
		&metrics.GaugeOpts{
			Subsystem:      SchedulerSubsystem,
			Name:           "scheduler_cache_size",
			Help:           "Number of nodes, pods, and assumed (bound) pods in the scheduler cache.",
			StabilityLevel: metrics.ALPHA,
		}, []string{"type"})
)

    All the histogram based metrics have 1ms as size for the smallest bucket.

    Functions

    func ActivePods

    func ActivePods() metrics.GaugeMetric

      ActivePods returns the pending pods metrics with the label active

      func BackoffPods

      func BackoffPods() metrics.GaugeMetric

        BackoffPods returns the pending pods metrics with the label backoff

        func GetGather

        func GetGather() metrics.Gatherer

          GetGather returns the gatherer. It used by test case outside current package.

          func PodScheduleError

          func PodScheduleError(profile string, duration float64)

            PodScheduleError can records a scheduling attempt that had an error and the duration since `start`.

            func PodScheduled

            func PodScheduled(profile string, duration float64)

              PodScheduled can records a successful scheduling attempt and the duration since `start`.

              func PodUnschedulable

              func PodUnschedulable(profile string, duration float64)

                PodUnschedulable can records a scheduling attempt for an unschedulable pod and the duration since `start`.

                func Register

                func Register()

                  Register all metrics.

                  func RegisterMetrics

                  func RegisterMetrics(extraMetrics ...metrics.Registerable)

                    RegisterMetrics registers a list of metrics. This function is exported because it is intended to be used by out-of-tree plugins to register their custom metrics.

                    func SinceInSeconds

                    func SinceInSeconds(start time.Time) float64

                      SinceInSeconds gets the time since the specified start in seconds.

                      func UnschedulablePods

                      func UnschedulablePods() metrics.GaugeMetric

                        UnschedulablePods returns the pending pods metrics with the label unschedulable

                        Types

                        type MetricRecorder

                        type MetricRecorder interface {
                        	Inc()
                        	Dec()
                        	Clear()
                        }

                          MetricRecorder represents a metric recorder which takes action when the metric Inc(), Dec() and Clear()

                          type PendingPodsRecorder

                          type PendingPodsRecorder struct {
                          	// contains filtered or unexported fields
                          }

                            PendingPodsRecorder is an implementation of MetricRecorder

                            func NewActivePodsRecorder

                            func NewActivePodsRecorder() *PendingPodsRecorder

                              NewActivePodsRecorder returns ActivePods in a Prometheus metric fashion

                              func NewBackoffPodsRecorder

                              func NewBackoffPodsRecorder() *PendingPodsRecorder

                                NewBackoffPodsRecorder returns BackoffPods in a Prometheus metric fashion

                                func NewUnschedulablePodsRecorder

                                func NewUnschedulablePodsRecorder() *PendingPodsRecorder

                                  NewUnschedulablePodsRecorder returns UnschedulablePods in a Prometheus metric fashion

                                  func (*PendingPodsRecorder) Clear

                                  func (r *PendingPodsRecorder) Clear()

                                    Clear set a metric counter to 0, in an atomic way

                                    func (*PendingPodsRecorder) Dec

                                    func (r *PendingPodsRecorder) Dec()

                                      Dec decreases a metric counter by 1, in an atomic way

                                      func (*PendingPodsRecorder) Inc

                                      func (r *PendingPodsRecorder) Inc()

                                        Inc increases a metric counter by 1, in an atomic way

                                        Directories

                                        Path Synopsis
                                        Package resources provides a metrics collector that reports the resource consumption (requests and limits) of the pods in the cluster as the scheduler and kubelet would interpret it.
                                        Package resources provides a metrics collector that reports the resource consumption (requests and limits) of the pods in the cluster as the scheduler and kubelet would interpret it.