Document username/password options for HTTP based modules #7134
Conversation
tsg
added
docs
needs_backport
tsg
force-pushed
the
document_user_password_for_http_modules
branch
from
7969d63 to
29c7c92
Compare
| @@ -200,3 +200,19 @@ A list of processors to apply to the data generated by the metricset. | |||
| See <<filtering-and-enhancing-data>> for information about specifying | |||
| processors in your config. | |||
|
|
|||
| [float] | |||
| [[module-http-config-options]] | |||
| === Standard HTTP config options | |||
There was a problem hiding this comment.
I wonder if we should just copy SSL settings here too, as both things are supported by the same helper
There was a problem hiding this comment.
I'm curious what @dedemorton thinks of this. Perhaps a fragment that we include in both (or multiple) places?
There was a problem hiding this comment.
@tsg Thank you for doing this! Right now, I agree that the user experience is not ideal (there's a lot of jumping around to find the full list of config options). Rather than pointing to another topic, I'd prefer to use an include to pull in any common (shared) options. To make this work, we'll need to add an attribute to the docs for each module (something like :modulename: modulename) and then use that attribute in the ID for shared sections. Do you want me to do that? This has been low down on my to-do list for awhile; I can bump the priority.
There was a problem hiding this comment.
...and looking at my notes, I see that the current design (pointing off to options) has resulted in problems for users in other areas (like not knowing that processors are valid in the config).
There was a problem hiding this comment.
I have this as a to-do item in a meta issue, but I've created a real issue to track the work: #7160
This adds commented out `username` and `password` settings to most of the config places where they are supported (this part is manual). Since those configs are included in the docs, they also show up there. This also adds a line in the docs that link to "HTTP specific settings" (this part is automatised during `make update`). Completes elastic#4268 and closes elastic#6493.
tsg
force-pushed
the
document_user_password_for_http_modules
branch
from
29c7c92 to
44231f2
Compare
|
I'm ok with merging this one, we can find a long-term solution later on |
This adds commented out `username` and `password` settings to most of the config places where they are supported (this part is manual). Since those configs are included in the docs, they also show up there. This also adds a line in the docs that link to "HTTP specific settings" (this part is automatised during `make update`). Completes elastic#4268 and closes elastic#6493. (cherry picked from commit 0a85fce)
tsg
added
v6.3.1
and removed
needs_backport
… based modules (#7330) Add commented out `username` and `password` settings to most of the config places where they are supported (this part is manual). Since those configs are included in the docs, they also show up there. This also adds a line in the docs that link to "HTTP specific settings" (this part is automatised during `make update`). Completes #4268 and closes #6493.
…or HTTP based modules (elastic#7330) Add commented out `username` and `password` settings to most of the config places where they are supported (this part is manual). Since those configs are included in the docs, they also show up there. This also adds a line in the docs that link to "HTTP specific settings" (this part is automatised during `make update`). Completes elastic#4268 and closes elastic#6493.
This adds commented out
usernameandpasswordsettings to mostof the config places where they are supported (this part is manual).
Since those configs are included in the docs, they also show up there.
This also adds a line in the docs that link to "HTTP specific settings"
(this part is automatised during
make update).Completes #4268 and closes #6493.