Add metrics for OTA transfers #39991
Open
+219
−14
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces metrics for OTA transfers. It adds a new categorization system for metrics to separate OTA metrics from existing commissioning metrics. The changes include new APIs for metrics collection, logging OTA-related data, and a new test to verify the functionality. The review focuses on a potential breaking API change in the metrics collector, code duplication, and adherence to Objective-C coding idioms.
|
PR #39991: Size comparison from ad2e3f5 to abdc57c Full report (59 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
| @@ -477,6 +480,8 @@ MTR_EXTERN NSString * const MTRDataVersionKey MTR_AVAILABLE(ios(17.6), macos(14. | |||
| */ | |||
| - (void)deviceConfigurationChanged:(MTRDevice *)device MTR_AVAILABLE(ios(17.6), macos(14.6), watchos(10.6), tvos(17.6)); | |||
|
|
|||
| - (void)otaTransferEnded:(MTRDevice *)device metrics:(MTRMetrics *)metrics; | |||
There was a problem hiding this comment.
Though I wonder whether we should communicate the metrics to the actual "transfer ended" callback... but that might be hard due to the API changes needed, I guess.
There was a problem hiding this comment.
I'm not sure which callback you're talking about here.
woody-apple
reviewed
Jul 15, 2025
woody-apple
approved these changes
Jul 15, 2025
anush-apple
reviewed
Jul 15, 2025
src/darwin/Framework/CHIPTests/TestHelpers/MTRDeviceTestDelegate.m
Outdated
Show resolved
Hide resolved
anush-apple
reviewed
Jul 15, 2025
anush-apple
reviewed
Jul 15, 2025
Comment on lines
110
to
113
| constexpr Tracing::MetricKey kMetricOTADeviceVendorID = NOT_COMMISSIONING_METRICS_KEY(ota, device_vendor_id); | ||
|
|
||
| // Device Product ID | ||
| constexpr Tracing::MetricKey kMetricOTADeviceProductID = NOT_COMMISSIONING_METRICS_KEY(ota, device_product_id); |
There was a problem hiding this comment.
Just a thought: Is there a better way to have product and vendor ID that is the same key for all categories ?
There was a problem hiding this comment.
The issue is the filtering, we could special-case vendor and product id and never filter them?
There was a problem hiding this comment.
But even with filtering the issue is that if we have values for different categories that use the same key, then we might be deleting those for all categories as soon as we submit one of the categories.
anush-apple
reviewed
Jul 15, 2025
anush-apple
reviewed
Jul 15, 2025
Co-authored-by: Boris Zbarsky <bzbarsky@apple.com>
peterv-apple
force-pushed
the
push-prowzykrrnwv
branch
from
5ab4e94 to
ae331e9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This adds metrics for OTA BDX transfers, recording vendor id, product id, whether the device is on a Thread network, the offset and number of bytes processed and the duration of the transfer.
Because the metrics infrastructure was only used for commissioning before, I tried adding support for encoding categories in the existing key/value system. I also think we don't have good support for recording metrics during simultaneous transfers to different devices. That would require a bit of a redesign of the metrics system.
Testing
I added a new test that verifies that metrics are recorded. Unfortunately the OTA tests that do an actual transfer are all disabled in automation, because they used to timeout. I did verify locally that the test passes.
Readability checklist
The checklist below will help the reviewer finish PR review in time and keep the
code readable:
descriptive
“When in Rome…”
rule (coding style)
See: Pull Request Guidelines