azure-functions-host icon indicating copy to clipboard operation
azure-functions-host copied to clipboard

Log the "durableTask" section of host.json on host startup

Open cgillum opened this issue 5 years ago • 2 comments

What problem would the feature you're requesting solve? Please describe.

I'm trying to investigate issues related to Durable Functions and I'm not able to see the host.json configuration values that the customer supplied.

Describe the solution you'd like

I would like to see the durableTask section of host.json included in the host.json logging. This will make diagnosing issues related misconfiguration easier.

Describe alternatives you've considered

Alternatively the Durable extension could dump the host.json information it sees. However, there are a few issues with this:

  • It can only dump information that it sees. If a customer applies config to a misnamed section, then we probably won't see it and can't log it.
  • This won't help customers who are using previous versions of our extension since we don't force them to upgrade.
  • It would be ideal if the host.json configuration log consistently provided all host.json settings instead of relying on extension authors to do this.

Additional context

N/A

cgillum avatar Dec 27 '19 18:12 cgillum

Thanks for opening @cgillum - this looks like a relatively simple change to whitelist the durableTask section here.

Could you confirm that this section doesn't have any sensitive information? (ex: eventGridTopicEndpoint).

mhoeger avatar Dec 30 '19 22:12 mhoeger

Hey @mhoeger, great to hear that this is a simple change! Yes, I can confirm that this section will not have any secrets or PII (I assume that's the criteria - let me know if it's more restrictive than this). In the case of event grid publishing, the user specifies the key using a keySettingName property documented here, which is just the name of an app setting.

cgillum avatar Dec 30 '19 23:12 cgillum