blazectl

blazectl is a command line tool to control your FHIR® server. blazectl also works with Blaze.

Currently you can upload transaction bundles from a directory and count resources.

Installation

blazectl is written in Go. All you need is a single binary which is available for Linux, macOS and Windows.

Linux

Download the latest release with the command:

curl -LO https://github.com/samply/blazectl/releases/download/v0.3.0/blazectl-0.3.0-linux-amd64.tar.gz

Untar the binary:

tar xzf blazectl-0.3.0-linux-amd64.tar.gz

Move the binary in to your PATH.

sudo mv ./blazectl /usr/local/bin/blazectl

Test to ensure the version you installed is up-to-date:
```
blazectl --version
```

macOS

Download the latest release with the command:

curl -LO https://github.com/samply/blazectl/releases/download/v0.3.0/blazectl-0.3.0-darwin-amd64.tar.gz

Untar the binary:

tar xzf blazectl-0.3.0-darwin-amd64.tar.gz

Move the binary in to your PATH.

sudo mv ./blazectl /usr/local/bin/blazectl

Test to ensure the version you installed is up-to-date:
```
blazectl --version
```

Windows

Download the latest release here
Unzip the binary.
Add the binary in to your PATH.
Test to ensure the version you downloaded is up-to-date:
```
blazectl --version
```

Usage

$ blazectl
Usage:
  blazectl [command]

Available Commands:
  count-resources Counts all resources by type
  help            Help about any command
  upload          Upload transaction bundles

Flags:
  -h, --help            help for blazectl
      --server string   the base URL of the server to use
      --version         version for blazectl

Use "blazectl [command] --help" for more information about a command.

Upload

You can use the upload command to upload transaction bundles to our server. currently only JSON files are supported. If you don't have any transaction bundles, you can generate some with SyntheaTM.

Assuming the URL of your FHIR server is http://localhost:8080, in order to upload run:

blazectl --server http://localhost:8080 upload my/bundles

You will see a progress bar with an estimated ETA during upload. After the upload, a statistic inspired by vegeta will be printed:

Starting Upload to http://localhost:8080 ...
Uploads          [total, concurrency]     362, 4
Success          [ratio]                  100 %
Duration         [total]                  1m42s
Requ. Latencies  [mean, 50, 95, 99, max]  826ms, 534ms, 2.71s, 3.85s 6.467s
Proc. Latencies  [mean, 50, 95, 99, max]  710ms, 526ms, 2.041s, 2.739s 4.133s
Bytes In         [total, mean]            5.10 MiB, 14.59 KiB
Bytes Out        [total, mean]            61.74 MiB, 176.59 KiB
Status Codes     [code:count]             200:362

The statistics have the following meaning:

Uploads - the total number of files uploaded with the given concurrency
Success - the success rate (possible errors will be printed under the statistics)
Duration - the total duration of the upload
Requ. Latencies - mean, max and percentiles of the duration of whole requests including networks transfers
Proc. Latencies - mean, max and percentiles of the duration of the server processing time excluding networks transfers
Bytes In - total and mean number of bytes returned by the server
Bytes Out - total and mean number of bytes send by blazectl
Status Codes - a list of status code frequencies. Will show non-200 status codes if they happen.

Count Resources

The count-resources command is useful to see how many resources a FHIR server stores by resource type. The resource counting is done by first fetching the capability statement of the server. After that blazectl will perform a search-type interaction with query parameter _summary set to count on every resource type which supports that interaction using one batch request. Bundle.total will be used as resource count.

You can run:

blazectl --server http://localhost:8080 count-resources

It will return:

Count all resources on http://localhost:8080 ...

AllergyIntolerance       :    7297
CarePlan                 :   49818
Claim                    :  689111
Condition                :  116688
DiagnosticReport         :  193141
Encounter                :  540542
ExplanationOfBenefit     :  540542
Goal                     :   39857
ImagingStudy             :   11212
Immunization             :  187987
MedicationAdministration :    6400
MedicationRequest        :  148569
Observation              : 2689215
Organization             :   52645
Patient                  :   16875
Practitioner             :   52647
Procedure                :  418310

Similar Software

VonkLoader - can also upload transaction bundles but needs .NET SDK
Synthea Uploader - no parallel uploads

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

gmkanand/blazectl