falcosecurity / falco-website

Source code of the official Falco website
https://falco.org
Creative Commons Attribution 4.0 International
33 stars 219 forks source link

Improve documentation around supported falco fields #985

Closed incertum closed 11 months ago

incertum commented 1 year ago

/area documentation

What would you like to be added:

Expand and improve https://falco.org/docs/reference/rules/supported-fields/:

We could add full schemas for each syscall that are accessible via evt.arg.* or at least refer to the source code file https://github.com/falcosecurity/libs/blob/master/driver/event_table.c.

Current mention is not explicit enough, I still don't know what valid field names are as typical end user (unless I am very familiar with the source code and each Linux syscall man page or deduct them from existing Falco rules):

"Event fields applicable to syscall events. Note that for most events you can access the individual arguments/parameters of each syscall via evt.arg, e.g. evt.arg.filename."

Related to https://github.com/falcosecurity/libs/issues/1134

Many users are also unfamiliar with the evt.arg.* fields and their meaning. Enhancing our documentation can address these issues by providing clear explanations and references to the concept of files in Linux.

On that note mesos can be removed as it is deprecated and I am not sure what span and fdlist classes actually represent and how you would use them in Falco. Can this be documented as well?

Why is this needed:

Improve UX for effective use of Falco.

leogr commented 11 months ago

We could add full schemas for each syscall that are accessible via evt.arg.* or at least refer to the source code file https://github.com/falcosecurity/libs/blob/master/driver/event_table.c.

Available evt.arg.* are listed in https://falco.org/docs/reference/rules/supported-events/ (now including the full list of flags, thanks to https://github.com/falcosecurity/falco-website/pull/1068). We may cross link them for reference. Would it be enough? :thinking:

On that note mesos can be removed as it is deprecated and I am not sure what span and fdlist classes actually represent and how you would use them in Falco. Can this be documented as well?

LucaGuerra commented 11 months ago

I added an explicit link (plus fixed a couple minor things). While the two pages are next to each other in the table of contents an extra link wouldn't hurt and will make the content easier to consume.