-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Logs restructure and new filtering docs #29199
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
cloudflare-noelle
wants to merge
4
commits into
cloudflare:production
from
cloudflare-noelle:logs-restructure-docs
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
5d7b6e6
Restructure Zero Trust logs documentation
cloudflare-noelle 6c71c16
Add new log viewer UI documentation for Access and Gateway logs
cloudflare-noelle f79d6ad
Address PR feedback: remove navigation instructions from dashboard-lo…
cloudflare-noelle e84b90c
Address PR feedback: improve log viewer documentation
cloudflare-noelle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
...ontent/docs/cloudflare-one/insights/logs/dashboard-logs/admin-activity-logs.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| pcx_content_type: reference | ||
| title: Admin activity logs | ||
| sidebar: | ||
| order: 1 | ||
| description: Monitor when a member on your account creates, updates, or deletes configurations. | ||
| --- | ||
|
|
||
| Admin activity logs record configuration changes made by members of your Cloudflare account. Use these logs to monitor when a member creates, updates, or deletes configurations in your Zero Trust organization. | ||
|
|
||
| To view admin activity logs, log in to [Cloudflare One](https://one.dash.cloudflare.com/) and go to **Insights** > **Logs** > **Admin activity logs**. | ||
|
|
||
| ## Explanation of the fields | ||
|
|
||
| | Field | Description | | ||
| | --------------------- | ------------------------------------------------------------------ | | ||
| | **Action timestamp** | Date and time when the change occurred. | | ||
| | **Action type** | Type of action taken (for example, `create`, `update`, `delete`). | | ||
| | **Action result** | Whether the action was successful. | | ||
| | **Actor email** | Email address of the user who performed the action. | | ||
| | **Actor IP address** | IP address of the user who performed the action. | | ||
| | **Actor type** | Type of user that initiated the action. | | ||
| | **Resource type** | The type of resource that was changed. | | ||
| | **Resource product** | The Cloudflare product associated with the resource. | | ||
|
|
||
| ## Export admin activity logs | ||
|
|
||
| Enterprise users can export admin activity logs using [Logpush](/cloudflare-one/insights/logs/logpush/). For a list of all available fields, refer to [Audit Logs V2](/logs/logpush/logpush-job/datasets/account/audit_logs_v2/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
src/content/docs/cloudflare-one/insights/logs/dashboard-logs/index.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| pcx_content_type: navigation | ||
| title: Dashboard logs | ||
| sidebar: | ||
| order: 1 | ||
| head: | ||
| - tag: title | ||
| content: Zero Trust dashboard logs | ||
| --- | ||
|
|
||
| import { DirectoryListing } from "~/components"; | ||
|
|
||
| The following logs are available in the [Zero Trust dashboard](https://one.dash.cloudflare.com/). | ||
|
|
||
| <DirectoryListing /> | ||
|
|
||
| For additional datasets and long-term log storage, refer to [Logpush](/cloudflare-one/insights/logs/logpush/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
src/content/docs/cloudflare-one/insights/logs/dashboard-logs/ssh-command-logs.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| pcx_content_type: reference | ||
| title: SSH command logs | ||
| sidebar: | ||
| order: 6 | ||
| description: Review SSH commands a user ran on a target. | ||
| --- | ||
|
|
||
| SSH command logs record the commands that users run on infrastructure targets protected by [Access for Infrastructure](/cloudflare-one/networks/connectors/cloudflare-tunnel/use-cases/ssh/ssh-infrastructure-access/). Use these logs to audit user activity on your SSH servers. | ||
|
|
||
| To view SSH command logs, log in to [Cloudflare One](https://one.dash.cloudflare.com/) and go to **Insights** > **Logs** > **SSH command logs**. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To generate SSH command logs, you must: | ||
|
|
||
| 1. Set up [Access for Infrastructure](/cloudflare-one/networks/connectors/cloudflare-tunnel/use-cases/ssh/ssh-infrastructure-access/) for your SSH servers. | ||
| 2. [Enable SSH command logging](/cloudflare-one/networks/connectors/cloudflare-tunnel/use-cases/ssh/ssh-infrastructure-access/#ssh-command-logs) by uploading an encryption public key. | ||
|
|
||
| ## View SSH logs | ||
|
|
||
| SSH command logs displayed in the dashboard are encrypted using a public key you provide. To view the contents of the logs: | ||
|
|
||
| 1. In [Cloudflare One](https://one.dash.cloudflare.com/), go to **Insights** > **Logs** > **SSH command logs**. | ||
| 2. Filter the logs using the name of your SSH application. | ||
| 3. Select the SSH session for which you want to export command logs. | ||
| 4. In the side panel, scroll down to **SSH logs** and select **Download**. | ||
| 5. Decrypt the log using the [SSH Logging CLI](https://github.com/cloudflare/ssh-log-cli/). | ||
|
|
||
| ## Explanation of the fields | ||
|
|
||
| | Field | Description | | ||
| | -------------------------- | ----------------------------------------------------------------------------------------------- | | ||
| | **Session ID** | Unique identifier for the SSH session. | | ||
| | **User email** | Email address of the user who initiated the SSH session. | | ||
| | **Target ID** | Identifier of the infrastructure target being accessed. | | ||
| | **Client address** | Source IP address of the SSH connection. | | ||
| | **Server address** | Destination IP address of the SSH server. | | ||
| | **Session start datetime** | Timestamp when the SSH session started. | | ||
| | **Session finish datetime**| Timestamp when the SSH session ended. | | ||
| | **Program type** | Type of SSH program (`shell`, `exec`, `x11`, `direct-tcpip`, or `forwarded-tcpip`). | | ||
| | **Payload** | Captured request/response data in asciicast v2 format, including commands for `exec` programs. | | ||
| | **Error** | SSH error message, if an error occurred. | | ||
|
|
||
| ## Export SSH logs with Logpush | ||
|
|
||
| Enterprise users can export SSH command logs using [Logpush](/cloudflare-one/insights/logs/logpush/). Logpush payloads are not encrypted with a customer-provided public key. | ||
|
|
||
| For a list of all available fields, refer to [SSH Logs](/logs/logpush/logpush-job/datasets/account/ssh_logs/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...udflare-one/insights/logs/enable-logs.mdx → ...ghts/logs/logpush/email-security-logs.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 8 additions & 4 deletions
12
...ne/insights/logs/use-logpush-with-ids.mdx → ...re-one/insights/logs/logpush/ids-logs.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Recommend starting page with an introductory paragraph instead of a header. Perhaps expand on the existing intro: https://developers.cloudflare.com/cloudflare-one/insights/logs/audit-logs/