Přehledy verzí a pracovních položek

Přehledy vydaných verzí a pracovních položek jsou zásadní pro optimalizaci životního cyklu vývoje softwaru. S vývojem aplikací je důležité pečlivě monitorovat jednotlivé verze a její pracovní položky. Tyto přehledy zvýrazňují kritické body výkonu a umožňují týmům aktivně řešit problémy a zajistit bezproblémové nasazení a uživatelské prostředí. Poskytují vývojářům a zúčastněným stranám rozhodování, úpravě procesů a poskytování vysoce kvalitního softwaru.

Průběžné monitorování

Azure Pipelines se integruje s Application Insights, aby bylo možné nepřetržitě monitorovat kanál verze Azure DevOps v průběhu životního cyklu vývoje softwaru.

Díky průběžnému monitorování můžou kanály verzí zahrnovat data monitorování z Application Insights a dalších prostředků Azure. Když kanál verze zjistí výstrahu Application Insights, může kanál zavírat nebo vrátit nasazení zpět, dokud se výstraha nevyřeší. Pokud všechny kontroly projdou, nasazení můžou pokračovat automaticky z testování až do produkčního prostředí bez nutnosti ručního zásahu.

Konfigurace průběžného monitorování

1. V Azure DevOps vyberte organizaci a projekt.

2. V nabídce vlevo na stránce projektu vyberte Verze kanálů>.

3. Vyberte šipku rozevíracího seznamu vedle položky Nový a vyberte Kanál nové verze. Nebo pokud kanál ještě nemáte, vyberte na stránce, která se zobrazí, nový kanál .

4. V podokně Vybrat šablonu vyhledejte a vyberte Aplikace Azure Nasazení služby s průběžným monitorováním a pak vyberte Použít.

   

5. V poli Fáze 1 vyberte hypertextový odkaz pro zobrazení úkolů fáze.

   

6. V podokně konfigurace fáze 1 vyplňte následující pole:

   Parametr	Hodnota
   Název fáze	Zadejte název fáze nebo ho ponechte ve fázi 1.
   Předplatné Azure	Vyberte šipku rozevíracího seznamu a vyberte propojené předplatné Azure, které chcete použít.
   Typ aplikace	Vyberte šipku rozevíracího seznamu a vyberte typ aplikace.
   Název služby App Service	Zadejte název služby Aplikace Azure.
   Název skupiny prostředků pro Application Insights	Vyberte šipku rozevíracího seznamu a vyberte skupinu prostředků, kterou chcete použít.
   Název prostředku Application Insights	Vyberte šipku rozevíracího seznamu a vyberte prostředek Application Insights pro skupinu prostředků, kterou jste vybrali.

7. Pokud chcete kanál uložit s výchozím nastavením pravidla upozornění, vyberte Uložit v pravém horním rohu okna Azure DevOps. Zadejte popisný komentář a vyberte OK.

Úprava pravidel upozornění

Nasazení služby Aplikace Azure service se šablonou průběžného monitorování obsahuje čtyři pravidla upozornění: dostupnost, neúspěšné požadavky, doba odezvy serveru a výjimky serveru. Můžete přidat další pravidla nebo změnit nastavení pravidla tak, aby vyhovovala vašim potřebám na úrovni služeb.

Úprava nastavení pravidla upozornění:

V levém podokně stránky kanálu verze vyberte Konfigurovat výstrahy Application Insights.

Pomocí vloženého skriptu se vytvoří čtyři výchozí pravidla upozornění:

