Skip to content

doc: update export filtering example #3626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2025
Merged

doc: update export filtering example #3626

merged 1 commit into from
Apr 15, 2025

Conversation

yeongjukang
Copy link
Contributor

Fixes #3570

Description

Filter spec has namespace with string list type as below, but document is written using just string, so submitting this PR to fix document.

repeated string namespace = 2;

@yeongjukang yeongjukang requested review from mtardy and a team as code owners April 14, 2025 01:40
Copy link

netlify bot commented Apr 14, 2025

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit c61181d
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/67fc67746c3f3f00085a0fe6
😎 Deploy Preview https://deploy-preview-3626--tetragon.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@yeongjukang
Copy link
Contributor Author

@mtardy
How about adding type description column info at the table here?
https://tetragon.io/docs/concepts/events/#list-of-process-event-filters

@mtardy
Copy link
Member

mtardy commented Apr 14, 2025

@mtardy How about adding type description column info at the table here? https://tetragon.io/docs/concepts/events/#list-of-process-event-filters

sure, if that can help :) it seems almost all of them are array?

@mtardy mtardy added area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation. labels Apr 14, 2025
@yeongjukang
Copy link
Contributor Author

@mtardy Thank you for the review!
Yes, most of them are array. My concerns were mobile readability gets bad and difference from proto code.

How about just embedding permlink of the main branch of filter message like this block?

...

##### List of Process Event Filters

- The type for each filter attribute can be determined by referring to the [events.proto](https://github.com/cilium/tetragon/blob/main/api/v1/tetragon/events.proto#L38) file.
| Filter | Description | 
| ------ | ----------- |
| `event_set` | Filter process events by event types. Supported types include: `PROCESS_EXEC`, `PROCESS_EXIT`, `PROCESS_KPROBE`, `PROCESS_UPROBE`, `PROCESS_TRACEPOINT`, `PROCESS_LOADER` |

...

@mtardy
Copy link
Member

mtardy commented Apr 15, 2025

How about just embedding permlink of the main branch of filter message like this block?

yep that's an idea!

@mtardy
Copy link
Member

mtardy commented Apr 15, 2025

Let's merge this fix, please make another patch if you want to add a link to the protobuf in the docs

@mtardy mtardy merged commit 4b399de into cilium:main Apr 15, 2025
10 of 11 checks passed
@yeongjukang
Copy link
Contributor Author

Thank you, I will do it immediately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multiple JSON objects in export-allowlist not working as intended
2 participants