518b8eca85
md-first memory extraction framework for AI agents. Markdown is the single source of truth; SQLite holds state and LanceDB provides the rebuildable vector + BM25 + scalar index. The codebase follows a single-direction DDD layering (entrypoints -> service -> memory -> infra, with component / core / config cross-cutting) enforced by import-linter. Engineering surface: - Coding conventions in .claude/rules/ (path-scoped) and workflows in .claude/skills/ (/commit, /new-branch, /pr). - GitHub Actions CI runs make lint + test + integration; pre-commit mirrors the gates locally (ruff, hygiene hooks, gitlint commit-msg). - Commit messages follow Conventional Commits, enforced by gitlint. - make lint also enforces datetime two-zone discipline and OpenAPI drift.
24 lines
970 B
Markdown
24 lines
970 B
Markdown
---
|
|
paths:
|
|
- "src/**/*.py"
|
|
---
|
|
|
|
# Logging & observability rule
|
|
|
|
- **Use the project logger**, never `print` or the stdlib `logging` directly:
|
|
```python
|
|
from everos.core.observability.logging import get_logger
|
|
logger = get_logger(__name__)
|
|
```
|
|
- **Structured logging** (`structlog`): pass context as keyword fields, not f-strings.
|
|
```python
|
|
logger.info("memory.search.completed", owner_type=owner, n_results=len(items))
|
|
```
|
|
Event name first (dotted, stable), structured kwargs after. This keeps logs
|
|
queryable and avoids leaking interpolated PII into the message string.
|
|
- **Levels**: `debug` for developer detail, `info` for lifecycle milestones,
|
|
`warning` for recoverable anomalies, `error` for failures with a stack/context.
|
|
- **Metrics** go through `core.observability.metrics` (Prometheus); don't invent
|
|
ad-hoc counters. Histograms/counters/gauges have registry helpers.
|
|
- Don't log secrets, API keys, or full memory content at `info`/above.
|