Chiebot-Mirror
/
grpc
mirror of https://github.com/grpc/grpc.git
8
0
Fork 0
Code Issues Projects Releases Wiki Activity

[metrics] Remove synchronous gauge API (#36334)

Browse Source 
<!--

If you know who should review your pull request, please assign it to that
person, otherwise the pull request would get assigned randomly.

If your pull request is for a specific language, please add the appropriate
lang label.

-->

Closes #36334

COPYBARA_INTEGRATE_REVIEW=https://github.com/grpc/grpc/pull/36334 from yijiem:grpc-metrics-better-compile-time-enforcement 2ae15acfeb
PiperOrigin-RevId: 623909848
pull/36341/head
Yijie Ma 10 months ago committed by Copybara-Service
parent 696d644bcf
commit 188bc021c3
7 changed files with 0 additions and 277 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 64
      src/core/lib/channel/metrics.cc
  2. 40
      src/core/lib/channel/metrics.h
  3. 5
      src/cpp/ext/otel/otel_plugin.cc
  4. 8
      src/cpp/ext/otel/otel_plugin.h
  5. 74
      test/core/channel/metrics_test.cc
  6. 18
      test/core/util/fake_stats_plugin.cc
  7. 68
      test/core/util/fake_stats_plugin.h

64
src/core/lib/channel/metrics.cc
Unescape View File

@ -160,70 +160,6 @@ GlobalInstrumentsRegistry::RegisterDoubleHistogram(
return handle;
}
GlobalInstrumentsRegistry::GlobalInt64GaugeHandle
GlobalInstrumentsRegistry::RegisterInt64Gauge(
absl::string_view name, absl::string_view description,
absl::string_view unit, absl::Span<const absl::string_view> label_keys,
absl::Span<const absl::string_view> optional_label_keys,
bool enable_by_default) {
auto& instruments = GetInstrumentList();
for (const auto& descriptor : instruments) {
if (descriptor.name == name) {
Crash(
absl::StrFormat("Metric name %s has already been registered.", name));
}
}
uint32_t index = instruments.size();
GPR_ASSERT(index < std::numeric_limits<uint32_t>::max());
GlobalInstrumentDescriptor descriptor;
descriptor.value_type = ValueType::kInt64;
descriptor.instrument_type = InstrumentType::kGauge;
descriptor.index = index;
descriptor.enable_by_default = enable_by_default;
descriptor.name = name;
descriptor.description = description;
descriptor.unit = unit;
descriptor.label_keys = {label_keys.begin(), label_keys.end()};
descriptor.optional_label_keys = {optional_label_keys.begin(),
optional_label_keys.end()};
instruments.push_back(std::move(descriptor));
GlobalInt64GaugeHandle handle;
handle.index = index;
return handle;
}
GlobalInstrumentsRegistry::GlobalDoubleGaugeHandle
GlobalInstrumentsRegistry::RegisterDoubleGauge(
absl::string_view name, absl::string_view description,
absl::string_view unit, absl::Span<const absl::string_view> label_keys,
absl::Span<const absl::string_view> optional_label_keys,
bool enable_by_default) {
auto& instruments = GetInstrumentList();
for (const auto& descriptor : instruments) {
if (descriptor.name == name) {
Crash(
absl::StrFormat("Metric name %s has already been registered.", name));
}
}
uint32_t index = instruments.size();
GPR_ASSERT(index < std::numeric_limits<uint32_t>::max());
GlobalInstrumentDescriptor descriptor;
descriptor.value_type = ValueType::kDouble;
descriptor.instrument_type = InstrumentType::kGauge;
descriptor.index = index;
descriptor.enable_by_default = enable_by_default;
descriptor.name = name;
descriptor.description = description;
descriptor.unit = unit;
descriptor.label_keys = {label_keys.begin(), label_keys.end()};
descriptor.optional_label_keys = {optional_label_keys.begin(),
optional_label_keys.end()};
instruments.push_back(std::move(descriptor));
GlobalDoubleGaugeHandle handle;
handle.index = index;
return handle;
}
GlobalInstrumentsRegistry::GlobalCallbackInt64GaugeHandle
GlobalInstrumentsRegistry::RegisterCallbackInt64Gauge(
absl::string_view name, absl::string_view description,

40
src/core/lib/channel/metrics.h
Unescape View File

@ -19,7 +19,6 @@
#include <memory>
#include <vector>
#include "absl/container/flat_hash_map.h"
#include "absl/functional/any_invocable.h"
#include "absl/functional/function_ref.h"
#include "absl/strings/string_view.h"
@ -58,7 +57,6 @@ class GlobalInstrumentsRegistry {
kUndefined,
kCounter,
kHistogram,
kGauge,
kCallbackGauge,
};
using InstrumentID = uint32_t;
@ -84,8 +82,6 @@ class GlobalInstrumentsRegistry {
struct GlobalDoubleCounterHandle : public GlobalInstrumentHandle {};
struct GlobalUInt64HistogramHandle : public GlobalInstrumentHandle {};
struct GlobalDoubleHistogramHandle : public GlobalInstrumentHandle {};
struct GlobalInt64GaugeHandle : public GlobalInstrumentHandle {};
struct GlobalDoubleGaugeHandle : public GlobalInstrumentHandle {};
struct GlobalCallbackInt64GaugeHandle : public GlobalInstrumentHandle {};
struct GlobalCallbackDoubleGaugeHandle : public GlobalInstrumentHandle {};
using GlobalCallbackHandle = absl::variant<GlobalCallbackInt64GaugeHandle,
@ -112,16 +108,6 @@ class GlobalInstrumentsRegistry {
absl::string_view unit, absl::Span<const absl::string_view> label_keys,
absl::Span<const absl::string_view> optional_label_keys,
bool enable_by_default);
static GlobalInt64GaugeHandle RegisterInt64Gauge(
absl::string_view name, absl::string_view description,
absl::string_view unit, absl::Span<const absl::string_view> label_keys,
absl::Span<const absl::string_view> optional_label_keys,
bool enable_by_default);
static GlobalDoubleGaugeHandle RegisterDoubleGauge(
absl::string_view name, absl::string_view description,
absl::string_view unit, absl::Span<const absl::string_view> label_keys,
absl::Span<const absl::string_view> optional_label_keys,
bool enable_by_default);
static GlobalCallbackInt64GaugeHandle RegisterCallbackInt64Gauge(
absl::string_view name, absl::string_view description,
absl::string_view unit, absl::Span<const absl::string_view> label_keys,
@ -220,22 +206,6 @@ class StatsPlugin {
GlobalInstrumentsRegistry::GlobalDoubleHistogramHandle handle,
double value, absl::Span<const absl::string_view> label_values,
absl::Span<const absl::string_view> optional_label_values) = 0;
// Sets an int64 \a value to the gauge specifed by \a handle. \a
// label_values and \a optional_label_values specify attributes that are
// associated with this measurement and must match with their corresponding
// keys in GlobalInstrumentsRegistry::RegisterInt64Gauge().
virtual void SetGauge(
GlobalInstrumentsRegistry::GlobalInt64GaugeHandle handle, int64_t value,
absl::Span<const absl::string_view> label_values,
absl::Span<const absl::string_view> optional_label_values) = 0;
// Sets a double \a value to the gauge specifed by \a handle. \a
// label_values and \a optional_label_values specify attributes that are
// associated with this measurement and must match with their corresponding
// keys in GlobalInstrumentsRegistry::RegisterDoubleGauge().
virtual void SetGauge(
GlobalInstrumentsRegistry::GlobalDoubleGaugeHandle handle, double value,
absl::Span<const absl::string_view> label_values,
absl::Span<const absl::string_view> optional_label_values) = 0;
// Adds a callback to be invoked when the stats plugin wants to
// populate the corresponding metrics (see callback->metrics() for list).
virtual void AddCallback(RegisteredMetricCallback* callback) = 0;
@ -304,16 +274,6 @@ class GlobalStatsPluginRegistry {
optional_values);
}
}
// Sets a value to a gauge in all stats plugins within the group. See the
// StatsPlugin interface for more documentation and valid types.
template <class HandleType, class ValueType>
void SetGauge(HandleType handle, ValueType value,
absl::Span<const absl::string_view> label_values,
absl::Span<const absl::string_view> optional_values) {
for (auto& state : plugins_state_) {
state.plugin->SetGauge(handle, value, label_values, optional_values);
}
}
// Registers a callback to be used to populate callback metrics.
// The callback will update the specified metrics. The callback

5
src/cpp/ext/otel/otel_plugin.cc
Unescape View File

@ -487,11 +487,6 @@ OpenTelemetryPlugin::OpenTelemetryPlugin(
descriptor.value_type));
}
break;
case grpc_core::GlobalInstrumentsRegistry::InstrumentType::kGauge:
grpc_core::Crash(
"Non-callback gauge is not supported and will be deleted in "
"the future.");
break;
case grpc_core::GlobalInstrumentsRegistry::InstrumentType::
kCallbackGauge:
switch (descriptor.value_type) {

8
src/cpp/ext/otel/otel_plugin.h
Unescape View File

@ -395,14 +395,6 @@ class OpenTelemetryPlugin : public grpc_core::StatsPlugin {
grpc_core::GlobalInstrumentsRegistry::GlobalDoubleHistogramHandle handle,
double value, absl::Span<const absl::string_view> label_values,
absl::Span<const absl::string_view> optional_values) override;
void SetGauge(
grpc_core::GlobalInstrumentsRegistry::GlobalInt64GaugeHandle /*handle*/,
int64_t /*value*/, absl::Span<const absl::string_view> /*label_values*/,
absl::Span<const absl::string_view> /*optional_values*/) override {}
void SetGauge(
grpc_core::GlobalInstrumentsRegistry::GlobalDoubleGaugeHandle /*handle*/,
double /*value*/, absl::Span<const absl::string_view> /*label_values*/,
absl::Span<const absl::string_view> /*optional_values*/) override {}
void AddCallback(grpc_core::RegisteredMetricCallback* callback)
ABSL_LOCKS_EXCLUDED(mu_) override;
void RemoveCallback(grpc_core::RegisteredMetricCallback* callback)

74
test/core/channel/metrics_test.cc
Unescape View File

@ -199,80 +199,6 @@ TEST_F(MetricsTest, DoubleHistogram) {
::testing::Optional(::testing::UnorderedElementsAre(1.23, 2.34, 3.45)));
}
TEST_F(MetricsTest, Int64Gauge) {
const absl::string_view kLabelKeys[] = {"label_key_1", "label_key_2"};
const absl::string_view kOptionalLabelKeys[] = {"optional_label_key_1",
"optional_label_key_2"};
auto int64_gauge_handle = GlobalInstrumentsRegistry::RegisterInt64Gauge(
"int64_gauge", "A simple int64 gauge.", "unit", kLabelKeys,
kOptionalLabelKeys, true);
constexpr absl::string_view kLabelValues[] = {"label_value_1",
"label_value_2"};
constexpr absl::string_view kOptionalLabelValues[] = {
"optional_label_value_1", "optional_label_value_2"};
constexpr absl::string_view kDomain1To4 = "domain1.domain2.domain3.domain4";
constexpr absl::string_view kDomain2To4 = "domain2.domain3.domain4";
constexpr absl::string_view kDomain3To4 = "domain3.domain4";
auto plugin1 = MakeStatsPluginForTarget(kDomain1To4);
auto plugin2 = MakeStatsPluginForTarget(kDomain2To4);
auto plugin3 = MakeStatsPluginForTarget(kDomain3To4);
GlobalStatsPluginRegistry::GetStatsPluginsForChannel(
StatsPluginChannelScope(kDomain1To4, ""))
.SetGauge(int64_gauge_handle, 1, kLabelValues, kOptionalLabelValues);
GlobalStatsPluginRegistry::GetStatsPluginsForChannel(
StatsPluginChannelScope(kDomain2To4, ""))
.SetGauge(int64_gauge_handle, 2, kLabelValues, kOptionalLabelValues);
GlobalStatsPluginRegistry::GetStatsPluginsForChannel(
StatsPluginChannelScope(kDomain3To4, ""))
.SetGauge(int64_gauge_handle, 3, kLabelValues, kOptionalLabelValues);
EXPECT_THAT(plugin1->GetGaugeValue(int64_gauge_handle, kLabelValues,
kOptionalLabelValues),
::testing::Optional(1));
EXPECT_THAT(plugin2->GetGaugeValue(int64_gauge_handle, kLabelValues,
kOptionalLabelValues),
::testing::Optional(2));
EXPECT_THAT(plugin3->GetGaugeValue(int64_gauge_handle, kLabelValues,
kOptionalLabelValues),
::testing::Optional(3));
}
TEST_F(MetricsTest, DoubleGauge) {
const absl::string_view kLabelKeys[] = {"label_key_1", "label_key_2"};
const absl::string_view kOptionalLabelKeys[] = {"optional_label_key_1",
"optional_label_key_2"};
auto double_gauge_handle = GlobalInstrumentsRegistry::RegisterDoubleGauge(
"double_gauge", "A simple double gauge.", "unit", kLabelKeys,
kOptionalLabelKeys, true);
constexpr absl::string_view kLabelValues[] = {"label_value_1",
"label_value_2"};
constexpr absl::string_view kOptionalLabelValues[] = {
"optional_label_value_1", "optional_label_value_2"};
constexpr absl::string_view kDomain1To4 = "domain1.domain2.domain3.domain4";
constexpr absl::string_view kDomain2To4 = "domain2.domain3.domain4";
constexpr absl::string_view kDomain3To4 = "domain3.domain4";
auto plugin1 = MakeStatsPluginForTarget(kDomain1To4);
auto plugin2 = MakeStatsPluginForTarget(kDomain2To4);
auto plugin3 = MakeStatsPluginForTarget(kDomain3To4);
GlobalStatsPluginRegistry::GetStatsPluginsForChannel(
StatsPluginChannelScope(kDomain1To4, ""))
.SetGauge(double_gauge_handle, 1.23, kLabelValues, kOptionalLabelValues);
GlobalStatsPluginRegistry::GetStatsPluginsForChannel(
StatsPluginChannelScope(kDomain2To4, ""))
.SetGauge(double_gauge_handle, 2.34, kLabelValues, kOptionalLabelValues);
GlobalStatsPluginRegistry::GetStatsPluginsForChannel(
StatsPluginChannelScope(kDomain3To4, ""))
.SetGauge(double_gauge_handle, 3.45, kLabelValues, kOptionalLabelValues);
EXPECT_THAT(plugin1->GetGaugeValue(double_gauge_handle, kLabelValues,
kOptionalLabelValues),
::testing::Optional(1.23));
EXPECT_THAT(plugin2->GetGaugeValue(double_gauge_handle, kLabelValues,
kOptionalLabelValues),
::testing::Optional(2.34));
EXPECT_THAT(plugin3->GetGaugeValue(double_gauge_handle, kLabelValues,
kOptionalLabelValues),
::testing::Optional(3.45));
}
TEST_F(MetricsTest, Int64CallbackGauge) {
const absl::string_view kLabelKeys[] = {"label_key_1", "label_key_2"};
const absl::string_view kOptionalLabelKeys[] = {"optional_label_key_1",

18
test/core/util/fake_stats_plugin.cc
Unescape View File

@ -175,24 +175,6 @@ GlobalInstrumentsRegistryTestPeer::FindDoubleHistogramHandleByName(
GlobalInstrumentsRegistry::InstrumentType::kHistogram);
}
absl::optional<GlobalInstrumentsRegistry::GlobalInt64GaugeHandle>
GlobalInstrumentsRegistryTestPeer::FindInt64GaugeHandleByName(
absl::string_view name) {
return FindInstrument<GlobalInstrumentsRegistry::GlobalInt64GaugeHandle>(
GlobalInstrumentsRegistry::GetInstrumentList(), name,
GlobalInstrumentsRegistry::ValueType::kInt64,
GlobalInstrumentsRegistry::InstrumentType::kGauge);
}
absl::optional<GlobalInstrumentsRegistry::GlobalDoubleGaugeHandle>
GlobalInstrumentsRegistryTestPeer::FindDoubleGaugeHandleByName(
absl::string_view name) {
return FindInstrument<GlobalInstrumentsRegistry::GlobalDoubleGaugeHandle>(
GlobalInstrumentsRegistry::GetInstrumentList(), name,
GlobalInstrumentsRegistry::ValueType::kDouble,
GlobalInstrumentsRegistry::InstrumentType::kGauge);
}
absl::optional<GlobalInstrumentsRegistry::GlobalCallbackInt64GaugeHandle>
GlobalInstrumentsRegistryTestPeer::FindCallbackInt64GaugeHandleByName(
absl::string_view name) {

68
test/core/util/fake_stats_plugin.h
Unescape View File

@ -239,16 +239,6 @@ class FakeStatsPlugin : public StatsPlugin {
}
break;
}
case GlobalInstrumentsRegistry::InstrumentType::kGauge: {
MutexLock lock(&mu_);
if (descriptor.value_type ==
GlobalInstrumentsRegistry::ValueType::kInt64) {
int64_gauges_.emplace(descriptor.index, descriptor);
} else {
double_gauges_.emplace(descriptor.index, descriptor);
}
break;
}
case GlobalInstrumentsRegistry::InstrumentType::kCallbackGauge: {
MutexLock lock(&callback_mu_);
if (descriptor.value_type ==
@ -347,34 +337,6 @@ class FakeStatsPlugin : public StatsPlugin {
if (iter == double_histograms_.end()) return;
iter->second.Record(value, label_values, optional_values);
}
void SetGauge(GlobalInstrumentsRegistry::GlobalInt64GaugeHandle handle,
int64_t value, absl::Span<const absl::string_view> label_values,
absl::Span<const absl::string_view> optional_values) override {
gpr_log(GPR_INFO,
"FakeStatsPlugin[%p]::RecordGauge(index=%u, value=(uint64)%lu, "
"label_values={%s}, optional_label_values={%s}",
this, handle.index, value,
absl::StrJoin(label_values, ", ").c_str(),
absl::StrJoin(optional_values, ", ").c_str());
MutexLock lock(&mu_);
auto iter = int64_gauges_.find(handle.index);
if (iter == int64_gauges_.end()) return;
iter->second.Set(value, label_values, optional_values);
}
void SetGauge(GlobalInstrumentsRegistry::GlobalDoubleGaugeHandle handle,
double value, absl::Span<const absl::string_view> label_values,
absl::Span<const absl::string_view> optional_values) override {
gpr_log(GPR_INFO,
"FakeStatsPlugin[%p]::RecordGauge(index=%u, value=(double)%f, "
"label_values={%s}, optional_label_values={%s}",
this, handle.index, value,
absl::StrJoin(label_values, ", ").c_str(),
absl::StrJoin(optional_values, ", ").c_str());
MutexLock lock(&mu_);
auto iter = double_gauges_.find(handle.index);
if (iter == double_gauges_.end()) return;
iter->second.Set(value, label_values, optional_values);
}
void AddCallback(RegisteredMetricCallback* callback) override {
gpr_log(GPR_INFO, "FakeStatsPlugin[%p]::AddCallback(%p)", this, callback);
callbacks_.insert(callback);
@ -439,28 +401,6 @@ class FakeStatsPlugin : public StatsPlugin {
}
return iter->second.GetValues(label_values, optional_values);
}
absl::optional<int64_t> GetGaugeValue(
GlobalInstrumentsRegistry::GlobalInt64GaugeHandle handle,
absl::Span<const absl::string_view> label_values,
absl::Span<const absl::string_view> optional_values) {
MutexLock lock(&mu_);
auto iter = int64_gauges_.find(handle.index);
if (iter == int64_gauges_.end()) {
return absl::nullopt;
}
return iter->second.GetValue(label_values, optional_values);
}
absl::optional<double> GetGaugeValue(
GlobalInstrumentsRegistry::GlobalDoubleGaugeHandle handle,
absl::Span<const absl::string_view> label_values,
absl::Span<const absl::string_view> optional_values) {
MutexLock lock(&mu_);
auto iter = double_gauges_.find(handle.index);
if (iter == double_gauges_.end()) {
return absl::nullopt;
}
return iter->second.GetValue(label_values, optional_values);
}
void TriggerCallbacks() {
gpr_log(GPR_INFO, "FakeStatsPlugin[%p]::TriggerCallbacks(): START", this);
Reporter reporter(*this);
@ -669,10 +609,6 @@ class FakeStatsPlugin : public StatsPlugin {
ABSL_GUARDED_BY(&mu_);
absl::flat_hash_map<uint32_t, Histogram<double>> double_histograms_
ABSL_GUARDED_BY(&mu_);
absl::flat_hash_map<uint32_t, Gauge<int64_t>> int64_gauges_
ABSL_GUARDED_BY(&mu_);
absl::flat_hash_map<uint32_t, Gauge<double>> double_gauges_
ABSL_GUARDED_BY(&mu_);
Mutex callback_mu_;
absl::flat_hash_map<uint32_t, Gauge<int64_t>> int64_callback_gauges_
ABSL_GUARDED_BY(&callback_mu_);
@ -725,10 +661,6 @@ class GlobalInstrumentsRegistryTestPeer {
FindUInt64HistogramHandleByName(absl::string_view name);
static absl::optional<GlobalInstrumentsRegistry::GlobalDoubleHistogramHandle>
FindDoubleHistogramHandleByName(absl::string_view name);
static absl::optional<GlobalInstrumentsRegistry::GlobalInt64GaugeHandle>
FindInt64GaugeHandleByName(absl::string_view name);
static absl::optional<GlobalInstrumentsRegistry::GlobalDoubleGaugeHandle>
FindDoubleGaugeHandleByName(absl::string_view name);
static absl::optional<
GlobalInstrumentsRegistry::GlobalCallbackInt64GaugeHandle>
FindCallbackInt64GaugeHandleByName(absl::string_view name);

Write Preview
Loading…
Cancel
Save