Open Metrics

Overview

The JFrog Platform now supports Open Metrics.

Credentials for Accessing Open Metrics

From Artifactory version 7.21.1, an admin user can create a scoped access token using system:metrics:r and use that as the credentials for getting the service metrics. The admin can create read-only access token to get metrics, which then enables anyone with the read-only token to read metrics. To learn more, see Access Token Structure.

To enable metrics in Artifactory, make the following configuration changes to the Artifactory System YAML.

artifactory:
    metrics:
        enabled: true

To enable metrics in Xray, make the following configuration changes to the Xray System YAML.

xray:
    metrics:
        enabled: true

To enable metrics in Insight, make the following configuration changes to the Insight System YAML.

## Insight scheduler template
insight-scheduler:
    metrics:
        enabled: false
## Insight server template
insight-server:
    metrics:
        enabled: false

Page Contents

Supported Open Metrics

Artifactory Metrics

The Get the Open Metrics for Artifactory REST API returns the following metrics in Open Metrics format.

Metric	Description
`sys_cpu_totaltime_seconds`	Total CPU used by the artifactory process
`app_disk_total_bytes`	Total Disk used by the application (Home directory)
`app_disk_free_bytes`	Total Disk free
`jfrt_artifacts_gc_duration_seconds`	Time taken by a GC run
`jfrt_artifacts_gc_binaries_total`	Number of binaries removed by a GC run
`jfrt_artifacts_gc_size_cleaned_bytes`	Space reclaimed by a GC run
`jfrt_artifacts_gc_current_size_bytes`	Space occupied by Binaries after a GC run (Only for FULL GC runs)
`jfrt_runtime_heap_freememory_bytes`	Available free memory for JVM
`jfrt_runtime_heap_maxmemory_bytes`	Maximum memory configured for JVM
`jfrt_runtime_heap_totalmemory_bytes`	Total memory configured for JVM memory
`jfrt_runtime_heap_processors_total`	Total number of processors for JVM memory
`jfrt_db_connections_active_total`	Total number of active total DB connections
`jfrt_db_connections_idle_total`	Total number of idle DB connections
`jfrt_db_connections_max_active_total`	Total number of maximum DB connections
`jfrt_db_connections_min_idle_total`	Total number of min idle DB connections
`jfrt_http_connections_available_total`	Total number of available outbound HTTP connections
`jfrt_http_connections_leased_total`	Total number of available leased HTTP connections
`jfrt_http_connections_pending_total`	Total number of available pending HTTP connections
`jfrt_http_connections_max_total`	Total number of maximum HTTP connections
`jfrt_slow_queries_duration_seconds`	Slow queries duration in seconds

jfrt_http_connections_* metrics collects outbound HTTP connections for repositories sorted by available pool count. If you want to collect this information for more repositories, you can set the value in the artifactory.system.properties file (available at $JFROG_HOME/var/etc/artifactory/) using the flag, artifactory.httpconnections.metrics.max.total.repositories. The default and recommended value is 10. You can set the value to any integer.

Xray Metrics

The Xray Metrics REST API returns the following metrics:

Metric	Description
`jfxr_db_sync_started_before_seconds`	Seconds that passed since the last Xray DB sync started running
`jfxr_db_sync_running_total`	DB sync total running time
`jfxr_db_sync_ended_persist_before_seconds`	Seconds that passed since completed persisting new updates to the database
`jfxr_db_sync_ended_analyze_before_seconds`	Seconds that passed since DB sync completed sending all impact analysis messages
`jfxr_data_artifacts_total`	Total number of Xray scanned artifacts by package type Note: Package type is a label `package_type`
`jfxr_data_components_total`	Total number of Xray scanned components by package type Note: Package type is a label `package_type`
`jfxr_performance_server_up_time_seconds`	Seconds that passed since Xray server has started on the particular node

`Logs`

The artifactory_metrics.log will contain system metrics such as:

- - Total disk space used
  - Total disk space free
  - Time CPU is used by the process
  - JVM available memory
  - JVM number of processors
  - DB number of active, idle, max and min connections
  - HTTP number of available, leased, pending and max connections
  - Xray DB sync running time
  - Xray total number of scanned artifacts and components
  - Xray server start time on a node

The artifactory_metrics_events.log will contain deduplicated metrics related to an event such as a GC run.

Usage Example - Prometheus

Update the prometheus.yml file to add a scrape job. Update the following configuration with the adequate values:

job_name: Use a unique name among other scrape jobs. All metrics collected through this job will have automatically a ‘job’ label with this value added to it
username: The name of an admin user
password: The admin password
targets: The URL of the Artifactory node.

- job_name: 'artifactory'
    # Configures the protocol scheme used for requests.
    [scheme: <scheme> | default = http]
    # Sets the `Authorization` header on every scrape request with
    # the configured credentials.
    authorization:
		[type: <string> | default: Bearer]
  		credentials: <secret> 
    # metrics_path defaults to '/metrics'
    metrics_path: '/artifactory/api/v1/metrics'
    static_configs:
    - targets: ['<JFROG_URL>:<PORT>']

For more information about Prometheus scrap job configuration, see here.

Content

Space Tools