fix: don't break on IndexError in logging

[tstadel]

Related Issues

• fixes haystack logging raising another error when logging exceptions

We've seen this for a production pipeline:

IndexError: Replacement index 0 out of range for positional args tuple

Here's the logline that caused this error:

except Exception as e:
            logger.error(
                f"Component {component.__class__.__name__} with prefix '{prefix}' failed with exception: {str(e)}",
                exc_info=True,
            )

relevant stacktrace:

  File "/home/haystackd/.local/lib/python3.12/site-packages/haystack/logging.py", line 144, in _log_only_with_kwargs
    return func(
           ^^^^^
  File "/home/haystackd/.pyenv/versions/3.12.8/lib/python3.12/logging/__init__.py", line 1568, in error
    self._log(ERROR, msg, args, **kwargs)
  File "/home/haystackd/.pyenv/versions/3.12.8/lib/python3.12/logging/__init__.py", line 1682, in _log
    record = self.makeRecord(self.name, level, fn, lno, msg, args,
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/haystackd/.local/lib/python3.12/site-packages/haystack/logging.py", line 194, in _wrapper
    interpolated_msg = msg.format(**safe_extra)
                       ^^^^^^^^^^^^^^^^^^^^^^^^
IndexError: Replacement index 0 out of range for positional args tuple

Proposed Changes:

• catch IndexError

How did you test it?

Notes for the reviewer

• a general catch all would be even safer I guess

Checklist

• I have read the contributors guidelines and the code of conduct
• I have updated the related issue with new insights and changes
• I added unit tests and updated the docstrings
• I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
• I documented my code
• I ran pre-commit hooks and fixed any issue

[coveralls]

Pull Request Test Coverage Report for Build 13946181933

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 90.068%

---

Totals
Change from base Build 13945256266:	0.0%
Covered Lines:	9740
Relevant Lines:	10814

---

💛 - Coveralls

[julian-risch]

LGTM! 👍