feat: add observability metrics for undo log manager by Sumit6307 · Pull Request #7984 · apache/incubator-seata

Sumit6307 · 2026-02-02T12:17:04Z

Ⅰ. Describe what this PR did

Detailed description:
This PR introduces observability metrics to the UndoLogManager in the rm-datasource module. Currently, there is limited visibility into the size and performance of Undo Log operations, which are critical for the stability and performance of AT mode.

The specific changes are:

Added Dependency: Added seata-metrics-core to rm-datasource/pom.xml to enable metrics recording.
Defined Metrics: Added new metric definitions in UndoLogConstants:
- seata.undo.log.size (Summary): Tracks the size of generated undo logs.
- seata.undo.log.delete.latency (Timer): Tracks the latency of undo log deletion operations (both single and batch).
- seata.undo.log.delete.count (Counter): Tracks the number of delete operations.
Instrumentation: Updated AbstractUndoLogManager to record these metrics during flush and delete operations.
Verification: Added UndoLogMetricsTest to verify the metrics recording logic using Mockito.

Ⅱ. Does this pull request fix one issue?

N/A (New Feature / GSoC Contribution)

Ⅲ. Why don't you add test cases (unit test/integration test)?

I have added a new unit test class org.apache.seata.rm.datasource.undo.UndoLogMetricsTest to verify the metrics recording logic independently of the database.

Ⅳ. Describe how to verify it

Run the new unit test: mvn test -pl rm-datasource -Dtest=UndoLogMetricsTest
In a running Seata environment, enable metrics in registry.conf.
Execute AT mode transactions.
Observe the new metrics (seata.undo.log.size, seata.undo.log.delete.latency) in the configured metrics backend (e.g., Prometheus).

Ⅴ. Special notes for reviews

The seata-metrics-core dependency was added to rm-datasource to access RegistryFactory and Id classes.

…meout - doPostWithHttp2(..., callback, 30) used 30ms timeout; watch holds until event (~2s) - Change to 30000ms to match blocking watch() test so callback runs and latch counts down - Fixes 'expected: <true> but was: <false>' at latch.await(35, TimeUnit.SECONDS)

funky-eyes

I'd appreciate it if you could open a related discussion issue and reach consensus there before submitting a PR, rather than coding first and opening a PR immediately.

Sumit6307 · 2026-02-03T06:18:15Z

I'd appreciate it if you could open a related discussion issue and reach consensus there before submitting a PR, rather than coding first and opening a PR immediately.

@funky-eyes
Okay sir, understood. I am currently working on the PR feat: add observability metrics for undo log manager #7984 .From next time, I’ll make sure to open a related discussion issue first and reach consensus before submitting a PR. Thank you for the guidance.

codecov · 2026-02-05T14:40:20Z

Codecov Report

❌ Patch coverage is 72.91667% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.09%. Comparing base (1145e54) to head (37844e3).

Files with missing lines	Patch %	Lines
...ata/rm/datasource/undo/AbstractUndoLogManager.java	63.88%	7 Missing and 6 partials ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##                2.x    #7984      +/-   ##
============================================
- Coverage     72.12%   72.09%   -0.04%     
  Complexity      872      872              
============================================
  Files          1320     1320              
  Lines         50550    50598      +48     
  Branches       6026     6033       +7     
============================================
+ Hits          36459    36478      +19     
- Misses        11101    11113      +12     
- Partials       2990     3007      +17

Files with missing lines	Coverage Δ
...che/seata/rm/datasource/undo/UndoLogConstants.java	`100.00% <100.00%> (ø)`
...ata/rm/datasource/undo/AbstractUndoLogManager.java	`57.91% <63.88%> (+0.82%)`	⬆️

... and 10 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sumit6307 · 2026-02-05T14:56:54Z

@funky-eyes Please Review and Merge this PR

Sumit6307 · 2026-03-05T20:02:51Z

@funky-eyes Please Check

Sumit6307 · 2026-03-11T17:58:30Z

@funky-eyes Sir Please Review this PR

Copilot

Pull request overview

This PR adds observability metrics around undo-log generation and deletion in the rm-datasource module, improving visibility into AT-mode undo-log size and delete latency/count.

Changes:

Add UndoLog metrics Id definitions (summary/timer/counter) in UndoLogConstants.
Instrument undo-log flush and delete (single + batch) paths in AbstractUndoLogManager to record metrics.
Add seata-metrics-core dependency and a Mockito-based unit test verifying metric recording.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File	Description
rm-datasource/src/main/java/org/apache/seata/rm/datasource/undo/AbstractUndoLogManager.java	Records undo-log size and delete latency/count; adds `getRegistry()` helper for metrics access
rm-datasource/src/main/java/org/apache/seata/rm/datasource/undo/UndoLogConstants.java	Defines metric `Id`s for undo-log size and delete timer/counter
rm-datasource/src/test/java/org/apache/seata/rm/datasource/undo/UndoLogMetricsTest.java	Adds unit tests verifying metrics are recorded for flush and single delete
rm-datasource/pom.xml	Adds `seata-metrics-core` dependency to enable metrics recording

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sumit6307 · 2026-03-25T19:12:16Z

Hi @funky-eyes ! Just a quick heads-up outside of the PR review: I am currently submitting my GSoC 2026 proposal for Apache Seata, titled "Enhance Seata Go SDK Multi Registry Support and Seata CTL Diagnostic Tool".

I saw FinnTew is listed as a potential mentor. Since you've reviewed most of my recent merged and open PRs, I just wanted to ask if you are also going to be mentoring any GSoC projects this year?

Thanks again for all your reviews on my code so far!

funky-eyes · 2026-04-01T07:09:40Z

Hi @funky-eyes ! Just a quick heads-up outside of the PR review: I am currently submitting my GSoC 2026 proposal for Apache Seata, titled "Enhance Seata Go SDK Multi Registry Support and Seata CTL Diagnostic Tool".

I saw FinnTew is listed as a potential mentor. Since you've reviewed most of my recent merged and open PRs, I just wanted to ask if you are also going to be mentoring any GSoC projects this year?

Thanks again for all your reviews on my code so far!

I'm sorry, but due to personal energy constraints, I will not be mentoring any projects this year, including GSoC and OSPP. As for the project you mentioned, a similar one has already been completed in previous OSPP cycles. You can find it in the historical PRs.

funky-eyes · 2026-04-01T07:11:37Z

Hi @funky-eyes ! Just a quick heads-up outside of the PR review: I am currently submitting my GSoC 2026 proposal for Apache Seata, titled "Enhance Seata Go SDK Multi Registry Support and Seata CTL Diagnostic Tool".

I saw FinnTew is listed as a potential mentor. Since you've reviewed most of my recent merged and open PRs, I just wanted to ask if you are also going to be mentoring any GSoC projects this year?

Thanks again for all your reviews on my code so far!

I'm sorry, but due to personal energy constraints, I will not be mentoring any projects this year, including GSoC and OSPP. As for the project you mentioned, a similar one has already been completed in previous OSPP cycles. You can find it in the historical PRs.

Sumit6307 · 2026-04-01T09:24:44Z

Hi @funky-eyes ! Just a quick heads-up outside of the PR review: I am currently submitting my GSoC 2026 proposal for Apache Seata, titled "Enhance Seata Go SDK Multi Registry Support and Seata CTL Diagnostic Tool".
I saw FinnTew is listed as a potential mentor. Since you've reviewed most of my recent merged and open PRs, I just wanted to ask if you are also going to be mentoring any GSoC projects this year?
Thanks again for all your reviews on my code so far!

I'm sorry, but due to personal energy constraints, I will not be mentoring any projects this year, including GSoC and OSPP. As for the project you mentioned, a similar one has already been completed in previous OSPP cycles. You can find it in the historical PRs.

@funky-eyes Hi Sir ,thank you for letting me know, and I completely understand. I really appreciate all the guidance and reviews you've given on my PRs so far.

My GSoC project, titled “Enhance Seata-Go Multi-Registry Support and seata-ctl Diagnostic Tool Capability”, is listed as a GSoC 2026 idea. If you’re comfortable, may I share my proposal with you for a quick review?

Thanks again for all your support

funky-eyes · 2026-04-02T02:49:19Z

Hi @funky-eyes ! Just a quick heads-up outside of the PR review: I am currently submitting my GSoC 2026 proposal for Apache Seata, titled "Enhance Seata Go SDK Multi Registry Support and Seata CTL Diagnostic Tool".
I saw FinnTew is listed as a potential mentor. Since you've reviewed most of my recent merged and open PRs, I just wanted to ask if you are also going to be mentoring any GSoC projects this year?
Thanks again for all your reviews on my code so far!

I'm sorry, but due to personal energy constraints, I will not be mentoring any projects this year, including GSoC and OSPP. As for the project you mentioned, a similar one has already been completed in previous OSPP cycles. You can find it in the historical PRs.

@funky-eyes Hi Sir ,thank you for letting me know, and I completely understand. I really appreciate all the guidance and reviews you've given on my PRs so far.

