Skip to content

Commit e53b549

Browse files
authored
docs: add Quickwit log exploration documentation (#467)
- Fix API path prefix (/v1/ -> /api/v1/) in quickwit-integration.md and skill.md - Add Quickwit troubleshooting section to user guide - Create comprehensive quickwit-log-exploration.md guide - Document pre-configured "Quickwit Logs" role in CLAUDE.md - Update documentation links - Fix secret detection false positive in skill.md Fixes outdated API paths that caused "Route not found" errors. Provides complete guidance for log exploration workflows.
1 parent b699086 commit e53b549

5 files changed

Lines changed: 465 additions & 7 deletions

File tree

CLAUDE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -729,8 +729,26 @@ terraphim-agent --config quickwit_production_config.json
729729
/search "level:ERROR AND service:api AND timestamp:[2024-01-13T10:00:00Z TO *]"
730730
```
731731

732+
**Pre-configured Role:**
733+
734+
The "Quickwit Logs" role is available in `terraphim_server/default/terraphim_engineer_config.json`:
735+
- Auto-discovery mode (searches all available indexes)
736+
- BM25 relevance function for text matching
737+
- LLM summarization disabled (faster results for log analysis)
738+
- Dark theme (darkly) optimized for log viewing
739+
- Specialized system prompt for log analysis
740+
741+
Use for quick log exploration:
742+
```bash
743+
terraphim-agent
744+
# In REPL, switch to Quickwit Logs role
745+
/role QuickwitLogs
746+
/search "level:ERROR"
747+
```
748+
732749
**Documentation:**
733750
- User Guide: `docs/quickwit-integration.md`
751+
- Log Exploration: `docs/user-guide/quickwit-log-exploration.md`
734752
- Example: `examples/quickwit-log-search.md`
735753
- Skill: `skills/quickwit-search/skill.md`
736754
- Configs: `terraphim_server/default/quickwit_*.json`

docs/quickwit-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ Search multiple specific indexes:
261261
### No Results
262262

263263
**Possible causes:**
264-
1. Index is empty - verify with: `curl http://localhost:7280/v1/{index}/search?query=*`
264+
1. Index is empty - verify with: `curl http://localhost:7280/api/v1/{index}/search?query=*`
265265
2. Query doesn't match any logs
266266
3. Auto-discovery found no indexes - check logs for warnings
267267

@@ -270,7 +270,7 @@ Search multiple specific indexes:
270270
**Error:** "No indexes discovered"
271271

272272
**Solutions:**
273-
1. Verify `/v1/indexes` endpoint works: `curl http://localhost:7280/v1/indexes`
273+
1. Verify `/api/v1/indexes` endpoint works: `curl http://localhost:7280/api/v1/indexes`
274274
2. Check authentication if required
275275
3. Try explicit `default_index` instead
276276

0 commit comments

Comments
 (0)