Skip to content

Commit

Permalink
Audit logs: missing status (#25906)
Browse files Browse the repository at this point in the history
- Add missing `status` for `installed_app_store_app`
- @noahtalerman: @iansltx and I tested the `installed_app_store_app`
activity and saw that the docs are missing `status`
- Clarify that `_software` activities are for Fleet-maintained apps and
custom packages
  • Loading branch information
noahtalerman authored Feb 3, 2025
1 parent dcc94cd commit f6b06a9
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 26 deletions.
27 changes: 14 additions & 13 deletions docs/Contributing/Audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -1178,7 +1178,7 @@ This activity contains the following fields:

## installed_software

Generated when a software is installed on a host.
Generated when a Fleet-maintained app or custom package is installed on a host.

This activity contains the following fields:
- "host_id": ID of the host.
Expand Down Expand Up @@ -1210,7 +1210,7 @@ This activity contains the following fields:

## uninstalled_software

Generated when a software is uninstalled on a host.
Generated when a Fleet-maintained app or custom package is uninstalled on a host.

This activity contains the following fields:
- "host_id": ID of the host.
Expand All @@ -1233,7 +1233,7 @@ This activity contains the following fields:

## added_software

Generated when a software installer is uploaded to Fleet.
Generated when a Fleet-maintained app or custom package is added to Fleet.

This activity contains the following fields:
- "software_title": Name of the software.
Expand Down Expand Up @@ -1270,7 +1270,7 @@ This activity contains the following fields:

## edited_software

Generated when a software installer is updated in Fleet.
Generated when a Fleet-maintained app or custom package is edited in Fleet.

This activity contains the following fields:
- "software_title": Name of the software.
Expand Down Expand Up @@ -1307,7 +1307,7 @@ This activity contains the following fields:

## deleted_software

Generated when a software installer is deleted from Fleet.
Generated when a Fleet maintained app or custom package is deleted from Fleet.

This activity contains the following fields:
- "software_title": Name of the software.
Expand Down Expand Up @@ -1449,14 +1449,15 @@ This activity contains the following fields:
Generated when an App Store app is installed on a device.

This activity contains the following fields:
- host_id: ID of the host on which the app was installed.
- self_service: App installation was initiated by device owner.
- host_display_name: Display name of the host.
- software_title: Name of the App Store app.
- app_store_id: ID of the app on the Apple App Store.
- command_uuid: UUID of the MDM command used to install the app.
- policy_id: ID of the policy whose failure triggered the install. Null if no associated policy.
- policy_name: Name of the policy whose failure triggered the install. Null if no associated policy.
- "host_id": ID of the host on which the app was installed.
- "self_service": App installation was initiated by device owner.
- "host_display_name": Display name of the host.
- "software_title": Name of the App Store app.
- "app_store_id": ID of the app on the Apple App Store.
- "status": Status of the App Store app installation.
- "command_uuid": UUID of the MDM command used to install the app.
- "policy_id": ID of the policy whose failure triggered the install. Null if no associated policy.
- "policy_name": Name of the policy whose failure triggered the install. Null if no associated policy.


#### Example
Expand Down
27 changes: 14 additions & 13 deletions server/fleet/activities.go
Original file line number Diff line number Diff line change
Expand Up @@ -1646,7 +1646,7 @@ func (a ActivityTypeInstalledSoftware) WasFromAutomation() bool {
}

func (a ActivityTypeInstalledSoftware) Documentation() (activity, details, detailsExample string) {
return `Generated when a software is installed on a host.`,
return `Generated when a Fleet-maintained app or custom package is installed on a host.`,
`This activity contains the following fields:
- "host_id": ID of the host.
- "host_display_name": Display name of the host.
Expand Down Expand Up @@ -1687,7 +1687,7 @@ func (a ActivityTypeUninstalledSoftware) HostIDs() []uint {
}

func (a ActivityTypeUninstalledSoftware) Documentation() (activity, details, detailsExample string) {
return `Generated when a software is uninstalled on a host.`,
return `Generated when a Fleet-maintained app or custom package is uninstalled on a host.`,
`This activity contains the following fields:
- "host_id": ID of the host.
- "host_display_name": Display name of the host.
Expand Down Expand Up @@ -1723,7 +1723,7 @@ func (a ActivityTypeAddedSoftware) ActivityName() string {
}

func (a ActivityTypeAddedSoftware) Documentation() (string, string, string) {
return `Generated when a software installer is uploaded to Fleet.`, `This activity contains the following fields:
return `Generated when a Fleet-maintained app or custom package is added to Fleet.`, `This activity contains the following fields:
- "software_title": Name of the software.
- "software_package": Filename of the installer.
- "team_name": Name of the team to which this software was added.` + " `null` " + `if it was added to no team." +
Expand Down Expand Up @@ -1767,7 +1767,7 @@ func (a ActivityTypeEditedSoftware) ActivityName() string {
}

func (a ActivityTypeEditedSoftware) Documentation() (string, string, string) {
return `Generated when a software installer is updated in Fleet.`, `This activity contains the following fields:
return `Generated when a Fleet-maintained app or custom package is edited in Fleet.`, `This activity contains the following fields:
- "software_title": Name of the software.
- "software_package": Filename of the installer as of this update (including if unchanged).
- "team_name": Name of the team on which this software was updated.` + " `null` " + `if it was updated on no team.
Expand Down Expand Up @@ -1810,7 +1810,7 @@ func (a ActivityTypeDeletedSoftware) ActivityName() string {
}

func (a ActivityTypeDeletedSoftware) Documentation() (string, string, string) {
return `Generated when a software installer is deleted from Fleet.`, `This activity contains the following fields:
return `Generated when a Fleet maintained app or custom package is deleted from Fleet.`, `This activity contains the following fields:
- "software_title": Name of the software.
- "software_package": Filename of the installer.
- "team_name": Name of the team to which this software was added.` + " `null` " + `if it was added to no team.
Expand Down Expand Up @@ -2061,14 +2061,15 @@ func (a ActivityInstalledAppStoreApp) WasFromAutomation() bool {

func (a ActivityInstalledAppStoreApp) Documentation() (string, string, string) {
return "Generated when an App Store app is installed on a device.", `This activity contains the following fields:
- host_id: ID of the host on which the app was installed.
- self_service: App installation was initiated by device owner.
- host_display_name: Display name of the host.
- software_title: Name of the App Store app.
- app_store_id: ID of the app on the Apple App Store.
- command_uuid: UUID of the MDM command used to install the app.
- policy_id: ID of the policy whose failure triggered the install. Null if no associated policy.
- policy_name: Name of the policy whose failure triggered the install. Null if no associated policy.
- "host_id": ID of the host on which the app was installed.
- "self_service": App installation was initiated by device owner.
- "host_display_name": Display name of the host.
- "software_title": Name of the App Store app.
- "app_store_id": ID of the app on the Apple App Store.
- "status": Status of the App Store app installation.
- "command_uuid": UUID of the MDM command used to install the app.
- "policy_id": ID of the policy whose failure triggered the install. Null if no associated policy.
- "policy_name": Name of the policy whose failure triggered the install. Null if no associated policy.
`, `{
"host_id": 42,
"self_service": true,
Expand Down

0 comments on commit f6b06a9

Please sign in to comment.