Update Santa tables (#35055)

- @noahtalerman: We decided to cut the `santa_rules` table and tweak
descriptions: https://github.com/fleetdm/fleet/pull/33825
  - Looks like these doc changes got added back to `main` by accident
This commit is contained in:
Noah Talerman 2025-10-31 14:26:47 -04:00 committed by GitHub
parent 0cdde239b9
commit dbf8697cdb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 12 additions and 68 deletions

View file

@ -24376,12 +24376,13 @@
},
{
"name": "santa_allowed",
"description": "List of applications Santa has allowed to run on the host.",
"description": "Logs events for when Santa allowed applications to run on the host. Fleet's agent (fleetd) only stores the most recent 10,000 allowed events.",
"platforms": [
"darwin"
],
"evented": false,
"examples": "Show Google Chrome open events, as allowed by Santa.\n\n```\nSELECT * FROM santa_allowed WHERE application = '/Applications/Google Chrome.app';\n```",
"notes": "- Fleetd only stores the most recent 10,000 allowed events to avoid hitting [osquery watchdog limits](https://fleetdm.com/guides/osquery-watchdog).\n- If you're running this query as a scheduled query, use the `differential_ignore_removals` to avoid hitting osquery watchdog limits",
"columns": [
{
"name": "timestamp",
@ -24413,12 +24414,13 @@
},
{
"name": "santa_denied",
"description": "List of applications Santa has denied from running on the host.",
"description": "Logs events for when Santa denied applications from running on the host. Fleet's agent (fleetd) only stores the most recent 10,000 denied events.",
"platforms": [
"darwin"
],
"evented": false,
"examples": "Collect all Santa denied logs from macOS hosts.\n```\nSELECT * FROM santa_denied;\n```",
"notes": "- Fleetd only stores the most recent 10,000 denied events to avoid hitting [osquery watchdog limits](https://fleetdm.com/guides/osquery-watchdog).\n- If you're running this query as a scheduled query, use the `differential_ignore_removals` to avoid hitting osquery watchdog limits",
"columns": [
{
"name": "timestamp",
@ -24448,43 +24450,6 @@
"url": "https://fleetdm.com/tables/santa_denied",
"fleetRepoUrl": "https://github.com/fleetdm/fleet/blob/main/schema/tables/santa_denied.yml"
},
{
"name": "santa_rules",
"description": "The [Santa](https://github.com/google/santa) rules that are currently installed on a macOS host.",
"platforms": [
"darwin"
],
"evented": false,
"examples": "Verify that running WhatsApp will be denied (blocked) by Santa via WhatsApp's Team ID.\n```\nSELECT state FROM santa_rules WHERE identifier = '57T9237FN3';\n```",
"columns": [
{
"name": "identifier",
"description": "Rule identifier (SHA256, Team ID, etc.",
"required": false,
"type": "text"
},
{
"name": "type",
"description": "Type of rule (Binary, Certificate, TeamID)",
"required": false,
"type": "text"
},
{
"name": "state",
"description": "Rule state (Allowlist, Denylist)",
"required": false,
"type": "text"
},
{
"name": "custom_message",
"description": "Custom message associated with the rule",
"required": false,
"type": "text"
}
],
"url": "https://fleetdm.com/tables/santa_rules",
"fleetRepoUrl": "https://github.com/fleetdm/fleet/blob/main/schema/tables/santa_rules.yml"
},
{
"name": "santa_status",
"description": "The output of `santactl status --json` showing current Santa statistics and configuration.",

View file

@ -1,5 +1,5 @@
name: santa_allowed
description: List of applications Santa has allowed to run on the host.
description: "Logs events for when Santa allowed applications to run on the host. Fleet's agent (fleetd) only stores the most recent 10,000 allowed events."
platforms:
- darwin
evented: false
@ -9,6 +9,9 @@ examples: |-
```
SELECT * FROM santa_allowed WHERE application = '/Applications/Google Chrome.app';
```
notes: |-
- Fleetd only stores the most recent 10,000 allowed events to avoid hitting [osquery watchdog limits](https://fleetdm.com/guides/osquery-watchdog).
- If you're running this query as a scheduled query, use the `differential_ignore_removals` to avoid hitting osquery watchdog limits
columns:
- name: timestamp
description: Timestamp of the decision

View file

@ -1,5 +1,5 @@
name: santa_denied
description: List of applications Santa has denied from running on the host.
description: Logs events for when Santa denied applications from running on the host. Fleet's agent (fleetd) only stores the most recent 10,000 denied events.
platforms:
- darwin
evented: false
@ -8,6 +8,9 @@ examples: |-
```
SELECT * FROM santa_denied;
```
notes: |-
- Fleetd only stores the most recent 10,000 denied events to avoid hitting [osquery watchdog limits](https://fleetdm.com/guides/osquery-watchdog).
- If you're running this query as a scheduled query, use the `differential_ignore_removals` to avoid hitting osquery watchdog limits
columns:
- name: timestamp
description: Timestamp of the decision

View file

@ -1,27 +0,0 @@
name: santa_rules
description: The [Santa](https://github.com/google/santa) rules that are currently installed on a macOS host.
platforms:
- darwin
evented: false
examples: |-
Verify that running WhatsApp will be denied (blocked) by Santa via WhatsApp's Team ID.
```
SELECT state FROM santa_rules WHERE identifier = '57T9237FN3';
```
columns:
- name: identifier
description: Rule identifier (SHA256, Team ID, etc.
required: false
type: text
- name: type
description: Type of rule (Binary, Certificate, TeamID)
required: false
type: text
- name: state
description: Rule state (Allowlist, Denylist)
required: false
type: text
- name: custom_message
description: Custom message associated with the rule
required: false
type: text