Mercurial > hg > orthanc-book
changeset 1247:e6c6ef5dfc02
fix
| author | Alain Mazy <am@orthanc.team> |
|---|---|
| date | Thu, 11 Dec 2025 16:53:54 +0100 |
| parents | 711492945bcf |
| children | 202b98f79bf5 |
| files | Sphinx/source/users/advanced-rest.rst |
| diffstat | 1 files changed, 110 insertions(+), 109 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/users/advanced-rest.rst Thu Dec 11 16:47:11 2025 +0100 +++ b/Sphinx/source/users/advanced-rest.rst Thu Dec 11 16:53:54 2025 +0100 @@ -427,115 +427,116 @@ 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_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_up_time_s`` | The time [s] spent since Orthanc started | Orthanc | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``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 DICOM cache | Orthanc DICOM cache | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_dicom_cache_size_mb`` | The size [MB] of all DICOM files currently stored in the DICOM cache | Orthanc DICOM cache | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_available_dicom_threads`` | The min number of DICOM threads count available over the last 10 | Orthanc DICOM protocol server | -| | seconds | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``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_available_http_threads`` | The min number of HTTP threads count available over the last 10 | Orthanc HTTP server | -| | seconds. This is counting only the threads used by the external HTTP | | -| | server while ``orthanc_rest_api_active_requests`` also counts the internal | | -| | requests e.g. made by a plugin | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``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_cache_count`` | The number of files currently stored in the Storage cache | Orthanc Storage cache | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_storage_cache_size_mb`` | The size [MB] of all files currently stored in the Storage cache | Orthanc Storage cache | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``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) | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_index_active_connections_count`` | The current number of active connections to the PostgreSQL server. | Orthanc PostgreSQL Index plugin | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_aborted_push_count`` | The number of push transfers that have been discarded without being | Transfers plugin | -| | committed (on the receiver side) | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_created_push_count`` | The number of push transfers that have been created | Transfers plugin | -| | (on the receiver side) | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_committed_push_count`` | The number of push transfers that have been committed | Transfers plugin | -| | (on the receiver side) | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_available_push_count`` | The number of push transfers that are available | Transfers plugin | -| | out of the ``MaxPushTransactions``. (on the receiver side) | | -| | Note: aborted transfers might consume available "slots" but will be pushed | | -| | out when room is required for a new active transfer. | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_cache_hit_count`` | The number of times the cache could be used to transfer an instance. | Transfers plugin | -| | (on the sender side) | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_cache_miss_count`` | The number of times the cache could not be used to transfer an instance. | Transfers plugin | -| | (on the sender side) | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_used_cache_size`` | The current size [bytes] of cache. | Transfers plugin | -| | (on the sender side) | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_push_total_received_bytes_count`` | The total number of bytes received during push transfers | Transfers plugin | -| | (on the receiver side). The bytes are added just at the beginning of the commit. | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_push_total_time_spent_in_commit_ms`` | The total time [ms] spent in push transfers commit operations. | Transfers plugin | -| | (on the receiver side). | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ -| ``orthanc_transfers_push_total_time_spent_in_reception_ms`` | The total time [ms] spent in push transfers reception, before the | Transfers plugin | -| | commit operation. (on the receiver side). | | -+-----------------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| Metrics | Meaning | Origin | ++=============================================================+===================================================================================+======================================================================+ +| ``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_up_time_s`` | The time [s] spent since Orthanc started | Orthanc | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``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 DICOM cache | Orthanc DICOM cache | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_dicom_cache_size_mb`` | The size [MB] of all DICOM files currently stored in the DICOM cache | Orthanc DICOM cache | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_available_dicom_threads`` | The min number of DICOM threads count available over the last 10 | Orthanc DICOM protocol server | +| | seconds | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``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_available_http_threads`` | The min number of HTTP threads count available over the last 10 | Orthanc HTTP server | +| | seconds. This is counting only the threads used by the external HTTP | | +| | server while ``orthanc_rest_api_active_requests`` also counts the internal | | +| | requests e.g. made by a plugin | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``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_cache_count`` | The number of files currently stored in the Storage cache | Orthanc Storage cache | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_storage_cache_size_mb`` | The size [MB] of all files currently stored in the Storage cache | Orthanc Storage cache | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``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) | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_index_active_connections_count`` | The current number of active connections to the PostgreSQL server. | Orthanc PostgreSQL Index plugin | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_aborted_push_count`` | The number of push transfers that have been discarded without being | Transfers plugin | +| | committed (on the receiver side) | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_created_push_count`` | The number of push transfers that have been created | Transfers plugin | +| | (on the receiver side) | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_committed_push_count`` | The number of push transfers that have been committed | Transfers plugin | +| | (on the receiver side) | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_available_push_count`` | The number of push transfers that are available | Transfers plugin | +| | out of the ``MaxPushTransactions``. (on the receiver side) | | +| | Note: aborted transfers might consume available "slots" but will be pushed | | +| | out when room is required for a new active transfer. | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_cache_hit_count`` | The number of times the cache could be used to transfer an instance. | Transfers plugin | +| | (on the sender side) | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_cache_miss_count`` | The number of times the cache could not be used to transfer an instance. | Transfers plugin | +| | (on the sender side) | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_used_cache_size`` | The current size [bytes] of cache. | Transfers plugin | +| | (on the sender side) | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_push_total_received_bytes_count`` | The total number of bytes received during push transfers | Transfers plugin | +| | (on the receiver side). The bytes are added just at the beginning of the commit. | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_push_total_time_spent_in_commit_ms`` | The total time [ms] spent in push transfers commit operations. | Transfers plugin | +| | (on the receiver side). The value is updated at the end of the commit. | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+ +| ``orthanc_transfers_push_total_time_spent_in_reception_ms`` | The total time [ms] spent in push transfers reception, before the | Transfers plugin | +| | commit operation. (on the receiver side). The value is updated at the beginning | | +| | of the commit. | | ++-------------------------------------------------------------+-----------------------------------------------------------------------------------+----------------------------------------------------------------------+