Scenario: Creating a Cloud APM Dashboard

Create a dashboard for Linux® OS monitoring agent to display the process that is running on a single VM instance and drill-down to details of a specific process.

Use case description

As a dashboard designer, by using Cloud APM data source, I want to create a dashboard that displays the summary level information of process and memory that is used by each process for Linux OS monitoring agent. Furthermore by using the process ID, I want to drill down to details of that process.

Create two dashboards, a controller dashboard that shows process IDs and memory that is used by each ID and another drill-down dashboard that shows details of that process. Both the dashboards are related by a common metric value, Process ID.

Metrics used

The dashboards for this use case display the following metrics from Linux OS monitoring agent:
  • Process ID
  • System Name
  • Resident Set Size
  • Number of Threads
  • Process Command Name
  • VM Size (MB)

Dashboard creation tasks

  1. Access the Dashboard Designer tool.

    For more information, see Accessing the IBM Cloud Application Business Insights web interface.

  2. Configure connector sources for the two widgets that you want to create.
    For example:
    1. Create connector source, APM_source that has the information about process IDs and memory that is used by each process ID for a Linux OS monitoring agent instance.
    Use the following information to create the APM connector source:
    Fields Value
    Connector Type APM
    Connector Source Name APM_source
    URL http://server_IP_or_HOSTNAME:8090
    System Config URL https://APM_Server_IP_or_HOSTNAME/8091
    Username User name to access the server where the Cloud APM is available.
    Password Password to access the server where the Cloud APM is available.

    For more information, see Configuring IBM Cloud Application Performance Management Connector Sources.

  3. Select and use the default 1X1 Layout to create a dashboard.

    For more information, see Layouts.

  4. Create a dashboard with Clustered Columns chart.
  5. Set the data definition by using the following information:
    Fields Value
    Source APM_source
    Resource Type Linux OS
    Metric Group KLZ_Process
    Metric(s)

    Process ID (X-axis)
    System Name (Legend)
    Resident Set Size (MB) (Y-axis)
    Instance(s) instance_name

    For more information, see Setting assisted data definitions.

  6. Specify the name of the dashboard as LinuxOS_process and save.
  7. Preview the dashboard to make sure that it looks as expected.
  8. Create another drill-down dashboard by using the following tasks:
    1. Select and use the default 1X1 Layout to create a dashboard.
    2. Create a dashboard with a Grid chart.
    3. Add the following default filters to the dashboard:
      1. Datetime
      2. Interval

      For more information, see Filters.

    4. Add the data definitions by using the following information and save:
      Fields Value
      Source APM_source
      Resource Type Linux OS
      Metric Group KLZ_Process
      Metric(s)

      Process ID
      Process Command Name
      Number of Threads
      VM Size (MB)
      Time Stamp
      Instance(s) instance_name
    5. Click Map Metrics & Filters and select the Automap Columns With Default Filters checkbox.
    6. Specify the name of the dashboard as Process_drilldown and save.
    7. Preview the dashboard to make sure that it looks as expected.
  9. On the LinuxOS_process dashboard, click the Set Relation Set Relation icon icon and complete the following steps:
    Set relation between controller and drill-down widget as follows:
    1. Click the Widgets tab and drag the LinuxOS_process widget to the first node.
    2. Right-click the node and select Add a Drilldown Dashboard and drag the Process_drilldown dashboard from the Dashboards tab.
    3. As the LinuxOS_process dashboard is now the controller for the drill-down relation, click the Set Controller Parameters Set Controller Parameters icon, and in the Default Parameter to be Published pane, specify a parameter name for the Value field that displays the first metric in the widget that is Process ID.

      For example, ProcessID.

    4. On the Process_drilldown dashboard, click the Map Drilldown Metrics To Controller Parameters Map Drilldown Metrics To Controller Parameters icon.

      The drill-down dashboard opens in a separate tab.

    5. Click the Map Listener Metrics To Controller Parameters Map Listener Metrics To Controller Parameters icon and in the MAP METRICS tab, map the common metrics in both the controller and the drill-down dashboards. For example,
      Process ID = ProcessID
    6. Click Save.

      For more information, see Creating a drill-down relation.

  10. Build a menu and add the dashboards to the menu by using the following tasks:
    1. From the navigation pane, click Menu Access > Create New Menu.
    2. Enter the name for the first menu. For example, APM_Dashboard.
    3. Right-click APM_Dashboard and select Add Child.
    4. Click the Dashboarddashboard icon icon and drag LinuxOS_process dashboard from the list on the Dashboards tab, which is on the right of the window.
    5. Click the User Groups tab and assign user groups who can view the dashboards.
    6. Save and publish the dashboard.

    For more information, see Menu Access.

  11. Access the Engine user interface.
  12. Go to APM_Dashboard > LinuxOS_process to view your dashboard.
  13. To view drill-down dashboard, click any process ID. The Process_drilldown dashboard displays the details of the selected process ID.
  14. To filter dashboard data, select filter conditions from the dashboard-level filters, and click Apply Filter.
  15. You can use column-filters Filter icon that are displayed on every column of the grid chart to filter data column-wise.

    For more information, see Viewing widgets and dashboards and performing additional actions.