go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/gce/appengine/backend/internal/metrics/quota.go (about)

     1  // Copyright 2019 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package metrics
    16  
    17  import (
    18  	"context"
    19  
    20  	"go.chromium.org/luci/common/tsmon/field"
    21  	"go.chromium.org/luci/common/tsmon/metric"
    22  )
    23  
    24  var (
    25  	quotaLimit = metric.NewFloat(
    26  		"gce/quota/limit",
    27  		"The GCE quota limit for a particular metric.",
    28  		nil,
    29  		field.String("metric"),
    30  		field.String("project"),
    31  		field.String("region"),
    32  	)
    33  
    34  	quotaRemaining = metric.NewFloat(
    35  		"gce/quota/remaining",
    36  		"The remaining GCE quota for a particular metric.",
    37  		nil,
    38  		field.String("metric"),
    39  		field.String("project"),
    40  		field.String("region"),
    41  	)
    42  
    43  	quotaUsage = metric.NewFloat(
    44  		"gce/quota/usage",
    45  		"The GCE quota being used for a particular metric.",
    46  		nil,
    47  		field.String("metric"),
    48  		field.String("project"),
    49  		field.String("region"),
    50  	)
    51  )
    52  
    53  // UpdateQuota sets GCE quota metrics.
    54  func UpdateQuota(c context.Context, limit, usage float64, metric, project, region string) {
    55  	quotaLimit.Set(c, limit, metric, project, region)
    56  	quotaRemaining.Set(c, limit-usage, metric, project, region)
    57  	quotaUsage.Set(c, usage, metric, project, region)
    58  }