UNCLASSIFIED - NO CUI

Update Administrator Guide authored by abhayashrestha's avatar abhayashrestha
......@@ -25,14 +25,14 @@ Every collector needs the following environmental variables for setup:
- `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 for a particular `TARGET_URL` which needs to be unique in the database for all the collectors
that are running).
- `COLLECTOR_NAME` which is the name of the collector (the name for a particular running instance of a collector for a particular `TARGET_URL`). This name needs to be unique for all the collectors that are going to be run.
- `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 domain 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)
- `LOOK_BACK_DAYS` which represents how old of a dataset (measured in days) do we want the collectors to collect data from (for example pull requests that were update 365 days ago for gitlab-scm-collector)
- `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 instance needs to stop sending requests for a brief period of time.
- `ACCESS_TOKEN` which is the token that must be set in order for the collector to retrieve data from whatever API might need the token (example: GitLab, Jira etc.).
## Environmental Variables needed for the API
......
......