My GSoC project, titled “Enhance Seata-Go Multi-Registry Support and seata-ctl Diagnostic Tool Capability”, is listed as a GSoC 2026 idea. If you’re comfortable, may I share my proposal with you for a quick review?

Thanks again for all your support

@Code-Fight PTAL

Sumit6307 · 2026-04-20T20:14:03Z

Hi @funky-eyes,

Thank you for the review and the helpful feedback! I have updated the PR to address all of the comments. Here is a summary of the improvements made:

Optimized Registry Caching: Implemented a Double-Checked Locking (DCL) pattern in AbstractUndoLogManager to cache the Registry instance. This prevents any performance overhead from repeated RegistryFactory.getInstance() calls in the hot path.
Consistent Counter Semantics: Aligned the deletion counter (seata.undo.log.delete.count) to represent "Operation Count" strictly. It now increments exactly by 1 for both single row deletes and batch deletes, ensuring consistent metrics regardless of the operation type.
Dependency Fixes: Added seata-metrics-core and seata-metrics-registry-compact to the pom.xml so the observability metrics record properly at runtime.
Improved Test Coverage: Wrote comprehensive unit tests in UndoLogMetricsTest.java to verify the counter alignments, latency timers, and summary size recordings (including edge cases where 0 rows are affected).
Code Style: Applied mvn spotless:apply to ensure the codebase strictly matches formatting standards.

Please let me know if there are any further adjustments needed or if this is ready to be merged!

Sumit6307 · 2026-04-22T13:44:38Z

@WangzJi Sir please Check this PR

Sumit6307 · 2026-04-26T15:01:33Z

@funky-eyes Sir plz Review this PR

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Sumit6307 and others added 6 commits January 30, 2026 01:27

feat: add observability metrics for undo log manager

1cee03b

fix(ci): add license header and apply spotless formatting

628607a

test: refactor to use spy instead of mockStatic for better compatibility

46f4069

fix: add getRegistry() method for testability - fixes CI build failures

9475b39

Merge branch '2.x' into feature/undo-log-observability

0242a9e

funky-eyes reviewed Feb 3, 2026

View reviewed changes

Sumit6307 and others added 3 commits February 5, 2026 17:59

feat: add observability metrics for undo log manager

492578a

Merge branch '2.x' into feature/undo-log-observability

e3afae6

fix: safe access to RegistryFactory to prevent CI failures

3b90394

Sumit6307 requested a review from funky-eyes February 5, 2026 14:57

Merge branch '2.x' into feature/undo-log-observability

42d1758

Merge branch '2.x' into feature/undo-log-observability

49bb1a8

funky-eyes requested a review from Copilot March 17, 2026 09:44

funky-eyes modified the milestones: 2.7.0, 2.x Backlog Mar 17, 2026

Copilot started reviewing on behalf of funky-eyes March 17, 2026 09:47 View session

Copilot AI reviewed Mar 17, 2026

View reviewed changes

Merge branch '2.x' into feature/undo-log-observability

e43f3ad

Sumit6307 and others added 3 commits April 21, 2026 01:20

Merge branch '2.x' into feature/undo-log-observability

ae23264

feat: optimize metrics registry caching and align counter semantics

3963d01

style: apply spotless code formatting

2ec0203

fix: resolve missing metric Id import in test class

c00fb50

Sumit6307 added 2 commits April 23, 2026 11:22

Merge branch '2.x' into feature/undo-log-observability

52754fa

Merge branch '2.x' into feature/undo-log-observability

37844e3

WangzJi requested a review from Copilot May 19, 2026 06:08

Copilot started reviewing on behalf of WangzJi May 19, 2026 06:08 View session

Copilot AI reviewed May 19, 2026

View reviewed changes

Conversation

Sumit6307 commented Feb 2, 2026

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

Uh oh!

funky-eyes left a comment

Choose a reason for hiding this comment

Uh oh!

Sumit6307 commented Feb 3, 2026

Uh oh!

codecov Bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Sumit6307 commented Feb 5, 2026

Uh oh!

Sumit6307 commented Mar 5, 2026

Uh oh!

Sumit6307 commented Mar 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sumit6307 commented Mar 25, 2026

Uh oh!

funky-eyes commented Apr 1, 2026

Uh oh!

funky-eyes commented Apr 1, 2026

Uh oh!

Sumit6307 commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

funky-eyes commented Apr 2, 2026

Uh oh!

Sumit6307 commented Apr 20, 2026

Uh oh!

Sumit6307 commented Apr 22, 2026

Uh oh!

Sumit6307 commented Apr 26, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov Bot commented Feb 5, 2026 •

edited

Loading

Sumit6307 commented Apr 1, 2026 •

edited

Loading