Repository: grpc/grpc-go
File: xds/internal/clients/xdsclient/metrics/metrics.go (Go)

Code before:
/*
 *
 * Copyright 2025 gRPC 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 metrics defines all metrics that can be produced by an xDS client.
// All calls to the MetricsRecorder by the xDS client will contain a struct
// from this package passed by pointer.
package metrics

// MetricResourceUpdateValid is a metric to report a valid resource update from
// the xDS management server for a given resource type.
type MetricResourceUpdateValid struct {
	ServerURI    string // ServerURI of the xDS management server.
	ResourceType string // Resource type.
}

// MetricResourceUpdateInvalid is a metric to report an invalid resource update
// from the xDS management server for a given resource type.
type MetricResourceUpdateInvalid struct {
	ServerURI    string // ServerURI of the xDS management server.
	ResourceType string // Resource type.
}

// MetricServerFailure is a metric to report a server failure of the xDS
// management server.
type MetricServerFailure struct {
	ServerURI string // ServerURI of the xDS management server.
}


Review comment (suggestion):
I think we can drop the `Metric` prefix from these types since they end up being used currently as `metrics.MetricResourceUpdateValid` at callsites, which is harded to read compared to `metrics.ResourceUpdateValid`.

Code after:
/*
 *
 * Copyright 2025 gRPC 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 metrics defines all metrics that can be produced by an xDS client.
// All calls to the MetricsRecorder by the xDS client will contain a struct
// from this package passed by pointer.
package metrics

// ResourceUpdateValid is a metric to report a valid resource update from
// the xDS management server for a given resource type.
type ResourceUpdateValid struct {
	ServerURI    string
	ResourceType string
}

// ResourceUpdateInvalid is a metric to report an invalid resource update
// from the xDS management server for a given resource type.
type ResourceUpdateInvalid struct {
	ServerURI    string
	ResourceType string
}

// ServerFailure is a metric to report a server failure of the xDS
// management server.
type ServerFailure struct {
	ServerURI string
}