[ANALYTICS-470] Action plan for monitoring the analytics connectors Created: 26/May/23  Updated: 19/Jul/23  Resolved: 19/Jul/23

Status: Closed
Project: Analytics
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Spike Priority: Neutral
Reporter: Andrei Ichimescu Assignee: Thuy To
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: 5d 5h
Original Estimate: Not Specified

Attachments: PNG File image-2023-07-10-10-59-13-556.png    
Issue Links:
relation
is related to ANALYTICS-419 Integration tests with system vars in... Open
is related to ANALYTICS-468 Implement the analytics health check ... Open
is related to ANALYTICS-469 Set up Jenkins jobs to regularly chec... Open
is related to ANALYTICS-490 Generate the common structure validat... Open
is related to ANALYTICS-495 Create a script that will be triggere... Open
is related to ANALYTICS-496 Implement email/notification/alert ba... Open
Template:
Date of First Response:
Epic Link: Connectors Health-checks
Story Points: 5
Team: AuthorX
Work Started:

 Description   

We need to monitor the existing connectors:

  • Google Analytics4
  • Matomo
  • Adobe Analytics

Timeboxed: 4PD

 
AC:

  1. Research on what APIs we can use to do the health check.
  2. Contact SRE to find out about the best practices for monitoring and alerting (email notification and/or slack message)
  3. Find and document the solution we want to take to monitor the analytics connectors.
  4. Create followup tickets

Outcome

ANALYTICS-490 Generate the common structure validators for analytics
ANALYTICS-468 Implement the analytics health check validation rest endpoint call
ANALYTICS-495 Create a script that will be triggered by Jenkins and will call the endpoints on analytics validators
ANALYTICS-469 Set up Jenkins jobs to regularly check Connectors credentials
ANALYTICS-496 Implement email/notification/alert based on the endpoint results
ANALYTICS-419 Integration tests with system vars include sanity check of sandbox and credentials


 Comments   
Comment by Thuy To [ 10/Jul/23 ]

As discussed, We have decided to do a health check proposal for the connector pack on new approach.

The following steps need to placed:

  1. Generate validators for analytics ANALYTICS-490
  2. Generate endpoints for analytics validator - ANALYTICS-495
  3. Generate integration test with system vars for those endpoints - ANALYTICS-496

we can extend the use of https://git.magnolia-cms.com/projects/ADDON/repos/analytics/browse/magnolia-analytics-u[…]alytics/ui/app/fields/validator/DataSupplierValidator.java as the image bellow

 

Comment by Thuy To [ 14/Jul/23 ]

After discovery, we have list of tasks which will do for health check connectors on Analytics.

1. Generate the common structure validators for analytics ==> ANALYTICS-490
2. Implement the analytics rest endpoint calls ==> ANALYTICS-468
3. Set up Jenkins jobs to regularly check Connectors credentials ==> ANALYTICS-469
4. Implement email/notification/alert based on the endpoint results ==> ANALYTICS-496
5. Integration tests with system vars include sanity check of sandbox and credentials ==> ANALYTICS-419

Generated at Sun Feb 11 23:19:09 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.