Data processing

Field names (CIM)

One set of field names for every source, the ones security teams already know from Splunk.

In short
LogPulse uses the field names of the Splunk Common Information Model (CIM): src, dest, user, process, signature_id. When an event is stored, LogPulse adds the CIM name next to the older LogPulse name, such as process_path next to image. Both work in search and detections.

How it works

Where the CIM names are added
Parse
Parsed fieldsimage, command_line, src_ip
Store
Add CIM namesonly the ones missing
Eventimage and process_path
Use
Search and dashboards
Detections
  1. Parsed fields to Add CIM names
  2. Add CIM names to Event
  3. Event to Search and dashboards
  4. Event to Detections

The CIM names come from the public CIM documentation. A value a parser already set under the CIM name wins; LogPulse only fills names that are missing. That costs a few percent more storage per event and keeps every existing search and rule working.

CIM fields and aliases

The CIM field gets the value of the first LogPulse field in the list that has one.

CIM fieldFilled fromCIM data model
srcsrc_ip, src_host, src_hostname, client_ipNetwork Traffic, Authentication, Intrusion Detection, Web, Network Sessions
destdest_ip, dest_host, dest_hostname, hostnameNetwork Traffic, Authentication, Endpoint, Intrusion Detection, Web
dvcdevice, device_name, device_ip, devnameNetwork Traffic, Intrusion Detection, Change
src_interfaceinterfaceNetwork Traffic
src_zone / dest_zonesrc_interface / dest_interfaceNetwork Traffic
tcp_flagtcp_flagsNetwork Traffic
src_macmac, src_mac_address, calling_station_idNetwork Traffic, Authentication, Network Sessions
vendor_actionwaf_action, pan_action, fortinet_actionNetwork Traffic
rulerule_name, policy, policy_nameNetwork Traffic, Intrusion Detection
signature_idevent_code, event_id, EventCode, asa_msgid, ise_code, logid, alert_typeIntrusion Detection, Malware, Authentication, Endpoint
signaturealert_name, threat_name, rule_name, log_descriptionIntrusion Detection, Malware, Alerts
authentication_methodauth_type, auth_protocol, authentication_protocolAuthentication
reasonfailure_reasonAuthentication
src_usersubject_user, actor, event_user, senderAuthentication, Change, Email
processcommand_line, process_cmdlineEndpoint
process_pathimage, process_path_fullEndpoint
process_namefile name of process_path or imageEndpoint
process_execprocess_nameEndpoint
process_integrity_levelintegrity_levelEndpoint
process_current_directorycurrent_directoryEndpoint
parent_process_pathparent_image, parent_process (when it is a path)Endpoint
parent_process_namefile name of the parent pathEndpoint
parent_process_idparent_pidEndpoint
registry_value_dataregistry_data, registry_valueEndpoint
registry_key_namelast part of registry_pathEndpoint
file_namefile name of file_pathEndpoint
http_user_agentuser_agentWeb
http_referrerreferer, referrerWeb
sitevhost, host_headerWeb
reply_coderesponse_code, rcodeNetwork Resolution (DNS)
record_typequery_type, qtypeNetwork Resolution (DNS)
recipientrecipientsEmail

Fields that already have the same name in LogPulse and the CIM, such as user, action, src_port, dest_port and query, are not in the table.

Your own data

Sending data over the HTTP API, from Cribl or with your own parser rules? Use the CIM names straight away. The built-in rules and the Sigma rules search on them. The rules from the Detection Hub follow; until then they use the older names, which is why both stay on every event.

parent_process

Warning: In LogPulse parent_process holds the path of the parent; in the CIM it is the parent's command line. Use parent_process_path and parent_process_name, which mean the same in both. In a later step parent_process gets the CIM meaning.

Frequently asked questions

Does LogPulse use Splunk CIM field names?
Yes. The Splunk Common Information Model names are the field standard of LogPulse: src, dest, user, action, process, process_path, signature_id, http_user_agent and so on. Searches, dashboards and detections moved from Splunk find their fields.
Do my existing LogPulse searches still work?
Yes. The older LogPulse names, such as src_ip, image and command_line, stay on every event. LogPulse adds the CIM name next to them when an event is stored.
What happens when a parser already sets a CIM field?
The parser wins. LogPulse only adds a CIM name that is missing from the event.
Does old data get the CIM names?
No. The CIM names are added when an event is stored, so only events stored after the change have them. Search older data with the LogPulse names.