[ANALYTICS-490] Generate the common structure validators for analytics Created: 07/Jul/23  Updated: 22/Aug/23

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

Type: Improvement Priority: Neutral
Reporter: Alberto Soto Assignee: Thuy To
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: 1d 1.5h
Original Estimate: Not Specified

Attachments: PNG File image-2023-07-07-15-31-47-937.png    
Issue Links:
relation
is related to ANALYTICS-470 Action plan for monitoring the analyt... Closed
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:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:
Epic Link: Connectors Health-checks
Team: AuthorX

 Description   

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

A new module from scratch is included in addons-pack that includes validators for each of the connector on analytics as shown in the image below

Development notes

We need to generate that new module. This new module will have some rest endpoint that will be checked regularly by jenkins. As an outcome we will have notifications when we can't deploy or secrets are not valid.

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
 

 

The new module is located at https://git.magnolia-cms.com/projects/ADDON/repos/addon-healthcheck/browse/magnolia-addon-healthcheck/src/main/resources/META-INF/magnolia?at=refs%2Fheads%2Ffeature%2FANALYTICS-490-generate-the-common-structure-validators-for-analytics 

Please, remember that, in order to have the injections of the different modules, the injected parts need to be defined in the module descriptor pointed above. The current project is a valid magnolia module that can be includded in addons pack with the following dependency to be included, after dependency management in parent pom, into magnolia-addon-webapp/pom.xml

 

<!--      addons healthcheck      -->
<dependency>
  <groupId>info.magnolia.addon.healthcheck</groupId>
  <artifactId>magnolia-addon-healthcheck</artifactId>
  <version>${addonsHealthCheckVersion}</version>
</dependency> 

 


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