Tutorial: Configurar um contêiner sidecar para um aplicativo Linux no Serviço de Aplicativo do Azure

Neste tutorial, você adicionará um coletor OpenTelemetry como um contêiner sidecar a um aplicativo Linux (traga seu próprio código) no Serviço de Aplicativo do Azure. Para contêineres personalizados, confira Tutorial: Configurar um contêiner sidecar para contêiner personalizado no Serviço de Aplicativo do Azure.

No Serviço de Aplicativo do Azure, você pode adicionar até nove contêineres sidecar para cada aplicativo Linux. Os contêineres sidecar permitem implantar serviços e recursos extras em seus aplicativos Linux sem torná-los fortemente acoplados ao contêiner principal (interno). Por exemplo, você pode adicionar serviços de monitoramento, registro em log, configuração e rede como contêineres sidecar. Um sidecar do coletor OpenTelemetry é um desses exemplos de monitoramento.

Para obter mais informações sobre contêineres laterais no Serviço de Aplicativo, confira:

• Apresentando sidecars para o Serviço de Aplicativo do Azure para Linux: agora em disponibilidade geral
• Anunciando a disponibilidade geral da extensibilidade de sidecar no Serviço de Aplicativo do Azure

Caso você não tenha uma assinatura do Azure, crie uma conta gratuita do Azure antes de começar.

1. Configurar os recursos necessários

Primeiro, crie os recursos que o tutorial usa. Eles são usados para esse cenário específico e não são necessários para contêineres sidecar em geral.

1. No Azure Cloud Shell, execute os seguintes comandos. Certifique-se de fornecer o <environment-name>.

   git clone https://github.com/Azure-Samples/app-service-sidecar-tutorial-prereqs
   cd app-service-sidecar-tutorial-prereqs
   azd env new <environment-name>
   azd provision
   

2. Quando solicitado, forneça a assinatura e a região de sua escolha. Por exemplo:

   • Assinatura: sua assinatura.
   • Região: (Europa) Oeste da Europa.

   Ao concluir a implantação, você deverá visualizar a seguinte saída:

    APPLICATIONINSIGHTS_CONNECTION_STRING = InstrumentationKey=...;IngestionEndpoint=...;LiveEndpoint=...
    Azure container registry name = <registry-name>
    Managed identity resource ID = <managed-identity-resource-id>
    Managed identity client ID = <managed-identity-client-id>
   
    Open resource group in the portal: https://portal.azure.com/#@/resource/subscriptions/<subscription-id>/resourceGroups/<group-name>
    

3. Copie esses valores de saída para versões posteriores. Você também pode encontrá-los no portal, nas páginas de gerenciamento dos respectivos recursos.

   Observação

   azd provision usa os modelos incluídos para criar os seguintes recursos do Azure:

   • Um grupo de recursos com base no nome do ambiente.
   • Um registro de contêiner com duas imagens implantadas:
     • Uma imagem Nginx com o módulo OpenTelemetry.
     • Uma imagem do coletor OpenTelemetry, configurada para exportar ao Azure Monitor.
   • Uma identidade gerenciada atribuída pelo usuário com a permissão AcrPull no grupo de recursos (para efetuar pull de imagens do registro).
   • Um workspace do Log Analytics.
   • Um componente do Application Insights.

2. Criar um aplicativo Web

Nesta etapa, você implantará um aplicativo ASP.NET Core de modelo. De volta ao Azure Cloud Shell, execute os seguintes comandos. Substitua <app-name> por um nome de aplicativo exclusivo.

cd ~
dotnet new webapp -n MyFirstAzureWebApp --framework net8.0
cd MyFirstAzureWebApp
az webapp up --name <app-name> --os-type linux

Após alguns minutos, esse aplicativo Web .NET é implantado como MyFirstAzureWebApp.dll em um novo aplicativo do Serviço de Aplicativo.

3. Adicione um contêiner sidecar

Nesta seção, você adicionará um contêiner sidecar ao seu aplicativo Linux. A experiência do portal ainda está sendo implementada. Se ainda não estiver disponível para você, continue com a guia Usar modelo do ARM abaixo.

Usar a interface do usuário do portal

1. No portal do Azure, navegue até a página de gerenciamento do aplicativos

2. Na página de gerenciamento do aplicativo, no menu à esquerda, selecione Centro de Implantação.

