docs: Add page about session recording audit events (#3430)

* docs: Add page about session recording audit events

Add some of the event field types that are emitted by session recording actions. There are lot of fields so this just focuses on some of the important fields for users to know what to expect

---------

Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
This commit is contained in:
Elim TsiagbeyandDan Heath authored and GitHub committed 2023-07-17 12:53:50 -04:00
1 parent 6afd2c96a5
commit 1822dc8e4f
2 files changed
+26 -1

No files matched your search

@@ -45,6 +45,31 @@ A controller retrieves the contents of a recording from a worker with access to
The controller decodes the contents of the recording into a format that is usable by the player.
The player then retrieves the data from the controller.
### Session recording audit events
Boundary emits audit events for actions performed by users. Here are **some** of the possible event field types that are emitted:
- `timestamp` - The timestamp of the event
- `auth` - Authentication information about the user who performed the action.
- `response.details.item.connection_recordings.`
- `id` - Session recording ID.
- `channel_recordings.id` - Session recording channel ID.
- `start_time.seconds` - Start time of session recording.
- `end_time.seconds` - End time of session recording.
- `bytes_up` - Upload bytes during session.
- `bytes_down` - Download bytes during session.
- `channel_recordings.duration.seconds`- Length of time a session took, recorded in seconds.
- `request_info.client_ip` - The client IP address used by the user.
- `response.details.item.create_time_values.`
- `target.name` - The name of the targets.
- `target.id` - The ID of the target accessed during the recording.
- `target.type` - The type of protocol used.
- `target.scope.name` - Name of the scope the target accessed belongs to.
- `target.scope.parent_scope_id` - Parent ID of the scope the target accessed belongs to.
- `response.details.item.Attrs.SshTargetAttributes.`
- `storage_bucket_id.value` - Storage bucket ID attached to a target that is used for storing session recordings.
- `enable_session_recording.value` - Determines if session recording is enabled on a target.
## Storage buckets
A resource known as a [storage bucket](/boundary/docs/concepts/domain-model/storage-buckets) is used to store the recorded sessions.
+1 -1
View File
@@ -666,4 +666,4 @@
}
]
}
]
]