Does logging a string information fall under magic strings?

Question

I would like to know a base thing.

_logger.LogInformation("Hi, Am I magic string?");

In the above line, does the string fall under magic string?

Any hardcoded validation/action against a response/return is considered a "magic string" to me. (Eg: _config["EmailTo"] should be _config.EmailTo, if(list.contains("error")) should be if(list.contains(errorValue))

Appreciate your thoughts!

In computer programming, a magic string is an input that a programmer believes will never come externally and which activates otherwise hidden functionality. — TheGeneral, May 31 '19 at 04:19
@TheGeneral He meant the “magic” as in “magic numbers.” — Константин Ван, May 31 '19 at 04:20
A log entry would never be considered a magic string, it has no procedural importance and its only static nature is the text for the consumption of the developer — TheGeneral, May 31 '19 at 04:22
_Magic_ stuff is _magic_ because it’s not descriptive and haphazard. Such a string in question is descriptive, doesn’t affect the code flow, and doesn’t confuse your friends, ―not magic. — Константин Ван, May 31 '19 at 04:34
@TheGeneral Spoken like a dev that's never had to parse IIS logs. — Kenneth K., May 31 '19 at 13:39

Emond · Accepted Answer · 2019-05-31T13:29:17.000

Magic exists when the audience expects one thing but sees another.

If there is any system that reads the log file and tries to interpret it and then take some action this string has become a contract/magic because changing it will confuse that system.

A good rule of thumb is to never parse logs unless there are well defined and guarded standards for the log. Parsing strings is not one of them in my opinion and experience. Error numbers are much better/safer.

Does logging a string information fall under magic strings?

1 Answers1