Skip to content

Commit

Permalink
Merge pull request #109128 from Jefftree/openapiv3-metrics
Browse files Browse the repository at this point in the history
Add metrics for OpenAPI v3 generation

Kubernetes-commit: ba1bbb5ac67084b25a17622a6573e648f88f440b
  • Loading branch information
k8s-publishing-bot committed Mar 30, 2022
2 parents 16d550b + 62f765a commit b94fca5
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
5 changes: 4 additions & 1 deletion pkg/controller/openapiv3/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ func (c *Controller) deleteCRD(name string) {
if len(crdListForGV) == 0 {
delete(c.specsByGVandName, gv)
}
regenerationCounter.With(map[string]string{"group": gv.Group, "version": gv.Version, "crd": name, "reason": "remove"})
c.updateGroupVersion(gv)
}
}
Expand Down Expand Up @@ -210,7 +211,9 @@ func (c *Controller) updateCRDSpec(crd *apiextensionsv1.CustomResourceDefinition
}

_, ok := c.specsByGVandName[gv]
reason := "update"
if !ok {
reason = "add"
c.specsByGVandName[gv] = map[string]*spec3.OpenAPI{}
}

Expand All @@ -222,7 +225,7 @@ func (c *Controller) updateCRDSpec(crd *apiextensionsv1.CustomResourceDefinition
}
}
c.specsByGVandName[gv][name] = v3

regenerationCounter.With(map[string]string{"crd": name, "group": gv.Group, "version": gv.Version, "reason": reason})
return c.updateGroupVersion(gv)
}

Expand Down
37 changes: 37 additions & 0 deletions pkg/controller/openapiv3/metrics.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*
Copyright 2022 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 openapiv3

import (
"k8s.io/component-base/metrics"
"k8s.io/component-base/metrics/legacyregistry"
)

var (
regenerationCounter = metrics.NewCounterVec(
&metrics.CounterOpts{
Name: "apiextensions_openapi_v3_regeneration_count",
Help: "Counter of OpenAPI v3 spec regeneration count broken down by group, version, causing CRD and reason.",
StabilityLevel: metrics.ALPHA,
},
[]string{"group", "version", "crd", "reason"},
)
)

func init() {
legacyregistry.MustRegister(regenerationCounter)
}

0 comments on commit b94fca5

Please sign in to comment.