Get System 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.

FamilySeriesMeaning
Database pooljfxr_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 seriesConnections in use, idle, maximum, opening, and acquires that blocked or were canceled. Label service_type.
Queuesqueue_messages_totalCurrent message count. One series per queue, label queue_name. Queues named trans.* and syncActionReply* are omitted.
RabbitMQrabbitmq_nodes_total, rabbitmq_nodes_running_total, rabbitmq_is_ha_quorum_total, rabbitmq_queue_min_members_total, rabbitmq_expected_replicas_totalCluster size, running nodes, quorum mode, smallest member count, and expected replicas.
Virtual storagejfxr_virtual_storage_available, jfxr_virtual_storage_reserved, jfxr_virtual_storage_reserved_messages_totalAvailable bytes, reserved bytes, and reserved message count. Present after virtual storage is initialized.
Jirajfxr_jira_no_of_integrations_total, jfxr_jira_no_of_profiles_totalIntegration count and profile count.
DB syncjfxr_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.
Cleanupcleanup_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_totalLast cleanup job.
Uptimejfxr_performance_server_up_timeSeconds since the Xray server process started.
Migrationsuncompleted_migrations_time_since_xray_version_initial_startupSeconds an unfinished migration has been running. Label migration_name. Zero when none are unfinished.
SBOM migrationsbom_migration_total_number_of_root_files_total, sbom_number_of_successfully_migrated_artifacts_total, sbom_number_of_failed_migrated_artifacts_total, sbom_migration_durationPresent when SBOM migration is enabled.
Cachescache_last_minute_size_total, cache_last_minute_requests_total, cache_last_minute_misses_total, cache_last_minute_missLast-minute cache stats. Label cache_name.
Runtime{service}_go_routines_total and Go memory seriesProcess stats from the shared collector.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Responses

401

Authentication is required. The response has no body.

403

The caller is authenticated and has neither Admin permission nor the system:metrics:r scope. The response has no body.

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain