Tutorial: Criar um widget de visão personalizadaTutorial: Build a custom insight widget

Este tutorial demonstra como usar suas próprias consultas de análise para compilar widgets insight personalizado.This tutorial demonstrates how to use your own insight queries to build custom insight widgets.

Durante este tutorial, você aprenderá como:During this tutorial you learn how to:

  • Execute sua própria consulta e exibi-lo em um gráficoRun your own query and view it in a chart
  • Criar um widget de visão personalizada do gráficoBuild a custom insight widget from the chart
  • Adicione o gráfico a um painel de controle de servidor ou banco de dadosAdd the chart to a server or database dashboard
  • Adicionar detalhes ao seu widget insight personalizadoAdd details to your custom insight widget

PrerequisitesPrerequisites

Este tutorial requer o SQL Server ou banco de dados SQL TutorialDB.This tutorial requires the SQL Server or Azure SQL Database TutorialDB. Para criar o TutorialDB banco de dados, conclua um dos seguintes inícios rápidos:To create the TutorialDB database, complete one of the following quickstarts:

Execute sua própria consulta e exibir o resultado em uma exibição de gráficoRun your own query and view the result in a chart view

Nesta etapa, execute um script sql para consultar as sessões ativas atuais.In this step, run a sql script to query the current active sessions.

  1. Para abrir um novo editor, pressione Ctrl + N.To open a new editor, press Ctrl+N.

  2. Alterar o contexto de conexão para TutorialDB.Change the connection context to TutorialDB.

  3. Cole a seguinte consulta no editor de consultas:Paste the following query into the query editor:

    SELECT count(session_id) as [Active Sessions]
    FROM sys.dm_exec_sessions
    WHERE status = 'running'
    
  4. Salve a consulta no editor para um *arquivo. SQL.Save the query in the editor to a *.sql file. Para este tutorial, salve o script como activeSession.sql.For this tutorial, save the script as activeSession.sql.

  5. Para executar a consulta, pressione F5.To execute the query, press F5.

  6. Depois que os resultados da consulta são exibidos, clique em exibir como gráfico, em seguida, clique no Visualizador gráfico guia.After the query results are displayed, click View as Chart, then click the Chart Viewer tab.

  7. Alteração tipo de gráfico à contagem.Change Chart Type to count. Essas configurações de renderizam um gráfico de contagem.These settings render a count chart.

Adicione o insight personalizado para o painel de banco de dadosAdd the custom insight to the database dashboard

  1. Para abrir a configuração do widget de insight, clique em criar Insight nos Visualizador gráfico:To open the insight widget configuration, click Create Insight on Chart Viewer:

    configuração

  2. Copie a configuração de informações (os dados JSON).Copy the insight configuration (the JSON data).

  3. Pressione Ctrl + vírgula para abrir configurações do usuário.Press Ctrl+Comma to open User Settings.

  4. Tipo de dashboard na as configurações de pesquisa.Type dashboard in Search Settings.

  5. Clique em edite para dashboard.database.widgets.Click Edit for dashboard.database.widgets.

    configurações do Dashboard

  6. Cole a configuração de insight JSON em dashboard.database.widgets.Paste the insight configuration JSON into dashboard.database.widgets. Banco de dados o painel configurações é semelhante ao seguinte:Database dashboard settings looks like the following:

     "dashboard.database.widgets": [
         {
             "name": "My-Widget",
             "gridItemConfig": {
                 "sizex": 2,
                 "sizey": 1
             },
             "widget": {
                 "insights-widget": {
                     "type": {
                         "count": {
                             "dataDirection": "vertical",
                             "dataType": "number",
                             "legendPosition": "none",
                             "labelFirstColumn": false,
                             "columnsAsLabels": false
                         }
                     },
                     "queryFile": "{your file folder}/activeSession.sql"
                 }
             }
         }
     ]
    
  7. Salvar a as configurações de usuário e abra o TutorialDB painel de banco de dados para ver o widget de sessões ativas:Save the User Settings file and open the TutorialDB database dashboard to see the active sessions widget:

    activesession insight

Adicionar detalhes ao insight personalizadoAdd details to custom insight

  1. Para abrir um novo editor, pressione Ctrl + N.To open a new editor, press Ctrl+N.

  2. Alterar o contexto de conexão para TutorialDB.Change the connection context to TutorialDB.

  3. Cole a seguinte consulta no editor de consultas:Paste the following query into the query editor:

     SELECT session_id AS [SID], login_time AS [Login Time], host_name AS [Host Name], program_name AS [Program Name], login_name AS [Login Name]
     FROM sys.dm_exec_sessions
     WHERE status = 'running'
    
  4. Salve a consulta no editor para um *arquivo. SQL.Save the query in the editor to a *.sql file. Para este tutorial, salve o script como activeSessionDetail.sql.For this tutorial, save the script as activeSessionDetail.sql.

  5. Pressione Ctrl + vírgula para abrir configurações do usuário.Press Ctrl+Comma to open User Settings.

  6. Editar as existentes dashboard.database.widgets nó no arquivo de configurações:Edit the existing dashboard.database.widgets node in your settings file:

     "dashboard.database.widgets": [
         {
             "name": "My-Widget",
             "gridItemConfig": {
                 "sizex": 2,
                 "sizey": 1
             },
             "widget": {
                 "insights-widget": {
                     "type": {
                         "count": {
                             "dataDirection": "vertical",
                             "dataType": "number",
                             "legendPosition": "none",
                             "labelFirstColumn": false,
                             "columnsAsLabels": false
                         }
                     },
                     "queryFile": "{your file folder}/activeSession.sql",
                     "details": {
                         "queryFile": "{your file folder}/activeSessionDetail.sql",
                         "label": "SID",
                         "value": "Login Name"
                     }
                 }
             }
         }
     ]
    
  7. Salvar a as configurações de usuário e abra o TutorialDB painel de banco de dados.Save the User Settings file and open the TutorialDB database dashboard. Clique no botão de reticências (...) ao lado Meus Widget para mostrar os detalhes:Click the ellipsis (...) button next to My-Widget to show the details:

    activesession insight

Próximas etapasNext steps

Neste tutorial, você aprendeu como:In this tutorial, you learned how to:

  • Execute sua própria consulta e exibi-lo em um gráficoRun your own query and view it in a chart
  • Criar um widget de visão personalizada do gráficoBuild a custom insight widget from the chart
  • Adicione o gráfico a um painel de controle de servidor ou banco de dadosAdd the chart to a server or database dashboard
  • Adicionar detalhes ao seu widget insight personalizadoAdd details to your custom insight widget

Para saber como fazer backup e restaurar bancos de dados, conclua o próximo tutorial:To learn how to backup and restore databases, complete the next tutorial: