mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-25 20:53:33 +00:00
b997e0e4d6
Volumes that are provisioned with `VolumeMode: Block` often have a MetrucsProvider interface declared in their type. However, the MetricsProvider should implement a GetMetrics() function. In the cases where the storage drivers do not implement GetMetrics(), a panic can occur. Usual type-assertions are not sufficient in this case. All assertions assume the interface is present. There is no straight forward way to verify that a valid GetMetrics() function is provided. By adding SupportsMetrics(), storage driver implementations require careful reviewing for metrics support.
36 lines
1.1 KiB
Go
36 lines
1.1 KiB
Go
/*
|
|
Copyright 2014 The Kubernetes Authors.
|
|
|
|
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 volume
|
|
|
|
var _ MetricsProvider = &MetricsNil{}
|
|
|
|
// MetricsNil represents a MetricsProvider that does not support returning
|
|
// Metrics. It serves as a placeholder for Volumes that do not yet support
|
|
// metrics.
|
|
type MetricsNil struct{}
|
|
|
|
// SupportsMetrics returns false for the MetricsNil type.
|
|
func (*MetricsNil) SupportsMetrics() bool {
|
|
return false
|
|
}
|
|
|
|
// GetMetrics returns an empty Metrics and an error.
|
|
// See MetricsProvider.GetMetrics
|
|
func (*MetricsNil) GetMetrics() (*Metrics, error) {
|
|
return &Metrics{}, NewNotSupportedError()
|
|
}
|