Azure Cosmos DB-gegevens bewaken met diagnostische instellingen van Azure Monitor Log Analytics

VAN TOEPASSING OP: NoSQL MongoDB Cassandra Gremlin Tafel

Diagnostische instellingen in Azure worden gebruikt om resourcelogboeken te verzamelen. Resources verzenden Azure-resourcelogboeken en bieden uitgebreide, frequente gegevens over de werking van die resource. Deze logboeken worden vastgelegd per aanvraag en worden aangeduid als 'gegevensvlaklogboeken'. Enkele voorbeelden van de gegevensvlakbewerkingen zijn verwijderen, invoegen en readFeed. De inhoud van deze logboeken verschilt per resourcetype.

Metrische platformgegevens en activiteitenlogboeken worden automatisch verzameld, terwijl u een diagnostische instelling moet maken om resourcelogboeken te verzamelen of door te sturen buiten Azure Monitor. U kunt de diagnostische instelling voor Azure Cosmos DB-accounts inschakelen en resourcelogboeken naar de volgende bronnen verzenden:

• Azure Monitor Log Analytics-werkruimten
  • Gegevens die naar Log Analytics worden verzonden, kunnen worden geschreven naar Azure Diagnostics-tabellen (verouderd) of resourcespecifieke (preview) -tabellen
• Event Hub
• Opslagaccount

Notitie

We raden u aan om de diagnostische instelling te maken in de resourcespecifieke modus (voor alle API's behalve API voor Table) volgens onze instructies voor het maken van diagnostische instellingen via REST API. Deze optie biedt extra kostenoptimalisaties met een verbeterde weergave voor het verwerken van gegevens.

Vereisten

• Een bestaand Azure Cosmos DB-account.
  • Als u een Azure-abonnement hebt, maakt u een nieuw account.
  • Als u geen Azure-abonnement hebt, maakt u een gratis account voordat u begint.
  • U kunt azure Cosmos DB ook gratis proberen voordat u zich doorvoert.
• Een bestaande Azure Monitor Log Analytics-werkruimte.

Waarschuwing

Als u een resource wilt verwijderen, een resource wilt hernoemen of verplaatsen of deze wilt migreren tussen resourcegroepen of abonnementen, verwijdert u eerst de diagnostische instellingen. Als u deze resource opnieuw maakt, kunnen de diagnostische instellingen voor de verwijderde resource worden opgenomen in de nieuwe resource, afhankelijk van de resourceconfiguratie voor elke resource. Als de diagnostische instellingen zijn opgenomen in de nieuwe resource, wordt de verzameling resourcelogboeken hervat zoals gedefinieerd in de diagnostische instelling en worden de toepasselijke metrische gegevens en logboekgegevens verzonden naar de eerder geconfigureerde bestemming.

Het is ook een goed idee om de diagnostische instellingen te verwijderen voor een resource die u gaat verwijderen en niet van plan bent om uw omgeving schoon te houden.

Diagnostische instellingen maken

Hier doorlopen we het proces voor het maken van diagnostische instellingen voor uw account.

Notitie

De metrische gegevens voor logboeken die als categorie worden geëxporteerd, worden momenteel niet ondersteund.

Azure-portal

1. Meld u aan bij het Azure-portaal.

2. Navigeer naar uw bestaande Azure Cosmos DB-account.

3. Selecteer diagnostische instellingen in de sectie Bewaking van het resourcemenu. Selecteer vervolgens de optie Diagnostische instelling toevoegen.

   

   Belangrijk

   Mogelijk ziet u een prompt voor het inschakelen van een volledige tekstquery [...] voor gedetailleerdere logboekregistratie' als de functie voor volledige tekstquery's niet is ingeschakeld in uw account. U kunt deze waarschuwing veilig negeren als u deze functie niet wilt inschakelen. Zie Volledige-tekstquery inschakelen voor meer informatie.

4. Geef in het deelvenster Diagnostische instellingen de voorbeeldinstelling een naam en selecteer vervolgens de categorie QueryRuntimeStatistics. Verzend de logboeken naar een Log Analytics-werkruimte die uw bestaande werkruimte selecteert. Selecteer ten slotte Resourcespecifiek als doeloptie.

   

Azure-CLI

Gebruik de az monitor diagnostic-settings create opdracht om een diagnostische instelling te maken met de Azure CLI. Raadpleeg de documentatie voor deze opdracht voor beschrijvingen van de parameters.

1. Zorg ervoor dat u bent aangemeld bij de Azure CLI. Zie aanmelden met Azure CLI voor meer informatie.

2. Gebruik az monitor diagnostic-settings create dit om de instelling te maken.

   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
       }
     ]'
   

   Belangrijk

   In dit voorbeeld wordt het --export-to-resource-specific argument gebruikt om resourcespecifieke tabellen in te schakelen.

3. Bekijk de resultaten van het maken van uw nieuwe instelling met behulp van 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

Gebruik de Azure Monitor REST API voor het maken van een diagnostische instelling via de interactieve console.

1. Zorg ervoor dat u bent aangemeld bij de Azure CLI. Zie aanmelden met Azure CLI voor meer informatie.

2. Maak de diagnostische instelling voor uw Azure Cosmos DB-resource met behulp van een HTTP-aanvraag PUT en 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"
       }
     }'
   

   Belangrijk

   In dit voorbeeld wordt de logAnalyticsDestinationType eigenschap ingesteld om resourcespecifieke tabellen in te Dedicated schakelen.

3. Gebruik az rest het opnieuw met een HTTP-werkwoord GET om de eigenschappen van de diagnostische instelling op te halen.

   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

Gebruik een Bicep-sjabloon om de diagnostische instelling te maken.

1. Zorg ervoor dat u bent aangemeld bij de Azure CLI. Zie aanmelden met Azure CLI voor meer informatie.

2. Maak een nieuw bestand met de naam diagnosticSetting.bicep.

3. Voer de volgende Bicep-sjablooninhoud in waarmee de diagnostische instelling voor uw Azure Cosmos DB-resource wordt geïmplementeerd.

   @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
         }
       ]
     }
   }    
   

   Belangrijk

   In dit voorbeeld wordt de logAnalyticsDestinationType eigenschap ingesteld om resourcespecifieke tabellen in te Dedicated schakelen.

4. Implementeer de sjabloon met behulp van 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>"
   

   Tip

   Gebruik de az bicep build opdracht om de Bicep-sjabloon te converteren naar een Azure Resource Manager-sjabloon.

Azure VPN-gateway

Gebruik een Azure Resource Manager-sjabloon om de diagnostische instelling te maken.

1. Zorg ervoor dat u bent aangemeld bij de Azure CLI. Zie aanmelden met Azure CLI voor meer informatie.

2. Maak een nieuw bestand met de naam diagnosticSetting.bicep.

3. Voer de volgende Azure Resource Manager-sjablooninhoud in waarmee de diagnostische instelling voor uw Azure Cosmos DB-resource wordt geïmplementeerd.

   {
     "$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
             }
           ]
         }
       }
     ]
   }
   

   Belangrijk

   In dit voorbeeld wordt de logAnalyticsDestinationType eigenschap ingesteld om resourcespecifieke tabellen in te Dedicated schakelen.

4. Implementeer de sjabloon met behulp van 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>"
   

   Tip

   Gebruik de az bicep decompile opdracht om de Azure Resource Manager-sjabloon te converteren naar een Bicep-sjabloon.

Volledige-tekstquery inschakelen voor querytekst voor logboekregistratie

Azure Cosmos DB biedt geavanceerde logboekregistratie voor gedetailleerde probleemoplossing. Door een volledige-tekstquery in te schakelen, kunt u de niet-verborgen query voor alle aanvragen in uw Azure Cosmos DB-account weergeven. U geeft ook toestemming voor Azure Cosmos DB om deze gegevens in uw logboeken te openen en weer te geven.

Waarschuwing

Als u deze functie inschakelt, kan dit leiden tot extra logboekregistratiekosten. Ga naar de prijzen van Azure Monitor voor prijsinformatie. Het wordt aanbevolen deze functie uit te schakelen na het oplossen van problemen.

Azure-portal

1. Selecteer op de bestaande azure Cosmos DB-accountpagina de optie Functies in de sectie Instellingen van het resourcemenu. Selecteer vervolgens de queryfunctie Voor volledige tekst diagnostische gegevens .

   

2. Selecteer Enablein het dialoogvenster . Deze instelling wordt binnen een paar minuten toegepast. Alle nieuw opgenomen logboeken hebben nu de volledige tekst of PIICommand-tekst voor elke aanvraag.

   

Azure CLI/REST API/Bicep/ARM-sjabloon

Gebruik de Azure CLI om query's voor volledige tekst in te schakelen voor uw Azure Cosmos DB-account.

1. Schakel query voor volledige tekst opnieuw in az rest met een HTTP-woord PATCH en een JSON-nettolading.

   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. Wacht enkele minuten totdat de bewerking is voltooid. Controleer de status van een volledige-tekstquery door deze opnieuw te gebruiken az rest met 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}"
   

   De uitvoer moet vergelijkbaar zijn met dit voorbeeld.

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

Gerelateerde inhoud

• Diagnostische query's in API voor NoSQL
• Diagnostische query's in API voor MongoDB
• Diagnostische query's in API voor Apache Cassandra