[Question]: Can we prevent Result from Logging even if Debug is turned on?

[chris-a-hammons]

What are you wanting to achieve?

Is there a way to be able to not allow logging of Result even if the log level debug/trace is turned on?

I generally worry about logging Results from any library since it could easily contain an object or string with Sensitive data. We cannot rely on Debug being turned off since support and developers can escalate logging in our system.

What code or approach do you have so far?

I have been looking at code, but cannot identify a way to be able to do what I am asking.

Additional context

No response

[martincostello]

Does #2072 solve this for you? (Added in 8.4.0)

[chris-a-hammons]

@martincostello I do not believe so that ticket is meant to change the Severity/Loglevel, not make sure that the value of Result is Never logged. For example we have a Polly that ends up with a string that is JWT token which I NEVER want logged even if Debug is turned on. It is currently logging the JWT token in the Result.

[martincostello]

OK, in that case my initial two suggestions are:

1. Add a log filter in your code to find such log messages and run your own filtering logic
2. Look into using log redaction to do the same

[josh-oakes]

I'm looking into the log filter and log redaction options here, but I was curious if there are any plans to allow some fine grained control over the telemetry? I've also run into a scenario where we added polly for retries on retrieving secrets from AWS secrets manager, I was a bit surprised to see those in my logs.

[martincostello]

We've done some customisation in the past, but as you can imagine the more options we give users, the more complicated our codebase gets.

I'm open to providing some options where there's sustainable/reasonable requests with broad applicability, but very laser-focused changes for specific user-cases aren't immediate "no-brainers" for us to react to and implement.

I'm happy to leave this open to collect additional feedback from the wider community or a more detailed use case on why this is "really really" needed.

Thanks for your understanding.

[github-actions]

This issue is stale because it has been open for 60 days with no activity. It will be automatically closed in 14 days if no further updates are made.

[github-actions]

This issue was closed because it has been inactive for 14 days since being marked as stale.

[giulianob]

FYI for anyone else that comes across this issue. You can also override TelemetryOptions.ResultFormatter to customize the value that gets logged:

Polly/src/Polly.Extensions/Telemetry/TelemetryOptions.cs

Line 69 in 8ba1e3b

public Func<ResilienceContext, object?, object?> ResultFormatter { get; set; } = (_, result) => result switch