Tutorial: Configuración de un contenedor sidecar para una aplicación Linux en Azure App Service

En este tutorial, agregará un recopilador de OpenTelemetry como contenedor sidecar a una aplicación Linux (traiga su propio código) en Azure App Service. Para los contenedores personalizados, consulte Tutorial: Configuración de un contenedor sidecar para un contenedor personalizado en Azure App Service.

Si no tiene una cuenta de Azure, cree una cuenta gratuita antes de comenzar.

¿Qué es un contenedor "sidecar"?

En Azure App Service, puede agregar hasta nueve contenedores sidecar para cada aplicación Linux. Los contenedores de Sidecar le permiten implementar servicios y características adicionales en las aplicaciones de Linux sin acoplarlos estrechamente al contenedor principal (integrado o personalizado). Por ejemplo, puede agregar servicios de supervisión, registro, configuración y redes como contenedores sidecar. Un sidecar de recopilador OpenTelemetry es uno de estos ejemplos de supervisión.

Los contenedores sidecar se ejecutan junto con el contenedor de aplicaciones principal en el mismo plan de App Service.

1. Configuración de los recursos necesarios

En primer lugar, cree los recursos que usa el tutorial. Se usan para este escenario en particular y no son necesarios para los contenedores sidecar en general.

1. En Azure Cloud Shell, ejecute los comandos siguientes. Asegúrese de proporcionar el <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. Cuando se le solicite, proporcione la suscripción y la región que prefiera. Por ejemplo:

   • Suscripción:Su suscripción.
   • Región: (Europa) Oeste de Europa.

   Cuando se complete la implementación, debería ver la siguiente salida:

    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 estos valores de salida para más adelante. También puede encontrarlos en el portal, en las páginas de administración de los recursos respectivos.

   Nota:

   azd provision usa las plantillas incluidas para crear los siguientes recursos de Azure:

   • Un grupo de recursos basado en el nombre del entorno.
   • Un registro de contenedor con dos imágenes implementadas:
     • Imagen Nginx con el módulo OpenTelemetry.
     • Imagen del recopilador OpenTelemetry configurado para exportar a Azure Monitor.
   • Una identidad administrada asignada por el usuario con el permiso AcrPull en el grupo de recursos (para extraer imágenes del registro).
   • Un área de trabajo de Log Analytics.
   • Un componente de Application Insights.

2. Creación de una aplicación web

En este paso, implementará una plantilla de aplicación ASP.NET Core. De nuevo en Azure Cloud Shell, ejecute los siguientes comandos. Reemplace <app-name> por un nombre de aplicación único.

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

Después de unos minutos, esta aplicación web de .NET se implementa como MyFirstAzureWebApp.dll en una nueva aplicación de App Service.

3. Agregar un contenedor sidecar

En esta sección, agregará un contenedor sidecar a la aplicación Linux.

Usar la interfaz de usuario del portal

1. En Azure Portal, navegue hasta la página de administración de la aplicación

2. En la página de administración de la aplicación, en el menú izquierdo, seleccione Centro de implementación.

3. Seleccione el banner ¿Interesado en agregar contenedores para que se ejecuten junto con la aplicación? Haga clic aquí para probarlo.

4. Cuando se vuelva a cargar la página, seleccione la pestaña Contenedores (nuevo).

5. Seleccione Agregar y configure el nuevo contenedor de la siguiente manera:

   • Nombre: otel-collector
   • Origen de la imagen: Azure Container Registry
   • Autenticación: Credenciales de administrador
   • Registro: registro creado por azd provision
   • Imagen: otel-collector
   • Etiqueta: más reciente

6. Seleccione Aplicar.

   

Usar plantilla de Resource Manager

1. En Cloud Shell, ejecute el siguiente comando para agregar a la aplicación web la identidad administrada asignada por el usuario que azd provision creó. Use el valor de <managed-identity-resource-id> (una cadena muy larga) en la salida azd provision.

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

   Si ejecuta este comando dentro de ~/MyFirstAzureWebApp, no es necesario agregar ningún otro parámetro porque az webapp up establece los valores predeterminados ya para el grupo de recursos y el nombre de la aplicación.

