docs(log) http-log authentication and retries logging #408
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Tieske
force-pushed
the
docs/retries-log
branch
from
c6bc0e4 to
fc85974
Compare
p0pr0ck5
reviewed
Apr 28, 2017
| @@ -77,9 +77,21 @@ Every request will be logged separately in a JSON object separated by a new line | |||
| "access-control-allow-origin": "*" | |||
| } | |||
| }, | |||
| "tries": [ | |||
There was a problem hiding this comment.
this is valid for the file-log plugin?
There was a problem hiding this comment.
Curious: why not? It should use the same serializer as the other ones, so yes. Maybe your understanding of the file-log plugin is that it doesn't log requests/response info?
There was a problem hiding this comment.
Yep, misread this. Thought this had to do with the log plugin retrying, not the retries in the serialized data. My bad!
theetrain
reviewed
Apr 28, 2017
app/plugins/http-log.md
Outdated
| @@ -40,11 +40,15 @@ form parameter | default | description | |||
| --- | --- | --- | |||
| `name` | | The name of the plugin to use, in this case: `http-log` | |||
| `consumer_id`<br>*optional* | | The CONSUMER ID that this plugin configuration will target. This value can only be used if [authentication has been enabled][faq-authentication] so that the system can identify the user making the request. | |||
| `config.http_endpoint` | | The HTTP endpoint (including the protocol to use) where to send the data to | |||
| `config.http_endpoint` | | The HTTP endpoint (including the protocol to use) where to send the data to. | |||
There was a problem hiding this comment.
The HTTP endpoint (including the protocol)
to which the data will be sent.
thibaultcha
requested changes
Apr 29, 2017
app/plugins/http-log.md
Outdated
| `config.method`<br>*optional* | `POST` | An optional method used to send data to the http server, other supported values are PUT, PATCH | ||
| `config.timeout`<br>*optional* | `10000` | An optional timeout in milliseconds when sending data to the upstream server | ||
| `config.keepalive`<br>*optional*| `60000` | An optional value in milliseconds that defines for how long an idle connection will live before being closed | ||
|
|
||
| **NOTE:** If the `config.http_endpoint` contains a username and password, then |
There was a problem hiding this comment.
I think we should make clear where exactly in the URL that username and password should be to be taken into consideration:
contains a username and password in the authentication section of the URL.
Ex: http://bob:[email protected]/logs
app/plugins/file-log.md
Outdated
| @@ -112,6 +124,7 @@ A few considerations on the above JSON object: | |||
|
|
|||
| * `request` contains properties about the request sent by the client | |||
| * `response` contains properties about the response sent to the client | |||
| * `tries` contains the information of the successive (re)tries, the upstream address and failure information | |||
There was a problem hiding this comment.
I think a bit more context here wouldn't hurt:
contains the list of (re)tries (successes and failures) made by
the load balancer for this request
Deals with Kong issue 2429: logging retries and failure info and 2430 for adding a basic auth header with the http log plugin
Tieske
force-pushed
the
docs/retries-log
branch
from
fc85974 to
d7be0cb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deals with Kong issue Kong/kong#2429: logging retries and failure info
and Kong/kong#2430 for adding a basic auth header with the http log plugin
This documents the additional changes in Kong/kong#2467.