An open API service indexing awesome lists of open source software.

https://github.com/stackrox/collector

Runtime data collection for the StackRox Kubernetes Security Platform using eBPF
https://github.com/stackrox/collector

Last synced: 10 months ago
JSON representation

Runtime data collection for the StackRox Kubernetes Security Platform using eBPF

Awesome Lists containing this project

README

          

# Stackrox Collector

![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/stackrox/collector/main.yml?style=for-the-badge)
![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/stackrox/collector/cpaas.yml?label=Downstream%20Nightly&style=for-the-badge)
![GitHub](https://img.shields.io/github/license/stackrox/collector?style=for-the-badge)
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/stackrox/collector?sort=semver&style=for-the-badge)

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](https://github.com/stackrox/falcosecurity-libs).

## Useful links

Here are few links to get more details:

1. [How to start](docs/how-to-start.md): 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.

2. [Design overview](docs/design-overview.md): 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.

3. [Troubleshooting](docs/troubleshooting.md): For common startup errors,
ways of identifying and fixing them.

4. [Release Process](docs/release.md): Having troubles with the release? Here
we have a few tips for you.

5. [References](docs/references.md): Contains a comprehensive list of
configuration options for the project.