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

: Measure Disk Performance - JSON Representation

Active as of 2026-11-22

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "disk-perf",
  "text" : {
    "status" : "generated",
    "div" : "<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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr><tr><td>OUT</td><td>rand-read</td><td/><td>1..*</td><td></td><td/><td><div><p>One run of the random read sweep per concurrency level.</p>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></td></tr></table></div>"
  },
  "url" : "https://blaze-server.org/fhir/OperationDefinition/disk-perf",
  "version" : "main",
  "name" : "DiskPerf",
  "title" : "Measure Disk Performance",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-11-22T10:48:55+00:00",
  "publisher" : "The Samply Community",
  "contact" : [
    {
      "name" : "The Samply Community",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://samply.de"
        }
      ]
    }
  ],
  "description" : "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" : true,
  "code" : "disk-perf",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "database",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The name of the database on which directory volume the benchmark runs. Defaults to index.",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "https://blaze-server.org/fhir/ValueSet/Database"
      }
    },
    {
      "name" : "file-size",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "decimal"
    },
    {
      "name" : "phase-duration",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The duration of the random read and the fsync phase in seconds, at most 300. Defaults to 30.",
      "type" : "decimal"
    },
    {
      "name" : "max-concurrency",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "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" : "positiveInt"
    },
    {
      "name" : "seq-write-throughput",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The throughput of the sequential write phase in bytes per second.",
      "type" : "Quantity"
    },
    {
      "name" : "rand-read",
      "use" : "out",
      "min" : 1,
      "max" : "*",
      "documentation" : "One run of the random read sweep per concurrency level.",
      "part" : [
        {
          "name" : "concurrency",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The number of concurrent reader threads of this run.",
          "type" : "positiveInt"
        },
        {
          "name" : "iops",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The number of I/O operations per second of this run.",
          "type" : "Quantity"
        },
        {
          "name" : "throughput",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The throughput of this run in bytes per second.",
          "type" : "Quantity"
        },
        {
          "name" : "latency-p50",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The median latency of a single random read of this run in microseconds.",
          "type" : "Quantity"
        },
        {
          "name" : "latency-p95",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The 95th percentile latency of a single random read of this run in microseconds.",
          "type" : "Quantity"
        },
        {
          "name" : "latency-p99",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The 99th percentile latency of a single random read of this run in microseconds.",
          "type" : "Quantity"
        },
        {
          "name" : "latency-max",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The maximum latency of a single random read of this run in microseconds.",
          "type" : "Quantity"
        }
      ]
    },
    {
      "name" : "fsync-rate",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The number of write + fsync operations per second in the fsync phase.",
      "type" : "Quantity"
    },
    {
      "name" : "fsync-latency-p50",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The median latency of a single write + fsync operation in microseconds.",
      "type" : "Quantity"
    },
    {
      "name" : "fsync-latency-p95",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The 95th percentile latency of a single write + fsync operation in microseconds.",
      "type" : "Quantity"
    },
    {
      "name" : "fsync-latency-p99",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The 99th percentile latency of a single write + fsync operation in microseconds.",
      "type" : "Quantity"
    },
    {
      "name" : "direct-io",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "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" : "boolean"
    },
    {
      "name" : "score",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The overall disk performance score between 0 and 100, where 100 represents the performance of a good local NVMe SSD.",
      "type" : "decimal"
    },
    {
      "name" : "rating",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The overall disk performance rating derived from the score.",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "https://blaze-server.org/fhir/ValueSet/DiskPerfRating"
      }
    },
    {
      "name" : "processing-duration",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The duration the whole benchmark took in seconds.",
      "type" : "Quantity"
    }
  ]
}