Once a KeyMirror client agent has been installed and configured, integrating it with HSM application is a single-step operation. Following configuration as below, the client agent will gather metadata from the application at runtime, process it and transfer to your Open- Telemetry collector.
BPF mode configuration
In BPF mode, edit /etc/keymirror/config.json to reflect the application/library path(s) you wish to monitor, followed by restarting the KeyMirror client agent.
For example, to instrument libcs_pkcs11, the configuration file would be edited to contain:
“files_to_hook“: [“/opt/utimaco/lib/libcs_pkcs11_R3.so“]
Shim mode configuration
In shim mode, launch your application with the environment variable:
LD_PRELOAD=/usr/local/lib/liblshim.so
Viewing the Metrics and Tracing
After this has been carried out, the KeyMirror client agent will collect metadata from your application/library at run time, process it, then transfer it to the configured OpenTelemetry receiver. The resulting traces and metrics can then be viewed in Grafana, Datadog etc. For ease of use, we provide a Grafana plugin application, along with example Grafana dashboard files, highlighting the main metrics and tracing behavior.