Details
-
Task
-
Resolution: Unresolved
-
Neutral
-
None
-
None
-
None
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.
Checklists
Attachments
Issue Links
- clones
-
ECOMMERCE-561 APIs are checked periodically via Postman
-
- Open
-
- is cloned by
-
MKTAUT-158 APIs are checked periodically via Postman
-
- Open
-
- is related to
-
ANALYTICS-470 Action plan for monitoring the analytics connectors
-
- Closed
-