Skip to content

metrics service: fix wrong argument arrange on MetricsServiceSink #17127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattklein123 merged 3 commits into from
Jul 2, 2021
Merged

metrics service: fix wrong argument arrange on MetricsServiceSink #17127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8b703c
metrics service: fix wrong argument arrange on MetricsServiceSink
Shikugawa Jun 24, 2021
35517b7
fix test
Shikugawa Jun 25, 2021
ab0fa2e
fix
Shikugawa Jun 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions source/extensions/stat_sinks/metrics_service/config.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ MetricsServiceSinkFactory::createStatsSink(const Protobuf::Message& config,

return std::make_unique<MetricsServiceSink<envoy::service::metrics::v3::StreamMetricsMessage,
envoy::service::metrics::v3::StreamMetricsResponse>>(
grpc_metrics_streamer, sink_config.emit_tags_as_labels(),
PROTOBUF_GET_WRAPPED_OR_DEFAULT(sink_config, report_counters_as_deltas, false));
grpc_metrics_streamer,
PROTOBUF_GET_WRAPPED_OR_DEFAULT(sink_config, report_counters_as_deltas, false),
sink_config.emit_tags_as_labels());
}

ProtobufTypes::MessagePtr MetricsServiceSinkFactory::createEmptyConfigProto() {
Expand Down
50 changes: 39 additions & 11 deletions test/extensions/stats_sinks/metrics_service/grpc_metrics_service_impl_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
#include "test/mocks/thread_local/mocks.h"
#include "test/test_common/simulated_time_system.h"

#include "io/prometheus/client/metrics.pb.h"

using namespace std::chrono_literals;
using testing::_;
using testing::InSequence;
Expand Down Expand Up @@ -186,17 +188,43 @@ TEST_F(MetricsServiceSinkTest, ReportCountersValues) {

// Test that verifies counters are reported as the delta between flushes when configured to do so.
TEST_F(MetricsServiceSinkTest, ReportCountersAsDeltas) {
MetricsServiceSink<envoy::service::metrics::v3::StreamMetricsMessage,
envoy::service::metrics::v3::StreamMetricsResponse>
sink(streamer_, true, false);

addCounterToSnapshot("test_counter", 1, 100);
counter_storage_.back()->setTagExtractedName("tag-counter-name");
counter_storage_.back()->setTags({{"a", "b"}});

EXPECT_CALL(*streamer_, send(_)).WillOnce(Invoke([](MetricsPtr&& metrics) {
EXPECT_EQ(1, metrics->size());
EXPECT_EQ(1, (*metrics)[0].metric(0).counter().value());
}));
sink.flush(snapshot_);
{
// This test won't emit any labels.
MetricsServiceSink<envoy::service::metrics::v3::StreamMetricsMessage,
envoy::service::metrics::v3::StreamMetricsResponse>
sink(streamer_, true, false);

EXPECT_CALL(*streamer_, send(_)).WillOnce(Invoke([](MetricsPtr&& metrics) {
ASSERT_EQ(1, metrics->size());
EXPECT_EQ("test_counter", (*metrics)[0].name());

const auto& metric = (*metrics)[0].metric(0);
EXPECT_EQ(1, metric.counter().value());
EXPECT_EQ(0, metric.label().size());
}));
sink.flush(snapshot_);
}

{
// This test will emit labels.
MetricsServiceSink<envoy::service::metrics::v3::StreamMetricsMessage,
envoy::service::metrics::v3::StreamMetricsResponse>
sink(streamer_, true, true);

EXPECT_CALL(*streamer_, send(_)).WillOnce(Invoke([](MetricsPtr&& metrics) {
ASSERT_EQ(1, metrics->size());
EXPECT_EQ("tag-counter-name", (*metrics)[0].name());

const auto& metric = (*metrics)[0].metric(0);
EXPECT_EQ(1, metric.counter().value());
EXPECT_EQ(1, metric.label().size());
}));
sink.flush(snapshot_);
}
}

// Test the behavior of tag emission based on the emit_tags_as_label flag.
Expand All @@ -217,7 +245,7 @@ TEST_F(MetricsServiceSinkTest, ReportMetricsWithTags) {
// When the emit_tags flag is false, we don't emit the tags and use the full name.
MetricsServiceSink<envoy::service::metrics::v3::StreamMetricsMessage,
envoy::service::metrics::v3::StreamMetricsResponse>
sink(streamer_, true, false);
sink(streamer_, false, false);

EXPECT_CALL(*streamer_, send(_)).WillOnce(Invoke([](MetricsPtr&& metrics) {
EXPECT_EQ(4, metrics->size());
Expand All @@ -244,7 +272,7 @@ TEST_F(MetricsServiceSinkTest, ReportMetricsWithTags) {
// When the emit_tags flag is true, we emit the tags as labels and use the tag extracted name.
MetricsServiceSink<envoy::service::metrics::v3::StreamMetricsMessage,
envoy::service::metrics::v3::StreamMetricsResponse>
sink(streamer_, true, true);
sink(streamer_, false, true);

EXPECT_CALL(*streamer_, send(_)).WillOnce(Invoke([&expected_label_pair](MetricsPtr&& metrics) {
EXPECT_EQ(4, metrics->size());
Expand Down