Skip to content

Documentation 2.0.0.0‐RC1

Jan Böhringer edited this page Mar 21, 2025 · 4 revisions

Documentation for ping-pong process version 2.0.0.0-RC1

Changes to previous versions can be found in the release notes.

Configuration

Input Parameters

download-resource-size-bytes

  • Specifies the size of the resource to be generated to make download tests with
  • Maximum value is 100.000.000 bytes or 100MB
  • Leave empty to default to 10MB

target-endpoints

  • FHIR search expression to retrieve a list of endpoints to ping. Below is an example of getting all Endpoint resources that belong to an organization with identifier 'test.identifier.org':
    Endpoint?status=active&organization:identifier=http://dsf.dev/sid/organization-identifier|test.identifier.org
  • Leave empty to ping all active endpoints

Environment Variables

DEV_DSF_BPE_PING_MAXDOWNLOADSIZEBYTES

  • Property: dev.dsf.bpe.ping.maxDownloadSizeBytes
  • Required: No
  • Processes: dsfdev_ping, dsfdev_pong
  • Description: Sets the download limit on resource downloads, essentially limiting the amount of data downloaded from other ping instances. Setting this to a negative value will disable resource downloads, effectively resulting in running the slim ("old") ping process.
  • Default: 10000000

DEV_DSF_BPE_PING_MAXUPLOADSIZEBYTES

  • Property: dev.dsf.bpe.ping.maxUploadSizeBytes
  • Required: No
  • Processes: dsfdev_ping, dsfdev_pong
  • Description: Sets the upload limit on resource uploads, essentially limiting the amount of data other ping instances are able to download from this instance.
  • Default: 10000000

DEV_DSF_BPE_PING_NETWORKSPEEDUNIT

  • Property: dev.dsf.bpe.ping.networkSpeedUnit
  • Required: No
  • Processes: dsfdev_ping, dsfdev_pong
  • Description: Unit to display upload and download speeds in. Eligible values be: "bits-per-second", "bytes-per-second", "megabits-per-second", "megabytes-per-second". Default is "megabytes-per-second".
  • Default: megabytes-per-second

DEV_DSF_DSF_BPE_PING_MAIL_ONPINGPROCESSFAILED

  • Property: dev.dsf.dsf.bpe.ping.mail.onPingProcessFailed
  • Required: No
  • Processes: dsfdev_ping
  • Description: To enable a mail being sent if the ping process fails, set to 'true'. This requires the SMPT mail service client to be configured in the DSF
  • Default: false

DEV_DSF_DSF_BPE_PING_MAIL_ONPONGPROCESSFAILED

  • Property: dev.dsf.dsf.bpe.ping.mail.onPongProcessFailed
  • Required: No
  • Processes: dsfdev_pong
  • Description: To enable a mail being sent if the pong process fails, set to 'true'. This requires the SMPT mail service client to be configured in the DSF
  • Default: false