scottk/kubernetes
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/kubernetes.git synced 2025-11-04 04:08:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for client/metrics pkg

Browse Source
This commit is contained in:
Tamer Tas
2015-09-14 14:16:52 +03:00
parent 50d805110a
commit c491d94a89
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
pkg/client/metrics/metrics.go
View File

@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
// Package metrics provides utilities for registering client metrics to Prometheus.
package metrics package metrics
import ( import (
@@ -26,6 +27,8 @@ import (
const restClientSubsystem = "rest_client" const restClientSubsystem = "rest_client"
var ( var (
// RequestLatency is a Prometheus Summary metric type partitioned by
// "verb" and "url" labels. It is used for the rest client latency metrics.
RequestLatency = prometheus.NewSummaryVec( RequestLatency = prometheus.NewSummaryVec(
prometheus.SummaryOpts{ prometheus.SummaryOpts{
Subsystem: restClientSubsystem, Subsystem: restClientSubsystem,
@@ -39,7 +42,8 @@ var (
var registerMetrics sync.Once var registerMetrics sync.Once
// Register all metrics. // Register registers all metrics to Prometheus with
// respect to the RequestLatency.
func Register() { func Register() {
// Register the metrics. // Register the metrics.
registerMetrics.Do(func() { registerMetrics.Do(func() {
@@ -47,7 +51,7 @@ func Register() {
}) })
} }
// Gets the time since the specified start in microseconds. // Calculates the time since the specified start in microseconds.
func SinceInMicroseconds(start time.Time) float64 { func SinceInMicroseconds(start time.Time) float64 {
return float64(time.Since(start).Nanoseconds() / time.Microsecond.Nanoseconds()) return float64(time.Since(start).Nanoseconds() / time.Microsecond.Nanoseconds())
} }