The common event format is an event exchange syntax. A sample message formatted as CEF looks as follows:
CEF:0|Splunk|Test|1.0|signature:2|Test event|5|src_addr=10.0.0.0 dest_addr=220.127.116.11 src_port=32122 dest_port=80
It consists of a common prefix that always has to be present, followed by a flexible key-value extension.
In order to parse CEF data correctly in Splunk, this add-on provides 2 transforms:
cefHeaders- use it to extract CEF headers
cefKeys- fixes multiword value extraction (by default Splunk would only extract key's values up to the first whitespace character)
This add-on also provides a
cefkv command, that should be used for extracting custom keys/value pairs from CEF data - usefull if you are dealing with Arcsight events.
CEF:0|Splunk|Test|1.0|signature:2|Test event|5|cs1=custom string value cs1Label=custom label
cefkv will extract following key/value pair from the sample message above:
custom_label="custom string value"
Installation in the Distributed Deployment
The add-on provides configurations that are used both at index time and at search time, so if you are installing the add-on in the distributed deployment you'll need to install it on the instances running the Parsing Pipeline (Heavy Forwarders or Indexers/Peers) and on the Search Heads.
See props.conf example supplied with the app
This add-on is partially based on "Common Event Format - Field Extractions" by raffy and "jsonutils" by vbumgarner
* Fixed timestamp extraction (thanks to EhudB for bringing the bug to my attention)
* Fixed typo in props.conf
Splunk's App Certification program uses a specific set of criteria to evaluate the level of quality, usability and security your app offers to its users. In addition, we evaluate the documentation and support you offer to your app's users.
As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 50GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps and add-ons from Splunk, our partners and our community. Find an app or add-on for most any data source and user need, or simply create your own with help from our developer portal.