Mercurial > hg > orthanc

changeset 7064:2683ca49dfea streaming

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
moving advanced streaming options to the dedicated file
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 12 Aug 2026 10:01:49 +0200
parents 126b525257e5
children 93188f55b5a3
files OrthancServer/Resources/AdvancedConfiguration.json OrthancServer/Resources/Configuration.json
diffstat 2 files changed, 88 insertions(+), 91 deletions(-) [+]
line wrap: on
line diff
--- a/OrthancServer/Resources/AdvancedConfiguration.json	Wed Aug 12 09:54:49 2026 +0200
+++ b/OrthancServer/Resources/AdvancedConfiguration.json	Wed Aug 12 10:01:49 2026 +0200
@@ -291,6 +291,9 @@
 
   /**
    * Performance-related options
+   *
+   * TODO-Streaming: add a page in the book: performance: fine tuning:
+   * limiting memory + increasing the number of threads
    **/
 
   // Defines the number of threads that are used to execute each type of
@@ -339,5 +342,79 @@
   // at any given time. A value of "0" indicates to use all the
   // available CPU logical cores. Prior to Orthanc 1.12.6, there was no limit.
   // (new in Orthanc 1.12.6)
-  "MaximumConcurrentDcmtkTranscoders" : 0
+  "MaximumConcurrentDcmtkTranscoders" : 0,
+
+  // Number of threads that are used to parse DICOM files (when you need
+  // to access the value of DICOM tags that are not store in DB).
+  // (new in Orthanc 1.12.11+)
+  // You should monitor the "orthanc_dicom_parser_available_threads"
+  // metrics to determine the optimal value for your setup and usage.
+  "DicomParserThreads" : 2,
+
+  // Amount of RAM (in MB) that are allocated to the DICOM parser threads.
+  // Note that this limit can be overpassed when a single file
+  // exceeds this size.
+  // (new in Orthanc 1.12.11+).
+  // You should monitor the "orthanc_dicom_parser_memory_usage_mb" and
+  // "orthanc_dicom_parser_memory_max_usage_mb" metrics to determine the
+  // optimal value for your setup and usage.
+  "DicomParserMemoryCapacity" : 256,
+
+  // Maximum size of the DICOM parser cache in MB.  This cache
+  // is stored in RAM and contains a parsed version of recently read
+  // DIOCM files.  A value of "0" indicates the cache
+  // is disabled.  (new in Orthanc 1.12.11+)
+  "DicomParserCacheSize" : 128,
+
+  // Number of threads that are used to parse transcode DICOM files.
+  // (new in Orthanc 1.12.11+)
+  // You should monitor the "orthanc_transcoder_available_threads"
+  // metrics to determine the optimal value for your setup and usage.
+  "TranscoderThreads" : 4,
+
+  // Amount of RAM (in MB) that are allocated to the transcoder threads.
+  // Note that this limit can be overpassed when a single file
+  // exceeds this size.
+  // (new in Orthanc 1.12.11+).
+  // You should monitor the "orthanc_transcoder_memory_usage_mb" and
+  // "orthanc_transcoder_memory_max_usage_mb" metrics to determine the
+  // optimal value for your setup and usage.
+  "TranscoderMemoryCapacity" : 256,
+
+  // Maximum size of the transcoder cache in MB.  This cache
+  // is stored in RAM and contains transcoded versions of recently read
+  // DIOCM files.  A value of "0" indicates the cache
+  // is disabled.  (new in Orthanc 1.12.11+)
+  "TranscoderCacheSize" : 128,
+
+  // Total number of threads that are used to provide DICOM files sequentially
+  // (currently used in Archive jobs, C-Store and C-Get).
+  // Each time such a job needs to get a DICOM file content, it requests it from
+  // a sequential DICOM reader that will itself use a s torage loader thread.
+  // Therefore, by default, the value of this configuration is identical to
+  // "StorageLoaderThreads".
+  // (new in Orthanc 1.13.0)
+  // You should monitor the "orthanc_seq_reader_available_threads"
+  // metrics to determine the optimal value for your setup and usage.
+  // "SequentialDicomReaderThreads" : 4,
+
+  // Number of files each sequential DICOM reader is allowed to buffer
+  // in advance before it is consumed by the related job.
+  // This is kind of equivalent to the older "LoaderThreads" configuration
+  // but, furthermore, you must make sure that there are enough "StorageLoaderThreads"
+  // and "SequentialDicomReaderThreads" for each job ->
+  // "StorageLoaderThreads" should be larger than "ConcurrentJobs" * "SequentialDicomReaderWindowSize"
+  // Together with "SequentialDicomReaderWindowCapacity", this also defines the amount of memory that is
+  // used by each job that required a SequentialDicomReader.
+  // By default, the value of this configuration is the same as "LoaderThreads".
+  // "SequentialDicomReaderWindowSize" : 4,
+
+  // Amount of RAM (in MB) that are allocated to each sequential DICOM
+  // Reader.  The sequential DICOM reader stops pauses buffering as soon
+  // as one of the "SequentialDicomReaderWindowSize" or
+  // "SequentialDicomReaderWindowCapacity" limit is reached.
+  // Note that this limit can be overpassed when a single file
+  // exceeds this size.
+  // (new in Orthanc 1.13.0).
+  "SequentialDicomReaderWindowCapacity" : 64
 }
