Övervaka Azure Cosmos DB-data med diagnostikinställningar för Azure Monitor Log Analytics

GÄLLER FÖR: NoSQL MongoDB Kassandra Gremlin Bord

Diagnostikinställningar i Azure används för att samla in resursloggar. Resurser genererar Azure-resursloggar och ger omfattande, frekventa data om hur resursen fungerar. Dessa loggar registreras per begäran och kallas för "dataplansloggar". Några exempel på dataplansåtgärder är borttagning, infogning och readFeed. Innehållet i loggarna varierar beroende på resurstyp.

Plattformsmått och aktivitetsloggar samlas in automatiskt, medan du måste skapa en diagnostikinställning för att samla in resursloggar eller vidarebefordra dem utanför Azure Monitor. Du kan aktivera diagnostikinställningen för Azure Cosmos DB-konton och skicka resursloggar till följande källor:

• Azure Monitor Log Analytics-arbetsytor
  • Data som skickas till Log Analytics kan skrivas till Azure Diagnostics -tabeller (äldre) eller resursspecifika tabeller (förhandsversion)
• Händelsehubb
• Lagringskonto

Kommentar

Vi rekommenderar att du skapar diagnostikinställningen i resursspecifikt läge (för alla API:er utom API för tabell) genom att följa våra instruktioner för att skapa diagnostikinställning via REST API. Det här alternativet ger ytterligare kostnadsoptimeringar med en förbättrad vy för hantering av data.

Förutsättningar

• Ett befintligt Azure Cosmos DB-konto.
  • Om du har en Azure-prenumeration skapar du ett nytt konto.
  • Om du inte har någon Azure-prenumeration skapar du ett kostnadsfritt konto innan du börjar.
  • Du kan också prova Azure Cosmos DB kostnadsfritt innan du checkar in.
• En befintlig Azure Monitor Log Analytics-arbetsyta.

Skapa diagnostikinställningar

Här går vi igenom processen med att skapa diagnostikinställningar för ditt konto.

Kommentar

Måttet till loggar exporteras som en kategori stöds för närvarande inte.

Azure-portalen

1. Logga in på Azure-portalen.

2. Gå till ditt befintliga Azure Cosmos DB-konto.

3. I avsnittet Övervakning på resursmenyn väljer du Diagnostikinställningar. Välj sedan alternativet Lägg till diagnostikinställning .

   

   Viktigt!

   Du kan se en uppmaning om att "aktivera fulltextfråga [...] för mer detaljerad loggning" om frågefunktionen i fulltext inte är aktiverad i ditt konto. Du kan ignorera den här varningen på ett säkert sätt om du inte vill aktivera den här funktionen. Mer information finns i aktivera fulltextfråga.

4. I fönstret Diagnostikinställningar namnger du inställningen example-setting och väljer sedan kategorin QueryRuntimeStatistics . Skicka loggarna till en Log Analytics-arbetsyta som väljer din befintliga arbetsyta. Välj slutligen Resursspecifik som målalternativ.

   

Azure CLI

az monitor diagnostic-settings create Använd kommandot för att skapa en diagnostikinställning med Azure CLI. I dokumentationen för det här kommandot finns beskrivningar av dess parametrar.

1. Se till att du har loggat in på Azure CLI. Mer information finns i logga in med Azure CLI.

2. Använd az monitor diagnostic-settings create för att skapa inställningen.

   az monitor diagnostic-settings create \
     --resource $(az cosmosdb show \
       --resource-group "<resource-group-name>" \
       --name "<account-name>" \
       --query "id" \
       --output "tsv" \
     ) \
     --workspace $(az monitor log-analytics workspace show \
       --resource-group "<resource-group-name>" \
       --name "<account-name>" \
       --query "id" \
       --output "tsv" \
     ) \
     --name "example-setting" \
     --export-to-resource-specific true \
     --logs '[
       {
         "category": "QueryRuntimeStatistics",
         "enabled": true
       }
     ]'
   

   Viktigt!

   Det här exemplet använder --export-to-resource-specific argumentet för att aktivera resursspecifika tabeller.

3. Granska resultatet av att skapa den nya inställningen med hjälp av az monitor diagnostics-settings show.

   az monitor diagnostic-settings show \
     --name "example-setting" \
     --resource $(az cosmosdb show \
       --resource-group "<resource-group-name>" \
       --name "<account-name>" \
       --query "id" \
       --output "tsv" \
     )
   

REST-API

Använd Rest-API:et för Azure Monitor för att skapa en diagnostikinställning via den interaktiva konsolen.

