Как настроить интеграцию APM и сертификаты удостоверяющих центров

Эта статья относится к: ❎ Basic/Standard ✅ Enterprise

В этой статье показано, как настроить интеграцию монитора производительности приложений (APM) и сертификаты центра сертификации (ЦС) в плане Azure Spring Apps Enterprise.

Вы можете включить или отключить службу сборки Tanzu на экземпляре плана Azure Spring Apps Enterprise. Дополнительные сведения см. в разделе Служба сборки по запросу в разделе Использование Tanzu Build Service.

Предварительные условия

• Уже подготовленный экземпляр плана Azure Spring Apps Enterprise. Для получения дополнительной информации см. краткое руководство по созданию и развертыванию приложений в Azure Spring Apps с использованием плана Enterprise.
• Azure CLI версии 2.49.0 или более поздней. Чтобы установить расширение Azure Spring Apps, выполните следующую команду: az extension add --name spring

Поддерживаемые сценарии — интеграция сертификатов APM и сертификационных центров (ЦС)

Служба сборки Tanzu использует привязку buildpack для интеграции с Tanzu Partner Buildpacks и других облачных собственных пакетов сборки, таких как пакет сборки ca-certificates на GitHub.

В настоящее время Azure Spring Apps поддерживает следующие типы APM:

• ApplicationInsights
• Dynatrace
• AppDynamics
• New Relic
• ElasticAPM

Azure Spring Apps поддерживает сертификаты УЦ для всех сборок для различных языковых семей, но не все поддерживаемые средства APM. В следующей таблице показаны типы привязок, поддерживаемые пакетами сборок семейства языков Tanzu.

Сведения об использовании веб-серверов см. в разделе "Развертывание статических веб-файлов".

Служба сборки Tanzu включена по умолчанию в Azure Spring Apps Enterprise. Если вы решили отключить службу сборки, вы можете развертывать приложения, но только с помощью пользовательского образа контейнера. В этом разделе содержатся рекомендации для сценариев как с включенными, так и с отключенными службами сборки.

Поддерживаемые типы APM

В этом разделе перечислены поддерживаемые языки и обязательные переменные среды для API, которые можно использовать для интеграции.

• Application Insights

  Поддерживаемые языки:

  • Java

  Переменные среды, необходимые для привязки buildpack:

  • connection-string

  Сведения о других поддерживаемых переменных среды см. в разделе "Обзор Application Insights".

• DynaTrace

  Поддерживаемые языки:

  • Java
  • .NET
  • Иди
  • Node.js
  • Веб-серверы
  • PHP

  Переменные среды, необходимые для привязки buildpack:

  • api-url или environment-id (используется в шаге сборки)
  • api-token (используется в шаге сборки)
  • TENANT
  • TENANTTOKEN
  • CONNECTION_POINT

  Сведения о других поддерживаемых переменных среды см. в разделе Dynatrace

• New Relic

  Поддерживаемые языки:

  • Java
  • .NET
  • Node.js
  • PHP

  Переменные среды, необходимые для связывания с buildpack:

  • license_key
  • app_name

  Другие поддерживаемые переменные среды см. в разделе New Relic

• Elastic

  Поддерживаемые языки:

  • Java
  • Node.js
  • PHP

  Переменные среды, необходимые для привязки buildpack:

  • service_name
  • application_packages
  • server_url

  Сведения о других поддерживаемых переменных среды см. в разделе Elastic

• AppDynamics

  Поддерживаемые языки:

  • Java
  • Node.js

  Переменные среды, необходимые для привязки buildpack:

  • agent_application_name
  • agent_tier_name
  • agent_node_name
  • agent_account_name
  • agent_account_access_key
  • controller_host_name
  • controller_ssl_enabled
  • controller_port

  Другие поддерживаемые переменные среды см. в разделе AppDynamics

Привязки в конструкторе устарели.

