go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/buildbucket/appengine/internal/metrics/v2.go (about)

     1  // Copyright 2021 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  	"math"
    19  
    20  	"go.chromium.org/luci/common/tsmon/distribution"
    21  	"go.chromium.org/luci/common/tsmon/field"
    22  	"go.chromium.org/luci/common/tsmon/metric"
    23  	"go.chromium.org/luci/common/tsmon/types"
    24  
    25  	bbmetrics "go.chromium.org/luci/buildbucket/metrics"
    26  )
    27  
    28  var (
    29  	// V2 is a collection of metric objects for V2 metrics.
    30  	V2 = struct {
    31  		BuildCount              metric.Int
    32  		BuildCountCreated       metric.Counter
    33  		BuildCountStarted       metric.Counter
    34  		BuildCountCompleted     metric.Counter
    35  		BuildDurationCycle      metric.CumulativeDistribution
    36  		BuildDurationRun        metric.CumulativeDistribution
    37  		BuildDurationScheduling metric.CumulativeDistribution
    38  		BuilderPresence         metric.Bool
    39  		ConsecutiveFailureCount metric.Int
    40  		MaxAgeScheduled         metric.Float
    41  	}{
    42  		BuildCount: metric.NewIntWithTargetType(
    43  			"buildbucket/v2/builds/count",
    44  			(&bbmetrics.BuilderTarget{}).Type(),
    45  			"Number of pending/running prod builds",
    46  			nil,
    47  			field.String("status"),
    48  		),
    49  		BuildCountCreated: metric.NewCounterWithTargetType(
    50  			"buildbucket/v2/builds/created",
    51  			(&bbmetrics.BuilderTarget{}).Type(),
    52  			"Build creation",
    53  			nil,
    54  			field.String("experiments"),
    55  		),
    56  		BuildCountStarted: metric.NewCounterWithTargetType(
    57  			"buildbucket/v2/builds/started",
    58  			(&bbmetrics.BuilderTarget{}).Type(),
    59  			"Build start",
    60  			nil,
    61  			field.String("experiments"),
    62  		),
    63  		BuildCountCompleted: metric.NewCounterWithTargetType(
    64  			"buildbucket/v2/builds/completed",
    65  			(&bbmetrics.BuilderTarget{}).Type(),
    66  			"Build completion, including success, failure and cancellation",
    67  			nil,
    68  			field.String("status"),
    69  			field.String("experiments"),
    70  		),
    71  		BuildDurationCycle: metric.NewCumulativeDistributionWithTargetType(
    72  			"buildbucket/v2/builds/cycle_durations",
    73  			(&bbmetrics.BuilderTarget{}).Type(),
    74  			"Duration between build creation and completion",
    75  			&types.MetricMetadata{Units: types.Seconds},
    76  			// Bucketer for 1s..48h range
    77  			//
    78  			// python3 -c "print(((10**0.053)**100) / (60*60))"
    79  			// 55.42395319358006
    80  			distribution.GeometricBucketer(math.Pow(10, 0.053), 100),
    81  			field.String("status"),
    82  			field.String("experiments"),
    83  		),
    84  		BuildDurationRun: metric.NewCumulativeDistributionWithTargetType(
    85  			"buildbucket/v2/builds/run_durations",
    86  			(&bbmetrics.BuilderTarget{}).Type(),
    87  			"Duration between build start and completion",
    88  			&types.MetricMetadata{Units: types.Seconds},
    89  			// Bucketer for 1s..48h range
    90  			distribution.GeometricBucketer(math.Pow(10, 0.053), 100),
    91  			field.String("status"),
    92  			field.String("experiments"),
    93  		),
    94  		BuildDurationScheduling: metric.NewCumulativeDistributionWithTargetType(
    95  			"buildbucket/v2/builds/scheduling_durations",
    96  			(&bbmetrics.BuilderTarget{}).Type(),
    97  			"Duration between build creation and start",
    98  			&types.MetricMetadata{Units: types.Seconds},
    99  			// Bucketer for 1s..48h range
   100  			distribution.GeometricBucketer(math.Pow(10, 0.053), 100),
   101  			field.String("experiments"),
   102  		),
   103  		BuilderPresence: metric.NewBoolWithTargetType(
   104  			"buildbucket/v2/builder/presence",
   105  			(&bbmetrics.BuilderTarget{}).Type(),
   106  			"A constant, always-true metric that indicates the presence of LUCI Builder",
   107  			nil,
   108  		),
   109  		ConsecutiveFailureCount: metric.NewIntWithTargetType(
   110  			"buildbucket/v2/builds/consecutive_failure_count",
   111  			(&bbmetrics.BuilderTarget{}).Type(),
   112  			"Number of consecutive non-successful build terminations since the last successful build.",
   113  			nil,
   114  			field.String("status"),
   115  		),
   116  		MaxAgeScheduled: metric.NewFloatWithTargetType(
   117  			"buildbucket/v2/builds/max_age_scheduled",
   118  			(&bbmetrics.BuilderTarget{}).Type(),
   119  			"Age of the oldest SCHEDULED build",
   120  			&types.MetricMetadata{Units: types.Seconds},
   121  		),
   122  	}
   123  )