--- a/OrthancServer/Resources/Configuration.json	Wed Aug 12 09:54:49 2026 +0200
+++ b/OrthancServer/Resources/Configuration.json	Wed Aug 12 10:01:49 2026 +0200
@@ -53,22 +53,22 @@
   "MaximumStorageCacheSize" : 128,
 
   // Amount of RAM (in MB) that are allocated to the storage loader threads.
-  // Note that this limit can be overpassed when a single file 
+  // Note that this limit can be overpassed when a single file
   // exceeds this size.
   // (new in Orthanc 1.12.11+).
   // You should monitor the "orthanc_storage_memory_usage_mb" and
-  // "orthanc_storage_memory_max_usage_mb" metrics to determine the 
-  // optimal value for your setup. 
-  "StorageMemoryCapacity": 512,
+  // "orthanc_storage_memory_max_usage_mb" metrics to determine the
+  // optimal value for your setup.
+  "StorageMemoryCapacity" : 512,
 
   // Number of threads that are used to read files from the storage.
   // (new in Orthanc 1.12.11+)
-  // A value > 4 is meaningful only if the storage is a distributed 
+  // A value > 4 is meaningful only if the storage is a distributed
   // network storage (e.g., object storage plugin).  In this case,
-  // you can typically increase it to 20 and you should then monitor 
-  // the "orthanc_storage_available_threads" metrics to determine 
+  // you can typically increase it to 20 and you should then monitor
+  // the "orthanc_storage_available_threads" metrics to determine
   // the optimal value for your setup.
-  "StorageLoaderThreads": 4,
+  "StorageLoaderThreads" : 4,
 
   // List of paths to the custom Lua scripts that are to be loaded
   // into this instance of Orthanc
@@ -119,7 +119,7 @@
   // all to Orthanc while, in the second case, external HTTP clients
   // will be able to connect but will receive a 401 Unauthorized
   // HTTP status code.
-  //"HttpBindAddresses" : ["1.2.3.4", "127.0.0.1"]
+  // "HttpBindAddresses" : ["1.2.3.4", "127.0.0.1"]
 
   // Number of threads that are used by the embedded HTTP server.
   "HttpThreadsCount" : 50,
@@ -851,85 +851,5 @@
   // Orthanc <= 1.12.10. This default value can be overwritten per archive,
   // by providing the "Utf8" field to the "{...}/archive" and
   // "/tools/create-archives" routes. (new in Orthanc 1.12.11)
