From 1fca59c535f21b4d0a8f097ca27ba89af33039d6 Mon Sep 17 00:00:00 2001
From: mahanth <22050509+gnmahanth@users.noreply.github.com>
Date: Mon, 30 Sep 2024 16:19:42 +0530
Subject: [PATCH] add docs for locating logs in agent (#2324)

(cherry picked from commit 75e1e6b7138839a64cd34500875231c7692e51f7)
---
 docs/docs/tips/debugging.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 docs/docs/tips/debugging.md

diff --git a/docs/docs/tips/debugging.md b/docs/docs/tips/debugging.md
new file mode 100644
index 0000000000..b38800b328
--- /dev/null
+++ b/docs/docs/tips/debugging.md
@@ -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 
\ No newline at end of file