Get the Open Metrics for Artifactory

JFrog REST APIs
Content Type
REST API

Description: Returns the open metrics collected for Artifactory.Artifactory Metrics

Security: Requires an admin user

Usage: GET /{microservice_name}/api/v1/metrics

Produces: text/plain (in Open Metrics format)

Sample Usage:

GET /api/v1/metrics

If metrics is not enabled - empty text.
If enabled : 
# HELP sys_cpu_totaltime_seconds Total cpu time from the threads in seconds
# UPDATED sys_cpu_totaltime_seconds 1595837402515
# TYPE sys_cpu_totaltime_seconds gauge
sys_cpu_totaltime_seconds 129.909 1595837402516
# HELP app_disk_total_bytes Used bytes for app home directory disk device
# UPDATED app_disk_total_bytes 1595837402515
# TYPE app_disk_total_bytes gauge
app_disk_total_bytes 1.038806e+11 1595837402516
# HELP app_disk_free_bytes Free bytes for app home directory disk device
# UPDATED app_disk_free_bytes 1595837402515
# TYPE app_disk_free_bytes gauge
app_disk_free_bytes 1.009052e+11 1595837402516
# HELP jfrt_artifacts_gc_duration_seconds Time taken for garbage collection
# UPDATED jfrt_artifacts_gc_duration_seconds 1595837402515
# TYPE jfrt_artifacts_gc_duration_seconds gauge
jfrt_artifacts_gc_duration_seconds{end="1595837400008",start="1595837400001",status="COMPLETED",type="TRASH_AND_BINARIES"} 0.007 1595837402516
# UPDATED jfrt_http_connections_available_total 1602763596303
jfrt_http_connections_available_total{max="50",pool="insight-remote-1602763529314"} 46 1602763596305
# UPDATED jfrt_http_connections_leased_total 1602763596303
jfrt_http_connections_leased_total{max="50",pool="insight-remote-1602763529314"} 0 1602763596305
# UPDATED jfrt_http_connections_pending_total 1602763596303
jfrt_http_connections_pending_total{max="50",pool="insight-remote-1602763529314"} 0 1602763596305
# UPDATED jfrt_http_connections_max_total 1602763596303
jfrt_http_connections_max_total{max="50",pool="insight-remote-1602763529314"} 50 1602763596305
# UPDATED jfrt_runtime_heap_freememory_bytes 1602763596303
jfrt_runtime_heap_freememory_bytes 9.229538e+08 1602763596305
# UPDATED jfrt_runtime_heap_maxmemory_bytes 1602763596303
jfrt_runtime_heap_maxmemory_bytes 2.147484e+09 1602763596305
# UPDATED jfrt_runtime_heap_totalmemory_bytes 1602763596303
jfrt_runtime_heap_totalmemory_bytes 2.147484e+09 1602763596305
# UPDATED jfrt_runtime_heap_processors_total 1602763596303
jfrt_runtime_heap_processors_total 4 1602763596305
# UPDATED sys_cpu_totaltime_seconds 1602763596305
sys_cpu_totaltime_seconds 1576.388 1602763596305
# UPDATED app_disk_total_bytes 1602763596301
app_disk_total_bytes 1.038806e+11 1602763596305
# UPDATED app_disk_free_bytes 1602763596301
app_disk_free_bytes 9.599553e+10 1602763596305

List of Microservices

The following microservices support open metrics:

  • Access: curl -H "Authorization: Bearer ****" -XGET https://{artifactory_url}/access/api/v1/metrics

  • Router: curl -H "Authorization: Bearer ****" -XGET https://{artifactory_url}/router/api/v1/metrics -s

  • Events: curl -H "Authorization: Bearer ****" -XGET https://{artifactory_url}/event/api/v1/metrics

  • Workers: curl -H "Authorization: Bearer ****" -XGET https://{artifactory_url}/workers/api/v1/metrics

  • Topology: curl -H "Authorization: Bearer ****" -XGET https://{artifactory_url}/topology/api/v1/metrics

  • JFConnect: curl -H "Authorization: Bearer ****" -XGET https://{artifactory_url}/jfconnect/api/v1/metrics

  • Observability: curl -H "Authorization: Bearer ****" -XGET https://{artifactory_url}/observability/api/v1/metrics -s

  • Artifactory Federation Service: curl -H "Authorization: Bearer ****" -XGET https://{artifactory_url}/rtfs/api/v1/metrics

    Note

    Artifactory Federation Service is available on Artifactory Self-Hosted versions starting from 7.111.12 and later, and 7.117.5 and later.