3. Selecione a faixa Interessado em adicionar contêineres para executar junto com seu aplicativo? Clique aqui para experimentar.

   Se você não conseguir ver a faixa, a interface do usuário do portal ainda não foi implementada na sua assinatura. Selecione a guia Usar modelo do ARM aqui e continue.

4. Quando a página for recarregada, selecione a guia Contêineres (novo).

5. Selecione Adicionar e configure o novo contêiner da seguinte maneira:

   • Nome: coletor Otel
   • Fonte da imagem: Registro de Contêiner do Azure
   • Autenticação: Credenciais de Administrador
   • Registro: o registro criado por azd provision
   • Imagem: coletor Otel
   • Marca: mais recente

6. Escolha Aplicar.

   

Usar modelo do ARM

1. No Cloud Shell, execute o comando a seguir para adicionar ao aplicativo Web a identidade gerenciada atribuída pelo usuário que azd provision criou. Use o valor de <managed-identity-resource-id> (uma cadeia de caracteres muito longa) na saída azd provision.

   az webapp identity assign --identities <managed-identity-resource-id>
   

   Se você executar esse comando dentro de ~/MyFirstAzureWebApp, não será necessário adicionar outros parâmetros porque az webapp up já define os padrões para o grupo de recursos e o nome do aplicativo.

2. Navegue até o modelo de implantação personalizada no portal.

3. Selecione Criar seu próprio modelo no editor.

4. Substitua o conteúdo na caixa de texto pelo código JSON a seguir e selecione Salvar. Para <registry-name> e <managed-identity-client-id>, use os valores de saída de azd provision antes. Para <app-name>, use o nome do aplicativo em az webapp up earlier. Para <sidecar-name>, forneça um nome para o contêiner sidecar.

   {
       "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
       "contentVersion": "1.0.0.0",
       "resources": [
           {
               "type": "Microsoft.Web/sites/sitecontainers",
               "apiVersion": "2024-04-01",
               "name": "<app-name>/<sidecar-name>",
               "properties": {
                   "image": "<registry-name>.azurecr.io/otel-collector:latest",
                   "isMain": false,
                   "authType": "UserAssigned",
                   "userManagedIdentityClientId": "<managed-identity-client-id>",
                   "volumeMounts": [],
                   "environmentVariables": []
               }
           }
       ]
   }
   

   Dica

   Para usar um contêiner em um registro público, modifique properties como o seguinte exemplo:

   "properties": {
       "image": "mcr.microsoft.com/appsvc/docs/sidecars/sample-experiment:otel-appinsights-1.0",
       "isMain": false,
       "authType": "Anonymous",
       "volumeMounts": [],
       "environmentVariables": []
   }
   

5. Para a entrada do modelo, selecione o grupo de recursos que tem o aplicativo Web. Selecione Examinar + Criar e Criar.

   Como a interface do usuário do portal não está disponível para você, você não pode ver esse contêiner sidecar como parte do aplicativo, mas você verá os logs de inicialização relacionados para o sidecar nos logs do aplicativo do Serviço de Aplicativo.

4. Configurar variáveis de ambiente

Para o cenário de exemplo, o sidecar do coletor Otel é configurado para exportar os dados OpenTelemetry para o Azure Monitor, mas precisa da cadeia de conexão como uma variável de ambiente (consulte o arquivo de configuração OpenTelemetry para a imagem do coletor Otel).

Você configura variáveis de ambiente para os contêineres, como qualquer aplicativo do Serviço de Aplicativo, definindo as configurações do aplicativo. As configurações do aplicativo são acessíveis a todos os contêineres no aplicativo.

1. Navegue até a página de gerenciamento do aplicativo do Serviço de Aplicativo.

2. No menu do lado esquerdo, selecione Variáveis de ambiente.

3. Adicione uma configuração de aplicativo selecionando Adicionar e configure-a da seguinte maneira:

   • Nome: APPLICATIONINSIGHTS_CONNECTION_STRING
   • Valor: a cadeia de conexão na saída de azd provision. Se você perdeu a sessão do Cloud Shell, também poderá encontrá-la na página Visão Geral do recurso Application Insight, em Cadeia de Conexão.

4. Selecione Aplicar, em seguida Aplicar e, em seguida, Confirmar.

   

5. Configurar a instrumentação na inicialização

