Skip to content

Commit 9a281ac

Browse files
authored
Merge pull request #5243 from Avarjana/master
Add remote log publish docs for Asgardeo
2 parents 9084b71 + fdac761 commit 9a281ac

File tree

3 files changed

+75
-1
lines changed

3 files changed

+75
-1
lines changed

en/asgardeo/docs/guides/asgardeo-logs/index.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,9 @@ Click the **filter icon** next to one or more of the log parameters and Asgardeo
4141

4242
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.
4343

44-
![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;"}
44+
![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;"}
45+
46+
47+
## Remote Log Publishing
48+
49+
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).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Remote Log Publishing
2+
3+
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.
4+
5+
## Configure Remote Log Publishing
6+
7+
Follow these steps to set up remote log publishing:
8+
9+
1. On the Asgardeo Console, navigate to **Logs**.
10+
2. Click on the **Configure** button in **Remote Log Publishing**.
11+
3. You will see two sections for configuring remote publishers:
12+
* Diagnostic Logs Publisher
13+
* Audit Logs Publisher
14+
15+
!!! warning
16+
- Configuration updates may take up to 15 minutes to propagate to the server.
17+
- There can be a delay of up to 5 minutes in log publishing after an event occurs.
18+
19+
For each publisher, you can configure the following settings:
20+
21+
<table>
22+
<tr>
23+
<th>Parameter</th>
24+
<th>Description</th>
25+
<th>Example Value</th>
26+
</tr>
27+
<tr>
28+
<td>Destination URL</td>
29+
<td>The URL of the remote log server where logs will be published.</td>
30+
<td><code>https://logserver.example.com/store</code></td>
31+
</tr>
32+
<tr>
33+
<td>Log publish interval</td>
34+
<td>The time interval in minutes between log publishing attempts. Must be at least 15 minutes.</td>
35+
<td><code>15</code></td>
36+
</tr>
37+
<tr>
38+
<td>Connection timeout</td>
39+
<td>The timeout in milliseconds for connecting to the remote server. Timeout should be between 1000 and 60000.</td>
40+
<td><code>1000</code></td>
41+
</tr>
42+
<tr>
43+
<td>Verify the hostname</td>
44+
<td>When enabled, verifies the remote server's hostname against its SSL certificate.</td>
45+
<td>False</td>
46+
</tr>
47+
<tr>
48+
<td>Remote server username</td>
49+
<td>The username for basic authentication with the remote server.</td>
50+
<td><code>username</code></td>
51+
</tr>
52+
<tr>
53+
<td>Remote server password</td>
54+
<td>The password for basic authentication with the remote server.</td>
55+
<td><code>password</code></td>
56+
</tr>
57+
</table>
58+
59+
After configuring the settings:
60+
61+
1. Click **Update** to save your configuration.
62+
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.
63+
64+
!!! tip
65+
- Configure both publishers separately if you want to store audit and diagnostic logs in different locations.
66+
- Ensure secure transmission by using HTTPS URLs for your destination servers.
67+
- Test the publisher configuration after setup to verify connectivity.
68+
- If you encounter issues, check your network connectivity and verify the remote server credentials.

en/asgardeo/mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,7 @@ nav:
420420
- Asgardeo logs: guides/asgardeo-logs/index.md
421421
- Diagnostic logs: guides/asgardeo-logs/diagnostic-logs.md
422422
- Audit logs: guides/asgardeo-logs/audit-logs.md
423+
- Remote log publish: guides/asgardeo-logs/remote-log-publish.md
423424
- Monitoring:
424425
- Monitoring: guides/monitoring/index.md
425426
- PII in Asgardeo logs: guides/monitoring/pii-in-asgardeo-logs.md

0 commit comments

Comments
 (0)