Číst v angličtině

Sdílet prostřednictvím

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

  • Článek

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.

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.

    Snímek obrazovky znázorňující úkol vybraný v části Fáze

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

    Snímek obrazovky znázorňující přidání nového úkolu a výběr 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é.

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

    Snímek obrazovky s nastavením úloh Azure CLI se zvýrazněným typem skriptu, umístěním skriptu, vloženým skriptem a argumenty skriptu

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

    PowerShell 
    -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.

    PowerShell 
    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é.

    PowerShell 
         .\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/aaaa0a-bb1b-cc2c-dd3d-eeeeee4e4e4e4e/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:

    Snímek obrazovky znázorňující kartu Výkon s vybranou poznámkou k verzi, která zobrazuje kartu Vlastnosti vydané verze

  • Selhání:

    Snímek obrazovky znázorňující kartu Selhání s vybranou poznámkou k verzi, která zobrazuje kartu Vlastnosti vydané verze

  • Zvyk:

    Snímek obrazovky znázorňující panel karet Uživatelé s vybranými poznámkami k verzi Poznámky k verzi se zobrazují jako modré šipky nad grafem označující okamžik v čase, kdy došlo k vydání.

  • Sešity:

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

    Snímek obrazovky znázorňující podokno Sešity s dotazem založeným na protokolu časových řad se zobrazenými poznámkami

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

Snímek obrazovky znázorňující nabídku Upřesnit nastavení se zvýrazněným zaškrtávacím polem 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.

    Snímek obrazovky znázorňující výběr organizace Azure DevOps a výběr možnosti Nainstalovat

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.

    Snímek obrazovky, který se zobrazuje v části Přístup k rozhraní API a zkopírováním ID aplikace

  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.

    Snímek obrazovky znázorňující výběr možnosti Přidat úlohu a Poznámku 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.

    Snímek obrazovky znázorňující vložení ID Application Insights

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

    Snímek obrazovky znázorňující výběr klíče rozhraní API na kartě Přístup k 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íč.

    Snímek obrazovky s oknem Vytvořit klíč rozhraní API, zadáním popisu, výběrem možnosti Zapisovat poznámky a následným výběrem klíče Generovat

  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.

    Snímek obrazovky, který se zobrazuje na kartě Proměnné Azure DevOps, výběr možnosti Přidat, pojmenování proměnné ApiKey a vložení klíče rozhraní API v části Hodnota

  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.

Viz také