RuleGo RuleGo
🏠Home
  • Quick Start
  • Rule Chain
  • Standard Components
  • Extension Components
  • Custom Components
  • Visualization
  • RuleGo-Server
  • AOP
  • Trigger
  • Advanced Topics
  • Performance
  • Standard Components
  • Extension Components
  • Custom Components
  • Components Marketplace
  • Overview
  • Quick Start
  • Routing
  • DSL
  • API
  • Options
  • Components
🔥Editor (opens new window)
  • RuleGo Editor (opens new window)
  • RuleGo Server (opens new window)
  • StreamSQL
  • AI Agent Framework
  • TPCLAW Agent Platform (opens new window)
  • Github (opens new window)
  • Gitee (opens new window)
  • Changelog (opens new window)
  • English
  • 简体中文
🏠Home
  • Quick Start
  • Rule Chain
  • Standard Components
  • Extension Components
  • Custom Components
  • Visualization
  • RuleGo-Server
  • AOP
  • Trigger
  • Advanced Topics
  • Performance
  • Standard Components
  • Extension Components
  • Custom Components
  • Components Marketplace
  • Overview
  • Quick Start
  • Routing
  • DSL
  • API
  • Options
  • Components
🔥Editor (opens new window)
  • RuleGo Editor (opens new window)
  • RuleGo Server (opens new window)
  • StreamSQL
  • AI Agent Framework
  • TPCLAW Agent Platform (opens new window)
  • Github (opens new window)
  • Gitee (opens new window)
  • Changelog (opens new window)
  • English
  • 简体中文

广告采用随机轮播方式显示 ❤️成为赞助商
  • Quick Start

  • Rule Chain

  • Standard Components

  • Extension Components

  • Custom Components

  • Components marketplace

  • Visualization

  • AOP

  • Trigger

  • Advanced Topic

  • Agent Framework

  • RuleGo-Server

    • Overview and Quick Start
    • Installation and Deployment
    • Authentication and Authorization
    • REST API Reference
    • MCP Service
    • AI Features
    • Component Marketplace
    • Run Logs
      • Configuration
      • Storage Backends
      • Query Execution History
      • Get a Single Record
      • Delete Records
      • Node Debug Data
      • Viewing in the Editor
      • WebSocket Real-time Debugging
    • Internationalization
    • Extension Development
    • Deploying and Invoking Rule Chains
    • Visual Editor

  • FAQ

  • Endpoint Module

  • Support

  • StreamSQL

目录

Run Logs

RuleGo-Server provides persistent storage and querying capabilities for rule chain execution logs, supporting multiple storage backends.

# Configuration

# Run log level: off (no logging, default) / summary (summary only) / detail (full per-node logs)
# Replaces the former save_run_log; per-chain additionalInfo.runLogMode can override this global setting
run_log_mode = summary
# Storage backend type: bbolt (default), file
run_log_store_type = bbolt
# Keep the most recent N log entries per rule chain, 0 means no limit
run_log_retention_count = 500
# Keep logs from the most recent N days, 0 means no limit
run_log_retention_days = 7
1
2
3
4
5
6
7
8
9

Run log levels:

Level Description
off Do not record run logs (default)
summary Record execution summary only (start/end time, status, duration), no per-node logs collected, near-zero overhead
detail Record full per-node logs; the detailed execution steps of each node can be viewed in the execution history

The rule chain level additionalInfo.runLogMode (off / summary / detail) can override the global setting, enabling per-chain log policies.

# Storage Backends

Type Description Use Case
bbolt Embedded key-value database (default) Production, good performance
file JSON Lines file storage Debugging, log export

When run_log_mode = off, a no-op store is used internally; no extra configuration is needed.

# Query Execution History

GET /api/v1/logs/runs?chainId={chainId}&page=1&size=20&startTime=&endTime=
Authorization: Bearer {token}
1
2

Query parameters:

Parameter Type Description
chainId string Rule chain ID filter
id string Specific run record ID
page int Page number
size int Items per page
startTime string Start time filter
endTime string End time filter

# Get a Single Record

GET /api/v1/logs/runs?id={runId}
Authorization: Bearer {token}
1
2

# Delete Records

# Delete by rule chain
DELETE /api/v1/logs/runs?chainId={chainId}

# Delete by record ID
DELETE /api/v1/logs/runs?id={runId}
Authorization: Bearer {token}
1
2
3
4
5
6

# Node Debug Data

Get debug logs for rule chain nodes:

GET /api/v1/logs/debug?chainId={chainId}&nodeId={nodeId}
Authorization: Bearer {token}
1
2

Node debug logging is controlled by the debug and max_node_log_size configuration:

# Whether to print node debug logs to the log file
debug = true
# Maximum log entries per node
max_node_log_size = 40
1
2
3
4

# Viewing in the Editor

  • Debug Console: Bottom panel displays node IN/OUT data in real time
  • Node Debug Panel: Click a node to view historical debug logs
  • Execution History: View historical execution records in the run dialog

# WebSocket Real-time Debugging

See REST API Reference - Real-time Debugging.

Edit this page on GitHub (opens new window)
Last Updated: 2026/08/13, 09:22:24
Component Marketplace
Internationalization

← Component Marketplace Internationalization→

Theme by Vdoing | Copyright © 2023-2026 RuleGo Team | Apache 2.0 License

  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式