При использовании Azure CLI для создания экземпляра службы может появиться сообщение Buildpack bindings feature is deprecated, it's not available when your own container registry is used for build service or build service is disabledоб ошибке. Это сообщение означает, что вы используете старую версию Azure CLI. Чтобы устранить эту проблему, обновите Azure CLI. Дополнительные сведения см. в статье Как обновить Azure CLI.

Настройка интеграции APM для сборок и развертываний приложений

APM можно настроить в Azure Spring Apps следующими способами:

• Управление конфигурациями APM на уровне экземпляра службы и их привязка к сборкам и развертываниям приложений посредством ссылок на них. Этот подход является рекомендуемым способом настройки APM.

• Управляйте конфигурациями APM через привязки в построителе и привязывайте к сборкам и развертываниям приложений, ссылаясь на построителя.

Теперь вы можете настроить APM в Azure Spring Apps, управляя конфигурациями APM на уровне экземпляра службы и привязываясь к сборкам и развертываниям приложений, ссылаясь на них. Этот подход является рекомендованным способом настройки APM.

В следующих разделах приведены рекомендации по обоим из этих подходов.

Управление API на уровне экземпляра службы (рекомендуется)

Конфигурацию APM можно создать и привязать к сборкам и развертываниям приложений, как описано в следующих разделах.

Управление конфигурацией APM в Azure Spring Apps

Вы можете управлять интеграцией APM, настраивая свойства или секреты в конфигурации APM с помощью портал Azure или Azure CLI.

Дополнительные сведения о параметрах properties и secrets для вашего пакета сборки см. в разделе «Поддерживаемые сценарии — интеграция APM и сертификатов ЦС».

Привязка к сборкам и развертываниям приложений

Для службы сборки, используюющей управляемый Реестр контейнеров Azure, используйте следующую команду, чтобы интегрировать APM в развертывания:

az spring app deploy \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --name <app-name> \
    --builder <builder-name> \
    --apms <APM-name> \
    --artifact-path <path-to-your-JAR-file>

Когда вы включаете конфигурацию APM глобально, все последующие сборки и развертывания используют его автоматически, и не требуется указывать --apms этот параметр. Если вы хотите переопределить конфигурацию APM, включенную глобально для развертывания, укажите конфигурации APM с помощью --apms параметра.

Для службы сборки, использующей собственный реестр контейнеров, можно создать образ контейнера из приложения и развернуть его на текущих или других экземплярах службы Azure Spring Apps Enterprise.

Предоставление собственного реестра контейнеров отделяет сборку от развертывания. Вы можете использовать команду сборки для создания или обновления сборки с помощью средства сборки, а затем использовать команду развертывания для развертывания образа контейнера в службу.

Чтобы создать образ и настроить APM, используйте следующую команду:

az spring build-service build <create|update> \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --name <app-name> \
    --builder <builder-name> \
    --apms <APM-name> \
    --artifact-path <path-to-your-JAR-file>

Когда вы включаете конфигурацию APM глобально, все последующие сборки и развертывания используют его автоматически, и не требуется указывать --apms этот параметр. Если вы хотите переопределить конфигурацию APM, включенную глобально для сборки, укажите конфигурации APM с помощью --apms параметра.

Используйте следующую команду, чтобы развернуть приложение с помощью образа контейнера, созданного ранее, и настроить APM. Конфигурацию APM можно использовать глобально или с помощью параметра --apms указать конкретную конфигурацию APM.

az spring app deploy \
   --resource-group <resource-group-name> \
   --service <Azure-Spring-Apps-instance-name> \
   --name <app-name> \
   --container-image <your-container-image> \
   --container-registry <your-container-registry> \
   --registry-password <your-password> \
   --registry-username <your-username> \
   --apms <your-APM>

При отключении службы сборки можно развернуть приложение только с помощью образа контейнера. Дополнительные сведения см. в «Развертывание приложения с пользовательским образом контейнера».

