search

rancher / rancher-docs

Rancher Documentation
https://ranchermanager.docs.rancher.com/
Apache License 2.0
57 stars 190 forks source link

Rancher API Audit log documentation is misleading #745

Open btat opened 11 months ago

btat commented 11 months ago

SURE-6569

The documentation: https://ranchermanager.docs.rancher.com/how-to-guides/advanced-user-guides/enable-api-audit-log#audit-log-levels is misleading because it only includes "Response Metadata" only on log level 3.

Currently, they have log level 1 in their cluster. With this log level setting, they can already see a lot of response metadata, like response code, headers, timestamps. They would consider them as the "Response Metadata".

I don't think that return code or headers are actually the metadata. Timestamps though according to Kuberneters API convention are considered to be metadata:

https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata

Can you please comment on this and eventually adjust the page accordingly?

btat commented 9 months ago

Hi @prachidamle, is API Audit Logging handled by your team? If so, can someone from your team help clarify what the current expected behavior is for each level. Thanks!

gunamata commented 3 months ago

@prachidamle , Any insights on this issue please?