hygieia/hygieia-relateditems-collector

[WIP] - Hygieia collector to process records in related_items collection to aid association of collector_items with dashboards.

Due to changes in the priorities, this project is currently not being supported. The project is archived as of 6/1/2023 and will be available in a read-only state. Please note, since archival, the project is not maintained or reviewed

hygieia-relateditems-collector

This project repository is a scheduled data collection from relatedItems collection in Hygieia and post it to subscriber end point.

Setup Instructions - Build & Deploy

To configure the Related Items collector Job, execute the following steps:

• Step 1: Change Directory

Change the current working directory to the hygieia-relatedItems-collector directory of your source code installation.

For example, in the Mac terminal, run the following command:

cd /Users/<user>/git/forks/hygieia-relateditems-collector

• Step 2: Run Maven Build

Run the maven build to package the project into an executable jar file:

 mvn install

The output file hygieia-relateditems-collector.jar is generated in the hygieia-relateditems-collector/target folder.

• Step 3: Set Parameters in Application Properties File

Set the configurable parameters in the application.properties file to connect to the Dashboard MongoDB database instance, including properties required by the relateditems-collector Job.

For information about sourcing the application properties file, refer to the Spring Boot Documentation.

To configure parameters for the relateditems-collector Job, refer to the sample application.properties file.

• Step 4: Deploy the Executable File

To deploy the hygieia-relateditems-collector.jar file, change directory to hygieia-relateditems-collector/target, and then execute the following from the command prompt:

java -jar hygieia-relateditems-collector.jar --spring.config.name=subversion --spring.config.location=[path to application.properties file]

Sample Application Properties File

The sample application.properties file lists parameter values to configure the relateditems-collector Job. Set the parameters based on your environment setup.

		# Database Name
		dbname=dashboarddb

		# Database HostName - default is localhost
		dbhost=localhost

		# Database Port - default is 27017
		dbport=27017

		# MongoDB replicaset
		dbreplicaset=[false if you are not using MongoDB replicaset]
		dbhostport=[host1:port1,host2:port2,host3:port3]

		# Database Username - default is blank
		dbusername=dashboarduser

		# Database Password - default is blank
		dbpassword=dbpassword

		# Logging File location
		logging.file=./logs/hygieia-relateditems-collector.log

		# Collector schedule (required)
		relateditems.cron=0 0/30 * * * *

		# server address
		relateditems.subscribers[0]=<server address>

		# Optional timestamp value to configure test results by specific time
		relateditems.lastExecutedTimeStamp=

Developing.

Before making any contribvutions, we suggest that you read the CONTRIBUTING.md and the Development Docs (housed in ./src/docs/README.md). But for the most part, running:

mvn clean test install site

will test and generate the project metrics (navigable from the locally built ./target/site/index.html -- see "Project Reports" in the left nav for all of the available reports). We generally want these reports to look good.