Add FOG_DEBUG env var and distinguish different providers
#185
Conversation
Co-authored-by: Wei Quan <[email protected]>
|
We have created an issue in Pivotal Tracker to manage this: https://www.pivotaltracker.com/story/show/175393470 The labels on this github issue will be updated when the story is started. |
|
|
|
EXCON_DEBUG was removed because it leaks S3 credentials. As a consequence, there are no debug logs on AWS when setting log_fog_requests to true. Maybe this can be addressed with newer fog-aws versions based on the FOG_DEBUG value that was added to fog-core. |
| config["env"]["FOG_DEBUG"] = true | ||
| config["env"]["DEBUG"] = true | ||
| else | ||
| config["env"]["DEBUG"] = true |
There was a problem hiding this comment.
Is DEBUG redundant with the addition of the FOG_DEBUG variable? From looking at this commit, it seems like FOG_DEBUG doesn't actually introduce new debug information? Or does it depend on the specific blobstore provider gem?
There was a problem hiding this comment.
Eventually, DEBUG will be redundant and can be removed. But FOG_DEBUG was introduced in fog-core just recently and is not yet released as far as I can see. Therefore I would stick with setting both FOG_DEBUG and DEBUG with the exception of Azure.
On Azure, setting DEBUG leads to full request/response logging including sensitive information and response bodies so we can't use DEBUG. FOG_DEBUG is handled in fog-azure-rm (branch fog-arm-cf) explicitly.
| when "azurerm" | ||
| config["env"]["FOG_DEBUG"] = true | ||
| when "aliyun" | ||
| config["env"]["ALIYUN_OSS_SDK_LOG_LEVEL"] = "debug" |
There was a problem hiding this comment.
Can you provide where this env variable is documented? Not seeing anything about it in fog-aliyun.
There was a problem hiding this comment.
The env var of fog-aliyun is not documented. We got it from:https://github.com/aliyun/aliyun-oss-ruby-sdk/blob/d0a02321bf53798525d17f1c53ed780c2fe7437b/lib/aliyun/common/logging.rb#L47
We've also tested it on our landscape, there were no problem.
Thanks for contributing to the
capi_release. To speed up the process of reviewing your pull request please provide us with:Add
FOG_DEBUGenvironment variable and add switch expression for different providersAdd additional
FOG_DEBUGenvironment variable for Azure blobstore(fog-azure-rm changes: add fog debug var fog/fog-azure-rm#431)Add switch expression to set different environment variables for different blobstore provider. Without this sensitive information could be leaked in the logs(i.g. when "DEBUG" is enabled on azure)
We also added a simple unit test for the bpm templating. Let us know if this can be done in a nicer way 🙃
I have viewed signed and have submitted the Contributor License Agreement
I have made this pull request to the
developbranchI have run CF Acceptance Tests on bosh lite