2. Vaya a la plantilla de implementación personalizada en el portal.

3. Seleccione Cree su propia plantilla en el editor.

4. Reemplace el contenido del cuadro de texto por el código JSON siguiente y seleccione Guardar. Para <registry-name> y <managed-identity-client-id>, use los valores de salida de azd provision anteriores. Para <app-name>, use el nombre de la aplicación en az webapp up earlier. Para <sidecar-name>, proporcione un nombre para el contenedor 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": []
               }
           }
       ]
   }
   

   Sugerencia

   Para usar un contenedor en un registro público, modifique properties como en el ejemplo siguiente:

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

5. Para la entrada de plantilla, seleccione el grupo de recursos que tiene la aplicación web. Seleccione Revisar y crear y, a continuación, seleccione Crear.

   Dado que la interfaz de usuario del portal no está disponible, no puede ver este contenedor sidecar como parte de la aplicación, pero debería poder ver los registros de inicio relacionados de sidecar en los registros de la aplicación de App Service.

4. Configuración de las variables de entorno

Para el escenario de ejemplo, el sidecar otel-collector está configurado para exportar los datos de OpenTelemetry a Azure Monitor, pero necesita la cadena de conexión como una variable de entorno (consulte el Archivo de configuración de OpenTelemetry para la imagen otel-collector).

Puede configurar variables de entorno para los contenedores como cualquier aplicación de App Service mediante la configuración de la aplicación. La configuración de la aplicación es accesible para todos los contenedores de la aplicación.

1. Vaya a la página de administración de la aplicación de App Service.

2. En el menú de la izquierda, seleccione Variables de entorno.

3. Para agregar una configuración de aplicación, seleccione Agregar y configúrela de la siguiente manera:

   • Nombre: APPLICATIONINSIGHTS_CONNECTION_STRING
   • Valor: cadena de conexión en la salida de azd provision. Si perdió la sesión de Cloud Shell, también puede encontrarla en la página Información general del recurso de Application Insight, en Cadena de conexión.

4. Seleccione Aplicar y, después, Aplicar y, en seguida, Confirmar.

   

5. Configurar la instrumentación en el inicio

En este paso, creará la instrumentación de la aplicación según los pasos descritos en la Instrumentación de código cero de .NET de OpenTelemetry.

1. De vuelta en Cloud Shell, cree startup.sh con las líneas siguientes.

   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. Implemente este archivo en la aplicación con el siguiente comando de la CLI de Azure. Si todavía está en el directorio de ~/MyFirstAzureWebApp, no es necesario ningún otro parámetro porque az webapp up ya establece valores predeterminados para el grupo de recursos y el nombre de la aplicación.

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

   Sugerencia

   Este enfoque implementa el archivo startup.sh por separado de la aplicación. De este modo, la configuración de instrumentación es independiente del código de la aplicación. Sin embargo, puede usar otros métodos de implementación para implementar el script junto con la aplicación.

3. De nuevo en la página de administración de la aplicación, en el menú izquierdo, seleccione Configuración.

4. Establezca Comando de inicio en /home/site/startup.sh. Es la misma ruta de acceso que implementó en el paso anterior.

5. Seleccione Guardar y, a continuación, Continuar.

   

5. Comprobar en Application Insights

El sidecar otel-collector debe exportar datos a Application Insights ahora.

1. De nuevo en la pestaña del explorador para https://<app-name>.azurewebsites.net, actualice la página varias veces para generar algunas solicitudes web.

2. Vuelva a la página de información general del grupo de recursos y seleccione el recurso de Application Insights que ha azd up creado. Ahora debería ver algunos datos en los gráficos predeterminados.

   

Nota:

En este escenario de supervisión muy común, Application Insights es solo uno de los destinos de OpenTelemetry que puede usar, como Jaeger, Prometheus y Zipkin.

6. Limpieza de recursos

Cuando ya no necesite el entorno, puede eliminar el grupo de recursos y todos los recursos relacionados. Solo tiene que ejecutar estos comandos en Cloud Shell:

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

