# HG changeset patch # User Alain Mazy # Date 1697636587 -7200 # Node ID 759f7d5aca941dbc618740323b8a88bd30f17128 # Parent 6650b0ab177a52d6c88a8447d52f04c3283086d1 metrics table diff -r 6650b0ab177a -r 759f7d5aca94 Sphinx/source/users/advanced-rest.rst --- a/Sphinx/source/users/advanced-rest.rst Fri Oct 13 15:16:41 2023 +0200 +++ b/Sphinx/source/users/advanced-rest.rst Wed Oct 18 15:43:07 2023 +0200 @@ -371,6 +371,74 @@ orthanc_uncompressed_size_mb 16855.9629 1680083638028 orthanc_up_time_s 64 1680083638028 +The metrics only appear in the response once they have been recorded at least once. Furthermore, some plugins +may add their own metrics dynamically. + ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| Metrics | Meaning | Origin | ++========================================================+=============================================================================+================================================================+ +| ``orthanc_up_time_s`` | The time [s] spent since Orthanc started | Orthanc | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_last_change`` | The current id of the last `change` event | Orthanc | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_memory_trimming_duration_ms`` | The max duration [ms] over the last 10 seconds of the last memory | Orthanc | +| | trimming duration | | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_store_dicom_duration_ms`` | The max duration [ms] over the last 10 seconds needed to store a | Orthanc | +| | DICOM file (received from HTTP, DICOM protocol or from a plugin) | | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_count_instances`` | The number of instances stored in DB | Orthanc DB | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_count_series`` | The number of series stored in DB | Orthanc DB | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_count_studies`` | The number of studies stored in DB | Orthanc DB | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_count_patients`` | The number of patients stored in DB | Orthanc DB | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_dicom_cache_count`` | The number of DICOM files currently stored in the cache | Orthanc DICOM cache | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_dicom_cache_size`` | The size [MB] of all DICOM files currently stored in the cache | Orthanc DICOM cache | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_find_scp_duration_ms`` | The max duration [ms] over the last 10 seconds of a C-Find SCP execution | Orthanc DICOM protocol server | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_get_scp_duration_ms`` | The max duration [ms] over the last 10 seconds of a C-Get SCP execution | Orthanc DICOM protocol server | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_move_scp_duration_ms`` | The max duration [ms] over the last 10 seconds of a C-Move SCP execution | Orthanc DICOM protocol server | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_rest_api_active_requests`` | The maximum number of concurrent HTTP requests being handled by the | Orthanc HTTP server | +| | HTTP server over the last 10 seconds. | | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_rest_api_duration_ms`` | The max duration [ms] over the last 10 seconds required to handle | Orthanc HTTP server | +| | an HTTP request | | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_jobs_pending`` | The current number of jobs whose execution is currently pending | Orthanc Jobs engine | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_jobs_running`` | The current number of jobs currently being executed | Orthanc Jobs engine | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_jobs_completed`` | The current number of jobs completed (failed or success) | Orthanc Jobs engine | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_jobs_success`` | The current number of jobs that have succeeded | Orthanc Jobs engine | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_jobs_failed`` | The current number of jobs that have failed | Orthanc Jobs engine | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_disk_size_mb`` | The size [MB] of all DICOM files currently stored in Orthanc | Orthanc storage | +| | (possibly compressed size) | | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_uncompressed_size_mb`` | The size [MB] of all DICOM files currently stored in Orthanc | Orthanc storage | +| | (uncompressed size) | | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_storage_create_duration_ms`` | The max duration [ms] over the last 10 seconds to save a file to disk | Orthanc Storage (default file system storage) | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_storage_read_duration_ms`` | The max duration [ms] over the last 10 seconds to read a file from disk | Orthanc Storage (default file system storage) | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_storage_remove_duration_ms`` | The max duration [ms] over the last 10 seconds to delete a file from disk | Orthanc Storage (default file system storage) | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_storage_read_bytes`` | The total number of bytes read from disk since Orthanc started | Orthanc Storage (default file system storage) | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ +| ``orthanc_storage_written_bytes`` | The total number of bytes written to disk since Orthanc started | Orthanc Storage (default file system storage) | ++--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ + + .. highlight:: bash