$subscription = az account show --query "id";$subscription.Trim("`"");$resource="/subscriptions/$subscription/resourcegroups/"+"$(Parameters.AppInsightsResourceGroupName)"+"/providers/microsoft.insights/components/" + "$(Parameters.ApplicationInsightsResourceName)";
az monitor metrics alert create -n 'Availability_$(Release.DefinitionName)' -g $(Parameters.AppInsightsResourceGroupName) --scopes $resource --condition 'avg availabilityResults/availabilityPercentage < 99' --description "created from Azure DevOps";
az monitor metrics alert create -n 'FailedRequests_$(Release.DefinitionName)' -g $(Parameters.AppInsightsResourceGroupName) --scopes $resource --condition 'count requests/failed > 5' --description "created from Azure DevOps";
az monitor metrics alert create -n 'ServerResponseTime_$(Release.DefinitionName)' -g $(Parameters.AppInsightsResourceGroupName) --scopes $resource --condition 'avg requests/duration > 5' --description "created from Azure DevOps";
az monitor metrics alert create -n 'ServerExceptions_$(Release.DefinitionName)' -g $(Parameters.AppInsightsResourceGroupName) --scopes $resource --condition 'count exceptions/server > 5' --description "created from Azure DevOps";

Skript můžete upravit a přidat další pravidla upozornění. Můžete také upravit podmínky upozornění. Můžete také odebrat pravidla upozornění, která nedává smysl pro účely nasazení.

Přidání podmínek nasazení

Když do kanálu verze přidáte brány nasazení, upozornění, které překročí nastavené prahové hodnoty, zabrání nežádoucímu povýšení vydané verze. Po vyřešení výstrahy může nasazení pokračovat automaticky.

Přidání bran nasazení:

1. Na hlavní stránce kanálu v části Fáze vyberte symbol podmínek před nasazením nebo podmínky po nasazení v závislosti na tom, která fáze vyžaduje bránu průběžného monitorování.

   

2. V podokně konfigurace podmínek před nasazením nastavte brány na Povoleno.

3. Vedle brány nasazení vyberte Přidat.

4. V rozevírací nabídce vyberte Dotazovat upozornění služby Azure Monitor. Tato možnost umožňuje přístup k upozorněním služby Azure Monitor i Application Insights.

   

5. V části Možnosti vyhodnocení zadejte požadované hodnoty pro nastavení, jako je doba mezi opětovným vyhodnocením bran a časový limit, po kterém brány selžou.

Zobrazení protokolů vydaných verzí

V protokolech vydaných verzí můžete vidět chování brány nasazení a další kroky vydané verze. Otevření protokolů:

1. V nabídce vlevo na stránce kanálu vyberte Vydané verze .

2. Vyberte libovolnou verzi.

3. V části Fáze vyberte libovolnou fázi a zobrazte souhrn vydané verze.

4. Pokud chcete zobrazit protokoly, vyberte Zobrazit protokoly v souhrnu vydané verze, vyberte hypertextový odkaz Úspěch nebo Selhání v libovolné fázi nebo najeďte myší na libovolnou fázi a vyberte Protokoly.

   

Poznámky k verzi

Poznámky ukazují, kde jste nasadili nový build nebo jiné významné události. Poznámky usnadňují zjištění, jestli vaše změny měly vliv na výkon vaší aplikace. Dají se automaticky vytvořit systémem sestavení Azure Pipelines . Můžete také vytvořit poznámky, které označí příznakem libovolnou událost, a to tak, že je vytvoříte z PowerShellu.

Poznámky k verzi s využitím buildu Azure Pipelines

Poznámky k verzi jsou funkcí cloudové služby Azure Pipelines Azure DevOps.

Pokud jsou splněna všechna následující kritéria, úloha nasazení automaticky vytvoří poznámku k verzi:

• Prostředek, ke kterému nasazujete, je propojený s Application Insights prostřednictvím APPINSIGHTS_INSTRUMENTATIONKEY nastavení aplikace.

• Prostředek Application Insights je ve stejném předplatném jako prostředek, do kterého nasazujete.

• Používáte jednu z následujících úloh kanálu Azure DevOps:

  Kód úkolu	Název úkolu	Verze
  AzureAppServiceSettings	Nastavení služby Aplikace Azure	Všechny
  AzureRmWebAppDeployment	nasazení služby Aplikace Azure	V3 a vyšší
  AzureFunctionApp	Azure Functions	Všechny
  AzureFunctionAppContainer	Azure Functions pro kontejner	Všechny
  AzureWebAppContainer	Azure Web App for Containers	Všechny
  AzureWebApp	Webová aplikace Azure	Všechny

Poznámka:

Pokud stále používáte úlohu nasazení poznámek Application Insights, měli byste ji odstranit.

Konfigurace poznámek k verzi

Pokud nemůžete použít některou z úloh nasazení v předchozí části, musíte do kanálu nasazení přidat vloženou úlohu skriptu.

1. Přejděte na nový nebo existující kanál a vyberte úlohu.

   

2. Přidejte novou úlohu a vyberte Azure CLI.

   

3. Zadejte příslušné předplatné Azure. Změňte typ skriptu na PowerShell a umístění skriptu na vložené.

4. Přidejte skript PowerShellu z kroku 2 v další části do vloženého skriptu.

5. Přidejte následující argumenty. Zástupné symboly v hranatých závorkách nahraďte hodnotami na Argumenty skriptu. Jedná se o -releaseProperties volitelné.

       -aiResourceId "<aiResourceId>" `
       -releaseName "<releaseName>" `
       -releaseProperties @{"ReleaseDescription"="<a description>";
            "TriggerBy"="<Your name>" }
   

   

   Následující příklad ukazuje metadata, která můžete nastavit v volitelném releaseProperties argumentu pomocí proměnných sestavení a vydané verze .

   -releaseProperties @{
    "BuildNumber"="$(Build.BuildNumber)";
    "BuildRepositoryName"="$(Build.Repository.Name)";
    "BuildRepositoryProvider"="$(Build.Repository.Provider)";
    "ReleaseDefinitionName"="$(Build.DefinitionName)";
    "ReleaseDescription"="Triggered by $(Build.DefinitionName) $(Build.BuildNumber)";
    "ReleaseEnvironmentName"="$(Release.EnvironmentName)";
    "ReleaseId"="$(Release.ReleaseId)";
    "ReleaseName"="$(Release.ReleaseName)";
    "ReleaseRequestedFor"="$(Release.RequestedFor)";
    "ReleaseWebUrl"="$(Release.ReleaseWebUrl)";
    "SourceBranch"="$(Build.SourceBranch)";
    "TeamFoundationCollectionUri"="$(System.TeamFoundationCollectionUri)" }
   

6. Zvolte Uložit.

Vytváření poznámek k verzi pomocí Azure CLI

Pomocí skriptu PowerShellu můžete vytvářet poznámky z libovolného CreateReleaseAnnotation procesu bez použití Azure DevOps.

1. Přihlaste se k Azure CLI.

2. Vytvořte místní kopii následujícího skriptu a zavolejte ji CreateReleaseAnnotation.ps1.

   param(
       [parameter(Mandatory = $true)][string]$aiResourceId,
       [parameter(Mandatory = $true)][string]$releaseName,
       [parameter(Mandatory = $false)]$releaseProperties = @()
   )
   
   # Function to ensure all Unicode characters in a JSON string are properly escaped
   function Convert-UnicodeToEscapeHex {
     param (
       [parameter(Mandatory = $true)][string]$JsonString
     )
     $JsonObject = ConvertFrom-Json -InputObject $JsonString
     foreach ($property in $JsonObject.PSObject.Properties) {
       $name = $property.Name
       $value = $property.Value
       if ($value -is [string]) {
         $value = [regex]::Unescape($value)
         $OutputString = ""
         foreach ($char in $value.ToCharArray()) {
           $dec = [int]$char
           if ($dec -gt 127) {
             $hex = [convert]::ToString($dec, 16)
             $hex = $hex.PadLeft(4, '0')
             $OutputString += "\u$hex"
           }
           else {
             $OutputString += $char
           }
         }
         $JsonObject.$name = $OutputString
       }
     }
     return ConvertTo-Json -InputObject $JsonObject -Compress
   }
   
   $annotation = @{
       Id = [GUID]::NewGuid();
       AnnotationName = $releaseName;
       EventTime = (Get-Date).ToUniversalTime().GetDateTimeFormats("s")[0];
       Category = "Deployment"; #Application Insights only displays annotations from the "Deployment" Category
       Properties = ConvertTo-Json $releaseProperties -Compress
   }
   
   $annotation = ConvertTo-Json $annotation -Compress
   $annotation = Convert-UnicodeToEscapeHex -JsonString $annotation  
   
   $accessToken = (az account get-access-token | ConvertFrom-Json).accessToken
   $headers = @{
       "Authorization" = "Bearer $accessToken"
       "Accept"        = "application/json"
       "Content-Type"  = "application/json"
   }
   $params = @{
       Headers = $headers
       Method  = "Put"
       Uri     = "https://management.azure.com$($aiResourceId)/Annotations?api-version=2015-05-01"
       Body    = $annotation
   }
   Invoke-RestMethod @params
   

   Poznámka:

   • Vaše poznámky musí mít nastavenou kategorii nasazení, aby se zobrazila na webu Azure Portal.
   • Pokud se zobrazí chyba Požadavek obsahuje tělo entity, ale bez hlavičky Content-Type, zkuste odebrat parametry nahrazení v následujícím řádku.

   $body = (ConvertTo-Json $annotation -Compress)

3. Pomocí následujícího kódu zavolejte skript PowerShellu. Zástupné symboly v hranatých závorkách nahraďte hodnotami. Jedná se o -releaseProperties volitelné.

        .\CreateReleaseAnnotation.ps1 `
         -aiResourceId "<aiResourceId>" `
         -releaseName "<releaseName>" `
         -releaseProperties @{"ReleaseDescription"="<a description>";
             "TriggerBy"="<Your name>" }
   

   Argument	Definice	Poznámka:
   aiResourceId	ID prostředku pro cílový prostředek Application Insights.	Příklad: /subscriptions/0000000-0000-0000-0000-00000000000/resourceGroups/MyRGName/providers/microsoft.insights/components/MyResourceName
   releaseName	Název, který má dát vytvořené poznámky k verzi.
   releaseProperties	Slouží k připojení vlastních metadat k poznámce.	Volitelné

Zobrazení poznámek

Poznámka:

Poznámky k verzi nejsou v současné době dostupné v podokně Metriky application Insights.

Pokaždé, když k nasazení nové verze použijete šablonu vydané verze, odešle se do Application Insights poznámka. Poznámky můžete zobrazit na následujících místech:

• Výkon:

  

• Selhání:

  

• Zvyk:

  

• Sešity:

  V libovolném dotazu sešitu založeném na protokolu, kde vizualizace zobrazuje čas podél osy x:

  

Pokud chcete v sešitu povolit poznámky, přejděte do Části Upřesnit nastavení a vyberte Zobrazit poznámky.

Výběrem libovolné značky poznámek otevřete podrobnosti o vydané verzi, včetně žadatele, větve správy zdrojového kódu, kanálu verze a prostředí.

Poznámky k vydaným verzím pomocí klíčů rozhraní API

Poznámky k verzi jsou funkcí cloudové služby Azure Pipelines Azure DevOps.

Důležité

Poznámky používající klíče rozhraní API jsou zastaralé. Místo toho doporučujeme použít Azure CLI .

Instalace rozšíření poznámek (jednou)

Pokud chcete vytvářet poznámky k verzi, nainstalujte jedno z mnoha rozšíření Azure DevOps dostupných v sadě Visual Studio Marketplace.

1. Přihlaste se k projektu Azure DevOps .

2. Na stránce rozšíření Poznámky k verzi Visual Studio Marketplace vyberte vaši organizaci Azure DevOps. Výběrem možnosti Nainstalovat přidáte rozšíření do vaší organizace Azure DevOps.

   

Rozšíření je potřeba nainstalovat jenom jednou pro vaši organizaci Azure DevOps. Teď můžete nakonfigurovat poznámky k verzi pro libovolný projekt ve vaší organizaci.

Konfigurace poznámek k verzím pomocí klíčů rozhraní API

Vytvořte samostatný klíč rozhraní API pro každou šablonu verze Azure Pipelines.

1. Přihlaste se k webu Azure Portal a otevřete prostředek Application Insights, který monitoruje vaši aplikaci. Nebo pokud ho nemáte, vytvořte nový prostředek Application Insights.

2. Otevřete kartu Přístup k rozhraní API a zkopírujte ID Application Insights.

   

3. V samostatném okně prohlížeče otevřete nebo vytvořte šablonu verze, která spravuje nasazení Azure Pipelines.

4. Vyberte Přidat úlohu a pak v nabídce vyberte úlohu Poznámky k verzi Application Insights.

   

   Poznámka:

   Úloha Poznámky k verzi aktuálně podporuje pouze agenty založené na Systému Windows. Nebude se spouštět v Linuxu, macOS ani jiných typech agentů.

5. V části ID aplikace vložte ID Application Insights, které jste zkopírovali z karty Přístup k rozhraní API.

   

6. Zpět v okně Přístup k rozhraní API Application Insights vyberte Vytvořit klíč rozhraní API.

   

7. V okně Vytvořit klíč rozhraní API zadejte popis, vyberte Zapisovat poznámky a pak vyberte Vygenerovat klíč. Zkopírujte nový klíč.

   

8. V okně šablony vydané verze vyberte na kartě Proměnné možnost Přidat a vytvořte definici proměnné pro nový klíč rozhraní API.

9. V části Název zadejte ApiKey. V části Hodnota vložte klíč rozhraní API, který jste zkopírovali z karty Přístup k rozhraní API.

   

10. Výběrem možnosti Uložit v okně hlavní šablony vydané verze šablonu uložte.

    Poznámka:

    Omezení pro klíče rozhraní API jsou popsaná v dokumentaci k limitům rychlosti rozhraní REST API.

Přechod na novou poznámku k verzi

Použití nových poznámek k verzi:

1. Odeberte rozšíření Poznámky k verzi.
2. Odeberte úlohu Poznámky k verzi Application Insights v nasazení Azure Pipelines.
3. Vytvářejte nové poznámky k verzi pomocí Azure Pipelines nebo Azure CLI.

Integrace pracovní položky

Funkce integrace pracovních položek umožňuje snadno vytvářet pracovní položky v GitHubu nebo Azure DevOps, které obsahují relevantní data Application Insights vložená do nich.

Integrace nové pracovní položky nabízí v klasické verzi následující funkce:

• Upřesňující pole, jako jsou přiřazení, projekty nebo milníky.
• Ikony úložiště, abyste mohli rozlišovat mezi sešity GitHubu a Azure DevOps.
• Více konfigurací pro libovolný počet úložišť nebo pracovních položek
• Nasazení prostřednictvím šablon Azure Resource Manageru
• Předdefinované a přizpůsobitelné dotazy jazyka KQL (Keyword Query Language) pro přidání dat Application Insights do pracovních položek
• Přizpůsobitelné šablony sešitu

Vytvoření a konfigurace šablony pracovní položky

1. Pokud chcete vytvořit šablonu pracovní položky, přejděte do prostředku Application Insights a vlevo v části Konfigurace vyberte Pracovní položky a pak nahoře vyberte Vytvořit novou šablonu.

   

   Šablonu pracovní položky můžete vytvořit také na kartě s podrobnostmi o celé transakci, pokud v současné době neexistuje žádná šablona. Vyberte událost a na pravé straně vyberte Vytvořit pracovní položku a pak začněte se šablonou sešitu.

   

2. Po výběru nové šablony můžete zvolit systémy sledování, pojmenovat sešit, propojit vybraný sledovací systém a zvolit oblast pro uložení šablony (výchozí možností je oblast, ve které se nachází prostředek Application Insights). Parametry adresy URL jsou výchozí adresou URL pro vaše úložiště, https://github.com/myusername/reponame https://dev.azure.com/{org}/{project}například .

   

   Konkrétní vlastnosti pracovní položky můžete nastavit přímo ze samotné šablony. To zahrnuje cestu přiřazení, cestu iterace, projekty a další informace v závislosti na vašem poskytovateli správy verzí.

Vytvoření pracovní položky

K nové šabloně můžete přistupovat z jakýchkoli podrobností o celé transakci, ke kterým máte přístup z karet Výkon, Selhání, Dostupnost nebo jiné karty.

1. Pokud chcete vytvořit pracovní položku, přejděte na podrobnosti o transakci typu End-to-end, vyberte událost a pak vyberte vytvořit pracovní položku a zvolte šablonu pracovní položky.

   

2. V prohlížeči se otevře nová karta s vybraným systémem sledování. V Azure DevOps můžete vytvořit chybu nebo úlohu a na GitHubu můžete vytvořit nový problém ve vašem úložišti. Nová pracovní položka se automaticky vytvoří s kontextovými informacemi, které poskytuje Application Insights.

   

   

Úprava šablony

Pokud chcete šablonu upravit, přejděte na kartu Pracovní položky v části Konfigurovat a vyberte ikonu tužky vedle sešitu, který chcete aktualizovat.

Vyberte úpravy v horním panelu nástrojů.

Můžete vytvořit více než jednu konfiguraci pracovní položky a mít vlastní sešit, který bude vyhovovat jednotlivým scénářům. Sešity je možné nasadit také pomocí Azure Resource Manageru, který zajišťuje standardní implementace ve vašich prostředích.

Integrace klasických pracovních položek

1. V prostředku Application Insights v části Konfigurovat vyberte Pracovní položky.

2. Vyberte Přepnout na Classic, vyplňte pole vašimi informacemi a autorizujete.

   

3. Vytvořte pracovní položku tak, že přejdete na podrobnosti o celé transakci, vyberete událost a pak vyberete Vytvořit pracovní položku (Classic).

Migrace na novou integraci pracovních položek

Pokud chcete provést migraci, odstraňte konfiguraci klasické pracovní položky a pak vytvořte a nakonfigurujte šablonu pracovní položky pro opětovné vytvoření integrace.

Pokud chcete odstranit, přejděte do prostředku Application Insights v části Konfigurovat vybrat Pracovní položky a pak v horní části vyberte Přepnout na Klasické a *Odstranit.

Viz také

• Dokumentace ke službě Azure Pipelines
• Vytváření pracovních položek
• Automatizace pomocí PowerShellu
• Test dostupnosti