get
https://jf.example.com/xray/api/v1/metrics
Returns the current Xray OpenMetrics scrape. The response Content-Type
is text/plain; version=0.0.4.
On the JFrog Platform the path is /xray/api/v1/metrics. Requires a
user with Admin permissions. A caller who is not an admin is allowed
when the access token includes the system:metrics:r scope.
Gauge and counter series end in _total. Queue, cache, migration, and
OpenTelemetry series depend on the deployment, so the body is not a
fixed list. sys_memory, sys_cpu, and sys_load are excluded.
| Family | Series | Meaning |
|---|---|---|
| Database pool | jfxr_db_connection_pool_in_use_total, jfxr_db_connection_pool_idle_total, jfxr_db_connection_pool_max_open_total, jfxr_db_connection_pool_constructing_total, jfxr_db_connection_pool_acquire_blocked_total, jfxr_db_connection_pool_canceled_acquire_total, and the blocked-wait series | Connections in use, idle, maximum, opening, and acquires that blocked or were canceled. Label service_type. |
| Queues | queue_messages_total | Current message count. One series per queue, label queue_name. Queues named trans.* and syncActionReply* are omitted. |
| RabbitMQ | rabbitmq_nodes_total, rabbitmq_nodes_running_total, rabbitmq_is_ha_quorum_total, rabbitmq_queue_min_members_total, rabbitmq_expected_replicas_total | Cluster size, running nodes, quorum mode, smallest member count, and expected replicas. |
| Virtual storage | jfxr_virtual_storage_available, jfxr_virtual_storage_reserved, jfxr_virtual_storage_reserved_messages_total | Available bytes, reserved bytes, and reserved message count. Present after virtual storage is initialized. |
| Jira | jfxr_jira_no_of_integrations_total, jfxr_jira_no_of_profiles_total | Integration count and profile count. |
| DB sync | jfxr_db_sync_* | One series per sync stat, including last_started, last_finished, is_running, total_updates_runs, and total_updates_failed. Other update sources use their own prefix. |
| Cleanup | cleanup_job_data_start_time, cleanup_job_data_end_time, cleanup_job_data_time_taken_by_last_job, cleanup_job_data_deleted_artifacts_total, cleanup_job_data_deleted_artifacts_in_last_batch_total, cleanup_job_data_processed_artifacts_total, cleanup_job_data_processed_artifacts_in_last_batch_total | Last cleanup job. |
| Uptime | jfxr_performance_server_up_time | Seconds since the Xray server process started. |
| Migrations | uncompleted_migrations_time_since_xray_version_initial_startup | Seconds an unfinished migration has been running. Label migration_name. Zero when none are unfinished. |
| SBOM migration | sbom_migration_total_number_of_root_files_total, sbom_number_of_successfully_migrated_artifacts_total, sbom_number_of_failed_migrated_artifacts_total, sbom_migration_duration | Present when SBOM migration is enabled. |
| Caches | cache_last_minute_size_total, cache_last_minute_requests_total, cache_last_minute_misses_total, cache_last_minute_miss | Last-minute cache stats. Label cache_name. |
| Runtime | {service}_go_routines_total and Go memory series | Process stats from the shared collector. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
401Authentication is required. The response has no body.
403The caller is authenticated and has neither Admin permission nor the system:metrics:r scope. The response has no body.
