Skip to content

feat: add structured logging across pipeline stages - #80

Merged
adaumsilva merged 6 commits into
adaumsilva:mainfrom
Ahaway1st:feat/structured-logging
Sep 27, 2026
Merged

adaumsilva merged 6 commits into
adaumsilva:mainfrom
Ahaway1st:feat/structured-logging

Conversation

@Ahaway1st

Copy link
Copy Markdown
Contributor

Description

Add structured logging across pipeline ingest, query, and retriever stages so users can observe document processing, retrieval, generation timings, and empty-ingest conditions.

Closes #41

Changes

  • Add a NullHandler to the package-level ragframework logger.
  • Add INFO summaries for ingest and query stages, including retrieval, embedding, and generation timings.
  • Add a WARNING when a source produces no chunks.
  • Add DEBUG logging for count and embedding dimension when adding chunks to the InMemory, FAISS, and Chroma retrievers.
  • Add caplog tests for pipeline, retriever, and package logging behavior.
  • Document how to enable logging and update the changelog.

Type of change

  • [ ] Bug fix
  • [ x ] New feature / integration
  • [ x ] Documentation update
  • [ ] Refactor / code quality

Checklist

  • [ x ] pytest tests/ -v passes locally
  • [ x ] ruff check ragframework/ passes
  • [ x ] mypy ragframework/ passes
  • [ x ] New or updated tests cover the changes
  • [ x ] Optional dependencies are guarded with a helpful import error
  • [ x ] Docstrings updated where applicable
  • [ x ] CHANGELOG.md updated under [Unreleased]

@adaumsilva
adaumsilva merged commit 98bb273 into adaumsilva:main Sep 27, 2026
4 checks passed
@adaumsilva

Copy link
Copy Markdown
Owner

Good job @Ahaway1st Thanks for contributing. PR Merged. Remember to star the repo if you didn't yet.

@Ahaway1st
Ahaway1st deleted the feat/structured-logging branch September 28, 2026 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add structured logging across pipeline stages

2 participants