elsa-workflows / elsa-workflows/elsa-core

To avoid excess log noise, app admins should not see many Elsa log messages at 'high importance' log levels

Open
#736 1 comment 2 reactions 0 assignees View on GitHub
core enhancement prio low triaged
Dominant language
C#
Stars
7.9k
Forks
1.5k
Avg merge
15h 22m
Merged PRs (30d)
114

Description

Whilst working with Elsa recently, I've noticed that it records a lot of its log messages at quite 'high importance' log levels. By 'high importance' I mean levels such as INFO, WARN, ERROR etc.

I read a really good article about logging some time ago, with which I agree. Frustratingly, I can't seem to find it anymore. What it was saying was something like this:

> When developing a framework or library which is designed to be consumed by another application, try to write log messages with the consumer of the library in mind. Whilst the library-writer might think of a particular message as an INFO message, would the administrator/developer of the consuming application think of that as an INFO message? Usually the people developing/administering the consuming application would think of those messages at a lower importance than the developer of the library itself.

So - my suggestion in this issue is to revisit the importance levels at which messages are logged. I think that we should make more use of TRACE and DEBUG, and levels like INFO more sparingly.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.