insight dashboard

Disables or enables an insight dashboard query.

The insight dashboard is an internal command that is used to enable or disable an insight dashboard query, configure zeppelin notebook in given ip/hostname, and run the dashboard queries. A graphical representation of the insight data from Iceberg is displayed on the Data Fabric UI. If a dashboard query is disabled, the graphs will not show up on the Data Fabric UI. By default, all the dashboard queries are enabled.

NOTE
The command is used internally by the Data Fabric UI. It is not meant for use directly by a customer.

The insight dashboard command configures Zeppelin on the node , creates a notebook named "Insights" in Zeppelin, and adds paragraphs containing all the dashboard queries to the Zeppelin notebook. The command facilitates the running of a specific dashboard query when a dashboard query ID is specified.

IMPORTANT
Ensure that the mapr-zeppelin package is installed for the Zeppelin notebook creation and paragraph addition.

Syntax

maprcli insight 
dashboard 
     [ -enable enable/disable dashboard query(ies) ]
     [ -id dashboard query identifier <n> ]
     [ -configure to configure zeppelin notebook on the given ip/hostname; supports -zeppelin, -jsessionid options; Parameter takes no value  ]
     [ -run run zeppelin notebook; supports -zeppelin, -jsessionid, -notebook, -queryid, logparastatus options; Parameter takes no value  ]
     [ -zeppelin <ip/hostname> to configure, can be used with -run or -configure only ]
     [ -jsessionid dashboard jsession id <n> needs to be used with -run or -configure only ]
     [ -logparastatus logs the paragraph result. Use with -run only Parameter takes no value  ]
     [ -notebook notebook path. Use with -run only ]
     [ -queryid dashboard query id. Use with -run only ]

Parameters

Parameter Description
enable (Optional) Set the value of the option to true to enable dashboard queries. Set the value to false to disable dashboard queries. Default: true.
id (Optional) The dashboard query identifier. The option can be used with the -enable option only.
configure (Optional) Use the option to configure a Zeppelin notebook on the given ip/hostname. The configure option also creates a notebook named “Insights” in Zeppelin, creates paragraphs for each dashboard query and runs all the paragraphs when configured for the first time.
run (Optional) Use the parameter to run the query and populate the graphs/chart in the Zeppelin notebook paragraph.
queryid (Mandatory when the -run option is used. ) The dashboard query identifier that represents The dashboard query identifier that represents the IDs for the dashboard queries present in Zeppelin paragraphs. Only one paragraph can be run at a time.
NOTE
You can fetch the query ID from the insight info -dashboard command.
jsessionid (Mandatory when the -configure option or the -run option is used.) The session identifier cookie used to maintain a user session.
zeppelin (Optional. Can be used with the -configure or the -run option only.) The IP address of the node on which Zeppelin is installed. The IP address of the node on which Zeppelin is installed. If the value for this parameter is not specified, then the command automatically picks up zeppelinMaster from maprcli insight info -dashboard -json command.
logparastatus (Optional. Can be used with the -run option only.) This option is to be used for debugging purpose to log the status of the paragraph. Use the option to log the paragraph result of the executed paragraph in the Zeppelin notebook.
notebook (Optional. Can be used with the -run option only.) The path where the Zeppelin notebook is to be saved. By default, the value is set to "/Insights".

Debug the insight dashboard query for jsessionid=379ffb7e-e30a-4bb3-affd-f210987d48d8, queryid=1

~# maprcli insight dashboard -run -jsessionid 379ffb7e-e30a-4bb3-affd-f210987d48d8 -queryid 1 -logparastatus -json
{
        "timestamp":1742897982348,
        "timeofday":"2025-03-25 03:19:42.348 GMT-0700 AM",
        "status":"OK",
        "total":1,
        "data":[
                {
                        "statusCode":3,
                        "statusStr":"ERROR"
                }
        ]
}

Enable all dashboard queries

maprcli insight dashboard -enable true -json
{
        "timestamp":1742897041554,
        "timeofday":"2025-03-25 03:04:01.554 GMT-0700 AM",
        "status":"OK",
        "total":0,
        "data":[
        ],
        "messages":[
                "Query enabled successfully."
        ]
}

Disable all dashboard queries

