config.md

@PLUGIN@ configuration

The @PLUGIN@ allows a systematic collection of repository metrics. Metrics are updated either upon a ref-update receive or on a time based refresh interval. ref-update events are received only on primary nodes, so on replicas gracePeriod will need to be set.

Currently, the metrics exposed are the following:

plugins_git_repo_metrics_numberofbitmaps_<repo_name>
plugins_git_repo_metrics_numberoflooseobjects_<repo_name>
plugins_git_repo_metrics_numberoflooserefs_<repo_name>
plugins_git_repo_metrics_numberofpackedobjects_<repo_name>
plugins_git_repo_metrics_numberofpackedrefs_<repo_name>
plugins_git_repo_metrics_numberofpackfiles_<repo_name>
plugins_git_repo_metrics_sizeoflooseobjects_<repo_name>
plugins_git_repo_metrics_sizeofpackedobjects_<repo_name>
plugins_git_repo_metrics_numberofkeepfiles_<repo_name>
plugins_git_repo_metrics_numberoffiles_<repo_name>
plugins_git_repo_metrics_numberofdirectories_<repo_name>
plugins_git_repo_metrics_numberofemptydirectories_<repo_name>
plugins_git_repo_metrics_combinedrefssha1_<repo_name>
plugins_git_repo_metrics_numberofobjectssincebitmap_<repo_name>
plugins_git_repo_metrics_numberofpackfilessincebitmap_<repo_name>

Settings

The plugin allows to customize its behaviour through a specific git-repo-metrics.config file in the $GERRIT_SITE/etc directory.

Following an example of config file:

[git-repo-metrics]
  project = test-project
  project = another-repo
  gracePeriod = 5m
  backend = GERRIT

git-repo-metrics.project: Project to collect metrics for. Multiple projects can be listed.

git-repo-metrics.collectAllRepositories: Collect metrics for all the repositories. By default, false.

git-repo-metrics.forcedCollection: Force the repositories' metric collection update every gracePeriod interval. By default, disabled.

NOTE: When using forcedCollection the gracePeriod should be defined to a positive interval, otherwise the collection would happen just once at the plugin startup time.

git-repo-metrics.gracePeriod: Grace period between samples collection. Used to avoid aggressive metrics collection. By default, 0.

git-repo-metrics.poolSize: Number of threads available to collect metrics. By default, 1. git-repo-metrics.gitBackend: Name of the Git SCM tool managing the Git data, for which this tools will expose metrics.

Currently supported values:

• GERRIT (default)
• GITLAB