-  "ZipUseUtf8" : false,
-
-
-  // -> TODO-Streaming: move this into AdvancedConfiguration.json
-
-  // TODO-Streaming: add a page in the book: performance: fine tuning: limiting memory + increasing the number of threads blah blah blah
-
-
-  // Number of threads that are used to parse DICOM files (when you need
-  // to access the value of DICOM tags that are not store in DB).
-  // (new in Orthanc 1.12.11+)
-  // You should monitor the "orthanc_dicom_parser_available_threads" 
-  // metrics to determine the optimal value for your setup and usage.
-  "DicomParserThreads": 2,
-
-  // Amount of RAM (in MB) that are allocated to the DICOM parser threads.
-  // Note that this limit can be overpassed when a single file 
-  // exceeds this size.
-  // (new in Orthanc 1.12.11+).
-  // You should monitor the "orthanc_dicom_parser_memory_usage_mb" and
-  // "orthanc_dicom_parser_memory_max_usage_mb" metrics to determine the 
-  // optimal value for your setup and usage. 
-  "DicomParserMemoryCapacity": 256,
-
-  // Maximum size of the DICOM parser cache in MB.  This cache
-  // is stored in RAM and contains a parsed version of recently read
-  // DIOCM files.  A value of "0" indicates the cache
-  // is disabled.  (new in Orthanc 1.12.11+)
-  "DicomParserCacheSize" : 128,
-
-  // Number of threads that are used to parse transcode DICOM files.
-  // (new in Orthanc 1.12.11+)
-  // You should monitor the "orthanc_transcoder_available_threads" 
-  // metrics to determine the optimal value for your setup and usage.
-  "TranscoderThreads": 4,
-
-  // Amount of RAM (in MB) that are allocated to the transcoder threads.
-  // Note that this limit can be overpassed when a single file 
-  // exceeds this size.
-  // (new in Orthanc 1.12.11+).
-  // You should monitor the "orthanc_transcoder_memory_usage_mb" and
-  // "orthanc_transcoder_memory_max_usage_mb" metrics to determine the 
-  // optimal value for your setup and usage. 
-  "TranscoderMemoryCapacity": 256,
-
-  // Maximum size of the transcoder cache in MB.  This cache
-  // is stored in RAM and contains transcoded versions of recently read
-  // DIOCM files.  A value of "0" indicates the cache
-  // is disabled.  (new in Orthanc 1.12.11+)
-  "TranscoderCacheSize" : 128,
-
-  // Total number of threads that are used to provide DICOM files sequentially
-  // (currently used in Archive jobs, C-Store and C-Get).
-  // Each time such a job needs to get a DICOM file content, it requests it from
-  // a sequential DICOM reader that will itself use a s torage loader thread.
-  // Therefore, by default, the value of this configuration is identical to
-  // "StorageLoaderThreads".
-  // (new in Orthanc 1.13.0)
-  // You should monitor the "orthanc_seq_reader_available_threads" 
-  // metrics to determine the optimal value for your setup and usage.
-  // "SequentialDicomReaderThreads": 4,
-
-  // Number of files each sequential DICOM reader is allowed to buffer
-  // in advance before it is consumed by the related job.
-  // This is kind of equivalent to the older "LoaderThreads" configuration
-  // but, furthermore, you must make sure that there are enough "StorageLoaderThreads"
-  // and "SequentialDicomReaderThreads" for each job -> 
-  // "StorageLoaderThreads" should be larger than "ConcurrentJobs" * "SequentialDicomReaderWindowSize"
-  // Together with "SequentialDicomReaderWindowCapacity", this also defines the amount of memory that is
-  // used by each job that required a SequentialDicomReader.
-  // By default, the value of this configuration is the same as "LoaderThreads".
-  // "SequentialDicomReaderWindowSize": 4,
-  
-  // Amount of RAM (in MB) that are allocated to each sequential DICOM
-  // Reader.  The sequential DICOM reader stops pauses buffering as soon
-  // as one of the "SequentialDicomReaderWindowSize" or 
-  // "SequentialDicomReaderWindowCapacity" limit is reached.
-  // Note that this limit can be overpassed when a single file 
-  // exceeds this size.
-  // (new in Orthanc 1.13.0).
-  "SequentialDicomReaderWindowCapacity": 64
+  "ZipUseUtf8" : false
 }