Вы можете использовать несколько экземпляров Azure Spring Apps Enterprise, где некоторые экземпляры создают и развертывают образы, а другие — только развертывать образы. Рассмотрим следующий сценарий:

Например, вы включите службу сборки с реестром пользовательских контейнеров. Затем вы создаете образ контейнера из файла артефакта или исходного кода с помощью APM или сертификата ЦС. Затем можно развернуть на текущем экземпляре Azure Spring Apps или других экземплярах служб. Дополнительные сведения см. в разделе "Сборка и развертывание приложений polyglot" статьи "Развертывание приложений polyglot в Azure Spring Apps Enterprise".

В другом сценарии, с отключённой службой сборки, вы развертываете приложение с образом контейнера в своем реестре и используете APM.

В этом сценарии можно глобально использовать конфигурацию APM или использовать --apms параметр для указания конфигурации APM, как показано в следующем примере:

az spring app deploy \
   --resource-group <resource-group-name> \
   --service <Azure-Spring-Apps-instance-name> \
   --name <app-name> \
   --container-image <your-container-image> \
   --container-registry <your-container-registry> \
   --registry-password <your-password> \
   --registry-username <your-username> \
   --apms <your-APM>

Управление APM с помощью привязок в конструкторе (устаревшее)

Когда служба сборки использует управляемый реестр контейнеров Azure Spring Apps, вы можете создать приложение на образ, а затем развернуть его, но только в текущем экземпляре службы Azure Spring Apps.

Управление конфигурациями APM с помощью привязок в построителе

Конфигурации APM можно управлять с помощью привязок в построителе. Дополнительные сведения см. в разделе "Управление привязками в построителе" в Azure Spring Apps (не рекомендуется).

Привязка к сборкам и развертываниям приложений

Используйте следующую команду, чтобы интегрировать APM в ваши развертывания. APM настраивается с помощью привязок в конструкторе.

az spring app deploy \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --name <app-name> \
    --builder <builder-name> \
    --artifact-path <path-to-your-JAR-file>

Включите Application Insights при создании экземпляра службы

Если включить Application Insights при создании экземпляра службы, применяются следующие условия:

• Если для службы сборки используется управляемый Реестр контейнеров Azure, Application Insights привязана к привязкам в построителе по умолчанию.
• Если вы используете собственный реестр контейнеров для службы сборки или отключите службу сборки, для Application Insights создается конфигурация APM по умолчанию. APM по умолчанию включен глобально, а все последующие сборки и развертывания используются автоматически.

Настройка сертификатов ЦС для сборок и развертываний приложений

Сертификаты ЦС можно настроить в Azure Spring Apps следующими способами:

• Вы можете управлять общедоступными сертификатами в параметрах TLS/SSL и привязывать к сборкам и развертываниям приложений, ссылаясь на них. Рекомендуется использовать этот подход для настройки сертификатов ЦС.
• Вы можете управлять общедоступными сертификатами в параметрах TLS/SSL и привязывать сертификаты ЦС с помощью привязок в построителе. Дополнительные сведения см. в разделе "Управление привязками в построителе" в Azure Spring Apps (не рекомендуется).

Теперь вы можете управлять общедоступными сертификатами в параметрах TLS/SSL и привязать к сборкам и развертываниям приложений, ссылаясь на них. Этот подход является рекомендуемым способом настройки сертификатов ЦС.

Чтобы управлять общедоступными сертификатами на уровне экземпляра службы, см. раздел Импорт сертификата в Использование TLS/SSL сертификатов в вашем приложении в Azure Spring Apps. Затем выполните один из подходов, описанных в следующих разделах, чтобы привязать сертификаты ЦС к сборкам и развертываниям приложений.

Привязка сертификатов ЦС к сборкам и развертываниям приложений

