Skip to content

fix: telemetry configuration_change payload #152

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
dmehala merged 1 commit into from
Sep 15, 2024
Merged

fix: telemetry configuration_change payload #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 5 additions & 9 deletions src/datadog/tracer_telemetry.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,16 +356,12 @@ std::string TracerTelemetry::configuration_change() {
generate_configuration_field(config_metadata));
}

// clang-format off
auto configuration_change = nlohmann::json({
{"request_type", "app-client-configuration-change"},
{"payload", nlohmann::json{
{"configuration", configuration_json}
}}
});
// clang-format on
auto telemetry_body =
generate_telemetry_body("app-client-configuration-change");
telemetry_body["payload"] =
nlohmann::json{{"configuration", configuration_json}};

return configuration_change.dump();
return telemetry_body.dump();
}

} // namespace tracing
Expand Down
24 changes: 23 additions & 1 deletion test/test_tracer_telemetry.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@

using namespace datadog::tracing;

namespace {
bool is_valid_telemetry_payload(const nlohmann::json& json) {
return json.contains("/api_version"_json_pointer) &&
json.at("api_version") == "v2" &&
json.contains("/seq_id"_json_pointer) &&
json.contains("/request_type"_json_pointer) &&
json.contains("/tracer_time"_json_pointer) &&
json.contains("/runtime_id"_json_pointer) &&
json.contains("/payload"_json_pointer) &&
json.contains("/application"_json_pointer) &&
json.contains("/host"_json_pointer);
}

} // namespace

TEST_CASE("Tracer telemetry", "[telemetry]") {
const std::time_t mock_time = 1672484400;
const Clock clock = [mock_time]() {
Expand All @@ -37,6 +52,7 @@ TEST_CASE("Tracer telemetry", "[telemetry]") {
SECTION("Without a defined integration") {
auto app_started_message = tracer_telemetry.app_started({});
auto app_started = nlohmann::json::parse(app_started_message);
REQUIRE(is_valid_telemetry_payload(app_started) == true);
REQUIRE(app_started["request_type"] == "message-batch");
REQUIRE(app_started["payload"].size() == 1);

Expand All @@ -50,6 +66,7 @@ TEST_CASE("Tracer telemetry", "[telemetry]") {
true, clock, logger, tracer_signature, "nginx", "1.25.2"};
auto app_started_message = tracer_telemetry.app_started({});
auto app_started = nlohmann::json::parse(app_started_message);
REQUIRE(is_valid_telemetry_payload(app_started) == true);
REQUIRE(app_started["request_type"] == "message-batch");
REQUIRE(app_started["payload"].size() == 2);

Expand All @@ -68,8 +85,8 @@ TEST_CASE("Tracer telemetry", "[telemetry]") {
ConfigMetadata::Origin::CODE)}};

auto app_started_message = tracer_telemetry.app_started(configuration);

auto app_started = nlohmann::json::parse(app_started_message);
REQUIRE(is_valid_telemetry_payload(app_started) == true);
REQUIRE(app_started["request_type"] == "message-batch");
REQUIRE(app_started["payload"].is_array());
REQUIRE(app_started["payload"].size() == 1);
Expand Down Expand Up @@ -97,6 +114,7 @@ TEST_CASE("Tracer telemetry", "[telemetry]") {
auto config_change_message = nlohmann::json::parse(
tracer_telemetry.configuration_change(), nullptr, false);
REQUIRE(config_change_message.is_discarded() == false);
REQUIRE(is_valid_telemetry_payload(app_started) == true);

CHECK(config_change_message["request_type"] ==
"app-client-configuration-change");
Expand All @@ -115,6 +133,7 @@ TEST_CASE("Tracer telemetry", "[telemetry]") {
auto config_change_message = nlohmann::json::parse(
tracer_telemetry.configuration_change(), nullptr, false);
REQUIRE(config_change_message.is_discarded() == false);
REQUIRE(is_valid_telemetry_payload(config_change_message) == true);

CHECK(config_change_message["request_type"] ==
"app-client-configuration-change");
Expand Down Expand Up @@ -149,6 +168,7 @@ TEST_CASE("Tracer telemetry", "[telemetry]") {
SECTION("generates a heartbeat message") {
auto heartbeat_message = tracer_telemetry.heartbeat_and_telemetry();
auto message_batch = nlohmann::json::parse(heartbeat_message);
REQUIRE(is_valid_telemetry_payload(message_batch) == true);
REQUIRE(message_batch["payload"].size() == 1);
auto heartbeat = message_batch["payload"][0];
REQUIRE(heartbeat["request_type"] == "app-heartbeat");
Expand All @@ -166,6 +186,7 @@ TEST_CASE("Tracer telemetry", "[telemetry]") {
auto heartbeat_and_telemetry_message =
tracer_telemetry.heartbeat_and_telemetry();
auto message_batch = nlohmann::json::parse(heartbeat_and_telemetry_message);
REQUIRE(is_valid_telemetry_payload(message_batch) == true);
REQUIRE(message_batch["payload"].size() == 2);
auto generate_metrics = message_batch["payload"][1];
REQUIRE(generate_metrics["request_type"] == "generate-metrics");
Expand All @@ -186,6 +207,7 @@ TEST_CASE("Tracer telemetry", "[telemetry]") {
SECTION("generates an app-closing event") {
auto app_closing_message = tracer_telemetry.app_closing();
auto message_batch = nlohmann::json::parse(app_closing_message);
REQUIRE(is_valid_telemetry_payload(message_batch) == true);
REQUIRE(message_batch["payload"].size() == 1);
auto heartbeat = message_batch["payload"][0];
REQUIRE(heartbeat["request_type"] == "app-closing");
Expand Down