1. Se till att du har loggat in på Azure CLI. Mer information finns i logga in med Azure CLI.

2. Skapa diagnostikinställningen för din Azure Cosmos DB-resurs med hjälp av en HTTP-begäran PUT och az rest.

   diagnosticSettingName="example-setting"
   
   resourceId=$(az cosmosdb show \
     --resource-group "<resource-group-name>" \
     --name "<account-name>" \
     --query "id" \
     --output "tsv" \
   )
   
   workspaceId=$(az monitor log-analytics workspace show \
     --resource-group "<resource-group-name>" \
     --name "<account-name>" \
     --query "id" \
     --output "tsv" \
   )
   
   az rest \
     --method "PUT" \
     --url "$resourceId/providers/Microsoft.Insights/diagnosticSettings/$diagnosticSettingName" \
     --url-parameters "api-version=2021-05-01-preview" \
     --body '{
       "properties": {
         "workspaceId": "'"$workspaceId"'",
         "logs": [
           {
             "category": "QueryRuntimeStatistics",
             "enabled": true
           }
         ],
         "logAnalyticsDestinationType": "Dedicated"
       }
     }'
   

   Viktigt!

   Det här exemplet anger egenskapen logAnalyticsDestinationType till Dedicated för att aktivera resursspecifika tabeller.

3. Använd az rest igen med ett HTTP-verb GET för att hämta egenskaperna för diagnostikinställningen.

   diagnosticSettingName="example-setting"
   
   resourceId=$(az cosmosdb show \
     --resource-group "<resource-group-name>" \
     --name "<account-name>" \
     --query "id" \
     --output "tsv" \
   )
   
   az rest \
     --method "GET" \
     --url "$resourceId/providers/Microsoft.Insights/diagnosticSettings/$diagnosticSettingName" \
     --url-parameters "api-version=2021-05-01-preview"
   

Bicep

Använd en Bicep-mall för att skapa diagnostikinställningen.

1. Se till att du har loggat in på Azure CLI. Mer information finns i logga in med Azure CLI.

2. Skapa en ny fil med namnet diagnosticSetting.bicep.

3. Ange följande Bicep-mallinnehåll som distribuerar diagnostikinställningen för din Azure Cosmos DB-resurs.

   @description('The name of the diagnostic setting to create.')
   param diagnosticSettingName string = 'example-setting'
   
   @description('The name of the Azure Cosmos DB account to monitor.')
   param azureCosmosDbAccountName string
   
   @description('The name of the Azure Monitor Log Analytics workspace to use.')
   param logAnalyticsWorkspaceName string
   
   resource azureCosmosDbAccount 'Microsoft.DocumentDB/databaseAccounts@2021-06-15' existing = {
     name: azureCosmosDbAccountName
   }
   
   resource logAnalyticsWorkspace 'Microsoft.OperationalInsights/workspaces@2023-09-01' existing = {
     name: logAnalyticsWorkspaceName
   }
   
   resource diagnosticSetting 'Microsoft.Insights/diagnosticSettings@2021-05-01-preview' = {
     name: diagnosticSettingName
     scope: azureCosmosDbAccount
     properties: {
       workspaceId: logAnalyticsWorkspace.id
       logAnalyticsDestinationType: 'Dedicated'
       logs: [
         {
           category: 'QueryRuntimeStatistics'
           enabled: true
         }
       ]
     }
   }    
   

   Viktigt!

   Det här exemplet anger egenskapen logAnalyticsDestinationType till Dedicated för att aktivera resursspecifika tabeller.

4. Distribuera mallen med .az deployment group create

   az deployment group create \
       --resource-group "<resource-group-name>" \
       --template-file diagnosticSetting.bicep \
       --parameters \
         azureCosmosDbAccountName="<azure-cosmos-db-account-name>" \
         logAnalyticsWorkspaceName="<log-analytics-workspace-name>"
   

   Dricks

   az bicep build Använd kommandot för att konvertera Bicep-mallen till en Azure Resource Manager-mall.

ARM-mall

Använd en Azure Resource Manager-mall för att skapa diagnostikinställningen.

1. Se till att du har loggat in på Azure CLI. Mer information finns i logga in med Azure CLI.

2. Skapa en ny fil med namnet diagnosticSetting.bicep.

