Details
-
Improvement
-
Resolution: Unresolved
-
Neutral
-
None
-
None
-
None
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)
- we can use https://learning.postman.com/docs/collections/using-newman-cli/newman-options/#exit-status to inject and make the build fail
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
- Or, otherwise, another implementation can be https://blog.jetbrains.com/idea/2022/12/http-client-cli-run-requests-and-tests-on-ci/
- Basic curl implementation can be used too, check if runner contains it's installation beforehand
Checklists
Attachments
Issue Links
- is related to
-
ANALYTICS-490 Generate the common structure validators for analytics
-
- Open
-
-
ANALYTICS-470 Action plan for monitoring the analytics connectors
-
- Closed
-
-
ANALYTICS-496 Implement email/notification/alert based on the endpoint results
-
- Open
-