refactor: metrics instrumentation framework typing and structure #12717
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
|
Currently, only patch changes are allowed on master. Your PR labels (semver: minor) indicate that it cannot be merged into the master at this time. |
Test Results - Alternative Providers987 tests 584 ✅ 23m 22s ⏱️ Results for commit d2d3cff. ♻️ This comment has been updated with latest results. |
Test Results (amd64) - Integration, Bootstrap 5 files 5 suites 2h 22m 47s ⏱️ Results for commit d2d3cff. ♻️ This comment has been updated with latest results. |
9429212 to
e3bd187
Compare
e3bd187 to
cb3585a
Compare
alexrashed
reviewed
Jun 10, 2025
There was a problem hiding this comment.
Nice and clean refactoring to move away from the factory pattern. As you explained in your PR description, and as discussed in the previous PRs, I think this totally makes sense.
I added a few comments / questions / suggestions, afterwards this should be good to go! 💯
Thanks for continuously improving the analytics framework!
localstack-core/localstack/services/cloudformation/resource_provider.py
Outdated
Show resolved
Hide resolved
...-core/localstack/services/stepfunctions/asl/static_analyser/usage_metrics_static_analyser.py
Outdated
Show resolved
Hide resolved
localstack-core/localstack/utils/analytics/metrics/interface.py
Outdated
Show resolved
Hide resolved
localstack-core/localstack/utils/analytics/metrics/interface.py
Outdated
Show resolved
Hide resolved
5d2f749 to
d2d3cff
Compare
alexrashed
approved these changes
Jun 11, 2025
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.
Motivation
follow-up to PR #12386 (thanks @alexrashed for the inputs)
The refactoring simplifies the class hierarchy and removes the overloaded factory pattern, which is increasingly becoming a code smell, as Counter and LabeledCounter evolve with diverging behavior and only partially overlapping interfaces.
The previous design made it increasingly difficult to enforce both static and dynamic typing guarantees, leading to ambiguity around the correct usage of the Counter and weakening the overall abstraction. The new structure clearly separates responsibilities, improves type safety at both runtime and development time, and lays a more solid foundation for extensibility.
Additionally, the monolithic
metrics.pymodule will be split into smaller, focused modules.Testing
pytest tests/unit/utils/analytics/test_metrics.pyTODO
note: the corresponding updates to the classes using the Counter in the ext package have been addressed in PR #4638