Skip to content
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

Add retransmission count to MRP TransmitEvent #37768

Merged
merged 3 commits into from
Feb 27, 2025
Merged

Add retransmission count to MRP TransmitEvent #37768

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
7a8cd32
Add retransmission count to MRP TransmitEvent
tehampson Feb 25, 2025
3807500
Self review
tehampson Feb 25, 2025
8becdc8
Change forth to fourth
tehampson Feb 26, 2025
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: 5 additions & 0 deletions src/messaging/ReliableMessageAnalyticsDelegate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@

#pragma once

#include <optional>

#include <lib/core/DataModelTypes.h>
#include <lib/core/NodeId.h>

Expand Down Expand Up @@ -65,6 +67,9 @@ class ReliableMessageAnalyticsDelegate
// The outgoing message counter associated with the event. If there is no outgoing message counter
// this value will be 0.
uint32_t messageCounter = 0;
// If the eventType is kRetransmission, this value will be populated with the number of the
// retransmission attempt
Copy link
Contributor

@bzbarsky-apple bzbarsky-apple Feb 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to document what "2" means: the first retransmission (i.e. the second packet sent), or the second retransmission (third packet sent).

std::optional<uint8_t> retransmissionCount;
};

virtual void OnTransmitEvent(const TransmitEvent & event) = 0;
Expand Down
6 changes: 6 additions & 0 deletions src/messaging/ReliableMessageMgr.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,12 @@ void ReliableMessageMgr::NotifyMessageSendAnalytics(const RetransTableEntry & en
ReliableMessageAnalyticsDelegate::SessionType::kEstablishedCase,
.eventType = eventType,
.messageCounter = messageCounter };

if (eventType == ReliableMessageAnalyticsDelegate::EventType::kRetransmission)
{
event.retransmissionCount = entry.sendCount;
}

mAnalyticsDelegate->OnTransmitEvent(event);
}
#endif // CHIP_CONFIG_MRP_ANALYTICS_ENABLED
Expand Down
32 changes: 22 additions & 10 deletions src/messaging/tests/TestReliableMessageProtocol.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2144,6 +2144,7 @@ TEST_F(TestReliableMessageProtocol, CheckReliableMessageAnalyticsForTransmitEven
EXPECT_EQ(firstTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(firstTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(firstTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kInitialSend);
EXPECT_EQ(firstTransmitEvent.retransmissionCount, std::nullopt);
// We have no way of validating the first messageCounter since this is a randomly generated value, but it should
// remain constant for all subsequent transmit events in this test.
const uint32_t messageCounter = firstTransmitEvent.messageCounter;
Expand All @@ -2153,34 +2154,39 @@ TEST_F(TestReliableMessageProtocol, CheckReliableMessageAnalyticsForTransmitEven
EXPECT_EQ(secondTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(secondTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(secondTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(secondTransmitEvent.retransmissionCount, 1);
EXPECT_EQ(messageCounter, secondTransmitEvent.messageCounter);

testAnalyticsDelegate.mTransmitEvents.pop();
auto thirdTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(thirdTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(thirdTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(thirdTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(thirdTransmitEvent.retransmissionCount, 2);
EXPECT_EQ(messageCounter, thirdTransmitEvent.messageCounter);

testAnalyticsDelegate.mTransmitEvents.pop();
auto forthTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(forthTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(forthTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(forthTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(messageCounter, forthTransmitEvent.messageCounter);
auto fourthTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(fourthTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(fourthTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(fourthTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(fourthTransmitEvent.retransmissionCount, 3);
EXPECT_EQ(messageCounter, fourthTransmitEvent.messageCounter);

testAnalyticsDelegate.mTransmitEvents.pop();
auto fifthTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(fifthTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(fifthTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(fifthTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(fifthTransmitEvent.retransmissionCount, 4);
EXPECT_EQ(messageCounter, fifthTransmitEvent.messageCounter);

testAnalyticsDelegate.mTransmitEvents.pop();
auto sixthTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(sixthTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(sixthTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(sixthTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kAcknowledged);
EXPECT_EQ(sixthTransmitEvent.retransmissionCount, std::nullopt);
EXPECT_EQ(messageCounter, sixthTransmitEvent.messageCounter);
}

Expand Down Expand Up @@ -2280,6 +2286,7 @@ TEST_F(TestReliableMessageProtocol, CheckReliableMessageAnalyticsForTransmitFail
EXPECT_EQ(firstTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(firstTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(firstTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kInitialSend);
EXPECT_EQ(firstTransmitEvent.retransmissionCount, std::nullopt);
// We have no way of validating the first messageCounter since this is a randomly generated value, but it should
// remain constant for all subsequent transmit events in this test.
const uint32_t messageCounter = firstTransmitEvent.messageCounter;
Expand All @@ -2289,33 +2296,38 @@ TEST_F(TestReliableMessageProtocol, CheckReliableMessageAnalyticsForTransmitFail
EXPECT_EQ(secondTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(secondTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(secondTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(secondTransmitEvent.retransmissionCount, 1);
EXPECT_EQ(messageCounter, secondTransmitEvent.messageCounter);

testAnalyticsDelegate.mTransmitEvents.pop();
auto thirdTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(thirdTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(thirdTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(thirdTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(thirdTransmitEvent.retransmissionCount, 2);
EXPECT_EQ(messageCounter, thirdTransmitEvent.messageCounter);

testAnalyticsDelegate.mTransmitEvents.pop();
auto forthTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(forthTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(forthTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(forthTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(messageCounter, forthTransmitEvent.messageCounter);
auto fourthTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(fourthTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(fourthTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(fourthTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(fourthTransmitEvent.retransmissionCount, 3);
EXPECT_EQ(messageCounter, fourthTransmitEvent.messageCounter);

testAnalyticsDelegate.mTransmitEvents.pop();
auto fifthTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(fifthTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(fifthTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(fifthTransmitEvent.retransmissionCount, 4);
EXPECT_EQ(fifthTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kRetransmission);
EXPECT_EQ(messageCounter, fifthTransmitEvent.messageCounter);

testAnalyticsDelegate.mTransmitEvents.pop();
auto sixthTransmitEvent = testAnalyticsDelegate.mTransmitEvents.front();
EXPECT_EQ(sixthTransmitEvent.nodeId, expectedNodeId);
EXPECT_EQ(sixthTransmitEvent.fabricIndex, expectedFabricIndex);
EXPECT_EQ(sixthTransmitEvent.retransmissionCount, std::nullopt);
EXPECT_EQ(sixthTransmitEvent.eventType, ReliableMessageAnalyticsDelegate::EventType::kFailed);
EXPECT_EQ(messageCounter, sixthTransmitEvent.messageCounter);
}
Expand Down
Loading