Harbor
Security Monitoring is now available Security Monitoring is now available

Harbor

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

This check monitors Harbor through the Datadog Agent.

Setup

Installation

The Harbor check is included in the Datadog Agent package. No additional installation is needed on your server.

Configuration

Host

Follow the instructions below to configure this check for an Agent running on a host. For containerized environments, see the Containerized section.

Metric Collection
  1. Edit the harbor.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Harbor performance data. See the sample harbor.d/conf.yaml for all available configuration options.

    Note: You can specify any type of user in the config but an account with admin permissions is required to fetch disk metrics. The metric harbor.projects.count only reflects the number of projects the provided user can access.

  2. Restart the Agent.

Log Collection

Available for Agent versions >6.0

  1. Collecting logs is disabled by default in the Datadog Agent, you need to enable it in datadog.yaml:

    logs_enabled: true
  2. Add this configuration block to your harbor.d/conf.yaml file to start collecting your Harbor logs:

     logs:
       - type: file
         path: /var/log/harbor/*.log
         source: harbor
         service: '<SERVICE_NAME>'
  3. Restart the Agent.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Metric collection
ParameterValue
<INTEGRATION_NAME>harbor
<INIT_CONFIG>blank or {}
<INSTANCE_CONFIG>{"url": "https://%%host%%", "username": "<USER_ID>", "password": "<USER_PASSWORD>"}
Log collection

Available for Agent versions >6.0

Collecting logs is disabled by default in the Datadog Agent. To enable it, see Kubernetes log collection documentation.

ParameterValue
<LOG_CONFIG>{"source": "harbor", "service": "<SERVICE_NAME>"}

Validation

Run the Agent’s status subcommand and look for harbor under the Checks section.

Data Collected

Metrics

harbor.projects.count
(gauge)
The total number of projects.
harbor.disk.free
(gauge)
The amount of storage space that is free.
Shown as byte
harbor.disk.total
(gauge)
The total amount of storage space.
Shown as byte
harbor.registry.read_only
(gauge)
The 'read_only' status of a registry.

Service Checks

harbor.can_connect:
Returns OK if the Harbor API is reachable and authentication is successful, otherwise returns CRITICAL.

harbor.status:
Returns OK if the specified Harbor component is healthy, otherwise returns CRITICAL. Returns UNKNOWN with Harbor < 1.5.

harbor.registry.status:
Returns OK if the service is healthy, otherwise returns CRITICAL. Monitors the health of external registries used by Harbor for replication.

Events

The Harbor integration does not include any events.

Troubleshooting

Need help? Contact Datadog support.