Prometheus exporter for Harbor

Change Log

Export harbor service health to Prometheus.

To run it:

make build
./harbor_exporter [flags]

To build a Docker image:

make dockerbuild

Exported Metrics

Metric	Meaning	Labels
harbor_up
harbor_health
harbor_components_health		component=[chartmuseum,core,database,jobservice,notary,portal,redis,registry,registryctl]
harbor_health_latency
harbor_scans_completed
harbor_scans_total
harbor_scans_requester
harbor_scans_latency
harbor_project_count_total		type=[private_project, public_project, total_project]
harbor_repo_count_total		type=[private_repo, public_repo, total_repo]
harbor_statistics_latency
harbor_quotas_count_total		repo_id, repo_name, type=[hard, used]
harbor_quotas_size_bytes		repo_id, repo_name, type=[hard, used]
harbor_quotas_latency
harbor_system_volumes_bytes		storage=[free, total]
harbor_system_volumes_latency
harbor_repositories_pull_total		repo_id, repo_name
harbor_repositories_star_total		repo_id, repo_name
harbor_repositories_tags_total		repo_id, repo_name
harbor_repositories_latency
harbor_replication_status	status of the last execution of this replication policy: Succeed = 1, any other status = 0	repl_pol_name
harbor_replication_tasks	number of replication tasks, with various results, in the latest execution of this replication policy	repl_pol_name, result=[failed, succeed, in_progress, stopped]
harbor_system_info		auth_mode, project_creation_restriction, harbor_version, registry_storage_provider_name
harbor_system_with_notary
harbor_system_self_registration
harbor_system_has_ca_root
harbor_system_read_only
harbor_system_with_chartmuseum
harbor_system_notification_enable
harbor_replication_latency
harbor_artifacts_vulnerabilities	quantity of detected vulnerabilities	artifact_id, artifact_name, project_id, project_name, repo_id, repo_name, report_id, status=[fixable, total, fixable, low, medium, high]
harbor_artifacts_size	size in bytes	artifact_id, artifact_name, project_id, project_name, repo_id, repo_name
harbor_artifacts_vulnerabilities_scans	current status of scan process: 1 - Success, 2 - Running, 0 - other	artifact_id, artifact_name, project_id, project_name, repo_id, repo_name, status
harbor_artifacts_vulnerabilities_scan_duration	time spent on the last scan	artifact_id, artifact_name, project_id, project_name, repo_id, repo_name, report_id
harbor_artifacts_vulnerabilities_scan_start	the last scan start timestamp	artifact_id, artifact_name, project_id, project_name, repo_id, repo_name, report_id

Note: when the harbor.instance flag is used, each metric name starts with harbor_instancename_ instead of just harbor_.

Flags

./harbor_exporter --help

skip.metrics - Skip collection of certain metric groups (optional)

valid value: scans|statistics|quotas|repositories|replication|health
default value: empty
example:

./harbor_exporter --skip.metrics scans --skip.metrics quotas

cache.enabled - Enable caching of metrics (optional)

valid value: true|false
default value: false
Cache duration can be changed with --cache.duration (default 20s).
example:

./harbor_exporter --cache.enabled --cache.duration 30s

This can also be configured via the environment variables HARBOR_CACHE_ENABLED and HARBOR_CACHE_DURATION.

harbor.pagesize - Set page size for results. Can be also set with Environment variable HARBOR_PAGESIZE

default value: 100

Environment variables

Below environment variables can be used instead of the corresponding flags. Easy when running the exporter in a container.

HARBOR_INSTANCE
HARBOR_URI
HARBOR_USERNAME
HARBOR_PASSWORD
HARBOR_CACHE_ENABLED
HARBOR_CACHE_DURATION

Using Docker

You can deploy this exporter using the Docker image.

For example:

docker pull c4po/harbor-exporter

docker run -d -p 9107:9107 -e HARBOR_USERNAME=admin -e HARBOR_PASSWORD=password c4po/harbor-exporter --harbor.server=https://harbor.dev

Run in Kubernetes

if you deploy Harbor to Kubernetes using the helm chart goharbor/harbor-helm, you can use this file kubernetes/harbor-exporter.yaml to deploy the harbor-exporter with secretKeyRef

Using Grafana

You can load this json file grafana/harbor-overview.json to Grafana instance to have the dashboard.