Outputting Matches to downstream receivers
Configure Match output via Stream, syslog, Kafka, and Recall.
Match Syslog or Kafka Log Output (QUX only)
Matches identified by the engine are emitted using syslog or Kafka. Navigate in your Brain UI to Configuration → RESPONSE → Notifications → Syslog or Kafka to configure either. Vectra has also updated our Splunk Add-on and App for Detect to support parsing of Match log output and created a new Vectra Match dashboard. The following KB articles on the Vectra support site provide some additional guidance:
In our sample deployment, we are using a Splunk instance and have set up Syslog to send in JSON format:
If you are already using Syslog or Kafka to output log data from your Brain, you may only need to modify the settings to include the new Vectra Match log type in addition to any other log types you may have previously configured.
The Include enhanced detail checkbox impacts both the syslog producer header and whether additional Vectra proprietary data is included in the log messages sent downstream.
Syslog producer header
Include enhanced detail checked – header is
vectra_json_vectra_match_v2Include enhanced detail unchecked – header is
vectra_json_vectra_match
Vectra proprietary data
When the Include enhanced detail checkbox is checked an additional field called
vectrais included that allows analysts to see HostID information and Sensor (device) information related to the Match that occurred. This will make it easier for analysts to understand which Sensor observed the traffic where the Match occurred and track the originating and responding host by its Vectra Host object. Vectra HostID is a proprietary process that takes into account network artifacts and other learned information to name hosts and track them more easily by this name rather than IP address which is often transient.For additional detail on HostID, please see: Understanding Vectra Host Naming
Example added data is below:
Below is how a raw message will appear in Splunk (screenshot does not include the additional Vectra field):
After the syslog producer header with the date, you can see that the data is in the same format output natively from Suricata.
Match Stream Output to Data Lake or SIEM (RUX and QUX)
To output Matches, using Stream is required for Respond UX deployments and optional for Quadrant UX deployments. For overall Stream deployment, please see the Stream Deployment Guide. Field descriptions are available in Vectra AI platform network metadata. To output Matches, ensure that your Stream configuration is set to output them in Configuration → COVERAGE → Stream → Metadata Types as seen in the screenshot below:
If you’re already using Stream with RAW JSON as the publisher, be sure to also update your Stream config with the desired port for Match metadata. All other Stream configuration is as described in the Stream Deployment Guide.
Using Match with Vectra Recall (QUX only)
Vectra Match supports metadata output to Vectra Recall for Quadrant UX deployments. This includes all log fields output by Match. If you are a Vectra Recall customer this metadata will automatically be sent to Recall and included as a new metadata_match* category for use in Recall.
Last updated
Was this helpful?