Installing and Configuring KeyMirror

Installing KeyMirror agents and monitoring in an estate comprises two essential stages and an optional stage:

1. Agent install: On each client machine, install a KeyMirror client agent (e.g. installation of keymirror.deb in Debian-based distributions)

2. Configure and License KeyMirror’s OpenTelemetry Collector Plugin: OpenTelemetry traffic from KeyMirror client agents is encrypted and OpenTelemetry collectors require a custom receiver to decrypt the traffic from KeyMirror client agents. Installing KeyMirror’s OTel receiver plugin allows this traffic to be decrypted when a valid license is applied.

3. Optional: install the KeyMirror Grafana App: For ease of use, we publish a Grafana plugin app which allows enhanced viewing, alerting, etc. of KeyMirror telemetry via Grafana.

Installing the KeyMirror Agent

KeyMirror client agent packages for your architecture can be downloaded from the KeyMirror client portal (https://portal.i2km.com). Transfer the package (e.g. keymirror.deb) to the target machine and install (e.g. with “sudo dpkg -i keymirror.deb). If further configuration changes are required (beyond the defaults configured in the client portal), edit the agent configuration file at /etc/keymirror/config.json and restart the agent.

Installing the OpenTelemetry receiver plugin

Download the OpenTelemetry receiver plugin from the KeyMirror client portal and follow the instructions on the portal to apply your license and then add the licensed receiver to your OpenTelemetry collector.