UNCLASSIFIED - NO CUI

Update Administrator Guide authored by abhayashrestha's avatar abhayashrestha
...@@ -15,6 +15,20 @@ ...@@ -15,6 +15,20 @@
## Collector Environmental Variables ## Collector Environmental Variables
Every collector needs the following environmental variables for setup:
- `DB_USER` which is the postgres database user.
- `DB_PASS` which is the postgres database user's password.
- `DB_HOST` which is the postgres database host.
- `DB_PORT` which is the postgres database port.
- `DB_NAME` which is the postgres database name.
- `COLLECTOR_NAME` which is the name of the collector (the name for a particular running instance of a collector).
- `COLLECTOR_INTERVAL_SECONDS` which is the amount of time in seconds the collector needs to sleep before beginning the next round of collection.
- `TARGET_URL` which is the base url for where the requests are going to be send to when collecting.
- `LOOK_BACK_DAYS` which represents how old of a dataset (measured in days) do we want the collectors to collect data from (for example issues that were update 365 days ago)
- `GO_RUN_ENV` which represents the environment type (can be "production" or "development" only).
- `COLLECTOR_TARGETS_INTRVL_SECS` which represents the amount of time that the top level collection (collector target collection) must wait before collecting again. Ideally 24 hours.
- `MAX_REQUESTS_PER_MINUTE` which represents the threshold for the amount of requests that can be sent to `TARGET_URL` in a minute before the collector needs to stop sending requests for a brief period of time.
## Environmental Variables needed for the API ## Environmental Variables needed for the API
... ...
......