Add option to define base federated metrics

README.md

@@ -62,6 +62,8 @@ If you make changes to Alerts, Recording rules, or Grafana dashboards, and if th
 * Run `make generate-federate` to update federation config.
 * And commit changes in `resources/prometheus/federation-config.yaml` file to the repo.
 
+You can add additional federated metrics that are not used in any Alert, Recording rule, or Grafana dashboard to `resources/prometheus/federation-config-base.yaml,` and they will be merged with other metrics. Always add a comment with the reason why metrics are added to the base list.
+
 ### Pre-commit hook
 
 This repository makes use of [pre-commit](https://pre-commit.com/) framework. Refer to the [installation instructions](https://pre-commit.com/#installation) for further information.

scripts/generate-federate-match.sh

@@ -80,7 +80,8 @@ function main() {
     sort "${metrics_list_file}" | uniq | grep -v -E "^acs|^rox|^aws|^central:|acscs_worker_nodes" | awk '{ print $1 "{job!~\"central|scanner\"}" }' > "${metrics_list_file}.filter"
 
     # Create federation-config.yaml
-    sed -e 's/^/- /'  "${metrics_list_file}.filter" | yq '{ "match[]": . }' > "${repo_dir}/resources/prometheus/federation-config.yaml"
+    local yq_expression='. *+ load("'"${repo_dir}/resources/prometheus/federation-config-base.yaml"'")."match[]" | unique | sort | { "match[]": . }'
+    sed -e 's/^/- /'  "${metrics_list_file}.filter" | yq "${yq_expression}" > "${repo_dir}/resources/prometheus/federation-config.yaml"
 
     # Clean up the temp directory with all transient files
     rm -rf "${working_tmp_dir}"