.NET Documentation Suggestion
fujiiface
Posted on
Jun 17 2014
This is just a suggestion. Unless something flew right over my head, I noticed the documentation for excluding specific form fields on the website is a little generic and leaves some questions. You can experiment to figure out what does and does not work but it might save some time and be more helpful to just spell it out in the documentation.
Under the Remove sensitive request data section you have Web.config settings and a programmatic API example.
<RaygunSettings apikey="your_apikey" ignoreFormDataNames="password,creditcard,cv2" />
For the Web.config example above, how does the ignoreFormDataNames list work? Using "password" as an example, does that work for server controls and their dynamic names or is that strictly an HTML ID, input type, etc.?
For the programmatic API, you have the following code sample:
raygunClient.IgnoreFormDataNames(new List() { "SensitiveKey1", "SomeCreditCardData"});
I eventually figured this out during off and on testing but it would have saved time to just know that the form controls' UniqueID was being used. I mistakenly thought the ClientID was being used since that's what I use in my JavaScript. It is my suggestion that the documentation show the programmatic API as the following unless different types of ID formats can be used:
raygunClient.IgnoreFormDataNames(new List() { "SensitiveKey1", SensitiveFormField.UniqueID });
Thank you for making a great product! This is an extremely helpful service that everyone should be using.
Callum
Posted on
Jul 04 2014
Thanks for your comments and suggestions, a new version of Raygun4NET has been released, v3.0, which contains new APIs for fine-grained filtering of the four sensitive data collections which should clear up any confusion around what the methods do. The docs have also been updated to reflect this, particularly the collections it affects.
We hope that this improves your Raygun experience - any more queries let us know.
Regards,
Callum Gavin
Mindscape Limited