[ANALYTICS-495] Create a script that will be triggered by Jenkins and will call the endpoints on analytics validators Created: 07/Jul/23  Updated: 22/Aug/23

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

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

Issue Links:
relation
is related to ANALYTICS-490 Generate the common structure validat... Open
is related to ANALYTICS-470 Action plan for monitoring the analyt... Closed
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)
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

Create an script file executeHealthChecks.sh that will call the endpoint  ANALYTICS-468
Fail the build if there is an error status code from the rest endpoint

 

[Alternative]Investigate if Postman monitoring can be included in CICD and execute the collection for the endpoints delivered by ANALYTICS-468

Development notes

 

Simple bash script with a curl command would be enough

[Alternatives]

There should be an script generated agnostically to the pipeline that executes the integration with jenkins as mentioned in here https://learning.postman.com/docs/collections/using-newman-cli/integration-with-jenkins/

 

The new endpoint can be triggered with postman schedule actions https://learning.postman.com/docs/collections/running-collections/scheduling-collection-runs-monitors/ 

As stated in https://magnolia-cms.slack.com/archives/CDG4DMWRM/p1689154371926219

We need to decide which is the best approach: bash curl vs newman (node package) vs ihttp (jetbrains)

 

Check first if a basic bash file can get executed in the project and evaluate the outcome.

Use in the script 

npm install -g newman
  • Basic curl implementation can be used too, check if runner contains it's installation beforehand

 


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