Fortinet white logo
Fortinet white logo

FortiDLP Administration Guide

Viewing FortiDLP Agent performance reports

Viewing FortiDLP Agent performance reports

Agent performance reports can be generated automatically or manually, either remotely or locally.

To enable the automatic generation of performance reports when CPU or memory thresholds are exceeded on managed nodes, you must turn on the Agent performance monitoring setting using Agent configuration groups.

To manually generate the report, follow the steps below.

How to collect a FortiDLP Agent performance report remotely
  1. In the FortiDLP Console, on the left-hand sidebar, click .
  2. Filter for the relevant node. For guidance on this, see Nodes.
  3. In the Table tab, select the row of the node.
  4. On the Node profile page, click Perform action.
  5. In the Actions dialog box, do the following:
    1. Click Request performance report.
    2. Do one of the following:
      • To generate a standard report:
        1. Optionally, alter the request timeout period.
        2. Click Request performance report.
      • To generate an advanced report:
        1. Select the Collect an advanced report containing debug data checkbox. An advanced report contains more information and takes longer to compile.
        2. Optionally, alter the request timeout period.
        3. Click Request performance report.
          The performance report is generated.
  6. To view the report, do the following:
    1. Click Close to exit the dialog box.
    2. In the Bundles and reports widget, for the relevant report, click .

      A ZIP file is downloaded to your device.
      Note

      Pending action requests for performance reports will display with a "Requested" badge.

      You can check for pending actions by sending a GET request to the FortiDLP API's /api/v1/actions/{agent_uuid}/in-flight endpoint.

    3. Extract the ZIP file.
    4. Double-click the performance-report folder.
    5. Double-click the index.html file.
Tooltip

You can also download the report from the Action details panel, accessible from the Action (New) or Action (Legacy) event stream (depending on the Agent version). In the Investigate module, just enter the action = performance_report search query and then open the panel for the relevant action event. For detailed information about the Investigate module, see Investigate searches.

How to collect a FortiDLP Agent performance report locally
  1. On the device you want to collect a performance report for, open a command-line interface.
  2. Note

    Administrator or root privileges are required.

  3. Do one of the following:
    • On Windows:
      • To generate a standard report, run
        "C:\Program Files\Jazz Networks\Agent\agent.exe" debug bundle -m performance_lite.
      • To generate advanced report, run
        "C:\Program Files\Jazz Networks\Agent\agent.exe" debug bundle -m performance.
    • On macOS:
      • To generate a standard report, run
        sudo /Library/Application\ Support/Ava/Reveal/agent/agent debug bundle -m performance_lite.
      • To generate an advanced report, run
        sudo /Library/Application\ Support/Ava/Reveal/agent/agent debug bundle -m performance.
    • On Linux:
      • To generate a standard report, run
        jazz-agent debug bundle -m performance_lite.
      • To generate an advanced report, run
        jazz-agent debug bundle -m performance.
    • The report is saved to the current directory as a ZIP file and its filename is shown in the output message.

  4. To view the report:
    1. Extract the ZIP file.
    2. Double-click the performance-report folder.
    3. Double-click the index.html file.

Viewing FortiDLP Agent performance reports

Viewing FortiDLP Agent performance reports

Agent performance reports can be generated automatically or manually, either remotely or locally.

To enable the automatic generation of performance reports when CPU or memory thresholds are exceeded on managed nodes, you must turn on the Agent performance monitoring setting using Agent configuration groups.

To manually generate the report, follow the steps below.

How to collect a FortiDLP Agent performance report remotely
  1. In the FortiDLP Console, on the left-hand sidebar, click .
  2. Filter for the relevant node. For guidance on this, see Nodes.
  3. In the Table tab, select the row of the node.
  4. On the Node profile page, click Perform action.
  5. In the Actions dialog box, do the following:
    1. Click Request performance report.
    2. Do one of the following:
      • To generate a standard report:
        1. Optionally, alter the request timeout period.
        2. Click Request performance report.
      • To generate an advanced report:
        1. Select the Collect an advanced report containing debug data checkbox. An advanced report contains more information and takes longer to compile.
        2. Optionally, alter the request timeout period.
        3. Click Request performance report.
          The performance report is generated.
  6. To view the report, do the following:
    1. Click Close to exit the dialog box.
    2. In the Bundles and reports widget, for the relevant report, click .

      A ZIP file is downloaded to your device.
      Note

      Pending action requests for performance reports will display with a "Requested" badge.

      You can check for pending actions by sending a GET request to the FortiDLP API's /api/v1/actions/{agent_uuid}/in-flight endpoint.

    3. Extract the ZIP file.
    4. Double-click the performance-report folder.
    5. Double-click the index.html file.
Tooltip

You can also download the report from the Action details panel, accessible from the Action (New) or Action (Legacy) event stream (depending on the Agent version). In the Investigate module, just enter the action = performance_report search query and then open the panel for the relevant action event. For detailed information about the Investigate module, see Investigate searches.

How to collect a FortiDLP Agent performance report locally
  1. On the device you want to collect a performance report for, open a command-line interface.
  2. Note

    Administrator or root privileges are required.

  3. Do one of the following:
    • On Windows:
      • To generate a standard report, run
        "C:\Program Files\Jazz Networks\Agent\agent.exe" debug bundle -m performance_lite.
      • To generate advanced report, run
        "C:\Program Files\Jazz Networks\Agent\agent.exe" debug bundle -m performance.
    • On macOS:
      • To generate a standard report, run
        sudo /Library/Application\ Support/Ava/Reveal/agent/agent debug bundle -m performance_lite.
      • To generate an advanced report, run
        sudo /Library/Application\ Support/Ava/Reveal/agent/agent debug bundle -m performance.
    • On Linux:
      • To generate a standard report, run
        jazz-agent debug bundle -m performance_lite.
      • To generate an advanced report, run
        jazz-agent debug bundle -m performance.
    • The report is saved to the current directory as a ZIP file and its filename is shown in the output message.

  4. To view the report:
    1. Extract the ZIP file.
    2. Double-click the performance-report folder.
    3. Double-click the index.html file.