Сведения о том, как привязать сертификаты ЦС к развертываниям, см. в разделе "Загрузка сертификата" документации "Использование сертификатов TLS/SSL в вашем приложении в Azure Spring Apps". Затем используйте следующие инструкции, чтобы привязаться к сборкам приложений.

Когда вы включаете службу сборки и используете управляемый реестр контейнеров Azure, используйте следующую команду для интеграции сертификатов центра сертификации в ваше развертывание.

az spring app deploy \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --name <app-name> \
    --builder <builder-name> \
    --build-certificates <CA certificate-name> \
    --artifact-path <path-to-your-JAR-file>

При использовании собственного реестра контейнеров для службы сборки или при отключении службы сборки, используйте следующую команду, чтобы интегрировать сертификаты удостоверяющего центра (CA) в вашу сборку.

az spring build-service build <create|update> \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --name <app-name> \
    --builder <builder-name> \
    --certificates <CA certificate-name> \
    --artifact-path <path-to-your-JAR-file>

Просмотр сертификатов центра сертификации, привязанных к сборкам приложений

Чтобы просмотреть сертификаты ЦС, привязанные к сборке, выполните следующие действия.

1. Перейдите на страницу сборки.

   

2. В области навигации в разделе "Параметры" выберите привязки сертификатов.

3. На странице "Привязки сертификатов" просмотрите сертификаты ЦС, привязанные к сборке.

   

Привязка сертификатов ЦС с помощью привязок в конструкторе (устарело)

Сертификаты ЦС используют пакет сборки ca-certificates для поддержки предоставления сертификатов ЦС в хранилище доверия системы во время сборки и времени выполнения.

В плане Azure Spring Apps Enterprise сертификаты ЦС используют вкладку "Сертификаты открытого ключа" на странице настроек TLS/SSL в портале Azure, как показано на следующем экране.

Сертификаты ЦС можно конфигурировать на странице "Изменение привязки". Сертификаты succeeded отображаются в списке сертификатов ЦС.

Управление связями в конструкторе в Azure Spring Apps (устарело)

Этот раздел применяется только к экземпляру службы Azure Spring Apps Enterprise с включенной службой сборки. Если служба сборки включена, одна привязка buildpack означает либо настройку учетных данных для одного типа APM, либо настройку сертификатов CA для типа сертификатов CA. Чтобы интегрировать APM, следуйте приведенным выше инструкциям, чтобы настроить необходимые переменные среды или секреты для APM.

Вы можете управлять привязками пакетов сборки с помощью портала Azure или Azure CLI.

az spring build-service builder buildpack-binding list \
    --resource-group <your-resource-group-name> \
    --service <your-service-instance-name> \
    --builder-name <your-builder-name>

az spring build-service builder buildpack-binding create \
    --resource-group <your-resource-group-name> \
    --service <your-service-instance-name> \
    --name <your-buildpack-binding-name> \
    --builder-name <your-builder-name> \
    --type <your-binding-type> \
    --properties a=b c=d \
    --secrets e=f g=h

az spring build-service builder buildpack-binding show \
    --resource-group <your-resource-group-name> \
    --service <your-service-instance-name> \
    --name <your-buildpack-binding-name> \
    --builder-name <your-builder-name>

az spring build-service builder buildpack-binding set \
    --resource-group <your-resource-group-name> \
    --service <your-service-instance-name> \
    --name <your-buildpack-binding-name> \
    --builder-name <your-builder-name> \
    --type <your-binding-type> \
    --properties a=b c=d \
    --secrets e=f2 g=h

az spring build-service builder buildpack-binding delete \
    --resource-group <your-resource-group-name> \
    --service <your-service-instance-name> \
    --name <your-buildpack-binding-name> \
    --builder-name <your-builder-name>

Перенос сертификатов APM и Центра сертификации из привязок в конструкторе

Функция привязок в построителе устарела и будет удалена в будущем. Мы рекомендуем перенести привязки в построителе.

Сертификаты APM и ЦС можно настроить в настройках привязок и мигрировать их, используя следующие разделы.

