User params #33
User params #33
Conversation
avoid applying `gofmt` to vendor files
README.md
Outdated
| @@ -391,6 +391,29 @@ network_groups: | |||
| - name: "reporting-apps" | |||
| networks: ["10.10.10.0/24"] | |||
|
|
|||
| # Optional list of GET params to send with each request | |||
There was a problem hiding this comment.
substitute this with the following text:
Optional lists of query params to send with each proxied request to ClickHouse.
These lists may be used for overriding ClickHouse settings on a per-user basis.
README.md
Outdated
| @@ -420,7 +443,6 @@ server: | |||
| # Certificates are automatically issued and renewed if this section | |||
| # is present. | |||
| # There is no need in cert_file and key_file if this section is present. | |||
| # Autocert requires application to listen on :80 port for certificate generation | |||
There was a problem hiding this comment.
Why this line has been removed?
There was a problem hiding this comment.
It was replaced with config/testdata/full.yml where this line was absent. Will add it in both places
README.md
Outdated
| @@ -467,6 +489,11 @@ users: | |||
| # By default responses aren't cached. | |||
| cache: "longterm" | |||
|
|
|||
| # ParamGroup name to use | |||
There was a problem hiding this comment.
Substitute this with:
An optional group of params to send to ClickHouse with each proxied request.
These params may be set in param_groups block.
By default no additional params are sent to ClickHouse.
config/config.go
Outdated
| @@ -464,7 +469,13 @@ func (ng *NetworkGroups) UnmarshalYAML(unmarshal func(interface{}) error) error | |||
| if err := unmarshal((*plain)(ng)); err != nil { | |||
| return err | |||
| } | |||
| return checkOverflow(ng.XXX, "network_groups") | |||
| if len(ng.Name) == 0 { | |||
There was a problem hiding this comment.
Probably, this change should be pushed in a separate commit if it is correct, since it is unrelated to the PR.
There was a problem hiding this comment.
True. Should be fixed in a separate PR
config/config_test.go
Outdated
| @@ -125,6 +160,7 @@ func TestLoadConfig(t *testing.T) { | |||
| MaxExecutionTime: Duration(time.Minute), | |||
| DenyHTTPS: true, | |||
| NetworksOrGroups: []string{"office", "1.2.3.0/24"}, | |||
| Params: "cron-job", | |||
There was a problem hiding this comment.
Either remove Params from this user or add a user without params in order to verify user config without params works as expected.
scope.go
Outdated
| // key is a hashed concatenation of the params list | ||
| key uint32 | ||
|
|
||
| r map[string]string |
There was a problem hiding this comment.
Why not storing []config.Param instead? This way params will be added to proxied requests always in the same order.
There was a problem hiding this comment.
Indeed, thx for pointing that out!
|
@valyala thanks for reviewing! |
| @@ -488,6 +518,8 @@ users: | |||
| to_user: "default" | |||
| allowed_networks: ["office", "1.2.3.0/24"] | |||
|
|
|||
| params: "cron-job" | |||
There was a problem hiding this comment.
Probably, this line must be removed in order to match full.yaml
This PR allows to create
param_groups- named lists of URL params. If the group is attached touserinparamsoption, proxy will send those params with every user's request.The
param_groupsconfiguration is following:Caching is still available while using
param_groups. Proxy will get a hash from the params list and use it as a part ofcache.Key