Nesta etapa, você criará a instrumentação para seu aplicativo de acordo com as etapas descritas na instrumentação de código zero do .NET do OpenTelemetry.

1. De volta ao Cloud Shell, crie startup.sh com as linhas a seguir.

   cat > startup.sh << 'EOF'
   #!/bin/bash
   
   # Download the bash script
   curl -sSfL https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest/download/otel-dotnet-auto-install.sh -O
   
   # Install core files
   sh ./otel-dotnet-auto-install.sh
   
   # Enable execution for the instrumentation script
   chmod +x $HOME/.otel-dotnet-auto/instrument.sh
   
   # Setup the instrumentation for the current shell session
   . $HOME/.otel-dotnet-auto/instrument.sh
   
   export OTEL_SERVICE_NAME="MyFirstAzureWebApp-Azure"
   export OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4318"
   export OTEL_TRACES_EXPORTER="otlp"
   export OTEL_METRICS_EXPORTER="otlp"
   export OTEL_LOGS_EXPORTER="otlp"
   
   # Run your application with instrumentation
   OTEL_SERVICE_NAME=myapp OTEL_RESOURCE_ATTRIBUTES=deployment.environment=staging,service.version=1.0.0 dotnet /home/site/wwwroot/MyFirstAzureWebApp.dll
   EOF
   

2. Implante esse arquivo em seu aplicativo com o seguinte comando da CLI do Azure. Se você ainda estiver no diretório ~/MyFirstAzureWebApp, nenhum outro parâmetro será necessário porque az webapp up já definiu os padrões para o grupo de recursos e o nome do aplicativo.

   az webapp deploy --src-path startup.sh --target-path /home/site/startup.sh --type static
   

   Dica

   Essa abordagem implanta o arquivo startup.sh separadamente do aplicativo. Dessa forma, a configuração de instrumentação é separada do código do aplicativo. No entanto, você pode usar outros métodos de implantação para implantar o script junto com seu aplicativo.

3. De volta à página de gerenciamento do aplicativo, no menu esquerdo, selecione Configuração.

4. Defina o Comando de Inicialização como /home/site/startup.sh. É o mesmo caminho para o qual você implantou na etapa anterior.

5. Selecione Salvar, depois, Continuar.

   

5. Verificar no Application Insights

O sidecar do coletor Otel deve exportar dados para o Application Insights agora.

1. De volta à guia do navegador para https://<app-name>.azurewebsites.net, atualizar a página algumas vezes para gerar algumas solicitações da Web.

2. Volte para a página de visão geral do grupo de recursos e selecione o recurso do Application Insights que azd up criou. Agora você deve visualizar alguns dados nos gráficos padrão.

   

Observação

Neste cenário de monitoramento muito comum, o Application Insights é apenas um dos destinos do OpenTelemetry que você poderá usar, como Jaeger, Prometheus e Zipkin.

6. Limpar os recursos

Quando não precisar mais do ambiente, você poderá excluir os grupos de recursos e todos os recursos relacionados. Basta executar esses comandos no Cloud Shell:

cd ~/MyFirstAzureWebApp
az group delete --yes
cd ~/app-service-sidecar-tutorial-prereqs
azd down

Perguntas frequentes

• Como os contêineres sidecar lidam com a comunicação interna?
• Como fazer para instrumentar outras pilhas de linguagens?

Como os contêineres sidecar lidam com a comunicação interna?

Os contêineres sidecar compartilham o mesmo host de rede que o contêiner principal, portanto, o contêiner principal (e outros contêineres sidecar) pode acessar qualquer porta no sidecar com localhost:<port>. O exemplo startup.sh usa localhost:4318 para acessar a porta 4318 no sidecar otel-collector.

Na caixa de diálogo Editar contêiner, a caixa Porta não é usada atualmente pelo Serviço de Aplicativo. Você pode usá-la como parte dos metadados do sidecar, por exemplo, para indicar qual porta o sidecar está escutando.

Como fazer para instrumentar outras pilhas de linguagens?

Você pode usar uma abordagem semelhante para instrumentar aplicativos em outras pilhas de linguagens. Para obter mais informações, confira a documentação do OpenTelemetry:

• .NET
• PHP
• Python
• Java
• Node.js

Mais recursos

• Implantação no Serviço de Aplicativo usando o GitHub Actions
• OpenTelemetry