Preguntas más frecuentes

• ¿Cómo controlan los contenedores sidecar la comunicación interna?
• ¿Puede un contenedor sidecar recibir solicitudes de Internet?
• ¿Cómo instrumento otras pilas de lenguaje?

¿Cómo controlan los contenedores sidecar la comunicación interna?

Los contenedores sidecar comparten el mismo host de red que el contenedor principal, por lo que el contenedor principal (y otros contenedores sidecar) pueden llegar a cualquier puerto del sidecar con localhost:<port>. En el ejemplo startup.sh se usa localhost:4318 para acceder al puerto 4318 en el sidecar de otel-collector.

En el cuadro de diálogo Editar contenedor, App Service no usa actualmente el cuadro Puerto. Puede usarlo como parte de los metadatos de sidecar, así como para indicar el puerto al que escucha el sidecar.

¿Puede un contenedor sidecar recibir solicitudes de Internet?

No. App Service enruta las solicitudes de Internet solo al contenedor principal. En el caso de las aplicaciones Linux basadas en código, el contenedor de Linux integrado es el contenedor principal y cualquier contenedor sidecar (sitecontainers) debe agregarse con IsMain=false. En el caso de contenedores personalizados, todos, excepto uno de los sitecontainers, deben tener IsMain=false.

Para obtener más información sobre cómo configurar IsMain, vea Microsoft.Web sites/sitecontainers.

¿Cómo uso montajes de volumen?

La característica Montajes de volúmenes permite compartir archivos y directorios no persistentes entre contenedores dentro de la aplicación web.

Subruta de volumen: Se trata de una ruta de acceso de directorio lógica que se crea automáticamente y no se hace referencia a él dentro del contenedor. Los contenedores configurados con la misma subruta de volumen pueden compartir archivos y directorios entre sí.

Ruta de acceso de montaje del contenedor: Esto corresponde a una ruta de acceso de directorio a la que se hace referencia dentro del contenedor. La ruta de acceso de montaje del contenedor se asigna a la subruta del volumen.

Por ejemplo, supongamos que se configuran los siguientes montajes de volumen:

Nombre de Sidecar	Subruta de volumen	Ruta de acceso de montaje del contenedor	Solo lectura
Contenedor1	/directory1/directory2	/container1Vol	Falso
Container2	/directory1/directory2	/container2Vol	Cierto
Contenedor3	/directory1/directory2/directory3	/container3Vol	Falso
Container4	/directory4	/container1Vol	Falso

En función de esta configuración, se aplican las condiciones siguientes:

• Si Container1 crea /container1Vol/myfile.txt, Container2 puede leer el archivo a través de /container2Vol/myfile.txt.
• Si Container1 crea /container1Vol/directory3/myfile.txt, Container2 puede leer el archivo a través de /container2Vol/directory3/myfile.txt, y Container3 puede leer y escribir en el archivo a través de /container3Vol/myfile.txt.
• Container4 no comparte un montaje de volumen en común con ninguno de los otros contenedores.

Nota:

El contenedor de Linux integrado no puede usar montaje de volúmenes para las aplicaciones de Linux basadas en código.

¿Cómo instrumento otras pilas de lenguaje?

Puede usar un enfoque similar para instrumentar aplicaciones en otras pilas de lenguaje. Para obtener más información, consulte la documentación de OpenTelemetry:

• .RED
• PHP
• Pitón
• Java
• Node.js

Más recursos

• Tutorial: Ejecutar el bot de chat en App Service con una extensión sidecar Phi-3 (ASP.NET Core)
• Tutorial: Ejecutar el bot de chat en App Service con una extensión sidecar Phi-3 (Spring Boot)
• Tutorial: Ejecutar el bot de chat en App Service con una extensión sidecar Phi-3 (FastAPI)
• Tutorial: Ejecutar el bot de chat en App Service con una extensión sidecar Phi-3 (Express.js)
• API DE REST: Web Apps: creación o actualización del contenedor de sitios
• Infraestructura como código: Microsoft.Web sites/sitecontainers