-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Edit haproxy module docs #3216
Edit haproxy module docs #3216
Conversation
@dedemorton The description is exactly the one available under the 9.1 section, and I will leave it as it is. I think what makes it unclear is that the description is not complete. For example,
|
@monicasarbu I understand that the value of Can you also comment on the edit that I proposed for
My proposed change tries to clarify this ambiguity: "Number of requests that encountered an error trying to connect to a server. For backends, this field reports the number of connection errors for all backend servers, plus any connection errors not associated with a particular server (such as the backend having no active servers)." |
@dedemorton Yes, the suggestion is good, just a small change:
|
@monicasarbu Thanks. I'll fix the description of What does the |
…3312, #3331, #3336) (#3345) * Edit haproxy module docs * Add fixes from review feedback * Fix broken Edit links * Clarify when registry file is updated in docs (#3274) See #3220 (comment) * Update close_timeout docs (#3320) Clarified close_timeout when there are updates to the file. * Fix typo in regexp Should be `regexp` and not `reqexp` * Fix a couple of typos and a broken link * Change "versions" to "supported_protocols" (#3336) Urso pointed out during the Heartbeat review that this name is wrong.
…3331, #3336) (#3347) * Edit haproxy module docs * Add fixes from review feedback * Fix broken Edit links * Update close_timeout docs (#3320) Clarified close_timeout when there are updates to the file. * Fix typo in regexp Should be `regexp` and not `reqexp` * Fix a couple of typos and a broken link * Change "versions" to "supported_protocols" (#3336) Urso pointed out during the Heartbeat review that this name is wrong.
…lastic#3320, elastic#3312, elastic#3331, elastic#3336) (elastic#3347) * Edit haproxy module docs * Add fixes from review feedback * Fix broken Edit links * Update close_timeout docs (elastic#3320) Clarified close_timeout when there are updates to the file. * Fix typo in regexp Should be `regexp` and not `reqexp` * Fix a couple of typos and a broken link * Change "versions" to "supported_protocols" (elastic#3336) Urso pointed out during the Heartbeat review that this name is wrong.
…lastic#3274, elastic#3320, elastic#3312, elastic#3331, elastic#3336) (elastic#3345) * Edit haproxy module docs * Add fixes from review feedback * Fix broken Edit links * Clarify when registry file is updated in docs (elastic#3274) See elastic#3220 (comment) * Update close_timeout docs (elastic#3320) Clarified close_timeout when there are updates to the file. * Fix typo in regexp Should be `regexp` and not `reqexp` * Fix a couple of typos and a broken link * Change "versions" to "supported_protocols" (elastic#3336) Urso pointed out during the Heartbeat review that this name is wrong.
Edits for HAProxy docs (what's there...there are still a bunch of field descriptions that are missing).
The field descriptions in the original doc are ambiguous, so please check my edits carefully to make sure I haven't inadvertently changed the meaning. I couldn't figure out what to do with a couple of the descriptions:
connection.errors: The description of this field is: "Number of requests that encountered an error trying to connect to a backend server. The backend stat is the sum of the stat for all servers of that backend, plus any connection errors not associated with a particular server (such as the backend having no active servers)." Does this edit work? "Number of requests that encountered an error trying to connect to a server. For backends, this field reports the number of connection errors for all backend servers, plus any connection errors not associated with a particular server (such as the backend having no active servers)."
server.active: The description of this field is: "Number of active servers (backend), server is active (server)." So, if the component type is a server, what value does this field contain to indicate it's an active server?
server.backup: The description of this field is: "Number of backup servers (backend), server is backup (server)." So, if the component type is server, what value does this field contain to indicate that it's a backup server? For this and the previous field, I'm making some assumptions about what the descriptions mean. It's pretty ambiguous in the HAProxy docs.
I've added some extra line breaks to get the bulleted lists to format correctly, but for some reason, the fix doesn't work for the that's generated under haproxy.stat.response.errors. What the heck? How can I fix this? Is it OK for me to add the blank lines?