Compare commits
3 Commits
7fffdb2660
...
8ce843415e
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8ce843415e | ||
|
|
46085bd8dd | ||
|
|
2ac83df1e0 |
49
=0.3.0
49
=0.3.0
@@ -1,49 +0,0 @@
|
||||
Requirement already satisfied: langchain in ./.venv/lib/python3.13/site-packages (1.2.12)
|
||||
Requirement already satisfied: langchain-xai in ./.venv/lib/python3.13/site-packages (1.2.2)
|
||||
Requirement already satisfied: langchain-core in ./.venv/lib/python3.13/site-packages (1.2.18)
|
||||
Requirement already satisfied: langgraph<1.2.0,>=1.1.1 in ./.venv/lib/python3.13/site-packages (from langchain) (1.1.2)
|
||||
Requirement already satisfied: pydantic<3.0.0,>=2.7.4 in ./.venv/lib/python3.13/site-packages (from langchain) (2.12.5)
|
||||
Requirement already satisfied: jsonpatch<2.0.0,>=1.33.0 in ./.venv/lib/python3.13/site-packages (from langchain-core) (1.33)
|
||||
Requirement already satisfied: langsmith<1.0.0,>=0.3.45 in ./.venv/lib/python3.13/site-packages (from langchain-core) (0.7.17)
|
||||
Requirement already satisfied: packaging>=23.2.0 in ./.venv/lib/python3.13/site-packages (from langchain-core) (26.0)
|
||||
Requirement already satisfied: pyyaml<7.0.0,>=5.3.0 in ./.venv/lib/python3.13/site-packages (from langchain-core) (6.0.3)
|
||||
Requirement already satisfied: tenacity!=8.4.0,<10.0.0,>=8.1.0 in ./.venv/lib/python3.13/site-packages (from langchain-core) (9.1.4)
|
||||
Requirement already satisfied: typing-extensions<5.0.0,>=4.7.0 in ./.venv/lib/python3.13/site-packages (from langchain-core) (4.15.0)
|
||||
Requirement already satisfied: uuid-utils<1.0,>=0.12.0 in ./.venv/lib/python3.13/site-packages (from langchain-core) (0.14.1)
|
||||
Requirement already satisfied: jsonpointer>=1.9 in ./.venv/lib/python3.13/site-packages (from jsonpatch<2.0.0,>=1.33.0->langchain-core) (3.0.0)
|
||||
Requirement already satisfied: langgraph-checkpoint<5.0.0,>=2.1.0 in ./.venv/lib/python3.13/site-packages (from langgraph<1.2.0,>=1.1.1->langchain) (4.0.1)
|
||||
Requirement already satisfied: langgraph-prebuilt<1.1.0,>=1.0.8 in ./.venv/lib/python3.13/site-packages (from langgraph<1.2.0,>=1.1.1->langchain) (1.0.8)
|
||||
Requirement already satisfied: langgraph-sdk<0.4.0,>=0.3.0 in ./.venv/lib/python3.13/site-packages (from langgraph<1.2.0,>=1.1.1->langchain) (0.3.11)
|
||||
Requirement already satisfied: xxhash>=3.5.0 in ./.venv/lib/python3.13/site-packages (from langgraph<1.2.0,>=1.1.1->langchain) (3.6.0)
|
||||
Requirement already satisfied: ormsgpack>=1.12.0 in ./.venv/lib/python3.13/site-packages (from langgraph-checkpoint<5.0.0,>=2.1.0->langgraph<1.2.0,>=1.1.1->langchain) (1.12.2)
|
||||
Requirement already satisfied: httpx>=0.25.2 in ./.venv/lib/python3.13/site-packages (from langgraph-sdk<0.4.0,>=0.3.0->langgraph<1.2.0,>=1.1.1->langchain) (0.28.1)
|
||||
Requirement already satisfied: orjson>=3.11.5 in ./.venv/lib/python3.13/site-packages (from langgraph-sdk<0.4.0,>=0.3.0->langgraph<1.2.0,>=1.1.1->langchain) (3.11.7)
|
||||
Requirement already satisfied: requests-toolbelt>=1.0.0 in ./.venv/lib/python3.13/site-packages (from langsmith<1.0.0,>=0.3.45->langchain-core) (1.0.0)
|
||||
Requirement already satisfied: requests>=2.0.0 in ./.venv/lib/python3.13/site-packages (from langsmith<1.0.0,>=0.3.45->langchain-core) (2.32.5)
|
||||
Requirement already satisfied: zstandard>=0.23.0 in ./.venv/lib/python3.13/site-packages (from langsmith<1.0.0,>=0.3.45->langchain-core) (0.25.0)
|
||||
Requirement already satisfied: anyio in ./.venv/lib/python3.13/site-packages (from httpx>=0.25.2->langgraph-sdk<0.4.0,>=0.3.0->langgraph<1.2.0,>=1.1.1->langchain) (4.12.1)
|
||||
Requirement already satisfied: certifi in ./.venv/lib/python3.13/site-packages (from httpx>=0.25.2->langgraph-sdk<0.4.0,>=0.3.0->langgraph<1.2.0,>=1.1.1->langchain) (2026.2.25)
|
||||
Requirement already satisfied: httpcore==1.* in ./.venv/lib/python3.13/site-packages (from httpx>=0.25.2->langgraph-sdk<0.4.0,>=0.3.0->langgraph<1.2.0,>=1.1.1->langchain) (1.0.9)
|
||||
Requirement already satisfied: idna in ./.venv/lib/python3.13/site-packages (from httpx>=0.25.2->langgraph-sdk<0.4.0,>=0.3.0->langgraph<1.2.0,>=1.1.1->langchain) (3.11)
|
||||
Requirement already satisfied: h11>=0.16 in ./.venv/lib/python3.13/site-packages (from httpcore==1.*->httpx>=0.25.2->langgraph-sdk<0.4.0,>=0.3.0->langgraph<1.2.0,>=1.1.1->langchain) (0.16.0)
|
||||
Requirement already satisfied: annotated-types>=0.6.0 in ./.venv/lib/python3.13/site-packages (from pydantic<3.0.0,>=2.7.4->langchain) (0.7.0)
|
||||
Requirement already satisfied: pydantic-core==2.41.5 in ./.venv/lib/python3.13/site-packages (from pydantic<3.0.0,>=2.7.4->langchain) (2.41.5)
|
||||
Requirement already satisfied: typing-inspection>=0.4.2 in ./.venv/lib/python3.13/site-packages (from pydantic<3.0.0,>=2.7.4->langchain) (0.4.2)
|
||||
Requirement already satisfied: aiohttp<4.0.0,>=3.9.1 in ./.venv/lib/python3.13/site-packages (from langchain-xai) (3.13.3)
|
||||
Requirement already satisfied: langchain-openai<2.0.0,>=1.1.7 in ./.venv/lib/python3.13/site-packages (from langchain-xai) (1.1.11)
|
||||
Requirement already satisfied: aiohappyeyeballs>=2.5.0 in ./.venv/lib/python3.13/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-xai) (2.6.1)
|
||||
Requirement already satisfied: aiosignal>=1.4.0 in ./.venv/lib/python3.13/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-xai) (1.4.0)
|
||||
Requirement already satisfied: attrs>=17.3.0 in ./.venv/lib/python3.13/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-xai) (25.4.0)
|
||||
Requirement already satisfied: frozenlist>=1.1.1 in ./.venv/lib/python3.13/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-xai) (1.8.0)
|
||||
Requirement already satisfied: multidict<7.0,>=4.5 in ./.venv/lib/python3.13/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-xai) (6.7.1)
|
||||
Requirement already satisfied: propcache>=0.2.0 in ./.venv/lib/python3.13/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-xai) (0.4.1)
|
||||
Requirement already satisfied: yarl<2.0,>=1.17.0 in ./.venv/lib/python3.13/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-xai) (1.22.0)
|
||||
Requirement already satisfied: openai<3.0.0,>=2.26.0 in ./.venv/lib/python3.13/site-packages (from langchain-openai<2.0.0,>=1.1.7->langchain-xai) (2.26.0)
|
||||
Requirement already satisfied: tiktoken<1.0.0,>=0.7.0 in ./.venv/lib/python3.13/site-packages (from langchain-openai<2.0.0,>=1.1.7->langchain-xai) (0.12.0)
|
||||
Requirement already satisfied: distro<2,>=1.7.0 in ./.venv/lib/python3.13/site-packages (from openai<3.0.0,>=2.26.0->langchain-openai<2.0.0,>=1.1.7->langchain-xai) (1.9.0)
|
||||
Requirement already satisfied: jiter<1,>=0.10.0 in ./.venv/lib/python3.13/site-packages (from openai<3.0.0,>=2.26.0->langchain-openai<2.0.0,>=1.1.7->langchain-xai) (0.13.0)
|
||||
Requirement already satisfied: sniffio in ./.venv/lib/python3.13/site-packages (from openai<3.0.0,>=2.26.0->langchain-openai<2.0.0,>=1.1.7->langchain-xai) (1.3.1)
|
||||
Requirement already satisfied: tqdm>4 in ./.venv/lib/python3.13/site-packages (from openai<3.0.0,>=2.26.0->langchain-openai<2.0.0,>=1.1.7->langchain-xai) (4.67.3)
|
||||
Requirement already satisfied: charset_normalizer<4,>=2 in ./.venv/lib/python3.13/site-packages (from requests>=2.0.0->langsmith<1.0.0,>=0.3.45->langchain-core) (3.4.4)
|
||||
Requirement already satisfied: urllib3<3,>=1.21.1 in ./.venv/lib/python3.13/site-packages (from requests>=2.0.0->langsmith<1.0.0,>=0.3.45->langchain-core) (2.6.3)
|
||||
Requirement already satisfied: regex>=2022.1.18 in ./.venv/lib/python3.13/site-packages (from tiktoken<1.0.0,>=0.7.0->langchain-openai<2.0.0,>=1.1.7->langchain-xai) (2026.2.28)
|
||||
461
docs/INDEX.md
461
docs/INDEX.md
@@ -3,6 +3,7 @@
|
||||
> **For AI Assistants**: This document contains all critical patterns, conventions, and best practices. Read this first to understand the codebase structure and ensure consistency.
|
||||
|
||||
**Quick Navigation:**
|
||||
- [iii Platform & Development Workflow](#iii-platform--development-workflow) - Platform evolution and CLI tools
|
||||
- [Core Concepts](#core-concepts) - System architecture and patterns
|
||||
- [Design Principles](#design-principles) - Event Storm & Bidirectional References
|
||||
- [Step Development](#step-development-best-practices) - How to create new steps
|
||||
@@ -23,6 +24,244 @@
|
||||
|
||||
---
|
||||
|
||||
## iii Platform & Development Workflow
|
||||
|
||||
### Platform Evolution (v0.8 → v0.9+)
|
||||
|
||||
**Status:** March 2026 - iii v0.9+ production-ready
|
||||
|
||||
iii has evolved from an all-in-one development tool to a **modular, production-grade event engine** with clear separation between development and deployment workflows.
|
||||
|
||||
#### Structural Changes Overview
|
||||
|
||||
| Component | Before (v0.2-v0.7) | Now (v0.9+) | Impact |
|
||||
|-----------|-------------------|-------------|--------|
|
||||
| **Console/Dashboard** | Integrated in engine process (port 3111) | Separate process (`iii-cli console` or `dev`) | More flexibility, less resource overhead, better scaling |
|
||||
| **CLI Tool** | Minimal or non-existent | `iii-cli` is the central dev tool | Terminal-based dev workflow, scriptable, faster iteration |
|
||||
| **Project Structure** | Steps anywhere in project | **Recommended:** `src/` + `src/steps/` | Cleaner structure, reliable hot-reload |
|
||||
| **Hot-Reload/Watcher** | Integrated in engine | Separate `shell::ExecModule` with `watch` paths | Only Python/TS files watched (configurable) |
|
||||
| **Start & Services** | Single `iii` process | Engine (`iii` or `iii-cli start`) + Console separate | Better for production (engine) vs dev (console) |
|
||||
| **Config Handling** | YAML + ENV | YAML + ENV + CLI flags prioritized | More control via CLI flags |
|
||||
| **Observability** | Basic | Enhanced (OTel, Rollups, Alerts, Traces) | Production-ready telemetry |
|
||||
| **Streams & State** | KV-Store (file/memory) | More adapters + file_based default | Better persistence handling |
|
||||
|
||||
**Key Takeaway:** iii is now a **modular, production-ready engine** where development (CLI + separate console) is clearly separated from production deployment.
|
||||
|
||||
---
|
||||
|
||||
### Development Workflow with iii-cli
|
||||
|
||||
**`iii-cli` is your primary tool for local development, debugging, and testing.**
|
||||
|
||||
#### Essential Commands
|
||||
|
||||
| Command | Purpose | When to Use | Example |
|
||||
|---------|---------|------------|---------|
|
||||
| `iii-cli dev` | Start dev server with hot-reload + integrated console | Local development, immediate feedback on code changes | `iii-cli dev` |
|
||||
| `iii-cli console` | Start dashboard only (separate port) | When you only need the console (no dev reload) | `iii-cli console --host 0.0.0.0 --port 3113` |
|
||||
| `iii-cli start` | Start engine standalone (like `motia.service`) | Testing engine in isolation | `iii-cli start -c iii-config.yaml` |
|
||||
| `iii-cli logs` | Live logs of all flows/workers/triggers | Debugging, error investigation | `iii-cli logs --level debug` |
|
||||
| `iii-cli trace <id>` | Show detailed trace information (OTel) | Debug specific request/flow | `iii-cli trace abc123` |
|
||||
| `iii-cli state ls` | List states (KV storage) | Verify state persistence | `iii-cli state ls` |
|
||||
| `iii-cli state get` | Get specific state value | Inspect state content | `iii-cli state get key` |
|
||||
| `iii-cli stream ls` | List all streams + groups | Inspect stream/websocket connections | `iii-cli stream ls` |
|
||||
| `iii-cli flow list` | Show all registered flows/triggers | Overview of active steps & endpoints | `iii-cli flow list` |
|
||||
| `iii-cli worker logs` | Worker logs (Python/TS execution) | Debug issues in step handlers | `iii-cli worker logs` |
|
||||
|
||||
#### Typical Development Workflow
|
||||
|
||||
```bash
|
||||
# 1. Navigate to project
|
||||
cd /opt/motia-iii/bitbylaw
|
||||
|
||||
# 2. Start dev mode (hot-reload + console on port 3113)
|
||||
iii-cli dev --host 0.0.0.0 --port 3113 --engine-port 3111
|
||||
|
||||
# Alternative: Separate engine + console
|
||||
# Terminal 1:
|
||||
iii-cli start -c iii-config.yaml
|
||||
|
||||
# Terminal 2:
|
||||
iii-cli console --host 0.0.0.0 --port 3113 \
|
||||
--engine-host 192.168.1.62 --engine-port 3111
|
||||
|
||||
# 3. Watch logs live (separate terminal)
|
||||
iii-cli logs -f
|
||||
|
||||
# 4. Debug specific trace
|
||||
iii-cli trace <trace-id-from-logs>
|
||||
|
||||
# 5. Inspect state
|
||||
iii-cli state ls
|
||||
iii-cli state get document:sync:status
|
||||
|
||||
# 6. Verify flows registered
|
||||
iii-cli flow list
|
||||
```
|
||||
|
||||
#### Development vs. Production
|
||||
|
||||
**Development:**
|
||||
- Use `iii-cli dev` for hot-reload
|
||||
- Console accessible on localhost:3113
|
||||
- Logs visible in terminal
|
||||
- Immediate feedback on code changes
|
||||
|
||||
**Production:**
|
||||
- `systemd` service runs `iii-cli start`
|
||||
- Console runs separately (if needed)
|
||||
- Logs via `journalctl -u motia.service -f`
|
||||
- No hot-reload (restart service for changes)
|
||||
|
||||
**Example Production Service:**
|
||||
```ini
|
||||
[Unit]
|
||||
Description=Motia III Engine
|
||||
After=network.target redis.service
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=motia
|
||||
WorkingDirectory=/opt/motia-iii/bitbylaw
|
||||
ExecStart=/usr/local/bin/iii-cli start -c /opt/motia-iii/bitbylaw/iii-config.yaml
|
||||
Restart=always
|
||||
RestartSec=10
|
||||
Environment="PATH=/usr/local/bin:/usr/bin"
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
#### Project Structure Best Practices
|
||||
|
||||
**Recommended Structure (v0.9+):**
|
||||
```
|
||||
bitbylaw/
|
||||
├── iii-config.yaml # Main configuration
|
||||
├── src/ # Source code root
|
||||
│ └── steps/ # All steps here (hot-reload reliable)
|
||||
│ ├── __init__.py
|
||||
│ ├── vmh/
|
||||
│ │ ├── __init__.py
|
||||
│ │ ├── document_sync_event_step.py
|
||||
│ │ └── webhook/
|
||||
│ │ ├── __init__.py
|
||||
│ │ └── document_create_api_step.py
|
||||
│ └── advoware_proxy/
|
||||
│ └── ...
|
||||
├── services/ # Shared business logic
|
||||
│ ├── __init__.py
|
||||
│ ├── xai_service.py
|
||||
│ ├── espocrm.py
|
||||
│ └── ...
|
||||
└── tests/ # Test files
|
||||
```
|
||||
|
||||
**Why `src/steps/` is recommended:**
|
||||
- **Hot-reload works reliably** - Watcher detects changes correctly
|
||||
- **Cleaner project** - Source code isolated from config/docs
|
||||
- **IDE support** - Better navigation and refactoring
|
||||
- **Deployment** - Easier to package
|
||||
|
||||
**Note:** Old structure (steps in root) still works, but hot-reload may be less reliable.
|
||||
|
||||
#### Hot-Reload Configuration
|
||||
|
||||
**Hot-reload is configured via `shell::ExecModule` in `iii-config.yaml`:**
|
||||
|
||||
```yaml
|
||||
modules:
|
||||
- type: shell::ExecModule
|
||||
config:
|
||||
watch:
|
||||
- "src/**/*.py" # Watch Python files in src/
|
||||
- "services/**/*.py" # Watch service files
|
||||
# Add more patterns as needed
|
||||
ignore:
|
||||
- "**/__pycache__/**"
|
||||
- "**/*.pyc"
|
||||
- "**/tests/**"
|
||||
```
|
||||
|
||||
**Behavior:**
|
||||
- Only files matching `watch` patterns trigger reload
|
||||
- Changes in `ignore` patterns are ignored
|
||||
- Reload is automatic in `iii-cli dev` mode
|
||||
- Production mode (`iii-cli start`) does NOT watch files
|
||||
|
||||
---
|
||||
|
||||
### Observability & Debugging
|
||||
|
||||
#### OpenTelemetry Integration
|
||||
|
||||
**iii v0.9+ has built-in OpenTelemetry support:**
|
||||
|
||||
```python
|
||||
# Traces are automatically created for:
|
||||
# - HTTP requests
|
||||
# - Queue processing
|
||||
# - Cron execution
|
||||
# - Service calls (if instrumented)
|
||||
|
||||
# Access trace ID in handler:
|
||||
async def handler(request: ApiRequest, ctx: FlowContext) -> ApiResponse:
|
||||
trace_id = ctx.trace_id # Use for debugging
|
||||
ctx.logger.info(f"Trace ID: {trace_id}")
|
||||
```
|
||||
|
||||
**View traces:**
|
||||
```bash
|
||||
# Get trace details
|
||||
iii-cli trace <trace-id>
|
||||
|
||||
# Filter logs by trace
|
||||
iii-cli logs --trace <trace-id>
|
||||
```
|
||||
|
||||
#### Debugging Workflow
|
||||
|
||||
**1. Live Logs:**
|
||||
```bash
|
||||
# All logs
|
||||
iii-cli logs -f
|
||||
|
||||
# Specific level
|
||||
iii-cli logs --level error
|
||||
|
||||
# With grep
|
||||
iii-cli logs -f | grep "document_sync"
|
||||
```
|
||||
|
||||
**2. State Inspection:**
|
||||
```bash
|
||||
# List all state keys
|
||||
iii-cli state ls
|
||||
|
||||
# Get specific state
|
||||
iii-cli state get sync:document:last_run
|
||||
```
|
||||
|
||||
**3. Flow Verification:**
|
||||
```bash
|
||||
# List all registered flows
|
||||
iii-cli flow list
|
||||
|
||||
# Verify endpoint exists
|
||||
iii-cli flow list | grep "/vmh/webhook"
|
||||
```
|
||||
|
||||
**4. Worker Issues:**
|
||||
```bash
|
||||
# Worker-specific logs
|
||||
iii-cli worker logs
|
||||
|
||||
# Check worker health
|
||||
iii-cli worker status
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Core Concepts
|
||||
|
||||
### System Overview
|
||||
@@ -1271,24 +1510,41 @@ sudo systemctl enable motia.service
|
||||
sudo systemctl enable iii-console.service
|
||||
```
|
||||
|
||||
**Manual (Development):**
|
||||
**Development (iii-cli):**
|
||||
```bash
|
||||
# Start iii Engine
|
||||
# Option 1: Dev mode with integrated console and hot-reload
|
||||
cd /opt/motia-iii/bitbylaw
|
||||
/opt/bin/iii -c iii-config.yaml
|
||||
iii-cli dev --host 0.0.0.0 --port 3113 --engine-port 3111
|
||||
|
||||
# Start iii Console (Web UI)
|
||||
/opt/bin/iii-console --enable-flow --host 0.0.0.0 --port 3113 \
|
||||
--engine-host 192.168.67.233 --engine-port 3111 --ws-port 3114
|
||||
# Option 2: Separate engine and console
|
||||
# Terminal 1: Start engine
|
||||
iii-cli start -c iii-config.yaml
|
||||
|
||||
# Terminal 2: Start console
|
||||
iii-cli console --host 0.0.0.0 --port 3113 \
|
||||
--engine-host 192.168.1.62 --engine-port 3111
|
||||
|
||||
# Option 3: Manual (legacy)
|
||||
/opt/bin/iii -c iii-config.yaml
|
||||
```
|
||||
|
||||
### Check Registered Steps
|
||||
|
||||
**Using iii-cli (recommended):**
|
||||
```bash
|
||||
# List all flows and triggers
|
||||
iii-cli flow list
|
||||
|
||||
# Filter for specific step
|
||||
iii-cli flow list | grep document_sync
|
||||
```
|
||||
|
||||
**Using curl (legacy):**
|
||||
```bash
|
||||
curl http://localhost:3111/_console/functions | python3 -m json.tool
|
||||
```
|
||||
|
||||
### Test HTTP Endpoint
|
||||
### Test HTTP Endpoints
|
||||
|
||||
```bash
|
||||
# Test document webhook
|
||||
@@ -1298,6 +1554,11 @@ curl -X POST "http://localhost:3111/vmh/webhook/document/create" \
|
||||
|
||||
# Test advoware proxy
|
||||
curl "http://localhost:3111/advoware/proxy?endpoint=employees"
|
||||
|
||||
# Test beteiligte sync
|
||||
curl -X POST "http://localhost:3111/vmh/webhook/beteiligte/create" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"entity_type": "CBeteiligte", "entity_id": "abc123", "action": "create"}'
|
||||
```
|
||||
|
||||
### Manually Trigger Cron
|
||||
@@ -1308,36 +1569,208 @@ curl -X POST "http://localhost:3111/_console/cron/trigger" \
|
||||
-d '{"function_id": "steps::VMH Beteiligte Sync Cron::trigger::0"}'
|
||||
```
|
||||
|
||||
### View Logs
|
||||
### View and Debug Logs
|
||||
|
||||
**Using iii-cli (recommended):**
|
||||
```bash
|
||||
# Live logs via journalctl
|
||||
journalctl -u motia-iii -f
|
||||
# Live logs (all)
|
||||
iii-cli logs -f
|
||||
|
||||
# Live logs with specific level
|
||||
iii-cli logs -f --level error
|
||||
iii-cli logs -f --level debug
|
||||
|
||||
# Filter by component
|
||||
iii-cli logs -f | grep "document_sync"
|
||||
|
||||
# Worker-specific logs
|
||||
iii-cli worker logs
|
||||
|
||||
# Get specific trace
|
||||
iii-cli trace <trace-id>
|
||||
|
||||
# Filter logs by trace ID
|
||||
iii-cli logs --trace <trace-id>
|
||||
```
|
||||
|
||||
**Using journalctl (production):**
|
||||
```bash
|
||||
# Live logs
|
||||
journalctl -u motia.service -f
|
||||
|
||||
# Search for specific step
|
||||
journalctl --since "today" | grep -i "document sync"
|
||||
journalctl -u motia.service --since "today" | grep -i "document sync"
|
||||
|
||||
# Show errors only
|
||||
journalctl -u motia.service -p err -f
|
||||
|
||||
# Last 100 lines
|
||||
journalctl -u motia.service -n 100
|
||||
|
||||
# Specific time range
|
||||
journalctl -u motia.service --since "2026-03-19 10:00" --until "2026-03-19 11:00"
|
||||
```
|
||||
|
||||
**Using log files (legacy):**
|
||||
```bash
|
||||
# Check for errors
|
||||
tail -100 /opt/motia-iii/bitbylaw/iii_new.log | grep -i error
|
||||
|
||||
# Follow log file
|
||||
tail -f /opt/motia-iii/bitbylaw/iii_new.log
|
||||
```
|
||||
|
||||
### Inspect State and Streams
|
||||
|
||||
**State Management:**
|
||||
```bash
|
||||
# List all state keys
|
||||
iii-cli state ls
|
||||
|
||||
# Get specific state value
|
||||
iii-cli state get document:sync:last_run
|
||||
|
||||
# Set state (if needed for testing)
|
||||
iii-cli state set test:key "test value"
|
||||
|
||||
# Delete state
|
||||
iii-cli state delete test:key
|
||||
```
|
||||
|
||||
**Stream Management:**
|
||||
```bash
|
||||
# List all active streams
|
||||
iii-cli stream ls
|
||||
|
||||
# Inspect specific stream
|
||||
iii-cli stream info <stream-id>
|
||||
|
||||
# List consumer groups
|
||||
iii-cli stream groups <stream-name>
|
||||
```
|
||||
|
||||
### Debugging Workflow
|
||||
|
||||
**1. Identify the Issue:**
|
||||
```bash
|
||||
# Check if step is registered
|
||||
iii-cli flow list | grep my_step
|
||||
|
||||
# View recent errors
|
||||
iii-cli logs --level error -n 50
|
||||
|
||||
# Check service status
|
||||
sudo systemctl status motia.service
|
||||
```
|
||||
|
||||
**2. Get Detailed Information:**
|
||||
```bash
|
||||
# Live tail logs for specific step
|
||||
iii-cli logs -f | grep "document_sync"
|
||||
|
||||
# Check worker processes
|
||||
iii-cli worker logs
|
||||
|
||||
# Inspect state
|
||||
iii-cli state ls
|
||||
```
|
||||
|
||||
**3. Test Specific Functionality:**
|
||||
```bash
|
||||
# Trigger webhook manually
|
||||
curl -X POST http://localhost:3111/vmh/webhook/...
|
||||
|
||||
# Check response and logs
|
||||
iii-cli logs -f | grep "webhook"
|
||||
|
||||
# Verify state changed
|
||||
iii-cli state get entity:sync:status
|
||||
```
|
||||
|
||||
**4. Trace Specific Request:**
|
||||
```bash
|
||||
# Make request, note trace ID from logs
|
||||
curl -X POST http://localhost:3111/vmh/webhook/document/create ...
|
||||
|
||||
# Get full trace
|
||||
iii-cli trace <trace-id>
|
||||
|
||||
# View all logs for this trace
|
||||
iii-cli logs --trace <trace-id>
|
||||
```
|
||||
|
||||
### Performance Monitoring
|
||||
|
||||
**Check System Resources:**
|
||||
```bash
|
||||
# CPU and memory usage
|
||||
htop
|
||||
|
||||
# Process-specific
|
||||
ps aux | grep iii
|
||||
|
||||
# Redis memory
|
||||
redis-cli info memory
|
||||
|
||||
# File descriptors
|
||||
lsof -p $(pgrep -f "iii-cli start")
|
||||
```
|
||||
|
||||
**Check Processing Metrics:**
|
||||
```bash
|
||||
# Queue lengths (if using Redis streams)
|
||||
redis-cli XINFO STREAM vmh:document:sync
|
||||
|
||||
# Pending messages
|
||||
redis-cli XPENDING vmh:document:sync group1
|
||||
|
||||
# Lock status
|
||||
redis-cli KEYS "lock:*"
|
||||
```
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Step not showing up:**
|
||||
1. Check file naming: Must end with `_step.py`
|
||||
2. Check for import errors: `grep -i "importerror\|traceback" iii.log`
|
||||
3. Verify `config` dict is present
|
||||
4. Restart iii engine
|
||||
2. Check for syntax errors: `iii-cli logs --level error`
|
||||
3. Check for import errors: `iii-cli logs | grep -i "importerror\|traceback"`
|
||||
4. Verify `config` dict is present
|
||||
5. Restart: `sudo systemctl restart motia.service` or restart `iii-cli dev`
|
||||
6. Verify hot-reload working: Check terminal output in `iii-cli dev`
|
||||
|
||||
**Redis connection failed:**
|
||||
- Check `REDIS_HOST` and `REDIS_PORT` environment variables
|
||||
- Verify Redis is running: `redis-cli ping`
|
||||
- Check Redis logs: `journalctl -u redis -f`
|
||||
- Service will work without Redis but with warnings
|
||||
|
||||
**Hot-reload not working:**
|
||||
- Verify using `iii-cli dev` (not `iii-cli start`)
|
||||
- Check `watch` patterns in `iii-config.yaml`
|
||||
- Ensure files are in watched directories (`src/**/*.py`)
|
||||
- Look for watcher errors: `iii-cli logs | grep -i "watch"`
|
||||
|
||||
**Handler not triggered:**
|
||||
- Verify endpoint registered: `iii-cli flow list`
|
||||
- Check HTTP method matches (GET, POST, etc.)
|
||||
- Test with curl to isolate issue
|
||||
- Check trigger configuration in step's `config` dict
|
||||
|
||||
**AttributeError '_log' not found:**
|
||||
- Ensure service inherits from `BaseSyncUtils` OR
|
||||
- Implement `_log()` method manually
|
||||
|
||||
**Trace not found:**
|
||||
- Ensure OpenTelemetry enabled in config
|
||||
- Check if trace ID is valid format
|
||||
- Use `iii-cli logs` with filters instead
|
||||
|
||||
**Console not accessible:**
|
||||
- Check if console service running: `systemctl status iii-console.service`
|
||||
- Verify port not blocked by firewall: `sudo ufw status`
|
||||
- Check console logs: `journalctl -u iii-console.service -f`
|
||||
- Try accessing via `localhost:3113` instead of public IP
|
||||
|
||||
---
|
||||
|
||||
## Key Patterns Summary
|
||||
|
||||
@@ -17,7 +17,7 @@ class LangChainXAIService:
|
||||
|
||||
Usage:
|
||||
service = LangChainXAIService(ctx)
|
||||
model = service.get_chat_model(model="grok-2-latest")
|
||||
model = service.get_chat_model(model="grok-4-1-fast-reasoning")
|
||||
model_with_tools = service.bind_file_search(model, collection_id)
|
||||
result = await service.invoke_chat(model_with_tools, messages)
|
||||
"""
|
||||
@@ -46,7 +46,7 @@ class LangChainXAIService:
|
||||
|
||||
def get_chat_model(
|
||||
self,
|
||||
model: str = "grok-2-latest",
|
||||
model: str = "grok-4-1-fast-reasoning",
|
||||
temperature: float = 0.7,
|
||||
max_tokens: Optional[int] = None
|
||||
):
|
||||
@@ -54,7 +54,7 @@ class LangChainXAIService:
|
||||
Initialisiert ChatXAI Model.
|
||||
|
||||
Args:
|
||||
model: Model name (default: grok-2-latest)
|
||||
model: Model name (default: grok-4-1-fast-reasoning)
|
||||
temperature: Sampling temperature 0.0-1.0
|
||||
max_tokens: Optional max tokens for response
|
||||
|
||||
|
||||
@@ -317,6 +317,18 @@ async def invoke_and_format_response(
|
||||
"total_tokens": getattr(u, 'input_tokens', 0) + getattr(u, 'output_tokens', 0)
|
||||
}
|
||||
|
||||
# Log complete LLM response
|
||||
ctx.logger.info("=" * 80)
|
||||
ctx.logger.info("📤 LLM RESPONSE")
|
||||
ctx.logger.info("-" * 80)
|
||||
ctx.logger.info(f"Model: {model_name}")
|
||||
ctx.logger.info(f"Completion ID: {completion_id}")
|
||||
ctx.logger.info(f"Usage: {usage['prompt_tokens']} prompt + {usage['completion_tokens']} completion = {usage['total_tokens']} total tokens")
|
||||
ctx.logger.info("-" * 80)
|
||||
ctx.logger.info("Content:")
|
||||
ctx.logger.info(content)
|
||||
ctx.logger.info("=" * 80)
|
||||
|
||||
# Format OpenAI-compatible response
|
||||
response_body = {
|
||||
'id': completion_id,
|
||||
Reference in New Issue
Block a user