Skip to content
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.

Sign up for GitHub

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

[HWORKS-1975] fix docs for path change #435

Merged
merged 1 commit into from
Jan 17, 2025
Merged

[HWORKS-1975] fix docs for path change #435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/assets/images/admin/audit/audit-log-vars.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 2 additions & 3 deletions docs/setup_installation/admin/audit/audit-logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ To edit a configuration variable, you can click on the edit button (:material-pe

| Name | Description |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| audit_log_count | the number of files to keep when rotating logs (java.util.logging.FileHandler.count) |
| audit_log_dir | the path where audit logs are saved |
| audit_log_count | the number of files to keep when rotating logs (java.util.logging.FileHandler count) | |
| audit_log_file_format | log file name pattern. (java.util.logging.FileHandler.pattern) |
| audit_log_file_type | the output format of the log file. Can be one of java.util.logging.SimpleFormatter (default), io.hops.hopsworks.audit.helper.JSONLogFormatter, or io.hops.hopsworks.audit.helper.HtmlLogFormatter. |
| audit_log_size_limit | the maximum number of bytes to write to any one file. (java.util.logging.FileHandler.limit) |
Expand All @@ -40,7 +39,7 @@ To edit a configuration variable, you can click on the edit button (:material-pe

## Step 2: Access the Logs

To access the audit logs, SSH into the **head node** of your Hopsworks cluster and navigate to the path set in the _audit\_log\_dir_ configuration variable.
To access the audit logs, SSH into the **instance pod** of your Hopsworks cluster and navigate to the path ```/opt/payara/appserver/glassfish/nodes/<node name>/<instance name>/logs/audit```.

Audit logs follow the format set in the _audit\_log\_file\_type_ configuration variable.

Expand Down
Loading