Acessar a interface do usuário da Web do Apache Airflow

Cloud Composer 1 | Cloud Composer 2

O Apache Airflow inclui uma interface do usuário (UI) da Web (em inglês) que pode ser usada para gerenciar fluxos de trabalho (DAGs), gerenciar o ambiente do Airflow e realizar ações administrativas. Por exemplo, é possível usar a interface da Web para analisar o progresso de um DAG, configurar uma nova conexão de dados ou verificar os registros de execuções anteriores do DAG.

Servidor da Web do Airflow

Todos os ambientes do Cloud Composer têm um servidor da Web que executa essa interface. O servidor da Web faz parte da arquitetura do ambiente do Cloud Composer.

O servidor da Web analisa os arquivos de definição do DAG na pasta dags/ e pode acessar os dados e recursos do DAG para carregar o DAG e atender a solicitações HTTP.

O servidor da Web atualiza os DAGs a cada 60 segundos, que é o worker_refresh_interval padrão no Cloud Composer. Um erro do servidor da Web poderá ocorrer se ele não puder analisar todos os DAGs dentro do intervalo de atualização.

O carregamento dos DAGs poderá exceder 60 segundos se houver um grande número desses arquivos ou uma carga de trabalho incomum para carregá-los. Para garantir que o servidor da Web permaneça acessível seja qual for o tempo de carregamento do DAG, configure o carregamento de DAGs assíncrono para analisá-los e carregá-los em segundo plano a um intervalo pré-configurado (disponível no composer-1.7.1-airflow-1.10.2 e em versões posteriores). Essa configuração também pode reduzir o tempo de atualização do DAG.

Além de exceder o intervalo de atualização do worker, o servidor da Web pode lidar normalmente com falhas de carregamento do DAG na maioria dos casos. Os DAGs que travam ou encerram o servidor da Web podem causar erros no navegador. Para mais informações, consulte Como resolver problemas de DAGs.

Se você continuar tendo problemas com o servidor da Web devido à análise do DAG, recomendamos que use o carregamento de DAGs assíncrono.

Antes de começar

  • Você precisa ter um papel que possa ver os ambientes do Cloud Composer. Para mais informações, consulte Controle de acesso.

  • Durante a criação do ambiente, o Cloud Composer configura o URL do servidor da Web que executa a interface da Web do Airflow. Não é possível personalizar o URL.

  • O recurso de controle de acesso à interface do Airflow (controle de acesso baseado em papéis) para a interface da Web do Airflow é compatível com ambientes do Cloud Composer que executam a versão 1.13.4 ou posterior do Composer, o Airflow na versão 1.10.10 ou posterior e o Python 3.

Como acessar a interface da Web do Airflow

O serviço do servidor da Web do Airflow é implantado no domínio appspot.com e concede acesso à interface da Web do Airflow. O Cloud Composer 1 fornece acesso à interface com base nas identidades de usuários e nas vinculações de políticas do IAM definidas para os usuários. O Cloud Composer 1 usa o Identity-Aware Proxy para essa finalidade.

Depois de criar um novo ambiente do Cloud Composer, levará até 25 minutos para que a interface da Web termine de ser hospedada e se torne acessível.

Como acessar a interface da Web pelo console do Google Cloud

Para acessar a interface da Web do Airflow no console do Google Cloud:

  1. No console do Google Cloud, acesse a página Ambientes.

    Acessar "Ambientes"

  2. Na coluna Servidor da Web do Airflow, siga o link Airflow do seu ambiente.

  3. Faça login com a Conta do Google que tem as permissões apropriadas.

Como limitar o acesso ao servidor da Web do Airflow

Os ambientes do Composer permitem limitar o acesso ao servidor da Web do Airflow:

  • É possível bloquear todo o acesso ou permitir o acesso de intervalos de IP externos IPv4 ou IPv6 específicos.
  • Não é possível configurar os intervalos de IP permitidos usando endereços IP particulares.

Como recuperar o URL da interface da Web por meio da ferramenta de linha de comando gcloud

É possível acessar a interface da Web do Airflow usando qualquer navegador. Para conseguir o URL da interface da Web, digite o seguinte comando gcloud:

gcloud composer environments describe ENVIRONMENT_NAME \
  --location LOCATION

Substitua:

  • ENVIRONMENT_NAME: o nome do ambiente;
  • LOCATION: a região em que o ambiente está localizado.

O comando gcloud mostra as propriedades de um ambiente do Cloud Composer, incluindo o URL da interface da Web. O URL está listado como airflowUri.

config:
  airflowUri: https://example-tp.appspot.com

Como configurar o carregamento de DAG assíncrono

Quando o carregamento assíncrono do DAG está ativado, o servidor da Web do Airflow cria um novo processo. Esse processo carrega DAGs em segundo plano, envia DAGs recém-carregados em intervalos definidos pela opção dagbag_sync_interval e, em seguida, fica suspenso.

O processo é ativado periodicamente para recarregar os DAGs, o intervalo é definido pela opção collect_dags_interval.

Para ativar o carregamento de DAG assíncrono:

  1. Desative a serialização do DAG. O carregamento assíncrono do DAG não pode ser usado com a serialização do DAG. Usar as opções de configuração async_dagbag_loader e store_serialized_dags do Airflow produz erros HTTP 503 e interrompe o ambiente.

  2. Substitua as seguintes opções de configuração do Airflow:

    Seção Chave Valor Observações
    webserver async_dagbag_loader True O padrão é False.
    webserver collect_dags_interval 30 O padrão é 30. Use um valor menor para fazer atualizações mais rápidas.
    webserver dagbag_sync_interval 10 O padrão é 10.
    webserver worker_refresh_interval 3600 O padrão é 60. Com o carregamento de DAG assíncrono, é possível usar um intervalo de atualização maior.

Reiniciar o servidor da Web

Ao depurar ou solucionar problemas de ambientes do Cloud Composer, alguns problemas podem ser resolvidos com a reinicialização do servidor da Web do Airflow. Reinicie o servidor da Web usando a API RestartWebServer ou o comando gcloud restart-web-server:

gcloud beta composer environments restart-web-server ENVIRONMENT_NAME \
  --location=LOCATION