Skip to content

LCORE-1225: updated documentation after Splunk patch was merged #1054

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

Merged
tisnik merged 1 commit into from
Jan 25, 2026
+106 −0
Merged

LCORE-1225: updated documentation after Splunk patch was merged #1054

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
78 changes: 78 additions & 0 deletions docs/config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,6 +591,17 @@ <h2 id="configuration">Configuration</h2>
<td/>
<td/>
</tr>
<tr class="even">
<td>splunk</td>
<td/>
<td>Splunk HEC configuration for sending telemetry events.</td>
</tr>
<tr class="odd">
<td>deployment_environment</td>
<td>string</td>
<td>Deployment environment name (e.g., &#x2018;development&#x2019;, &#x2018;staging&#x2019;,
&#x2018;production&#x2019;). Used in telemetry events.</td>
</tr>
</tbody>
</table>
<h2 id="conversationhistoryconfiguration">ConversationHistoryConfiguration</h2>
Expand Down Expand Up @@ -1383,6 +1394,73 @@ <h2 id="serviceconfiguration">ServiceConfiguration</h2>
</tr>
</tbody>
</table>
<h2 id="splunkconfiguration">SplunkConfiguration</h2>
<p>Splunk HEC (HTTP Event Collector) configuration.</p>
<p>Splunk HEC allows sending events directly to Splunk over HTTP/HTTPS.
This configuration is used to send telemetry events for inference
requests to the corporate Splunk deployment.</p>
<p>Useful resources:</p>
<ul>
<li>
<a href="https://docs.splunk.com/Documentation/SplunkCloud">Splunk
HEC Docs</a>
</li>
<li>
<a href="https://docs.splunk.com/Documentation/Splunk/latest/Data">About
HEC</a>
</li>
</ul>
<table>
<colgroup>
<col style="width: 26%"/>
<col style="width: 23%"/>
<col style="width: 50%"/>
</colgroup>
<thead>
<tr class="header">
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>enabled</td>
<td>boolean</td>
<td>Enable or disable Splunk HEC integration.</td>
</tr>
<tr class="even">
<td>url</td>
<td>string</td>
<td>Splunk HEC endpoint URL.</td>
</tr>
<tr class="odd">
<td>token_path</td>
<td>string</td>
<td>Path to file containing the Splunk HEC authentication token.</td>
</tr>
<tr class="even">
<td>index</td>
<td>string</td>
<td>Target Splunk index for events.</td>
</tr>
<tr class="odd">
<td>source</td>
<td>string</td>
<td>Event source identifier.</td>
</tr>
<tr class="even">
<td>timeout</td>
<td>integer</td>
<td>HTTP timeout in seconds for HEC requests.</td>
</tr>
<tr class="odd">
<td>verify_ssl</td>
<td>boolean</td>
<td>Whether to verify SSL certificates for HEC endpoint.</td>
</tr>
</tbody>
</table>
<h2 id="tlsconfiguration">TLSConfiguration</h2>
<p>TLS configuration.</p>
<p>Transport Layer Security (TLS) is a cryptographic protocol designed
Expand Down
28 changes: 28 additions & 0 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,8 @@ Global service configuration.
| a2a_state | | Configuration for A2A protocol persistent state storage. |
| quota_handlers | | Quota handlers configuration |
| azure_entra_id | | |
| splunk | | Splunk HEC configuration for sending telemetry events. |
| deployment_environment | string | Deployment environment name (e.g., 'development', 'staging', 'production'). Used in telemetry events. |


## ConversationHistoryConfiguration
Expand Down Expand Up @@ -513,6 +515,32 @@ the service can handle requests concurrently.
| cors | | Cross-Origin Resource Sharing configuration for cross-domain requests |


## SplunkConfiguration


Splunk HEC (HTTP Event Collector) configuration.

Splunk HEC allows sending events directly to Splunk over HTTP/HTTPS.
This configuration is used to send telemetry events for inference
requests to the corporate Splunk deployment.

Useful resources:

- [Splunk HEC Docs](https://docs.splunk.com/Documentation/SplunkCloud)
- [About HEC](https://docs.splunk.com/Documentation/Splunk/latest/Data)


| Field | Type | Description |
|-------|------|-------------|
| enabled | boolean | Enable or disable Splunk HEC integration. |
| url | string | Splunk HEC endpoint URL. |
| token_path | string | Path to file containing the Splunk HEC authentication token. |
| index | string | Target Splunk index for events. |
| source | string | Event source identifier. |
| timeout | integer | HTTP timeout in seconds for HEC requests. |
| verify_ssl | boolean | Whether to verify SSL certificates for HEC endpoint. |


## TLSConfiguration


Expand Down
Loading