Welcome to the Stackrox Collector project documentation. Here you can learn more about idea behind the project, how to start guidelines, design overview and detailed references.
Collector is a component of Stackrox responsible for gathering runtime data. In a few words it is an agent that runs on every node under strict performance limitations and gathers the data via kernel modules or eBPF probes (the default collection mode nowadays). To implement eBPF probes and collect data, the project leverages the Falco libraries via a custom fork.
Here are few links to get more details:
-
How to start: If you want to contribute to the project, this is the best place to start. This section covers building and troubleshooting the project from scratch.
-
Design overview: When your goal is to better understand how Collector works, and it's place in the grand scheme of things, you may want to look here.
-
Troubleshooting: For common startup errors, ways of identifying and fixing them.
-
Release Process: Having troubles with the release? Here we have a few tips for you.
-
References: Contains a comprehensive list of configuration options for the project.