Skip to content

docs(#10438): add tasks:all-tasks telemetry entry#2171

Merged
dianabarsan merged 2 commits intomedic:mainfrom
megha1807:feat/document-tasks-all-tasks-telemetry
Mar 27, 2026
Merged

docs(#10438): add tasks:all-tasks telemetry entry#2171
dianabarsan merged 2 commits intomedic:mainfrom
megha1807:feat/document-tasks-all-tasks-telemetry

Conversation

@megha1807
Copy link
Copy Markdown
Contributor

@megha1807 megha1807 commented Mar 26, 2026

Description

Adds documentation for the new telemetry entry tasks:all-tasks, which records the number of tasks visible to the user each time refreshTasks() is called.

This covers both initial load and subsequent recalculations triggered by changes or rules engine updates.

Related to medic/cht-core#10438

@megha1807 megha1807 force-pushed the feat/document-tasks-all-tasks-telemetry branch from 5d92c84 to 14b35fd Compare March 27, 2026 06:08
Copy link
Copy Markdown
Member

@dianabarsan dianabarsan left a comment

Choose a reason for hiding this comment

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

Thank you so much for adding this. I added one small request below.

| `analytics:target_aggregates:load` | The time taken to load the target aggregates. Added in 4.7. | Yes. Added in 4.7 |
| `tasks:load` | The time taken to load the tasks page. Added in 3.9 | Yes. Added in 4.7 |
| `tasks:refresh` | The time taken to refresh tasks on the tasks page. Added in 3.9 | Yes. Added in 4.7 |
| `tasks:all-tasks` | The number of tasks visible to the user at the time of recalculation. Recorded each time `refreshTasks()` is called, covering both initial load and subsequent recalculations triggered by changes or rules engine updates. Added in 5.1.0 | |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we should not get into implementation details, by mentioning internal function names here. Can you please remove references to function names?
The description can be simplified by just mentioning that task counts are recorded on every recalculation, it is sufficient.

@megha1807 megha1807 requested a review from dianabarsan March 27, 2026 10:44
@megha1807
Copy link
Copy Markdown
Contributor Author

Done @dianabarsan — removed the internal function name reference and simplified the description as suggested. Thanks for the feedback!

Copy link
Copy Markdown
Member

@dianabarsan dianabarsan left a comment

Choose a reason for hiding this comment

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

@dianabarsan dianabarsan merged commit bbf5257 into medic:main Mar 27, 2026
1 check passed
@github-project-automation github-project-automation bot moved this from 👤 Assigned to 🚀 Done in CHT Community Contributions Q1 2026 Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Status: 🚀 Done

Development

Successfully merging this pull request may close these issues.

3 participants