file-log curl examples wrong?

[rkazak]

Where is the problem?

https://docs.konghq.com/hub/kong-inc/file-log/#custom-fields-by-lua

What happened?

I followed the given example

Test2 /Users/rkazak >curl -i -X POST --url http://localhost:28001/plugins/bd4b169a-9547-4135-b023-d1cc86f38542 --data config.custom_fields_by_lua.route="return nil"

which resulted in

HTTP/1.1 405 Not Allowed
Date: Tue, 28 Jun 2022 01:13:07 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: http://localhost:28002
X-Kong-Admin-Request-ID: W59MIMJYRXIaryjMLwdtMzU12rmDj2sR
vary: Origin
Access-Control-Allow-Credentials: true
Content-Length: 32
X-Kong-Admin-Latency: 0
Server: kong/2.8.1.1-enterprise-edition

{"message":"Method not allowed"}%

What did you expect to happen?

Plugin to be updated with new settings.

We can achieve what we want with

Test2 /Users/rkazak >curl -i -X PATCH --url http://localhost:28001/plugins/bd4b169a-9547-4135-b023-d1cc86f38542 --data config.custom_fields_by_lua.route="return nil"

Which resulted in

HTTP/1.1 200 OK
Date: Tue, 28 Jun 2022 01:13:34 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: http://localhost:28002
X-Kong-Admin-Request-ID: hLM3wAFwhk6wIv0TK2rPXiD0F3CPcdo5
vary: Origin
Access-Control-Allow-Credentials: true
Content-Length: 306
X-Kong-Admin-Latency: 15
Server: kong/2.8.1.1-enterprise-edition

{"consumer":null,"protocols":["grpc","grpcs","http","https"],"enabled":true,"config":{"reopen":false,"custom_fields_by_lua":{"route":"return nil"},"path":"/tmp/file.log"},"created_at":1656378281,"id":"bd4b169a-9547-4135-b023-d1cc86f38542","tags":["g-f-l-p-0"],"route":null,"name":"file-log","service":null}%

As an aside, I did try PUT but that requires the whole object to be defined ( I think ). For completeness

Test2 /Users/rkazak >curl -i -X PUT --url http://localhost:28001/plugins/bd4b169a-9547-4135-b023-d1cc86f38542 --data config.custom_fields_by_lua.route="return nil"

Which resulted in

HTTP/1.1 400 Bad Request
Date: Tue, 28 Jun 2022 01:13:16 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: http://localhost:28002
X-Kong-Admin-Request-ID: erdIUqSkfZniU8fFLgvHMCSleU7gAeDm
vary: Origin
Access-Control-Allow-Credentials: true
Content-Length: 139
X-Kong-Admin-Latency: 2
Server: kong/2.8.1.1-enterprise-edition

{"message":"schema violation (name: required field missing)","code":2,"name":"schema violation","fields":{"name":"required field missing"}}%

Code of Conduct and Community Expectations

• I agree to follow this project's Code of Conduct
• I agree to abide by the Community Expectations

[rkazak]

I could not find the source for

{% include /md/plugins-hub/log_custom_fields_by_lua.md %}

else I would have provided some text around this.

[mheap]

The request you made to http://localhost:28001/plugins/bd4b169a-9547-4135-b023-d1cc86f38542 is trying to POST to an existing plugin configuration. As you mentioned, this requires a PATCH request instead.

The docs suggest a POSt to /plugins/, which is how you create a plugin configuration. I could not find any instance of a POST to a URL with an ID present in the docs.

Could you confirm that there is an issue in the docs here?

[rkazak]

https://docs.konghq.com/hub/kong-inc/file-log/#custom-fields-by-lua

The paragraph

The custom_fields_by_lua configuration allows for the dynamic modification of log fields using Lua code. Below is an example configuration that removes the existing route field in the logs:

The examples that follow do not work. They as you mention use POST which is used to create a plugin. even though they look incomplete to me ( is that what the ... means ) should they not be using PATCH ?

I feel we should always be providing complete working examples.