pdf-aggregation-statistics/README.md

1.7 KiB

PDF Aggregation Statistics Build Status

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.