Skip to content

PCSM-167 Updated the pcsm status output #15

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
nastena1606 merged 3 commits into from
Jan 13, 2026
Merged

PCSM-167 Updated the pcsm status output #15

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e622f0
PCSM-167 Updated the pcsm status output
nastena1606 Nov 20, 2025
84668c6
Updated after the review
nastena1606 Nov 21, 2025
cd97ac2
Removed excessive file
nastena1606 Jan 13, 2026
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
43 changes: 22 additions & 21 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,36 +146,37 @@
| `state` | string | Current replication state |
| `info` | string | Additional information about the current state|
| `error`| string | (optional): The error message if the operation failed.
| `lagTime` | number | Current lag time in logical seconds between source and target clusters. |
| `eventsProcessed` | number | Total events processed |
| `lastReplicatedOpTime` | string | The last replicated operation time.|
| `lagTimeSeconds` | number | Current lag time in logical seconds between source and target clusters. |
| `eventsRead` | number | Total number of events read from the source |
| `eventsApplied` | number | Total number of events applied to the target |
| `lastReplicatedOpTime` | string | The last replicated operation time. It includes both the time stamp and its human-readable representation |
Copy link

Copilot AI Nov 20, 2025

Choose a reason for hiding this comment

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

The type is documented as 'string' but the example shows it as an object with 'ts' and 'isoDate' fields. Update the type to 'object' to match the actual structure.

Suggested change
| `lastReplicatedOpTime` | string | The last replicated operation time. It includes both the time stamp and its human-readable representation |
| `lastReplicatedOpTime` | object | The last replicated operation time. Object with `ts` (timestamp) and `isoDate` (human-readable date) fields. |

Copilot uses AI. Check for mistakes.
Copy link
Collaborator

@inelpandzic inelpandzic Nov 20, 2025

Choose a reason for hiding this comment

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

What do you think that we add ts and isoDate fields as separate, like

  • lastReplicatedOpTime.ts
  • lastReplicatedOpTime.isoDate

Just like we have for initialSync object.

| `initialSync.completed` | boolean | Initial sync completion status |
| `initialSync.lagTime` | number | The lag time in logical seconds until the initial sync completed|
Copy link

Copilot AI Nov 20, 2025

Choose a reason for hiding this comment

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

The field initialSync.lagTime is documented but not shown in the example response. Either add it to the example or remove from documentation if it's no longer supported.

Copilot uses AI. Check for mistakes.
| `initialSync.cloneCompleted` | boolean | Clone process completion status |
| `initialSync.estimatedCloneSize` | number | Estimated total size to clone (bytes) |
| `initialSync.clonedSize` | number | Current cloned size (bytes) |
| `initialSync.estimatedCloneSizeBytes` | number | Estimated total size to clone (bytes) |

Check notice on line 156 in docs/api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api.md#L156 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/api.md", "range": {"start": {"line": 156, "column": 82}}}, "severity": "INFO"}
| `initialSync.clonedSizeBytes` | number | Current cloned size (bytes) |

Check notice on line 157 in docs/api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api.md#L157 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/api.md", "range": {"start": {"line": 157, "column": 64}}}, "severity": "INFO"}


Example:

```json
{
"ok": true,
"state": "running",
"info": "Initial Sync",

"lagTime": 22,
"eventsProcessed": 5000,
"lastReplicatedOpTime": "1740335200.5",

"initialSync": {
"completed": false,
"lagTime": 5,

"cloneCompleted": false,
"estimatedCloneSize": 5000000000,
"clonedSize": 2500000000
}
"ok": true,
"state": "running",
"info": "Replicating Changes",
"lagTimeSeconds": 1,
"eventsRead": 0,
"eventsApplied": 0,
"lastReplicatedOpTime": {
"ts": "1763649865.1",
"isoDate": "2025-11-20T14:44:25Z"
},
"initialSync": {
"estimatedCloneSizeBytes": 24220000,
"clonedSizeBytes": 24220000,
"completed": true,
"cloneCompleted": true
}
}
```

Expand Down