Add documentation

This commit is contained in:
Anish Ramasekar 2018-01-29 22:05:38 -06:00
parent bf60d93c30
commit 4bc46c022a
No known key found for this signature in database
GPG key ID: 649FAC6DAB39EA54
3 changed files with 9 additions and 4 deletions

View file

@ -127,6 +127,7 @@ The following table shows a configuration option's name, type, and the default v
|[limit‑rate‑after](#limit-rate-after)|int|0|
|[http‑redirect‑code](#http-redirect-code)|int|308|
|[proxy‑buffering](#proxy-buffering)|string|"off"|
|[limit‑request‑status‑code](#limit-request-status-code)|int|503|
## add-headers
@ -703,3 +704,7 @@ Why the default code is 308?
## proxy-buffering
Enables or disables [buffering of responses from the proxied server](http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering).
## limit-request-status-code
Sets the [status code to return in response to rejected requests](http://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_status).Default: 503

View file

@ -471,7 +471,7 @@ type Configuration struct {
// LargeClientHeaderBuffers Sets the status code to return in response to rejected requests.
// http://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_status
// Default: 503
LimitReqStatus string `json:"limit-req-status"`
LimitReqStatusCode int `json:"limit-req-status-code"`
}
// NewDefault returns the default nginx configuration
@ -565,7 +565,7 @@ func NewDefault() Configuration {
JaegerServiceName: "nginx",
JaegerSamplerType: "const",
JaegerSamplerParam: "1",
LimitReqStatus: "503",
LimitReqStatusCode: 503,
}
if glog.V(5) {

View file

@ -102,7 +102,7 @@ http {
underscores_in_headers {{ if $cfg.EnableUnderscoresInHeaders }}on{{ else }}off{{ end }};
ignore_invalid_headers {{ if $cfg.IgnoreInvalidHeaders }}on{{ else }}off{{ end }};
limit_req_status {{ $cfg.LimitReqStatus }};
limit_req_status {{ $cfg.LimitReqStatusCode }};
{{ if $cfg.EnableOpentracing }}
opentracing on;