Skip to content

Add remote log publish docs for Asgardeo #5243

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

Merged
merged 2 commits into from
Apr 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion en/asgardeo/docs/guides/asgardeo-logs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,9 @@ Click the **filter icon** next to one or more of the log parameters and Asgardeo

For example, if you would like to view logs related to a request, click the filter icon next to the relevant traceId and click **Run Query** to filter out all the related logs.

![Logs filter by specific value]({{base_path}}/assets/img/guides/asgardeo-logs/logs-filter-by-specific-value.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
![Logs filter by specific value]({{base_path}}/assets/img/guides/asgardeo-logs/logs-filter-by-specific-value.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}


## Remote Log Publishing

Asgardeo allows you to securely publish both audit and diagnostic logs to external servers for long-term storage and analysis. You can configure separate publishers for audit and diagnostic logs with custom settings for each. Learn more about setting up [Remote Log Publishing]({{base_path}}/guides/asgardeo-logs/remote-log-publish).
68 changes: 68 additions & 0 deletions en/asgardeo/docs/guides/asgardeo-logs/remote-log-publish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Remote Log Publishing

Remote Log Publishing enables organizations to securely transmit and store both audit and diagnostic logs in an external server. This capability ensures that critical log data is preserved in a secure location while remaining accessible for analysis and compliance auditing.

## Configure Remote Log Publishing

Follow these steps to set up remote log publishing:

1. On the Asgardeo Console, navigate to **Logs**.
2. Click on the **Configure** button in **Remote Log Publishing**.
3. You will see two sections for configuring remote publishers:
* Diagnostic Logs Publisher
* Audit Logs Publisher

!!! warning
- Configuration updates may take up to 15 minutes to propagate to the server.
- There can be a delay of up to 5 minutes in log publishing after an event occurs.

For each publisher, you can configure the following settings:

<table>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Example Value</th>
</tr>
<tr>
<td>Destination URL</td>
<td>The URL of the remote log server where logs will be published.</td>
<td><code>https://logserver.example.com/store</code></td>
</tr>
<tr>
<td>Log publish interval</td>
<td>The time interval in minutes between log publishing attempts. Must be at least 15 minutes.</td>
<td><code>15</code></td>
</tr>
<tr>
<td>Connection timeout</td>
<td>The timeout in milliseconds for connecting to the remote server. Timeout should be between 1000 and 60000.</td>
<td><code>1000</code></td>
</tr>
<tr>
<td>Verify the hostname</td>
<td>When enabled, verifies the remote server's hostname against its SSL certificate.</td>
<td>False</td>
</tr>
<tr>
<td>Remote server username</td>
<td>The username for basic authentication with the remote server.</td>
<td><code>username</code></td>
</tr>
<tr>
<td>Remote server password</td>
<td>The password for basic authentication with the remote server.</td>
<td><code>password</code></td>
</tr>
</table>

After configuring the settings:

1. Click **Update** to save your configuration.
2. Use the **Test** button to verify the connection with your remote server using the saved configuration. This will publish logs for last 15 minutes.

!!! tip
- Configure both publishers separately if you want to store audit and diagnostic logs in different locations.
- Ensure secure transmission by using HTTPS URLs for your destination servers.
- Test the publisher configuration after setup to verify connectivity.
- If you encounter issues, check your network connectivity and verify the remote server credentials.
1 change: 1 addition & 0 deletions en/asgardeo/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,7 @@ nav:
- Asgardeo logs: guides/asgardeo-logs/index.md
- Diagnostic logs: guides/asgardeo-logs/diagnostic-logs.md
- Audit logs: guides/asgardeo-logs/audit-logs.md
- Remote log publish: guides/asgardeo-logs/remote-log-publish.md
- Monitoring:
- Monitoring: guides/monitoring/index.md
- PII in Asgardeo logs: guides/monitoring/pii-in-asgardeo-logs.md
Expand Down