This device provides an easy way to track HL7v2 message properties and visualize these via Prometheus and Grafana.
By default, Connexion includes some HL7v2 information as part of built-in metrics. For example, the connexion_queue_message_count metric provides queue-level message counts which include the message type. If your channel is processing HL7v2 messages, then the exposed metric includes the value from MSH-9.
If you wish to create metrics based on other HL7v2 fields, then you can utilize the HL7 Metrics Device, or, use a custom code device (refer to the metrics tutorials).
Let’s look at a simple scenario where you wish to track the Sending Facility values.
Position of this device within the channel is important, as metrics are calculated when the message passes through the device. For example, if you wish to accurately track the time a message is received, the device should go before the first queue. If you with to track updated message values, the device should be placed after any transforms.
In this example, we’re going to track the distribution of messages by MSH-4 (Sending Facility) and create both pie and line charts. Let’s assume the following channel, which receives messages over a network.
We want our device to track the value from MSH-4 (sending facility). To do this, add a new line item by clicking the Add Metric button:
Next, double-click in the Name column and enter SendingFacility. This is the label used in Prometheus/Grafana. Next, enter the HL7 path into the Expression column.
Ensure the HL7v2 metric is enabled, and run some messages through the test channel.
You should be able to visit Grafana and create the following visualizations: