[ANALYTICS-468] Implement the analytics health check validation rest endpoint call Created: 22/Jan/21  Updated: 23/Aug/23

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

Type: Task Priority: Neutral
Reporter: Laura Delnevo Assignee: Alberto Soto
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Cloners
clones ECOMMERCE-561 APIs are checked periodically via Pos... Open
is cloned by MKTAUT-158 APIs are checked periodically via Pos... Open
relation
is related to ANALYTICS-470 Action plan for monitoring the analyt... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: Connectors Health-checks
Team: AuthorX

 Description   

Context

To have visibility and a health check for the connector pack, we need to integrate a Health check for analytics.

The process need to generate an structure for the validator of analytics, use that structure in some endpoints and have these endpoints to be executed regularly by jenkins. Check details on related linked tasks.

Acceptance criteria

Generate an unique endpoint with delivery API or healthcheck API that executes the validation included in ANALYTICS-490 

Endpoints should be at this references for example

  • /analytics/health-check

The response server code could be, as expected:

  • 200 in case is a valid response and system is ok
  • 503 for service unavailable with a retry-after http header of 24h in case alert is generated
  • The body response needs to return the connector that is failing and an explanation message as "The analytics connector {Matomo/GA4/Adobe} healthcheck has failed. The problem relies on: ..."

Also include the stacktrace.

 

Otherwise, Response.Ok should be enough

Development notes

As an additional module which is going to be included in addons-pack we can use a light module approach, using static resources

The endpoints could make use of magnolia delivery endpoints in order to be reachable without additional credentials

https://docs.magnolia-cms.com/product-docs/6.2/Developing/API/Delivery-API.html

In case of using the java implementation https://docs.magnolia-cms.com/product-docs/6.2/Developing/Development-how-tos/How-to-create-a-custom-Java-based-REST-endpoint.html ensure credentials are setup properly in the module.


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