The Statistics app of the PDF Aggregation Service.
Go to file
Lampros Smyrnaios 2656fc0b72 Allow to set an "root_address" in application.yml. This is used to declare the address of this server, when using proxy. 2023-11-09 16:40:35 +02:00
gradle/wrapper Update dependencies. 2023-10-05 15:21:52 +03:00
src Allow to set an "root_address" in application.yml. This is used to declare the address of this server, when using proxy. 2023-11-09 16:40:35 +02:00
.gitignore Fully functional "PDF Aggregation Statistics" Service. 2023-06-20 22:16:07 +03:00
Dockerfile Fully functional "PDF Aggregation Statistics" Service. 2023-06-20 22:16:07 +03:00
LICENSE Add LICENSE. 2023-09-14 16:11:23 +03:00
README.md Improve documentation. 2023-10-26 13:06:07 +03:00
build.gradle - Set the release version. 2023-11-08 12:41:25 +02:00
docker-compose.yml Fully functional "PDF Aggregation Statistics" Service. 2023-06-20 22:16:07 +03:00
gradle.properties Fully functional "PDF Aggregation Statistics" Service. 2023-06-20 22:16:07 +03:00
installAndRun.sh - In case the provided "datasourceID" is not found inside the "datasourcesWithNumOfPayloads" map (but does not appear to have invalid form), add an explanatory message in the HTTP-404 response, to be able to distinguish it from a non-existent endpoint. 2023-10-23 14:46:20 +03:00
settings.gradle Fully functional "PDF Aggregation Statistics" Service. 2023-06-20 22:16:07 +03:00
shutdownService.sh - Add the "shutdownService.sh" script. 2023-07-26 17:35:21 +03:00

README.md

PDF Aggregation Statistics

This is a public API to get specific statistics from the PDF Aggregation Service.
This service is designed to respond as fast as possible, by caching the relevant data in memory, instead of running new queries to the database, for every request. The cached data is updated every 6 hours, by default.
It is possible to configure the "cacheUpdateInterval" value inside the application.yml file.

Statistics API:

  • "getNumberOfPayloadsForDatasource" endpoint: http://<IP>:<PORT>/api/stats/getNumberOfPayloadsForDatasource?datasourceId=<givenDatasourceId>
    This endpoint returns the number of payloads which belong to the datasource specified by the given datasourceID.

To install and run the application:

  • Run git clone and then cd pdf_aggregation_statistics.
  • Set the preferable values inside the application.yml file.
  • Execute the installAndRun.sh script which builds and runs the app.
    If you want to just run the app, then run the script with the argument "1": ./installAndRun.sh 1.
    If you want to build and run the app on a Docker Container, then run the script with the argument "0" followed by the argument "1": ./installAndRun.sh 0 1.