Blaze FHIR Server
main - ci-build
Blaze FHIR Server - Local Development build (vmain) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2026-11-22 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="disk-perf"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition disk-perf</b></p><a name="disk-perf"> </a><a name="hcdisk-perf"> </a><p>URL: [base]/$disk-perf</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>database</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-Database.html">Database Value Set</a> (Required)</td><td><div><p>The name of the database on which directory volume the benchmark runs. Defaults to index.</p>
</div></td></tr><tr><td>IN</td><td>file-size</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#decimal">decimal</a></td><td/><td><div><p>The size of the test file to write and read in GiB, at least 1 MiB and at most 64 GiB. Defaults to 4.</p>
</div></td></tr><tr><td>IN</td><td>phase-duration</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#decimal">decimal</a></td><td/><td><div><p>The duration of the random read and the fsync phase in seconds, at most 300. Defaults to 30.</p>
</div></td></tr><tr><td>IN</td><td>max-concurrency</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#positiveInt">positiveInt</a></td><td/><td><div><p>The maximum number of concurrent reader threads of the random read sweep, between 1 and 1024. The sweep measures one run per concurrency level, doubling the number of readers from 1 up to the maximum. Defaults to 32.</p>
</div></td></tr><tr><td>OUT</td><td>seq-write-throughput</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The throughput of the sequential write phase in bytes per second.</p>
</div></td></tr><tr><td>OUT</td><td>rand-read</td><td/><td>1..*</td><td/><td/><td><div><p>One run of the random read sweep per concurrency level.</p>
</div></td></tr><tr><td>OUT</td><td>rand-read.concurrency</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#positiveInt">positiveInt</a></td><td/><td><div><p>The number of concurrent reader threads of this run.</p>
</div></td></tr><tr><td>OUT</td><td>rand-read.iops</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The number of I/O operations per second of this run.</p>
</div></td></tr><tr><td>OUT</td><td>rand-read.throughput</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The throughput of this run in bytes per second.</p>
</div></td></tr><tr><td>OUT</td><td>rand-read.latency-p50</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The median latency of a single random read of this run in microseconds.</p>
</div></td></tr><tr><td>OUT</td><td>rand-read.latency-p95</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The 95th percentile latency of a single random read of this run in microseconds.</p>
</div></td></tr><tr><td>OUT</td><td>rand-read.latency-p99</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The 99th percentile latency of a single random read of this run in microseconds.</p>
</div></td></tr><tr><td>OUT</td><td>rand-read.latency-max</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The maximum latency of a single random read of this run in microseconds.</p>
</div></td></tr><tr><td>OUT</td><td>fsync-rate</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The number of write + fsync operations per second in the fsync phase.</p>
</div></td></tr><tr><td>OUT</td><td>fsync-latency-p50</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The median latency of a single write + fsync operation in microseconds.</p>
</div></td></tr><tr><td>OUT</td><td>fsync-latency-p95</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The 95th percentile latency of a single write + fsync operation in microseconds.</p>
</div></td></tr><tr><td>OUT</td><td>fsync-latency-p99</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The 99th percentile latency of a single write + fsync operation in microseconds.</p>
</div></td></tr><tr><td>OUT</td><td>direct-io</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Whether the random read phase was able to bypass the page cache using direct I/O. If false, the read results include page cache effects.</p>
</div></td></tr><tr><td>OUT</td><td>score</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#decimal">decimal</a></td><td/><td><div><p>The overall disk performance score between 0 and 100, where 100 represents the performance of a good local NVMe SSD.</p>
</div></td></tr><tr><td>OUT</td><td>rating</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-DiskPerfRating.html">Disk Performance Rating Value Set</a> (Required)</td><td><div><p>The overall disk performance rating derived from the score.</p>
</div></td></tr><tr><td>OUT</td><td>processing-duration</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Quantity">Quantity</a></td><td/><td><div><p>The duration the whole benchmark took in seconds.</p>
</div></td></tr></table></div>
</text>
<url value="https://blaze-server.org/fhir/OperationDefinition/disk-perf"/>
<version value="main"/>
<name value="DiskPerf"/>
<title value="Measure Disk Performance"/>
<status value="active"/>
<kind value="operation"/>
<date value="2026-11-22T10:48:55+00:00"/>
<publisher value="The Samply Community"/>
<contact>
<name value="The Samply Community"/>
<telecom>
<system value="url"/>
<value value="https://samply.de"/>
</telecom>
</contact>
<description
value="Measures the performance of the disk volume of one of the database directories with an I/O profile similar to the one Blaze's RocksDB databases produce. The response is always async according to the Asynchronous Interaction Request Pattern. The results are also available as outputs of the underlying DiskPerfJob Task resource."/>
<affectsState value="true"/>
<code value="disk-perf"/>
<system value="true"/>
<type value="false"/>
<instance value="false"/>
<parameter>
<name value="database"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The name of the database on which directory volume the benchmark runs. Defaults to index."/>
<type value="code"/>
<binding>
<strength value="required"/>
<valueSet value="https://blaze-server.org/fhir/ValueSet/Database"/>
</binding>
</parameter>
<parameter>
<name value="file-size"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The size of the test file to write and read in GiB, at least 1 MiB and at most 64 GiB. Defaults to 4."/>
<type value="decimal"/>
</parameter>
<parameter>
<name value="phase-duration"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The duration of the random read and the fsync phase in seconds, at most 300. Defaults to 30."/>
<type value="decimal"/>
</parameter>
<parameter>
<name value="max-concurrency"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The maximum number of concurrent reader threads of the random read sweep, between 1 and 1024. The sweep measures one run per concurrency level, doubling the number of readers from 1 up to the maximum. Defaults to 32."/>
<type value="positiveInt"/>
</parameter>
<parameter>
<name value="seq-write-throughput"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The throughput of the sequential write phase in bytes per second."/>
<type value="Quantity"/>
</parameter>
<parameter>
<name value="rand-read"/>
<use value="out"/>
<min value="1"/>
<max value="*"/>
<documentation
value="One run of the random read sweep per concurrency level."/>
<part>
<name value="concurrency"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The number of concurrent reader threads of this run."/>
<type value="positiveInt"/>
</part>
<part>
<name value="iops"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The number of I/O operations per second of this run."/>
<type value="Quantity"/>
</part>
<part>
<name value="throughput"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="The throughput of this run in bytes per second."/>
<type value="Quantity"/>
</part>
<part>
<name value="latency-p50"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The median latency of a single random read of this run in microseconds."/>
<type value="Quantity"/>
</part>
<part>
<name value="latency-p95"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The 95th percentile latency of a single random read of this run in microseconds."/>
<type value="Quantity"/>
</part>
<part>
<name value="latency-p99"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The 99th percentile latency of a single random read of this run in microseconds."/>
<type value="Quantity"/>
</part>
<part>
<name value="latency-max"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The maximum latency of a single random read of this run in microseconds."/>
<type value="Quantity"/>
</part>
</parameter>
<parameter>
<name value="fsync-rate"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The number of write + fsync operations per second in the fsync phase."/>
<type value="Quantity"/>
</parameter>
<parameter>
<name value="fsync-latency-p50"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The median latency of a single write + fsync operation in microseconds."/>
<type value="Quantity"/>
</parameter>
<parameter>
<name value="fsync-latency-p95"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The 95th percentile latency of a single write + fsync operation in microseconds."/>
<type value="Quantity"/>
</parameter>
<parameter>
<name value="fsync-latency-p99"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The 99th percentile latency of a single write + fsync operation in microseconds."/>
<type value="Quantity"/>
</parameter>
<parameter>
<name value="direct-io"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Whether the random read phase was able to bypass the page cache using direct I/O. If false, the read results include page cache effects."/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="score"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The overall disk performance score between 0 and 100, where 100 represents the performance of a good local NVMe SSD."/>
<type value="decimal"/>
</parameter>
<parameter>
<name value="rating"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The overall disk performance rating derived from the score."/>
<type value="code"/>
<binding>
<strength value="required"/>
<valueSet
value="https://blaze-server.org/fhir/ValueSet/DiskPerfRating"/>
</binding>
</parameter>
<parameter>
<name value="processing-duration"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation value="The duration the whole benchmark took in seconds."/>
<type value="Quantity"/>
</parameter>
</OperationDefinition>