Documentation Index
Fetch the complete documentation index at: https://mintlify.com/GuaiZai233/FrostAgent/llms.txt
Use this file to discover all available pages before exploring further.
LogService exposes the in-memory log ring buffer that FrostAgent writes to at runtime. The buffer holds up to 5,000 entries and is initialised at startup; once full, the oldest entries are overwritten by new ones. The service is accessible at /frostagent.v1.LogService/ and provides three RPCs: ListLogs for paginated queries, StreamLogs for a live feed of new entries, and ClearLogs to flush the buffer.
Log levels
Log level values map to theLogLevel enum in the protobuf definition. Use numeric or string values in JSON requests.
| Name | Value | Description |
|---|---|---|
LOG_LEVEL_UNSPECIFIED | 0 | Unset; matches all levels when used as min_level |
LOG_LEVEL_DEBUG | 1 | Verbose diagnostic output |
LOG_LEVEL_INFO | 2 | Normal operational messages |
LOG_LEVEL_WARN | 3 | Non-fatal warnings |
LOG_LEVEL_ERROR | 4 | Errors that require attention |
Log sources
Each log entry carries asource string derived from the internal Category type. Use these exact strings in source_filter to narrow results.
| Source | Typical content |
|---|---|
SYSTEM | Engine lifecycle events — startup, shutdown, initialisation |
HTTP | Inbound HTTP requests and outbound HTTP responses |
TOOL | Tool invocations and their results |
WEBSOCKET | OneBot WebSocket connection and message events |
LLM_REQUEST | Outbound prompts sent to the upstream LLM provider |
LLM_RESPONSE | Raw responses received from the upstream LLM provider |
ListLogs
Returns a paginated, timestamp-descending snapshot of log entries from the ring buffer. Optional filters narrow results by minimum severity level and source category. Request:ListLogsRequest
Controls which page of results to return.
Only return entries at or above this severity level. Omit or set to
0 (LOG_LEVEL_UNSPECIFIED) to return all levels.Only return entries whose
source matches this string exactly, e.g. "LLM_REQUEST". Omit or set to "" to return all sources.ListLogsResponse
Log entries for the requested page, sorted by timestamp descending (most recent first).
Pagination metadata.
total is the filtered entry count; page_token is the cursor for the next page, or "" on the last page.StreamLogs
A server-streaming RPC that pushes newLogEntry messages to the client as they are emitted by the engine. The stream remains open until the client disconnects or the server is shut down. Filters work identically to ListLogs — entries that do not match are dropped before being sent.
Request: StreamLogsRequest
Minimum severity level to stream. Defaults to all levels if omitted.
Exact source name to filter by. Omit or set to
"" to stream all sources.LogEntry
Each streamed message has the same fields as documented in ListLogs above.
Example — stream all LLM request/response entries
ClearLogs
Flushes the in-memory ring buffer by replacing it with a fresh, empty ring of the same capacity (5,000). Entries are gone immediately and cannot be recovered. Request:ClearLogsRequest
No fields. Send {}.
Response: ClearLogsResponse
Always
true when the operation completes. The buffer is unconditionally reset.All logs are stored in memory only and are lost when FrostAgent restarts. The ring buffer holds a maximum of 5,000 entries; older entries are silently overwritten as new ones arrive. If you need persistent log storage, consider forwarding log output from stdout to an external collector.