Criar uma exibição de métrica

Saiba como criar uma exibição de métrica para centralizar a lógica de negócios e definir consistentemente os principais indicadores de desempenho entre superfícies de relatório. Veja as visões métricas do Catálogo Unity. Este tutorial demonstra como criar uma exibição de métrica usando a interface do usuário do Catalog Explorer. Para definir exibições de métrica usando SQL, consulte CREATE VIEW.

Pré-requisitos

• Você deve ter SELECT privilégios nos objetos de dados de origem.
• Você deve ter o privilégio CREATE TABLE e o privilégio USE SCHEMA no esquema onde deseja criar a visualização de métricas.
• Você também deve ter o privilégio USE CATALOG no catálogo pai do esquema.
• Permissões PODE USAR em um armazenamento de SQL ou outro recurso de computação que executa o Databricks Runtime versão 16.4 ou posterior.

Um administrador metastore ou o proprietário do catálogo podem conceder todos esses privilégios. Um proprietário de esquema ou um usuário com o privilégio MANAGE pode conceder os privilégios USE SCHEMA e CREATE TABLE no esquema para você.

Etapa 1: Escolher uma fonte de dados

Sua exibição de métrica pode ser baseada em uma tabela, exibição ou consulta SQL. Este tutorial usa a tabela orders no esquema samples do catálogo tpch.

1. Clique no Catálogo na barra lateral do workspace.
2. Use a barra de pesquisa no navegador de esquema para localizar a tabela samples.tpch.orders. Clique em Pedidos para mostrar detalhes da tabela.
3. Clique em Criar>Visão de métrica. O editor YAML é aberto.

Etapa 2: Definir métricas

A definição de YAML para essa exibição de métrica inclui os seguintes campos de nível superior:

• version: Assume o padrão de 0.1. Esta é a versão da especificação de exibição de métrica.
• fonte:samples.tpch.orders é um nome de tabela totalmente qualificado. Todas as dimensões e medidas nessa exibição de métrica usam a tabela especificada como a fonte de dados.
• filter: todas as consultas nessa exibição retornam registros com um o_orderdate após 1º de janeiro de 1990.
• dimensions:Order Month, Order Statuse Order Priority são definidos como dimensões.
• measures: quatro medidas (Order Count, Total Revenue, e Total Revenue per CustomerTotal Revenue for Open Orders) são definidas, cada uma com uma expressão de agregação especificada.

1. Use o menu suspenso de catálogo e esquema para escolher onde quer salvar a visualização de métrica. Os usuários downstream devem ter pelo menos USE CATALOG e USE SCHEMA privilégios para acessar a exibição de métrica.

2. Digite um nome para a exibição da métrica. Os nomes de exibição de métrica podem incluir valores alfanuméricos e sublinhados.

3. Substitua o conteúdo do editor pela seguinte definição:

   version: 0.1
   
   source: samples.tpch.orders
   filter: o_orderdate > '1990-01-01'
   
   dimensions:
     - name: Order Month
       expr: DATE_TRUNC('MONTH', o_orderdate)
   
     - name: Order Status
       expr: CASE
         WHEN o_orderstatus = 'O' then 'Open'
         WHEN o_orderstatus = 'P' then 'Processing'
         WHEN o_orderstatus = 'F' then 'Fulfilled'
         END
   
     - name: Order Priority
       expr: SPLIT(o_orderpriority, '-')[1]
   
   measures:
     - name: Order Count
       expr: COUNT(1)
   
     - name: Total Revenue
       expr: SUM(o_totalprice)
   
     - name: Total Revenue per Customer
       expr: SUM(o_totalprice) / COUNT(DISTINCT o_custkey)
   
     - name: Total Revenue for Open Orders
       expr: SUM(o_totalprice) FILTER (WHERE o_orderstatus='O')
   

4. Clique em Criar.

Sua visualização de métricas está pronta para consumo por qualquer usuário com pelo menos SELECT privilégios na visualização. Consulte privilégios do Catálogo do Unity e objetos protegíveis para saber mais sobre como gerenciar permissões. Para saber mais sobre como os usuários podem consultar essa exibição, consulte Consultar uma exibição de métrica. Depois de criar uma exibição de métrica, você pode examinar a origem, o filtro e as medidas e dimensões especificadas na Visão Geral que é aberta.

Etapa 3: Adicionar uma descrição, comentários e marcas

Na guia de visão geral:

• Clique em Adicionar descrição para adicionar uma descrição aos metadados da exibição.
• Para adicionar comentários, passe o mouse sobre a coluna Comentário para a linha em que você deseja adicionar um comentário.
• Para adicionar marcas a uma medida ou dimensão, passe o mouse sobre a coluna Marcas em que você deseja adicionar uma marca.
• Para adicionar uma marca ao modo de exibição, clique em Adicionar marcas no lado direito da página.

Etapa 4: (Opcional) Editar a definição de YAML

Você pode exibir a definição yaml e abrir o editor YAML na guia Detalhes .

1. Clique em Detalhes.
2. Clique em... mais linhas para exibir a definição completa.
3. Clique em Editar para abrir o editor yaml.
4. Adicionar ou excluir dimensões ou medidas. Clique em Salvar.

Etapa 5: (Opcional) Definir permissões

As visualizações de métricas respeitam o mesmo modelo de permissões hierárquicas que outros objetos securáveis do Unity Catalog. Nenhuma nova permissão será necessária se a visualização de métricas estiver armazenada em um esquema ao qual os consumidores designados têm acesso de leitura. Você pode atribuir permissões explicitamente na exibição de métrica na guia Permissões .

1. Clique em Permissões.
2. Use a interface do usuário para conceder e revogar permissões para outros usuários do Azure Databricks.

Para obter mais detalhes, consulte Conceder permissões em objetos em um metastore do Catálogo do Unity.

Consultar uma visualização de métrica

Você pode consultar uma exibição de métrica no editor de SQL interno do workspace ou em qualquer editor de SQL que possa acessar seus dados no Azure Databricks. Para consultar uma visualização de métrica, você deve estar vinculado a um SQL Warehouse ou a outro recurso de computação usando o Databricks Runtime 16.4 ou superior.

A consulta de exemplo a seguir avalia as três medidas listadas e agrega em Order Month e Order Status. Ele retorna resultados classificados por Order Month.

Todas as medidas devem ser encapsuladas na MEASURE função. Consulte measure a função de agregação.

SELECT
 `Order Month`,
 `Order Status`,
 MEASURE(`Order Count`),
 MEASURE(`Total Revenue`),
 MEASURE(`Total Revenue per Customer`)
FROM
 orders_metric_view
GROUP BY ALL
ORDER BY 1 ASC

Próximas etapas

• Use o SQL para definir uma exibição de métrica.
• Use a API de Execução de Declaração para executar as declarações SQL de visualização de métricas.
• Configure um alerta.
• Adicione uma exibição de métrica a um painel.
• Adicione uma exibição de métrica a um espaço do Genie.
• Solucione problemas de exibições de métricas.