Explanations required for this rule.

[franckleveque]

[Enter feedback here] Hi,

It would be great to have an explanation on WHY this rule is in effect, I understand that positional parameter can be harmful in lengthy log message but not in short ones. So I don't really understand why I should force named parameter when I have only three parameters in my log.

ie : this.logger.LogInformation("Cache entry {0}_{1} exists : {2}", CacheId, requestId, result);

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 03da1d8e-6ed0-df80-4ae3-e5a04048cfcc
• Version Independent ID: 91a91bf7-90e8-4d62-2c2d-43eaef69db77
• Content: CA2253: Named placeholders should not be numeric values - .NET
• Content Source: docs/fundamentals/code-analysis/quality-rules/ca2253.md
• Product: dotnet-fundamentals
• GitHub Login: @Youssef1313
• Microsoft Alias: gewarren

[gewarren]

@franckleveque I assume this is for the same reason that CA2254 exists:

When performing logging, it's desirable to preserve the structure of the log (including placeholder names) along with the placeholder values. Preserving this information allows for better observability and search in log aggregation and monitoring software.

That is, having a number for the key doesn't lend itself well to observability and searching in logs.

@Youssef1313 @maryamariyan If you agree, we can add this info to the article.