/* 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 vclib import ( "sync" "time" "github.com/vmware/govmomi/vim25/types" "k8s.io/component-base/metrics" "k8s.io/component-base/metrics/legacyregistry" ) // Cloud Provider API constants const ( APICreateVolume = "CreateVolume" APIDeleteVolume = "DeleteVolume" APIAttachVolume = "AttachVolume" APIDetachVolume = "DetachVolume" ) // Cloud Provider Operation constants const ( OperationDeleteVolume = "DeleteVolumeOperation" OperationAttachVolume = "AttachVolumeOperation" OperationDetachVolume = "DetachVolumeOperation" OperationDiskIsAttached = "DiskIsAttachedOperation" OperationDisksAreAttached = "DisksAreAttachedOperation" OperationCreateVolume = "CreateVolumeOperation" OperationCreateVolumeWithPolicy = "CreateVolumeWithPolicyOperation" OperationCreateVolumeWithRawVSANPolicy = "CreateVolumeWithRawVSANPolicyOperation" ) var vCenterMetric *vcenterMetric func init() { vCenterMetric = &vcenterMetric{ vCenterInfos: make(map[string]types.AboutInfo), mux: sync.Mutex{}, } } // vsphereAPIMetric is for recording latency of Single API Call. var vsphereAPIMetric = metrics.NewHistogramVec( &metrics.HistogramOpts{ Name: "cloudprovider_vsphere_api_request_duration_seconds", Help: "Latency of vsphere api call", StabilityLevel: metrics.ALPHA, }, []string{"request"}, ) var vsphereAPIErrorMetric = metrics.NewCounterVec( &metrics.CounterOpts{ Name: "cloudprovider_vsphere_api_request_errors", Help: "vsphere Api errors", StabilityLevel: metrics.ALPHA, }, []string{"request"}, ) // vsphereOperationMetric is for recording latency of vSphere Operation which invokes multiple APIs to get the task done. var vsphereOperationMetric = metrics.NewHistogramVec( &metrics.HistogramOpts{ Name: "cloudprovider_vsphere_operation_duration_seconds", Help: "Latency of vsphere operation call", StabilityLevel: metrics.ALPHA, }, []string{"operation"}, ) var vsphereOperationErrorMetric = metrics.NewCounterVec( &metrics.CounterOpts{ Name: "cloudprovider_vsphere_operation_errors", Help: "vsphere operation errors", StabilityLevel: metrics.ALPHA, }, []string{"operation"}, ) var vsphereVersion = metrics.NewDesc( "cloudprovider_vsphere_vcenter_versions", "Versions for connected vSphere vCenters", []string{"hostname", "version", "build"}, nil, metrics.ALPHA, "") // RegisterMetrics registers all the API and Operation metrics func RegisterMetrics() { legacyregistry.MustRegister(vsphereAPIMetric) legacyregistry.MustRegister(vsphereAPIErrorMetric) legacyregistry.MustRegister(vsphereOperationMetric) legacyregistry.MustRegister(vsphereOperationErrorMetric) legacyregistry.CustomMustRegister(vCenterMetric) } type vcenterMetric struct { metrics.BaseStableCollector mux sync.Mutex vCenterInfos map[string]types.AboutInfo } func (collector *vcenterMetric) DescribeWithStability(ch chan<- *metrics.Desc) { ch <- vsphereVersion } func (collector *vcenterMetric) CollectWithStability(ch chan<- metrics.Metric) { collector.mux.Lock() defer collector.mux.Unlock() for vCenter, info := range collector.vCenterInfos { ch <- metrics.NewLazyMetricWithTimestamp(time.Now(), metrics.NewLazyConstMetric(vsphereVersion, metrics.GaugeValue, float64(1), vCenter, info.Version, info.Build)) } } func (collector *vcenterMetric) setAbout(server string, info types.AboutInfo) { collector.mux.Lock() defer collector.mux.Unlock() collector.vCenterInfos[server] = info } func setVCenterInfoMetric(connection *VSphereConnection) { vCenterMetric.setAbout(connection.Hostname, connection.Client.ServiceContent.About) } // RecordvSphereMetric records the vSphere API and Operation metrics func RecordvSphereMetric(actionName string, requestTime time.Time, err error) { switch actionName { case APICreateVolume, APIDeleteVolume, APIAttachVolume, APIDetachVolume: recordvSphereAPIMetric(actionName, requestTime, err) default: recordvSphereOperationMetric(actionName, requestTime, err) } } func recordvSphereAPIMetric(actionName string, requestTime time.Time, err error) { if err != nil { vsphereAPIErrorMetric.With(metrics.Labels{"request": actionName}).Inc() } else { vsphereAPIMetric.With(metrics.Labels{"request": actionName}).Observe(calculateTimeTaken(requestTime)) } } func recordvSphereOperationMetric(actionName string, requestTime time.Time, err error) { if err != nil { vsphereOperationErrorMetric.With(metrics.Labels{"operation": actionName}).Inc() } else { vsphereOperationMetric.With(metrics.Labels{"operation": actionName}).Observe(calculateTimeTaken(requestTime)) } } // RecordCreateVolumeMetric records the Create Volume metric func RecordCreateVolumeMetric(volumeOptions *VolumeOptions, requestTime time.Time, err error) { var actionName string if volumeOptions.StoragePolicyName != "" { actionName = OperationCreateVolumeWithPolicy } else if volumeOptions.VSANStorageProfileData != "" { actionName = OperationCreateVolumeWithRawVSANPolicy } else { actionName = OperationCreateVolume } RecordvSphereMetric(actionName, requestTime, err) } func calculateTimeTaken(requestBeginTime time.Time) (timeTaken float64) { if !requestBeginTime.IsZero() { timeTaken = time.Since(requestBeginTime).Seconds() } else { timeTaken = 0 } return timeTaken }