maprcli insight dashboard -enable false -json
{
        "timestamp":1742897041554,
        "timeofday":"2025-03-25 03:04:01.554 GMT-0700 AM",
        "status":"OK",
        "total":0,
        "data":[
        ],
        "messages":[
                "Query disabled successfully."
        ]

Configure Zeppelin notebook on the node using the jsession ID to create a new Zeppelin notebook named '/Insights' and run all the queries when configured for the first time

maprcli insight dashboard -configure [-zeppelin <zeppelinMaster>] [-jsessionid <jsessionId>] -json
{
        "timestamp":1742898057652,
        "timeofday":"2025-03-25 03:20:57.652 GMT-0700 AM",
        "status":"OK",
        "total":8,
        "data":[
                {
                        "notebookId":"2KQUUR52J",
                        "paragraphId":"paragraph_1742898000764_368483075",
                        "dashboardQueryId":1,
                        "configVersion":1,
                        "title":"NumFilesCreated",
                        "linkToParagraph":"https://10.160.160.209:9995/#/notebook/2KQUUR52J/paragraph/paragraph_1742898000764_368483075?asIframe",
                        "queryDesc":"Number of files created in a given time duration"
                },
                {
                        "notebookId":"2KQUUR52J",
                        "paragraphId":"paragraph_1742898050345_284868466",
                        "dashboardQueryId":2,
                        "configVersion":1,
                        "title":"NumFilesDeleted",
                        "linkToParagraph":"https://10.160.160.209:9995/#/notebook/2KQUUR52J/paragraph/paragraph_1742898050345_284868466?asIframe",
                        "queryDesc":"Number of files deleted in a given time duration"
                },
                {
                        "notebookId":"2KQUUR52J",
                        "paragraphId":"paragraph_1742898051405_1184728210",
                        "dashboardQueryId":3,
                        "configVersion":1,
                        "title":"MostAccessedDataSources",
                        "linkToParagraph":"https://10.160.160.209:9995/#/notebook/2KQUUR52J/paragraph/paragraph_1742898051405_1184728210?asIframe",
                        "queryDesc":"Number of read and write operations performed against each volume"
                },
                {
                        "notebookId":"2KQUUR52J",
                        "paragraphId":"paragraph_1742898052443_1995907206",
                        "dashboardQueryId":4,
                        "configVersion":1,
                        "title":"NumberOfAppConnections",
                        "linkToParagraph":"https://10.160.160.209:9995/#/notebook/2KQUUR52J/paragraph/paragraph_1742898052443_1995907206?asIframe",
                        "queryDesc":"Number of app connections established"
                },
                {
                        "notebookId":"2KQUUR52J",
                        "paragraphId":"paragraph_1742898053477_676774236",
                        "dashboardQueryId":5,
                        "configVersion":1,
                        "title":"UsersWithHighestAuthFailures",
                        "linkToParagraph":"https://10.160.160.209:9995/#/notebook/2KQUUR52J/paragraph/paragraph_1742898053477_676774236?asIframe",
                        "queryDesc":"Users/ClientIps with highest authentication failures over the last 7 days"
                },
                {
                        "notebookId":"2KQUUR52J",
                        "paragraphId":"paragraph_1742898054516_867934166",
                        "dashboardQueryId":6,
                        "configVersion":1,
                        "title":"NumberOfAuthFailures",
                        "linkToParagraph":"https://10.160.160.209:9995/#/notebook/2KQUUR52J/paragraph/paragraph_1742898054516_867934166?asIframe",
                        "queryDesc":"Number of authentication failures over the last 7 days"
                },
                {
                        "notebookId":"2KQUUR52J",
                        "paragraphId":"paragraph_1742898055555_866128797",
                        "dashboardQueryId":7,
                        "configVersion":1,
                        "title":"UsersWithHighestAuthzFailures",
                        "linkToParagraph":"https://10.160.160.209:9995/#/notebook/2KQUUR52J/paragraph/paragraph_1742898055555_866128797?asIframe",
                        "queryDesc":"Users/ClientIps with highest authorization failures over the last 7 days"
                },
                {
                        "notebookId":"2KQUUR52J",
                        "paragraphId":"paragraph_1742898056589_937837318",
                        "dashboardQueryId":8,
                        "configVersion":1,
                        "title":"NumberOfAuthzFailures",
                        "linkToParagraph":"https://10.160.160.209:9995/#/notebook/2KQUUR52J/paragraph/paragraph_1742898056589_937837318?asIframe",
                        "queryDesc":"Number of authorization failures over the last 7 days"
                }
        ]
}

Enable dashboard query for id = 2

maprcli insight dashboard -enable true -id 2 -json
{
        "timestamp":1742897041554,
        "timeofday":"2025-03-25 03:04:01.554 GMT-0700 AM",
        "status":"OK",
        "total":0,
        "data":[

        ],
        "messages":[
                "Query enabled successfully."
        ]
}
Disable dashboard for id = 2
maprcli insight dashboard -enable false -id 2 -json
{
        "timestamp":1742897041554,
        "timeofday":"2025-03-25 03:04:01.554 GMT-0700 AM",
        "status":"OK",
        "total":0,
        "data":[

        ],
        "messages":[
                "Query disabled successfully."
        ]
}