feat: include error message in HaystackError telemetry events

[vblagoje]

Related Issues

• related to Use telemetry to identify most common errors #3309

Proposed Changes:

Added a message field to all HaystackError(s) raised. If set message property will be visible in telemetry

How did you test it?

Manual verification, there is no other way.

Notes for the reviewer

Someone familiar with telemetry needs to review. Otherwise, the context is rather big and requires time to pick up.

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 tests that demonstrate the correct behavior of the change
• I've used the conventional commit convention for my PR title
• I documented my code
• I ran pre-commit hooks and fixed any issue

[julian-risch]

@vblagoje I committed the small changes that we discussed. In addition, one could add the send_message_in_event parameter also to FilterError with default None. That would allow to raise a FilterError and explicitly turn on send_message_in_event to send the message in the telemetry event if that is needed somewhere in Haystack. However, I don't see a need for that at the moment and therefore I didn't include it. Please also review the changes and if you approve them too that this is ready to be merged. 👍

[julian-risch]

LGTM! 👍 @vblagoje please also review the changes, thank you. Feel free to merge when you are done with your review.

[vblagoje]

Yes, LGTM as well. If CI is green, let's integrate it!