add: FAQ
Browse files
README.md
CHANGED
|
@@ -212,6 +212,35 @@ The model demonstrates high accuracy in classifying Wazuh alerts but may require
|
|
| 212 |
- **Libraries:** Transformers, Hugging Face Datasets, Unsloth
|
| 213 |
- **Training Platform:** Google Cloud Platform (Compute Engine)
|
| 214 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 215 |
## Citation
|
| 216 |
|
| 217 |
**BibTeX:**
|
|
|
|
| 212 |
- **Libraries:** Transformers, Hugging Face Datasets, Unsloth
|
| 213 |
- **Training Platform:** Google Cloud Platform (Compute Engine)
|
| 214 |
|
| 215 |
+
## 🧠 FAQ
|
| 216 |
+
|
| 217 |
+
### Q: Where should I extract the alerts from within Wazuh for this model?
|
| 218 |
+
|
| 219 |
+
The alerts in the example input are raw JSON data extracted from the Wazuh alert log at:
|
| 220 |
+
|
| 221 |
+
`/var/ossec/logs/alerts/alerts.json`
|
| 222 |
+
|
| 223 |
+
|
| 224 |
+
Using raw alert data is recommended because it provides the **full unaltered structure** of each alert. This ensures the model learns from and classifies alerts based on **complete original context**, which helps improve its real-world usability.
|
| 225 |
+
|
| 226 |
+
That said, you're also free to extract alerts via:
|
| 227 |
+
|
| 228 |
+
- **Custom external integrations**
|
| 229 |
+
|
| 230 |
+
If you're working on **real-time alert processing**, using Wazuh's [external API integrations](https://documentation.wazuh.com/current/user-manual/manager/integration-with-external-apis.html) is ideal. You can configure your custom integration to only forward certain alert levels (e.g., level ≥ 3).
|
| 231 |
+
|
| 232 |
+
> 💡 For this model, alerts of **level 3 and above** were used during training.
|
| 233 |
+
|
| 234 |
+
If you'd like to **retrain or fine-tune** the model on specific alert fields only (e.g., `rule.description`, `full_log`, etc.), feel free to reach out — I can share the training script used in this project.
|
| 235 |
+
|
| 236 |
+
---
|
| 237 |
+
|
| 238 |
+
**References:**
|
| 239 |
+
|
| 240 |
+
- 📘 [Wazuh Alert Management](https://documentation.wazuh.com/current/user-manual/manager/alert-management.html)
|
| 241 |
+
- 🔌 [Wazuh API Integration](https://documentation.wazuh.com/current/user-manual/manager/integration-with-external-apis.html)
|
| 242 |
+
|
| 243 |
+
|
| 244 |
## Citation
|
| 245 |
|
| 246 |
**BibTeX:**
|