server_metric_recorder.h

Go to the documentation of this file.

//
//
// Copyright 2023 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 GRPCPP_EXT_SERVER_METRIC_RECORDER_H
#define GRPCPP_EXT_SERVER_METRIC_RECORDER_H
 
#include <functional>
#include <map>
#include <memory>
 
#include <grpcpp/impl/sync.h>
#include <grpcpp/support/string_ref.h>
 
namespace grpc_core {
struct BackendMetricData;
}  // namespace grpc_core
 
namespace grpc {
class BackendMetricState;
 
namespace experimental {
class ServerMetricRecorder {
 public:
  // Factory method. Use this to create.
  static std::unique_ptr<ServerMetricRecorder> Create();
  void SetCpuUtilization(double value);
  void SetMemoryUtilization(double value);
  void SetApplicationUtilization(double value);
  void SetQps(double value);
  void SetEps(double value);
  void SetNamedUtilization(string_ref name, double value);
  void SetAllNamedUtilization(std::map<string_ref, double> named_utilization);
 
  void ClearCpuUtilization();
  void ClearMemoryUtilization();
  void ClearApplicationUtilization();
  void ClearQps();
  void ClearEps();
  void ClearNamedUtilization(string_ref name);
 
 private:
  // To access GetMetrics().
  friend class grpc::BackendMetricState;
  friend class OrcaService;
 
  struct BackendMetricDataState;
 
  // No direct creation, use the factory method Create() above.
  ServerMetricRecorder();
 
  // Updates the metric state by applying `updater` to the data and incrementing
  // the sequence number.
  void UpdateBackendMetricDataState(
      std::function<void(grpc_core::BackendMetricData*)> updater);
 
  grpc_core::BackendMetricData GetMetrics() const;
  // Returned metric data is guaranteed to be identical between two calls if the
  // sequence numbers match.
  std::shared_ptr<const BackendMetricDataState> GetMetricsIfChanged() const;
 
  mutable grpc::internal::Mutex mu_;
  std::shared_ptr<const BackendMetricDataState> metric_state_
      ABSL_GUARDED_BY(mu_);
};
 
}  // namespace experimental
}  // namespace grpc
 
#endif  // GRPCPP_EXT_SERVER_METRIC_RECORDER_H