Collect logs from Google Santa with Elastic Agent.
What is an Elastic integration?
This integration is powered by Elastic Agent. Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to our documentation for a detailed comparison between Beats and Elastic Agent.
Prefer to use Beats for this use case? See Filebeat modules for logs or Metricbeat modules for metrics.
See the integrations quick start guides to get started:
The Google Santa integration collects and parses logs from Google Santa, a security tool for macOS that monitors process executions and can blacklist/whitelist binaries.
The Google Santa integration was tested with logs from Santa 2022.4.
Google Santa is available for MacOS only.
The integration is by default configured to read logs from /var/db/santa/santa.log.
This is the Google Santa log dataset.
An example event for log looks as following:
{
"@timestamp": "2022-05-12T11:30:05.248Z",
"agent": {
"ephemeral_id": "ea9b3ab9-896a-456a-8e87-7a6452edad19",
"id": "2c596a05-d358-406e-924c-bf221088f43c",
"name": "docker-fleet-agent",
"type": "filebeat",
"version": "8.2.1"
},
"data_stream": {
"dataset": "santa.log",
"namespace": "ep",
"type": "logs"
},
"ecs": {
"version": "8.7.0"
},
"elastic_agent": {
"id": "2c596a05-d358-406e-924c-bf221088f43c",
"snapshot": true,
"version": "8.2.1"
},
"event": {
"action": "link",
"agent_id_status": "verified",
"dataset": "santa.log",
"ingested": "2022-05-18T03:34:40Z",
"kind": "event"
},
"file": {
"path": "/private/var/db/santa/santa.log",
"target_path": "/private/var/db/santa/santa.log.0"
},
"group": {
"id": "0",
"name": "wheel"
},
"host": {
"architecture": "x86_64",
"containerized": false,
"hostname": "docker-fleet-agent",
"ip": [
"192.168.160.7"
],
"mac": [
"02:42:c0:a8:a0:07"
],
"name": "docker-fleet-agent",
"os": {
"codename": "focal",
"family": "debian",
"kernel": "5.10.104-linuxkit",
"name": "Ubuntu",
"platform": "ubuntu",
"type": "linux",
"version": "20.04.4 LTS (Focal Fossa)"
}
},
"input": {
"type": "log"
},
"log": {
"file": {
"path": "/tmp/service_logs/santa.log"
},
"level": "I",
"offset": 1150
},
"process": {
"args": [
"/usr/sbin/newsyslog"
],
"entity_id": "2c596a05-d358-406e-924c-bf221088f43c-71559-1096716",
"executable": "/usr/sbin/newsyslog",
"name": "newsyslog",
"parent": {
"pid": 1
},
"pid": 71559,
"start": "2022-05-12T11:30:05.248Z"
},
"related": {
"user": [
"root"
]
},
"santa": {
"action": "LINK",
"pidversion": 1096716
},
"tags": [
"santa-log"
],
"user": {
"id": "0",
"name": "root"
}
}Exported fields
| Field | Description | Type |
|---|---|---|
@timestamp | Event timestamp. | date |
agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword |
cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword |
cloud.availability_zone | Availability zone in which this host is running. | keyword |
cloud.image.id | Image ID for the cloud instance. | keyword |
cloud.instance.id | Instance ID of the host machine. | keyword |
cloud.instance.name | Instance name of the host machine. | keyword |
cloud.machine.type | Machine type of the host machine. | keyword |
cloud.project.id | Name of the project in Google Cloud. | keyword |
cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword |
cloud.region | Region in which this host is running. | keyword |
container.id | Unique container id. | keyword |
container.image.name | Name of the image the container was built on. | keyword |
container.labels | Image labels. | object |
container.name | Container name. | keyword |
data_stream.dataset | Data stream dataset. | constant_keyword |
data_stream.namespace | Data stream namespace. | constant_keyword |
data_stream.type | Data stream type. | constant_keyword |
ecs.version | ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword |
event.dataset | Event dataset | constant_keyword |
event.ingested | Timestamp when an event arrived in the central data store. This is different from @timestamp, which is when the event originally occurred. It's also different from event.created, which is meant to capture the first time an agent saw the event. In normal conditions, assuming no tampering, the timestamps should chronologically look like this: @timestamp < event.created < event.ingested. | date |
event.module | Event module | constant_keyword |
file.path | Full path to the file, including the file name. It should include the drive letter, when appropriate. | keyword |
file.path.text | Multi-field of file.path. | match_only_text |
file.target_path | Target path for symlinks. | keyword |
file.target_path.text | Multi-field of file.target_path. | match_only_text |
file.x509.issuer.common_name | List of common name (CN) of issuing certificate authority. | keyword |
group.id | Unique identifier for the group on the system/platform. | keyword |
group.name | Name of the group. | keyword |
host.architecture | Operating system architecture. | keyword |
host.containerized | If the host is a container. | boolean |
host.domain | Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider. | keyword |
host.hostname | Hostname of the host. It normally contains what the hostname command returns on the host machine. | keyword |
host.id | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of beat.name. | keyword |
host.ip | Host ip addresses. | ip |
host.mac | Host mac addresses. | keyword |
host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. | keyword |
host.os.build | OS build information. | keyword |
host.os.codename | OS codename, if any. | keyword |
host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword |
host.os.kernel | Operating system kernel version as a raw string. | keyword |
host.os.name | Operating system name, without the version. | keyword |
host.os.name.text | Multi-field of host.os.name. | text |
host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword |
host.os.version | Operating system version as a raw string. | keyword |
host.type | Type of host. For Cloud providers this can be the machine type like t2.medium. If vm, this could be the container, for example, or other information meaningful in your environment. | keyword |
input.type | Input type | keyword |
log.file.path | Full path to the log file this event came from, including the file name. It should include the drive letter, when appropriate. If the event wasn't read from a log file, do not populate this field. | keyword |
log.level | Original log level of the log event. If the source of the event provides a log level or textual severity, this is the one that goes in log.level. If your source doesn't specify one, you may put your event transport's severity here (e.g. Syslog severity). Some examples are warn, err, i, informational. | keyword |
log.offset | Log offset | long |
process.args | Array of process arguments, starting with the absolute path to the executable. May be filtered to protect sensitive information. | keyword |
process.entity_id | Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. Constructing a globally unique identifier is a common practice to mitigate PID reuse as well as to identify a specific process over time, across multiple monitored hosts. | keyword |
process.executable | Absolute path to the process executable. | keyword |
process.executable.text | Multi-field of process.executable. | match_only_text |
process.hash.sha256 | SHA256 hash. | keyword |
process.name | Process name. Sometimes called program name or similar. | keyword |
process.name.text | Multi-field of process.name. | match_only_text |
process.parent.pid | Process id. | long |
process.pid | Process id. | long |
process.start | The time the process started. | date |
related.hash | All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you're unsure what the hash algorithm is (and therefore which key name to search). | keyword |
related.user | All the user names or other user identifiers seen on the event. | keyword |
santa.action | Action | keyword |
santa.certificate.common_name | Common name from code signing certificate. | keyword |
santa.certificate.sha256 | SHA256 hash of code signing certificate. | keyword |
santa.decision | Decision that santad took. | keyword |
santa.disk.appearance | Timestamp for volume operation. | date |
santa.disk.bsdname | The disk BSD name. | keyword |
santa.disk.bus | The disk bus protocol. | keyword |
santa.disk.fs | The disk volume kind (filesystem type). | keyword |
santa.disk.model | The disk model. | keyword |
santa.disk.mount | The disk volume path. | keyword |
santa.disk.serial | The disk serial number. | keyword |
santa.disk.volume | The volume name. | keyword |
santa.explain | Further details for the decision. | keyword |
santa.mode | Operating mode of Santa. | keyword |
santa.pidversion | macOS process identity version. | long |
santa.reason | Reason for the decision. | keyword |
tags | List of keywords used to tag each event. | keyword |
user.id | Unique identifier of the user. | keyword |
user.name | Short name or login of the user. | keyword |
user.name.text | Multi-field of user.name. | match_only_text |
| Version | Details |
|---|---|
3.6.0 | Enhancement View pull request Update package to ECS 8.7.0. |
3.5.1 | Enhancement View pull request Added categories and/or subcategories. |
3.5.0 | Enhancement View pull request Update package to ECS 8.6.0. |
3.4.1 | Enhancement View pull request Migrate the visualizations to by value in dashboards to minimize the saved object clutter and reduce time to load |
3.4.0 | Enhancement View pull request Update package to ECS 8.5.0. |
3.3.0 | Enhancement View pull request Update package to ECS 8.4.0 |
3.2.1 | Enhancement View pull request Update package name and description to align with standard wording |
3.2.0 | Enhancement View pull request Update package to ECS 8.3.0. |
3.1.0 | Enhancement View pull request Add process.entity_id field. |
3.0.0 | Enhancement View pull request Update log format to support the GA releases of Santa. The pre-GA Santa log format (circa 2017) is no longer accepted. |
2.1.0 | Enhancement View pull request Update to ECS 8.2 |
2.0.1 | Enhancement View pull request Add documentation for multi-fields |
2.0.0 | Enhancement View pull request Update to ECS 8.0 Enhancement View pull request process.ppid replaced with process.parent.pid (breaking change) |
1.1.0 | Enhancement View pull request Add 8.0.0 version constraint |
1.0.3 | Enhancement View pull request Uniform with guidelines |
1.0.2 | Enhancement View pull request Update Title and Description. |
1.0.1 | Bug fix View pull request Fix logic that checks for the 'forwarded' tag |
1.0.0 | Enhancement View pull request make GA |
0.4.0 | Enhancement View pull request Update to ECS 1.12.0 |
0.3.2 | Enhancement View pull request Convert to generated ECS fields |
0.3.1 | Enhancement View pull request update to ECS 1.11.0 |
0.3.0 | Enhancement View pull request Update integration description |
0.2.0 | Enhancement View pull request Set "event.module" and "event.dataset" |
0.1.0 | Enhancement View pull request update to ECS 1.10.0 and adding event.original options |
0.0.3 | Enhancement View pull request update to ECS 1.9.0 |
0.0.2 | Enhancement View pull request Fix compatibility with Kibana |
0.0.1 | Enhancement View pull request initial release |