Aleph
Gateway RPCMethods Reference

logs.*

System logs and diagnostics RPC methods

Log methods provide access to system logs, diagnostics, and tracing information for monitoring and debugging Aleph operations.

Methods

logs.list

List available log files or recent log entries.

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "logs.list",
  "params": {
    "limit": 100,
    "level": "info"
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "entries": [
      {
        "timestamp": "2024-01-15T10:30:00Z",
        "level": "info",
        "component": "gateway",
        "message": "RPC request: agent.run"
      }
    ],
    "total": 1
  }
}

Parameters:

ParameterTypeRequiredDescription
limitnumberNoMaximum entries to return
levelstringNoFilter by level: "trace", "debug", "info", "warn", "error"
componentstringNoFilter by component name
sincestringNoISO timestamp for start of range

logs.get

Get a specific log entry or log file contents.

Request:

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "logs.get",
  "params": {
    "log_id": "log-1"
  }
}

logs.tail

Stream recent log entries (for real-time monitoring).

Request:

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "logs.tail",
  "params": {
    "lines": 50,
    "follow": false
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "entries": [
      {
        "timestamp": "2024-01-15T10:30:00Z",
        "level": "info",
        "message": "Session started: session-uuid-123"
      }
    ]
  }
}

logs.levels

Get current log levels for all components.

Request:

{
  "jsonrpc": "2.0",
  "id": 4,
  "method": "logs.levels",
  "params": {}
}

Response:

{
  "jsonrpc": "2.0",
  "id": 4,
  "result": {
    "levels": {
      "gateway": "info",
      "agent": "debug",
      "memory": "warn"
    }
  }
}

logs.set_level

Set the log level for a component.

Request:

{
  "jsonrpc": "2.0",
  "id": 5,
  "method": "logs.set_level",
  "params": {
    "component": "agent",
    "level": "trace"
  }
}

Parameters:

ParameterTypeRequiredDescription
componentstringYesComponent name or "*" for all
levelstringYesLog level: "trace", "debug", "info", "warn", "error"

Log Levels

LevelDescription
traceVerbose tracing information
debugDebug information
infoGeneral operational information
warnWarning messages
errorError messages

See Also

On this page