Перенесите APM, который сконфигурирован в привязках

В большинстве случаев используется только один APM, настроенный в привязках в построителе по умолчанию. Вы можете создать новую конфигурацию APM с той же конфигурацией в привязках и включить эту конфигурацию APM глобально. Все последующие сборки и развертывания используют эту конфигурацию автоматически. Чтобы выполнить миграцию, выполните следующие действия.

1. Чтобы создать конфигурацию APM, используйте следующую команду:

   az spring apm create \
       --resource-group <resource-group-name> \
       --service <Azure-Spring-Apps-instance-name> \
       --name <your-APM-name> \
       --type <your-APM-type> \
       --properties a=b c=d \
       --secrets e=f g=h
   

2. Используйте следующую команду, чтобы глобально включить конфигурацию APM:

   az spring apm enable-globally \
       --resource-group <resource-group-name> \
       --service <Azure-Spring-Apps-instance-name> \
       --name <your-APM-name> \
   

3. Используйте следующую команду, чтобы повторно развернуть все приложения, чтобы использовать новую конфигурацию APM, включенную глобально:

   az spring app deploy \
       --resource-group <resource-group-name> \
       --service <Azure-Spring-Apps-instance-name> \
       --name <app-name> \
       --builder <builder-name> \
       --artifact-path <path-to-your-JAR-file>
   

4. Убедитесь, что новая конфигурация APM работает для всех приложений. Если все работает хорошо, используйте следующую команду, чтобы удалить привязки APM в построителе:

   az spring build-service builder buildpack-binding delete \
       --resource-group <resource-group-name> \
       --service <Azure-Spring-Apps-instance-name> \
       --name <your-APM-buildpack-binding-name> \
       --builder-name <your-builder-name>
   

Если в привязках настроено несколько APM, можно создать несколько конфигураций APM с той же конфигурацией в привязках и включить конфигурацию APM глобально, если это применимо. Используйте параметр --apms, чтобы указать конфигурацию APM для развертывания, если вы хотите переопределить глобально включённый APM, как показано в следующей команде.

az spring app deploy \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --name <app-name> \
    --builder <builder-name> \
    --apms <APM-name> \
    --artifact-path <path-to-your-JAR-file>

В процессе миграции APM настраивается как в привязках, так и в настройках конфигурации APM. В этом случае конфигурация APM вступает в силу, и привязка игнорируется.

Перенос сертификата ЦС, настроенного в привязках

Чтобы перенести сертификат ЦС, выполните следующие действия.

1. Для сертификата ЦС, настроенного в привязке, если он используется во время выполнения программы, вы можете загрузить сертификат в ваше приложение. Дополнительные сведения см. в разделе "Загрузка сертификата " в разделе "Использование TLS/SSL-сертификатов" в приложении в Azure Spring Apps.

2. Используйте следующую команду, чтобы повторно развернуть все приложения, используя сертификат ЦС. Если сертификат используется во время сборки, используйте --build-certificates параметр, чтобы указать сертификат ЦС, используемый во время сборки для развертывания:

   az spring app deploy \
       --resource-group <resource-group-name> \
       --service <Azure-Spring-Apps-instance-name> \
       --name <app-name> \
       --builder <builder-name> \
       --build-certificates <CA certificate-name> \
       --artifact-path <path-to-your-JAR-file>
   

3. Проверьте, работает ли сертификат ЦС для всех приложений, использующих его. Если все работает хорошо, используйте следующую команду, чтобы удалить привязки сертификатов ЦС в построителе:

   az spring build-service builder buildpack-binding delete \
       --resource-group <resource-group-name> \
       --service <Azure-Spring-Apps-instance-name> \
       --name <your-CA-certificate-buildpack-binding-name> \
       --builder-name <your-builder-name>
   

Следующие шаги

• Развертывание многолотных приложений в Azure Spring Apps Enterprise