call_metric_recorder.h

Go to the documentation of this file.

/*
 *
 * Copyright 2022 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_CALL_METRIC_RECORDER_H
#define GRPCPP_EXT_CALL_METRIC_RECORDER_H
 
#include <memory>
#include <string>
 
#include "absl/strings/string_view.h"
#include "absl/types/optional.h"
 
#include <grpcpp/impl/codegen/slice.h>
#include <grpcpp/impl/codegen/sync.h>
 
namespace grpc_core {
class Arena;
struct BackendMetricData;
}  // namespace grpc_core
 
namespace grpc {
class ServerBuilder;
 
namespace experimental {
class OrcaServerInterceptor;
 
// Registers the per-rpc orca load reporter into the \a ServerBuilder.
// Once this is done, the server will automatically send the load metrics
// after each RPC as they were reported. In order to report load metrics,
// call the \a ServerContext::ExperimentalGetCallMetricRecorder() method to
// retrieve the recorder for the current call.
void EnableCallMetricRecording(ServerBuilder*);
 
class CallMetricRecorder {
 public:
  explicit CallMetricRecorder(grpc_core::Arena* arena);
  ~CallMetricRecorder();
 
  CallMetricRecorder& RecordCpuUtilizationMetric(double value);
 
  CallMetricRecorder& RecordMemoryUtilizationMetric(double value);
 
  CallMetricRecorder& RecordUtilizationMetric(string_ref name, double value);
 
  CallMetricRecorder& RecordRequestCostMetric(string_ref name, double value);
 
 private:
  absl::optional<std::string> CreateSerializedReport();
 
  internal::Mutex mu_;
  grpc_core::BackendMetricData* backend_metric_data_ ABSL_GUARDED_BY(&mu_);
  friend class experimental::OrcaServerInterceptor;
};
 
}  // namespace experimental
}  // namespace grpc
 
#endif  // GRPCPP_EXT_CALL_METRIC_RECORDER_H