Skip to content

Add section to DAST documentation to help customers when troubleshooting

Problem

Customers in DAST have voiced concern that there is no documentation to help troubleshoot a scan when something is not working. This issue proposes that a new section be added to the documentation with some general troubleshooting guidance.

Proposal

A new page should be added to the hierarchy of the page DAST browser-based crawler called DAST browser-based troubleshooting

Possible information that it could contain:

  • "failed to parse TOML configuration due to..."
  • Common situations for when the scan is missing pages
    • The element is hidden behind a popup
    • The scan has been accidentally logged out (unauthenticated)
    • The size of the browser window is causing a responsive view, and the element is not present
    • MaxActions/MaxDepth/Crawl Time
    • The page is not loading faster than the navigation timeout
    • The element is not unique enough, hence is considered to be already viewed
    • The element may have been excluded with DAST_BROWSER_EXCLUDED_ELEMENTS
    • Actioning (e.g. clicking) the element may take the user to a page that is out of scope (e.g. another host/port)
    • The page has work to do before being considered "ready"
  • How to enable the debug log
    • How to read the debug log
  • How to turn on Chrome DevTools logging
  • How to view the Crawl Graph as an SVG
  • How to add the log request error report