3. Ange följande Azure Resource Manager-mallinnehåll som distribuerar diagnostikinställningen för din Azure Cosmos DB-resurs.

   {
     "$schema": "<https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#>",
     "contentVersion": "1.0.0.0",
     "parameters": {
       "diagnosticSettingName": {
         "type": "string",
         "defaultValue": "example-setting",
         "metadata": {
           "description": "The name of the diagnostic setting to create."
         }
       },
       "azureCosmosDbAccountName": {
         "type": "string",
         "metadata": {
           "description": "The name of the Azure Cosmos DB account to monitor."
         }
       },
       "logAnalyticsWorkspaceName": {
         "type": "string",
         "metadata": {
           "description": "The name of the Azure Monitor Log Analytics workspace to use."
         }
       }
     },
     "resources": [
       {
         "type": "Microsoft.Insights/diagnosticSettings",
         "apiVersion": "2021-05-01-preview",
         "scope": "[format('Microsoft.DocumentDB/databaseAccounts/{0}', parameters('azureCosmosDbAccountName'))]",
         "name": "[parameters('diagnosticSettingName')]",
         "properties": {
           "workspaceId": "[resourceId('Microsoft.OperationalInsights/workspaces', parameters('logAnalyticsWorkspaceName'))]",
           "logAnalyticsDestinationType": "Dedicated",
           "logs": [
             {
               "category": "QueryRuntimeStatistics",
               "enabled": true
             }
           ]
         }
       }
     ]
   }
   

   Viktigt!

   Det här exemplet anger egenskapen logAnalyticsDestinationType till Dedicated för att aktivera resursspecifika tabeller.

4. Distribuera mallen med .az deployment group create

   az deployment group create \
       --resource-group "<resource-group-name>" \
       --template-file azuredeploy.json \
       --parameters \
         azureCosmosDbAccountName="<azure-cosmos-db-account-name>" \
         logAnalyticsWorkspaceName="<log-analytics-workspace-name>"
   

   Dricks

   az bicep decompile Använd kommandot för att konvertera Azure Resource Manager-mallen till en Bicep-mall.

Aktivera fulltextfråga för att logga frågetext

Azure Cosmos DB tillhandahåller avancerad loggning för detaljerad felsökning. Genom att aktivera fulltextfråga kan du visa den inaktuella frågan för alla begäranden i ditt Azure Cosmos DB-konto. Du ger också behörighet för Azure Cosmos DB att komma åt och visa dessa data i dina loggar.

Varning

Om du aktiverar den här funktionen kan det leda till ytterligare loggningskostnader för prisinformation i Prissättning för Azure Monitor. Vi rekommenderar att du inaktiverar den här funktionen efter felsökning.

Azure-portalen

1. På den befintliga Azure Cosmos DB-kontosidan väljer du alternativet Funktioner i avsnittet Inställningar på resursmenyn. Välj sedan frågefunktionen Diagnostik i fulltext .

   

2. I dialogrutan väljer du Enable. Den här inställningen tillämpas inom några minuter. Alla nyligen inmatade loggar har nu fulltext- eller PIICommand-text för varje begäran.

   

Azure CLI/REST API/Bicep/ARM-mall

Använd Azure CLI för att aktivera fulltextfråga för ditt Azure Cosmos DB-konto.

1. Aktivera fulltextfråga med hjälp av az rest igen med ett HTTP-verb PATCH och en JSON-nyttolast.

   az rest \
     --method "PATCH" \
     --url $(az cosmosdb show \
       --resource-group "<resource-group-name>" \
       --name "<account-name>" \
       --query "id" \
       --output "tsv" \
     ) \
     --url-parameters "api-version=2021-05-01-preview" \
     --body '{
       "properties": {
         "diagnosticLogSettings": {
           "enableFullTextQuery": "True"
         }
       }
     }'
   

2. Vänta några minuter tills åtgärden har slutförts. Kontrollera statusen för fulltextfrågan genom att använda az rest igen med HTTP GET.

   az rest \
     --method "GET" \
     --url $(az cosmosdb show \
       --resource-group "<resource-group-name>" \
       --name "<account-name>" \
       --query "id" \
       --output "tsv" \
     ) \
     --url-parameters "api-version=2021-05-01-preview" \
     --query "{accountName:name,fullTextQueryEnabled:properties.diagnosticLogSettings.enableFullTextQuery}"
   

   Utdata bör likna det här exemplet.

   {
     "accountName": "<account-name>",
     "fullTextQueryEnabled": "True"
   }
   

Relaterat innehåll

• Diagnostikfrågor i API för NoSQL
• Diagnostikfrågor i API för MongoDB
• Diagnostikfrågor i API för Apache Cassandra