Conversation
mariot
added
filigran team
SamuelHassine
changed the title
There was a problem hiding this comment.
Pull request overview
This PR adds a collector-focused contribution guide to help contributors understand how to scaffold and implement a new OpenAEV collector in this repository, addressing the need in #291 for clearer contribution guidance (specifically around collector development).
Changes:
- Add a new Markdown guide describing collector architecture, inputs/outputs, and a step-by-step creation flow.
- Include example configuration, trace model shape, and suggested linting/testing commands for collectors.
Comment on lines
+38
to
+42
| - **OpenAEV connection**: URL and API token (see `config.yml`) | ||
| - **Collector metadata**: Unique collector ID, log level, etc. | ||
| - **Tool-specific settings**: API keys, FQDN, credentials, etc. | ||
|
|
||
| Example (`config.yml`): |
Comment on lines
+48
to
+50
| collector: | ||
| id: 'Palo Alto Cortex XDR' | ||
| log_level: 'debug' |
Comment on lines
+90
to
+91
| poetry new my-collector | ||
| cd my-collector |
Comment on lines
+101
to
+107
| class ConfigLoader: | ||
| def __init__(self, config_path='src/config.yml'): | ||
| with open(config_path) as f: | ||
| self.config = yaml.safe_load(f) | ||
| # Optionally override with env vars | ||
| self.config['openaev']['token'] = os.getenv('OPENAEV_TOKEN', self.config['openaev']['token']) | ||
| ``` |
Comment on lines
+1
to
+4
| # Contribution Guide: Creating a New Collector for OpenAEV | ||
|
|
||
| ## Overview | ||
| A collector integrates a security tool (EDR, XDR, SIEM, etc.) with the OpenAEV platform, fetching relevant data and transforming it into a standard format for analysis and validation. Each collector runs as a standalone service, following a common architecture and interface. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed changes
Testing Instructions
Related issues
Checklist
Further comments