framework de extensões do Looker

O framework de extensão do Looker é um framework de desenvolvimento que reduz significativamente o esforço e a complexidade da criação de ferramentas e aplicativos de dados JavaScript personalizados, como:

  • Aplicativos de plataforma interna para sua empresa
  • Plataformas externas para seus clientes, como portais de clientes para aplicativos de análise incorporada criados com dados no Looker
  • Ferramentas internas segmentadas
  • Aplicativos para incorporação em aplicativos externos

Exemplos atuais de extensões do Looker disponíveis no Marketplace do Looker incluem o dicionário de dados e o diagrama do LookML.

Por que usar o framework de extensão?

Algumas partes da criação de aplicativos da web são fáceis e divertidas, enquanto outras obviamente são mais demoradas e não são exatamente divertidas. A estrutura de extensão simplifica muitas dessas tarefas não tão divertidas.

O framework de extensão cuida de alguns dos aspectos mais tediosos da criação de um aplicativo da Web para que você possa começar o desenvolvimento imediatamente. Aplicativos e ferramentas personalizados criados com o framework de extensão podem ser acessados de dentro do Looker, permitindo que ele lide com os seguintes tipos de funções, como:

Recursos do framework de extensão

O framework de extensão do Looker inclui os seguintes recursos:

  • O SDK da extensão do Looker, que fornece funções para acesso à API pública do Looker e para interagir no ambiente do Looker.
  • Componentes do Looker, uma biblioteca de componentes de interface do React pré-criados que podem ser usados nas suas extensões.
  • O SDK de incorporação, uma biblioteca que pode ser usada para incorporar painéis, Looks e Análises na sua extensão. Consulte a extensão de pia de cozinha para conferir um exemplo de código. Você também pode usar o SDK de incorporação para incorporar sua extensão em aplicativos de terceiros. Os cookies precisam estar ativados no navegador ao incorporar análises, Looks ou dashboards a uma extensão.
  • O utilitário create-looker-extension, que cria uma extensão básica que inclui todos os arquivos e dependências de extensão necessários e pode ser usado como ponto de partida.
  • O repositório de exemplos de framework de extensão do Looker, que inclui modelos e extensões de exemplo para ajudar você a começar rapidamente.
  • A capacidade de acessar endpoints de API de terceiros e adicionar dados de terceiros à extensão.

  • A capacidade de criar extensões de tela cheia no Looker. As extensões em tela cheia podem ser usadas para aplicativos de plataforma internos ou externos.

    Em uma extensão de tela cheia, é possível impedir que um conjunto de usuários navegue para outras partes do Looker pela sua extensão adicionando usuários a um grupo de usuários "Somente extensões". Também é possível remover a barra de navegação do Looker substituindo /extensions por /spartan no URL da extensão.

  • A capacidade de configurar uma chave de acesso para a extensão, de modo que os usuários precisem inserir uma chave para executar a extensão. Isso é útil se você quer cobrar pela extensão, mas deve usar permissões padrão do Looker para limitar o acesso a quem nunca deve conseguir acessar uma extensão.

  • A partir do Looker 24.0, as extensões podem ser desenvolvidas para serem executadas em um bloco nos painéis. Extensões que podem ser executadas como um bloco ou visualização podem ser adicionadas enquanto o dashboard está no modo de edição ou salvas em um dashboard como uma visualização de uma Análise. As extensões também podem ser configuradas como blocos nos painéis do LookML.

Requisitos do framework de extensões

Para desenvolver usando o framework de extensão do Looker:

  • Você vai precisar de permissões de desenvolvedor do LookML para sua instância.
  • O administrador do Looker precisa ativar o recurso Extension Framework.
  • Recomendamos que você tenha familiaridade com JavaScript ou TypeScript.
  • Recomendamos o desenvolvimento no React, embora exista um SDK de extensão para JavaScript bruto.

Para ser executada no Looker, cada extensão, independente da função, precisa incluir os seguintes elementos:

  • Um projeto do LookML que:

  • O arquivo modelo do LookML precisa de um parâmetro connection que aponte para uma conexão de banco de dados válida na instância.

  • O arquivo de manifesto do projeto exige um parâmetro application. O parâmetro application atribui um rótulo à extensão, informa ao Looker onde encontrar o JavaScript da extensão e fornece uma lista de direitos da extensão. Os direitos definem os recursos do Looker que a extensão pode acessar. A extensão não vai conseguir acessar um recurso do Looker, a menos que ele esteja listado nos direitos.

    Confira a seguir um exemplo de arquivo de manifesto do projeto com um parâmetro application:

      project_name: "super_duper_extension"
  application: super_duper_extension {
    label: "Super Duper Extension"
    url: "http://localhost:8080/dist/bundle.js"
    mount_points: {
      standalone: no
    }
    entitlements: {
      local_storage: no
      navigation: no
      new_window: no
      new_window_external_urls: []
      use_form_submit: yes
      use_embeds: no
      use_downloads: no
      core_api_methods: []
      external_api_urls: []
      oauth2_urls: []
      scoped_user_attributes: []
      global_user_attributes: []
    }
  }

    Para mais detalhes, consulte a página de documentação do parâmetro application.

Começar a desenvolver com o framework de extensão do Looker

A maneira mais fácil de começar é gerar uma nova extensão inicial usando um modelo e, em seguida, personalizar e adicionar funcionalidades a ela. Isso garante que toda a configuração e o empacotamento estejam corretos, o que pode ser difícil de fazer manualmente. Consulte a página de documentação Como criar uma extensão do Looker para ver instruções sobre como criar um novo projeto do Looker para sua extensão e gerar uma extensão inicial.

Para modelos mais personalizados ou avançados, consulte o repositório de exemplos do Looker Extension Framework. Qualquer extensão nesse repositório pode ser clonada e reaproveitada como ponto de partida para seu projeto.

Depois de criar uma extensão simples e verificar se tudo está funcionando, você pode começar a adicionar mais funcionalidades e personalizações: