metrics.go

Documentation: k8s.io/kubernetes/pkg/serviceaccount

     1  /*
     2  Copyright 2020 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package serviceaccount
    18  
    19  import (
    20  	"sync"
    21  
    22  	"k8s.io/component-base/metrics"
    23  	"k8s.io/component-base/metrics/legacyregistry"
    24  )
    25  
    26  const kubeServiceAccountSubsystem = "serviceaccount"
    27  
    28  var (
    29  	// LegacyTokensTotal is the number of legacy tokens used against apiserver.
    30  	legacyTokensTotal = metrics.NewCounter(
    31  		&metrics.CounterOpts{
    32  			Subsystem:      kubeServiceAccountSubsystem,
    33  			Name:           "legacy_tokens_total",
    34  			Help:           "Cumulative legacy service account tokens used",
    35  			StabilityLevel: metrics.ALPHA,
    36  		},
    37  	)
    38  
    39  	// StaleTokensTotal is the number of stale projected tokens not refreshed on
    40  	// client side.
    41  	staleTokensTotal = metrics.NewCounter(
    42  		&metrics.CounterOpts{
    43  			Subsystem:      kubeServiceAccountSubsystem,
    44  			Name:           "stale_tokens_total",
    45  			Help:           "Cumulative stale projected service account tokens used",
    46  			StabilityLevel: metrics.ALPHA,
    47  		},
    48  	)
    49  
    50  	// mauallyCreatedTokensTotal is the number of manually created secret-based long lived tokens.
    51  	manuallyCreatedTokensTotal = metrics.NewCounter(
    52  		&metrics.CounterOpts{
    53  			Subsystem:      kubeServiceAccountSubsystem,
    54  			Name:           "legacy_manual_token_uses_total",
    55  			Help:           "Cumulative manually created legacy tokens used",
    56  			StabilityLevel: metrics.ALPHA,
    57  		},
    58  	)
    59  
    60  	// autoGeneratedTokensTotal is the number of automatically generated secret-based long lived tokens.
    61  	autoGeneratedTokensTotal = metrics.NewCounter(
    62  		&metrics.CounterOpts{
    63  			Subsystem:      kubeServiceAccountSubsystem,
    64  			Name:           "legacy_auto_token_uses_total",
    65  			Help:           "Cumulative auto-generated legacy tokens used",
    66  			StabilityLevel: metrics.ALPHA,
    67  		},
    68  	)
    69  
    70  	// invalidatedAutoTokensTotal is the number of uses of automatically generated secret-based long lived tokens that have been marked as invalid.
    71  	invalidatedAutoTokensTotal = metrics.NewCounter(
    72  		&metrics.CounterOpts{
    73  			Subsystem:      kubeServiceAccountSubsystem,
    74  			Name:           "invalid_legacy_auto_token_uses_total",
    75  			Help:           "Cumulative invalid auto-generated legacy tokens used",
    76  			StabilityLevel: metrics.ALPHA,
    77  		},
    78  	)
    79  
    80  	// ValidTokensTotal is the number of valid projected tokens used.
    81  	validTokensTotal = metrics.NewCounter(
    82  		&metrics.CounterOpts{
    83  			Subsystem:      kubeServiceAccountSubsystem,
    84  			Name:           "valid_tokens_total",
    85  			Help:           "Cumulative valid projected service account tokens used",
    86  			StabilityLevel: metrics.ALPHA,
    87  		},
    88  	)
    89  )
    90  
    91  var registerMetricsOnce sync.Once
    92  
    93  func RegisterMetrics() {
    94  	registerMetricsOnce.Do(func() {
    95  		legacyregistry.MustRegister(legacyTokensTotal)
    96  		legacyregistry.MustRegister(staleTokensTotal)
    97  		legacyregistry.MustRegister(manuallyCreatedTokensTotal)
    98  		legacyregistry.MustRegister(autoGeneratedTokensTotal)
    99  		legacyregistry.MustRegister(invalidatedAutoTokensTotal)
   100  		legacyregistry.MustRegister(validTokensTotal)
   101  	})
   102  }
   103
View as plain text