Mercurial > hg > orthanc-book
comparison Sphinx/source/users/advanced-rest.rst @ 987:759f7d5aca94
metrics table
author | Alain Mazy <am@osimis.io> |
---|---|
date | Wed, 18 Oct 2023 15:43:07 +0200 |
parents | a6bf749b3c04 |
children | 27b75c653a8b |
comparison
equal
deleted
inserted
replaced
986:6650b0ab177a | 987:759f7d5aca94 |
---|---|
369 orthanc_storage_read_duration_ms 2 1680083630557 | 369 orthanc_storage_read_duration_ms 2 1680083630557 |
370 orthanc_store_dicom_duration_ms 7 1680083630570 | 370 orthanc_store_dicom_duration_ms 7 1680083630570 |
371 orthanc_uncompressed_size_mb 16855.9629 1680083638028 | 371 orthanc_uncompressed_size_mb 16855.9629 1680083638028 |
372 orthanc_up_time_s 64 1680083638028 | 372 orthanc_up_time_s 64 1680083638028 |
373 | 373 |
374 The metrics only appear in the response once they have been recorded at least once. Furthermore, some plugins | |
375 may add their own metrics dynamically. | |
376 | |
377 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
378 | Metrics | Meaning | Origin | | |
379 +========================================================+=============================================================================+================================================================+ | |
380 | ``orthanc_up_time_s`` | The time [s] spent since Orthanc started | Orthanc | | |
381 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
382 | ``orthanc_last_change`` | The current id of the last `change` event | Orthanc | | |
383 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
384 | ``orthanc_memory_trimming_duration_ms`` | The max duration [ms] over the last 10 seconds of the last memory | Orthanc | | |
385 | | trimming duration | | | |
386 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
387 | ``orthanc_store_dicom_duration_ms`` | The max duration [ms] over the last 10 seconds needed to store a | Orthanc | | |
388 | | DICOM file (received from HTTP, DICOM protocol or from a plugin) | | | |
389 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
390 | ``orthanc_count_instances`` | The number of instances stored in DB | Orthanc DB | | |
391 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
392 | ``orthanc_count_series`` | The number of series stored in DB | Orthanc DB | | |
393 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
394 | ``orthanc_count_studies`` | The number of studies stored in DB | Orthanc DB | | |
395 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
396 | ``orthanc_count_patients`` | The number of patients stored in DB | Orthanc DB | | |
397 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
398 | ``orthanc_dicom_cache_count`` | The number of DICOM files currently stored in the cache | Orthanc DICOM cache | | |
399 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
400 | ``orthanc_dicom_cache_size`` | The size [MB] of all DICOM files currently stored in the cache | Orthanc DICOM cache | | |
401 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
402 | ``orthanc_find_scp_duration_ms`` | The max duration [ms] over the last 10 seconds of a C-Find SCP execution | Orthanc DICOM protocol server | | |
403 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
404 | ``orthanc_get_scp_duration_ms`` | The max duration [ms] over the last 10 seconds of a C-Get SCP execution | Orthanc DICOM protocol server | | |
405 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
406 | ``orthanc_move_scp_duration_ms`` | The max duration [ms] over the last 10 seconds of a C-Move SCP execution | Orthanc DICOM protocol server | | |
407 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
408 | ``orthanc_rest_api_active_requests`` | The maximum number of concurrent HTTP requests being handled by the | Orthanc HTTP server | | |
409 | | HTTP server over the last 10 seconds. | | | |
410 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
411 | ``orthanc_rest_api_duration_ms`` | The max duration [ms] over the last 10 seconds required to handle | Orthanc HTTP server | | |
412 | | an HTTP request | | | |
413 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
414 | ``orthanc_jobs_pending`` | The current number of jobs whose execution is currently pending | Orthanc Jobs engine | | |
415 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
416 | ``orthanc_jobs_running`` | The current number of jobs currently being executed | Orthanc Jobs engine | | |
417 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
418 | ``orthanc_jobs_completed`` | The current number of jobs completed (failed or success) | Orthanc Jobs engine | | |
419 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
420 | ``orthanc_jobs_success`` | The current number of jobs that have succeeded | Orthanc Jobs engine | | |
421 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
422 | ``orthanc_jobs_failed`` | The current number of jobs that have failed | Orthanc Jobs engine | | |
423 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
424 | ``orthanc_disk_size_mb`` | The size [MB] of all DICOM files currently stored in Orthanc | Orthanc storage | | |
425 | | (possibly compressed size) | | | |
426 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
427 | ``orthanc_uncompressed_size_mb`` | The size [MB] of all DICOM files currently stored in Orthanc | Orthanc storage | | |
428 | | (uncompressed size) | | | |
429 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
430 | ``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) | | |
431 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
432 | ``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) | | |
433 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
434 | ``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) | | |
435 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
436 | ``orthanc_storage_read_bytes`` | The total number of bytes read from disk since Orthanc started | Orthanc Storage (default file system storage) | | |
437 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
438 | ``orthanc_storage_written_bytes`` | The total number of bytes written to disk since Orthanc started | Orthanc Storage (default file system storage) | | |
439 +--------------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------+ | |
440 | |
441 | |
374 | 442 |
375 .. highlight:: bash | 443 .. highlight:: bash |
376 | 444 |
377 Note that the collection of metrics can be statically disabled by | 445 Note that the collection of metrics can be statically disabled by |
378 setting the :ref:`global configuration option <configuration>` | 446 setting the :ref:`global configuration option <configuration>` |