Skip to content

Commit d0aace9

Browse files
authored
Clarify docs for entitlement filtering config keys (#783)
Hopefully addresses some of the ambiguity. Part of #782 Docs screenshots <img width="951" height="323" alt="image" src="https://github.com/user-attachments/assets/0ec38542-0b11-4e78-98e5-9fa5ae1654a8" /> <img width="1002" height="183" alt="image" src="https://github.com/user-attachments/assets/c2106ce0-3dfe-43fb-bf0e-14ec0ee3d89b" />
1 parent fa793fa commit d0aace9

2 files changed

Lines changed: 21 additions & 6 deletions

File tree

docs/docs/features/telemetry.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -386,8 +386,14 @@ Applies when using the `protobuf` or `json` log types.
386386
### Additional Options
387387

388388
- `EnableMachineIDDecoration`: Adds machine ID to filelog entries
389-
- `EntitlementsPrefixFilter`: Entitlement prefixes to exclude from logging
390-
- `EntitlementsTeamIDFilter`: Team IDs whose entitlements should not be logged
389+
- `EntitlementsPrefixFilter`: Entitlement prefixes to exclude from execution telemetry.
390+
Matching entitlements will be omitted from the logged event, but the execution event
391+
itself is still logged. Entitlements are only logged when `EventLogType` is set to
392+
`protobuf` or `json`.
393+
- `EntitlementsTeamIDFilter`: Team IDs whose process entitlements should be excluded from
394+
execution telemetry. Matching entitlements will be omitted from the logged event, but the
395+
execution event itself is still logged. Entitlements are only logged when `EventLogType`
396+
is set to `protobuf` or `json`.
391397

392398
## Example Configuration
393399

@@ -429,4 +435,4 @@ This configuration:
429435
- Monitors shell script changes in user directories
430436
- Excludes temporary directory changes
431437
- Adds machine ID to log entries
432-
- Filters out private Apple entitlements and platform binary entitlements
438+
- Omits private Apple entitlements and platform binary entitlements from execution events

docs/src/lib/santaconfig.ts

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -465,14 +465,23 @@ changes in the release notes of any future release that changes them.`,
465465
},
466466
{
467467
key: "EntitlementsPrefixFilter",
468-
description: `Entitlement prefixes that should not be logged (for example: \`com.apple.private\`).`,
468+
description: `Filters entitlements from execution telemetry based on prefix (for example:
469+
\`com.apple.private\`). Entitlements matching a prefix in this list will be omitted
470+
from the logged event. This does not prevent the execution event itself from being
471+
logged - it only controls which entitlements are included in the event. Entitlements
472+
are only logged when \`EventLogType\` is set to \`protobuf\` or \`json\`.`,
469473
type: "string",
470474
repeated: true,
471475
},
472476
{
473477
key: "EntitlementsTeamIDFilter",
474-
description: `Entitlements from processes with a matching TeamID in the code signature
475-
will not be logged. Use the value \`platform\` to filter entitlements from platform binaries.`,
478+
description: `Filters entitlements from execution telemetry based on the process's
479+
TeamID. When a process's code signature has a TeamID matching an entry in this list,
480+
its entitlements will be omitted from the logged event. This does not prevent the
481+
execution event itself from being logged - it only controls which entitlements are
482+
included in the event. Entitlements are only logged when \`EventLogType\` is set to
483+
\`protobuf\` or \`json\`. Use the value \`platform\` to filter entitlements from
484+
platform binaries.`,
476485
type: "string",
477486
repeated: true,
478487
},

0 commit comments

Comments
 (0)