On this page:
   35.39    FHIR Performance 35.41    FHIR Storage Scheduled Tasks   

35.40FHIR Performance Tracing

 

The FHIR Performance Tracing configuration category includes the following configurable options:

  • Capture Raw SQL or Equivalent

  • Trigger

  • Performance Tracing Enabled

  • Output to Response Headers

  • Output to System Log

  • Output to Transaction Log

35.40.1Property: Capture Raw SQL or Equivalent

 
Property Name Capture Raw SQL or Equivalent
Property Key
Property Type BOOLEAN
Description If this is enabled, the raw SQL commands issued to the database will be captured. In the case of non-SQL storage modules (e.g. MongoDB) the raw queries will be captured instead. Note that this can have a measurable impact on performance so this should be enabled only to troubleshoot specific issues.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value true
Example Property
module.[MODULE_ID].config.performance_tracing.capture.raw_sql = true

35.40.2Property: Trigger

 
Property Name Trigger
Property Key
Property Type ENUM
Values
  • ALL_REQUESTS
  • ON_DEMAND
Description Adjust this setting to determine which transactions are traced.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value ALL_REQUESTS
Example Property
module.[MODULE_ID].config.performance_tracing.capture.trigger = ALL_REQUESTS

35.40.3Property: Performance Tracing Enabled

 
Property Name Performance Tracing Enabled
Property Key
Property Type BOOLEAN
Description Enable this setting in order to enable detailed performance tracing. Note that this feature has an impact on performance itself, so it should be enabled with caution on production systems. The other settings in this category will have no effect if this is not enabled. See Performance Tracing for more information. If this setting is disabled, all other performance tracing settings will be ignored.
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.performance_tracing.enabled = false

35.40.4Property: Output to Response Headers

 
Property Name Output to Response Headers
Property Key
Property Type BOOLEAN
Description Should performance tracing logs be appended to the HTTP response headers?
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value true
Example Property
module.[MODULE_ID].config.performance_tracing.output.response_headers = true

35.40.5Property: Output to System Log

 
Property Name Output to System Log
Property Key
Property Type BOOLEAN
Description Should performance tracing logs be appended to the System Logs?
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value false
Example Property
module.[MODULE_ID].config.performance_tracing.output.system_log = false

35.40.6Property: Output to Transaction Log

 
Property Name Output to Transaction Log
Property Key
Property Type BOOLEAN
Description Should performance tracing messages be appended to the Transaction Log?
Applies to Modules
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
Default Value true
Example Property
module.[MODULE_ID].config.performance_tracing.output.transaction_log = true
   35.39    FHIR Performance 35.41    FHIR Storage Scheduled Tasks