UNCLASSIFIED - NO CUI

Update Administrator Guide authored by Mark Howard's avatar Mark Howard
......@@ -106,7 +106,28 @@ The cost metrics are built using pay data that is uploaded in a CSV format. Once
If this experimental feature is enabled, Holocron will report metrics on how often team's deploy their projects. This is based on build job status and as such requires a consistent use of job names.
#### PROJECT_ANALYSIS
If this experimental feature is enabled, Holocron will report collected metrics from project analysis tools like SonarQube, if such collectors are run.
## [Collector Specifics](#collector-specifics)
- **GitLab Workflow Collector**: In addition to the setup needed for environmental variables, you will need the following requirements to be met in order to be able to use this collector:
1. Your hosted GitLab's GraphQL maximum query complexity must be no lower than 234.
**GitLab Workflow Collector**:
This collector also utilizes the following environment variables:
- `HIGHEST_PRIORITY_LABELS`: Comma delineated list identifying a ticket as highest priority.
- `HIGH_PRIORITY_LABELS`: Comma delineated list identifying a ticket as high priority.
- `MEDIUM_PRIORITY_LABELS`: Comma delineated list identifying a ticket as medium priority.
- `LOW_PRIORITY_LABELS`: Comma delineated list identifying a ticket as low priority.
- `LOWEST_PRIORITY_LABELS`: Comma delineated list identifying a ticket as lowest priority.
- `DEFAULT_TICKET_PRIORITY`: The priority to use if no matching label is found. Also used in case of conflict between label lists. Possible values are `HIGHEST`, `HIGH`, `MEDIUM`, `LOW`, `LOWEST`. Defaults to `LOWEST`.
- `FEATURE_LABELS`: Comma delineated list identifying a ticket as a feature ticket.
- `DEFECT_LABELS`: Comma delineated list identifying a ticket as a defect ticket.
- `MAINTENANCE_LABELS`: Comma delineated list identifying a ticket as a maintenance ticket.
- `UNPLANNED_LABELS`: Comma delineated list identifying a ticket as an unplanned ticket.
- `DEFAULT_TICKET_TYPE`: The type to use if no matching label is found. Also used in case of conflict between label lists. Possible values are `FEATURE`, `DEFECT`, `MAINTENANCE`, and `UNPLANNED`. Defaults to `FEATURE`.
In addition to the setup needed for environmental variables, you will need the following requirements to be met in order to be able to use this collector:
1. Your hosted GitLab's GraphQL maximum query complexity must be no lower than 234.
2. Your hosted GitLab must be Enterprise Edition (currently only tested against v16).
\ No newline at end of file