Skip to content
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.

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

Restore endpoint to get live telemetry data #28123

Closed
dsilvam opened this issue Apr 2, 2024 · 5 comments
Closed

Restore endpoint to get live telemetry data #28123

dsilvam opened this issue Apr 2, 2024 · 5 comments

Comments

@dsilvam
Copy link
Contributor

dsilvam commented Apr 2, 2024

Parent Issue

No response

Task

For the initial implementation of the former "experience" plugin an endpoint to get the live stats used to be available.
This task is to restore that endpoint to be able to get live telemetry data.

Proposed Objective

Integrations

Proposed Priority

Priority 2 - Important

Acceptance Criteria

An endpoint available to get live telemetry data
api/v1/telemetry/stats

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

@john-thomas-dotcms
Copy link
Contributor

Here are a few specific requirements:

  1. The endpoint should return all metrics which are generated by the scheduled telemetry job.
    • We should write it so the endpoint will automatically pick up any new metrics we add to the scheduled job at a later date.
  2. This endpoint should be restricted to admin users.
    • In other words, only users with the CMS Administrator role should be able to access this endpoint.
  3. Hitting this endpoint should not reset any metrics which cover a time range or which are resettable.
    • It should show current values without changing the data collection at all.

@dsilvam
Copy link
Contributor Author

dsilvam commented May 7, 2024

@dsilvam
Copy link
Contributor Author

dsilvam commented May 10, 2024

IQA: Needs work.

Hitting the frontend at localhost:8080 registers API hits for /da in the temp db table but the telemetry endpoint is showing 0 as the count. The metrics cache was set to 1 minute.

Image

Image

@freddyDOTCMS freddyDOTCMS added the on hold In Progress, but paused to work on higher priority card label May 13, 2024
@freddyDOTCMS
Copy link
Contributor

IQA: Needs work.

Hitting the frontend at localhost:8080 registers API hits for /da in the temp db table but the telemetry endpoint is showing 0 as the count. The metrics cache was set to 1 minute.

Image

Image

Really this behavior is because this two issues:

#28354

#28542

@dsilvam
Copy link
Contributor Author

dsilvam commented May 16, 2024

Passed Internal QA: We are passing this one as it achieved its scope / acceptance criteria.
Two issues were created that are going to be worked separately.

@dsilvam dsilvam added QA : Not Needed and removed on hold In Progress, but paused to work on higher priority card labels May 16, 2024
@dsilvam dsilvam added the LTS : Next Ticket that will be added to LTS label May 29, 2024
@dsilvam dsilvam closed this as completed May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

3 participants