Skip to content

Commit

Permalink
add docs for locating logs in agent (#2324)
Browse files Browse the repository at this point in the history
(cherry picked from commit 75e1e6b)
  • Loading branch information
gnmahanth authored and ramanan-ravi committed Oct 2, 2024
1 parent eeb4b22 commit 1fca59c
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/docs/tips/debugging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Debugging
---

# Diagnostics logs
Deepfence Management console provides a way to download the logs for the console or from the specific agent on host or kubernetes cluster or cloud scanner. For steps to download agent logs from console UI refer [Support and Diagnostics](../operations/support.md)

# Agent Log Locations

- **General Log Locations**
- `/var/log/supervisor` - bootstrapper logs, this is the daemon which manages all the plugins used in the agent
- `/var/log/deepfenced` - logs of plugins managed by bootstrapper like `package-scanner`, `secret-scanner`, etc.,
- `/var/log/fenced` - all the data collected by the plugins are written here before its pushed to deepfence console

- Linux Binary Agent
- In case of linux binary agent prefix `/opt/deepfence` to **General Log Locations**

- AWS Fargate Agent
- In case of AWS Fargate agent prefix `DF_INSTALL_DIR` to **General Log Locations**

- Cloud Scanner
- prefix `/home/deepfence` if deployed as ECS task or AWS Fargate or GCP Cloud Run container to **General Log Locations**
- prefix `/data/home/deepfence` if deployed as docker container or kubernetes pod to **General Log Locations**

# Vulnerability scan failures
- Check agent `package_scanner.log` file for errors this file can be located in the directory `/var/log/deepfenced`
- If there are no errors on agent and sbom generation was successful, then check the deepfence-worker logs for issue in sbom scan on console

0 comments on commit 1fca59c

Please sign in to comment.