Whenever I can get away with it, I include basic troubleshooting information in the footer of my web applications. So it isn’t distracting (or blatantly exposed) to the standard user, the text is hidden. In other words, I make the font color the same as the background color so the text is only visible when selected.
The hidden text is intended to give the developer basic information about the logged-in user, server and build as well as enough information to link the user’s session back to more detailed logs.
So, prior to a release to the Test Environment, I share the location of the hidden text with the QA
and UAT groups and request they include the information when writing up defects. And once the application rolls to the Production Environment, the Help Desk and Stability Groups begin to leverage the information as well.
Even though the information is “hidden,” I am very particular/careful when it comes to the troubleshooting information which I present. As a general rule, I only include information which would be harmless if “found” by anyone — including future auditors. I use this technique with caution, but I do use it whenever I can. I’ve found this “trick” very handy over the years and maybe now you will too.
Do you have any troubleshooting tips which can be shared?