metrics.h

Go to the documentation of this file.

// Copyright 2024 The 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.
 
#ifndef GRPC_SUPPORT_METRICS_H
#define GRPC_SUPPORT_METRICS_H
 
#include <grpc/event_engine/endpoint_config.h>
#include <grpc/support/port_platform.h>
 
#include "absl/strings/string_view.h"
 
namespace grpc_core {
namespace experimental {
 
// Configuration (scope) for a specific client channel to be used for stats
// plugins. For some components like XdsClient where the same XdsClient instance
// can be shared across multiple channels that share the same target name but
// have different default authority and channel arguments, the component uses
// the configuration from the first channel that uses this XdsClient instance to
// determine StatsPluginChannelScope.
class StatsPluginChannelScope {
 public:
  StatsPluginChannelScope(
      absl::string_view target, absl::string_view default_authority,
      const grpc_event_engine::experimental::EndpointConfig& args)
      : target_(target), default_authority_(default_authority), args_(args) {}
 
  absl::string_view target() const { return target_; }
  absl::string_view default_authority() const { return default_authority_; }
  // TODO(roth, ctiller, yashkt): Find a better representation for
  // channel args before de-experimentalizing this API.
  const grpc_event_engine::experimental::EndpointConfig& experimental_args()
      const {
    return args_;
  }
 
 private:
  // Disable copy constructor and copy-assignment operator.
  StatsPluginChannelScope(const StatsPluginChannelScope&) = delete;
  StatsPluginChannelScope& operator=(const StatsPluginChannelScope&) = delete;
 
  absl::string_view target_;
  absl::string_view default_authority_;
  const grpc_event_engine::experimental::EndpointConfig& args_;
};
 
}  // namespace experimental
}  // namespace grpc_core
 
#endif /* GRPC_SUPPORT_METRICS_H */