buildbucket/metrics/builder.go

// Copyright 2022 The LUCI 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 bbmetrics

import (
	"hash/fnv"
	"reflect"

	"go.chromium.org/luci/common/tsmon/target"
	tsmonpb "go.chromium.org/luci/common/tsmon/ts_mon_proto"
	"go.chromium.org/luci/common/tsmon/types"
)

// BuilderTarget is a metric target that represents a LUCI Builder.
type BuilderTarget struct {
	// Project is the LUCI project of the Builder.
	Project string
	// Bucket is the bucket name of the Builder.
	Bucket string
	// Builder is the name of the Builder.
	Builder string

	// ServiceName is the reporting service name.
	//
	// For a GAE app, typically, it will be the GAE application name.
	ServiceName string
	// JobName is the reporting service name.
	//
	// For a GAE app, typically, it will be the module name of the GAE
	// application.
	JobName string
	// InstanceID is the ID of the reporting instance.
	//
	// For a GAE app, typically, it will be the GAE host name.
	InstanceID string
}

// Clone returns a deep copy.
func (b *BuilderTarget) Clone() types.Target {
	clone := *b
	return &clone
}

// Type returns the metric type identification.
func (b *BuilderTarget) Type() types.TargetType {
	return types.TargetType{
		Name: "buildbucket.Builder",
		Type: reflect.TypeOf(&BuilderTarget{}),
	}
}

// Hash computes a hash of the Builder object.
func (b *BuilderTarget) Hash() uint64 {
	h := fnv.New64a()
	h.Write([]byte(b.Project))
	h.Write([]byte(b.Bucket))
	h.Write([]byte(b.Builder))
	h.Write([]byte(b.ServiceName))
	h.Write([]byte(b.JobName))
	h.Write([]byte(b.InstanceID))
	return h.Sum64()
}

// PopulateProto populates root labels into the proto for the target fields.
func (b *BuilderTarget) PopulateProto(d *tsmonpb.MetricsCollection) {
	d.RootLabels = []*tsmonpb.MetricsCollection_RootLabels{
		target.RootLabel("project", b.Project),
		target.RootLabel("bucket", b.Bucket),
		target.RootLabel("builder", b.Builder),

		target.RootLabel("service_name", b.ServiceName),
		target.RootLabel("job_name", b.JobName),
		target.RootLabel("instance_id", b.InstanceID),
	}
}