PerfTop dashboards

    The best way to get started with building custom dashboards is to duplicate and modify one of the existing JSON files in the directory.

    • Tables show metrics per dimension. For example, if your metric is CPU_Utilization and your dimension ShardID, a PerfTop table shows a row for each shard on each node.
    • Bar graphs are aggregated for the cluster, unless you add nodeName to the dashboard. See the options for all elements.
    • Line graphs are aggregated for each node. Each line represents a node.

    PerfTop positions elements within a grid. For example, consider this 12 * 12 grid.

    • Orange: row 0, column 0
    • Purple: row 2, column 2
    • Green: row 1, column 6

    These boxes span a number of rows and columns. In this case:

    • Orange: 2 rows, 4 columns
    • Green: 3 rows, 2 columns

    In JSON form, we have the following:

    At this point, however, all the JSON does is define the size and position of three tables. To fill elements with data, you specify a query.

    1. {
    2.   "queryParams": {
    3.     "metrics": "estimated,limitConfigured",
    4.     "aggregates": "avg,avg",
    5.     "dimensions": "type",
    6.     "sortBy": "estimated"
    7. }

    For details on available metrics, see .

    Options include labels, colors, and a refresh interval. Different elements types have different options.

    Dashboards support the 16 ANSI colors: black, red, green, yellow, blue, magenta, cyan, and white. For the “bright” variants of these colors, use the numbers 8–15. If your terminal supports 256 colors, you can also use hex codes (e.g. #6D40ED).