[WIP] Add rough draft of configuration options documentation #373
Conversation
|
|
||
| ## async_handler | ||
|
|
||
| If `config.use_async = true` explicitly sets the function used to send |
There was a problem hiding this comment.
The object passed to this option should respond to #call and receive the payload. Examples in lib/rollbar/delay/.
|
Nice work @Crisfole 😄. I just wrote some inline comments in the docs. |
| ## scrub_password | ||
|
|
||
| TODO: CORRECT THIS | ||
|
|
There was a problem hiding this comment.
These values should be boolean and the purpose is what you have already there.
When scrubbing the URL, we scrub or not the user/password. By default true.
So, scrubbing URLs, we always scrub the query string, and the user and password is configurable. We'll scrub by default those.
There was a problem hiding this comment.
Who sends their password in the URL!? Or does this scrub access tokens too?
That's not hidden by HTTPS...If they're sending the password in plaintext in the URL they've got bigger problems that us recording it in Rollbar!
|
I'm still not 100% certain I have all this right.
|
|
@Crisfole if Instead of this, there is some delayed_job data to be sent or not. We can disabled it with |
|
@jondeandres what sort of metadata are we talking? |
|
@Crisfole job class, queue... |
|
|
||
| ### branch | ||
|
|
||
| **Default** "master" |
There was a problem hiding this comment.
Looking at our code I cannot see a default master value for this.
There was a problem hiding this comment.
The default is master on the server side.
There was a problem hiding this comment.
I'll toss it anyway.
| **Default** `false` | ||
|
|
||
| When `true` indicates you wish to send data to Rollbar asynchronously. If | ||
| installed, uses `girl_friday`, otherwise defaults to `Threading`. |
There was a problem hiding this comment.
If you use the ` characters you should use existing methods, constants, etc...
In ruby Threading is not a constant and doesn't exist in the core library, use Thread instead.
There was a problem hiding this comment.
Oops, didn't know the name of ruby's Thread implementation, just sort of typed stuff in.
|
@jondeandres All set, I believe. |
[WIP] Add rough draft of configuration options documentation
@jondeandres @brianr
This is a first pass at each one. I stuck a few
TODOwhere I was extremely uncertain, and it's not organized the way I want yet (see the TODO at the top).