mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-09-20 07:29:50 +00:00
aa698bc3e1
Kubernetes v1.22 version has been released and this update ceph csi dependencies to use the same version. Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
112 lines
3.6 KiB
Go
112 lines
3.6 KiB
Go
/*
|
|
Copyright 2017 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 audit
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
auditinternal "k8s.io/apiserver/pkg/apis/audit"
|
|
"k8s.io/component-base/metrics"
|
|
"k8s.io/component-base/metrics/legacyregistry"
|
|
"k8s.io/klog/v2"
|
|
)
|
|
|
|
const (
|
|
subsystem = "apiserver_audit"
|
|
)
|
|
|
|
/*
|
|
* By default, all the following metrics are defined as falling under
|
|
* ALPHA stability level https://github.com/kubernetes/enhancements/blob/master/keps/sig-instrumentation/1209-metrics-stability/kubernetes-control-plane-metrics-stability.md#stability-classes)
|
|
*
|
|
* Promoting the stability level of the metric is a responsibility of the component owner, since it
|
|
* involves explicitly acknowledging support for the metric across multiple releases, in accordance with
|
|
* the metric stability policy.
|
|
*/
|
|
var (
|
|
eventCounter = metrics.NewCounter(
|
|
&metrics.CounterOpts{
|
|
Subsystem: subsystem,
|
|
Name: "event_total",
|
|
Help: "Counter of audit events generated and sent to the audit backend.",
|
|
StabilityLevel: metrics.ALPHA,
|
|
})
|
|
errorCounter = metrics.NewCounterVec(
|
|
&metrics.CounterOpts{
|
|
Subsystem: subsystem,
|
|
Name: "error_total",
|
|
Help: "Counter of audit events that failed to be audited properly. " +
|
|
"Plugin identifies the plugin affected by the error.",
|
|
StabilityLevel: metrics.ALPHA,
|
|
},
|
|
[]string{"plugin"},
|
|
)
|
|
levelCounter = metrics.NewCounterVec(
|
|
&metrics.CounterOpts{
|
|
Subsystem: subsystem,
|
|
Name: "level_total",
|
|
Help: "Counter of policy levels for audit events (1 per request).",
|
|
StabilityLevel: metrics.ALPHA,
|
|
},
|
|
[]string{"level"},
|
|
)
|
|
|
|
ApiserverAuditDroppedCounter = metrics.NewCounter(
|
|
&metrics.CounterOpts{
|
|
Subsystem: subsystem,
|
|
Name: "requests_rejected_total",
|
|
Help: "Counter of apiserver requests rejected due to an error " +
|
|
"in audit logging backend.",
|
|
StabilityLevel: metrics.ALPHA,
|
|
},
|
|
)
|
|
)
|
|
|
|
func init() {
|
|
legacyregistry.MustRegister(eventCounter)
|
|
legacyregistry.MustRegister(errorCounter)
|
|
legacyregistry.MustRegister(levelCounter)
|
|
legacyregistry.MustRegister(ApiserverAuditDroppedCounter)
|
|
}
|
|
|
|
// ObserveEvent updates the relevant prometheus metrics for the generated audit event.
|
|
func ObserveEvent(ctx context.Context) {
|
|
eventCounter.WithContext(ctx).Inc()
|
|
}
|
|
|
|
// ObservePolicyLevel updates the relevant prometheus metrics with the audit level for a request.
|
|
func ObservePolicyLevel(ctx context.Context, level auditinternal.Level) {
|
|
levelCounter.WithContext(ctx).WithLabelValues(string(level)).Inc()
|
|
}
|
|
|
|
// HandlePluginError handles an error that occurred in an audit plugin. This method should only be
|
|
// used if the error may have prevented the audit event from being properly recorded. The events are
|
|
// logged to the debug log.
|
|
func HandlePluginError(plugin string, err error, impacted ...*auditinternal.Event) {
|
|
// Count the error.
|
|
errorCounter.WithLabelValues(plugin).Add(float64(len(impacted)))
|
|
|
|
// Log the audit events to the debug log.
|
|
msg := fmt.Sprintf("Error in audit plugin '%s' affecting %d audit events: %v\nImpacted events:\n",
|
|
plugin, len(impacted), err)
|
|
for _, ev := range impacted {
|
|
msg = msg + EventString(ev) + "\n"
|
|
}
|
|
klog.Error(msg)
|
|
}
|