Azure Cosmos DB-adatok monitorozása az Azure Monitor Log Analytics diagnosztikai beállításaival

A KÖVETKEZŐKRE VONATKOZIK: NoSQL MongoDB Cassandra Gremlin Asztal

Az Azure-ban a diagnosztikai beállítások az erőforrásnaplók gyűjtésére szolgálnak. Az erőforrások Azure-erőforrásnaplókat bocsátanak ki, és gazdag, gyakori adatokat szolgáltatnak az adott erőforrás működéséről. Ezek a naplók kérésenként vannak rögzítve, és "adatsík-naplóknak" is nevezik őket. Néhány példa az adatsík műveleteire: törlés, beszúrás és readFeed. Ezeknek a naplóknak a tartalma erőforrástípusonként változik.

A platformmetrikákat és a tevékenységnaplókat a rendszer automatikusan gyűjti, míg az erőforrásnaplók gyűjtéséhez vagy az Azure Monitoron kívüli továbbításhoz létre kell hoznia egy diagnosztikai beállítást. Bekapcsolhatja az Azure Cosmos DB-fiókok diagnosztikai beállításait, és erőforrásnaplókat küldhet a következő forrásoknak:

• Azure Monitor Log Analytics-munkaterületek
  • A Log Analyticsnek küldött adatok az Azure Diagnostics (örökölt) vagy az erőforrás-specifikus (előzetes verzió) táblákba írhatók
• Eseményközpont
• Tárfiók

Feljegyzés

Javasoljuk, hogy a diagnosztikai beállítást erőforrás-specifikus módban hozza létre (a Table API kivételével minden API-hoz) a diagnosztikai beállítás REST API-n keresztüli létrehozásának utasításait követve. Ez a lehetőség további költségoptimalizációkat biztosít, és továbbfejlesztett nézetet biztosít az adatok kezeléséhez.

Előfeltételek

• Egy meglévő Azure Cosmos DB-fiók.
  • Ha Rendelkezik Azure-előfizetéssel, hozzon létre egy új fiókot.
  • Ha még nincs Azure-előfizetése, kezdés előtt hozzon létre egy ingyenes fiókot.
  • Másik lehetőségként a véglegesítés előtt ingyenesen kipróbálhatja az Azure Cosmos DB-t.
• Egy meglévő Azure Monitor Log Analytics-munkaterület.

Diagnosztikai beállítások létrehozása

Itt végigvezetjük a fiók diagnosztikai beállításainak létrehozásának folyamatán.

Feljegyzés

A kategóriaként exportálni kívánt metrika jelenleg nem támogatott.

Azure Portal

1. Jelentkezzen be az Azure Portalra.

2. Lépjen a meglévő Azure Cosmos DB-fiókjához.

3. Az erőforrás menüjének Figyelés szakaszában válassza a Diagnosztikai beállítások lehetőséget. Ezután válassza a Diagnosztikai beállítás hozzáadása lehetőséget.

   

   Fontos

   Előfordulhat, hogy megjelenik egy "teljes szöveges lekérdezés engedélyezése [...] részletesebb naplózáshoz", ha a teljes szöveges lekérdezési funkció nincs engedélyezve a fiókjában. Ha nem szeretné engedélyezni ezt a funkciót, nyugodtan figyelmen kívül hagyhatja ezt a figyelmeztetést. További információ: Teljes szöveges lekérdezés engedélyezése.

4. A Diagnosztikai beállítások panelen adja meg a példabeállítást, majd válassza ki a QueryRuntimeStatistics kategóriát. Küldje el a naplókat a meglévő munkaterületet kiválasztó Log Analytics-munkaterületre . Végül válassza az Erőforrás-specifikus lehetőséget célként.

   

Azure CLI

az monitor diagnostic-settings create A paranccsal hozzon létre egy diagnosztikai beállítást az Azure CLI-vel. A parancs paramétereinek leírását a parancs dokumentációjában találja.

1. Győződjön meg arról, hogy bejelentkezett az Azure CLI-be. További információ: bejelentkezés az Azure CLI-vel.

2. A beállítás létrehozásához használható az monitor diagnostic-settings create .

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

   Fontos

   Ez a minta az argumentumot használja az --export-to-resource-specific erőforrás-specifikus táblák engedélyezéséhez.

3. Tekintse át az új beállítás létrehozásának eredményeit a következő használatával 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

Az Azure Monitor REST API használatával diagnosztikai beállításokat hozhat létre az interaktív konzolon keresztül.

1. Győződjön meg arról, hogy bejelentkezett az Azure CLI-be. További információ: bejelentkezés az Azure CLI-vel.

2. Hozzon létre diagnosztikai beállítást az Azure Cosmos DB-erőforráshoz EGY HTTP-kérés PUT és az restegy .

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

   Fontos

   Ez a minta beállítja a tulajdonságot az logAnalyticsDestinationTypeDedicated erőforrás-specifikus táblák engedélyezéséhez.

3. A diagnosztikai beállítás tulajdonságainak lekéréséhez használja az rest ismét a HTTP-parancsot GET .

   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

A diagnosztikai beállítás létrehozásához használjon Bicep-sablont.

1. Győződjön meg arról, hogy bejelentkezett az Azure CLI-be. További információ: bejelentkezés az Azure CLI-vel.

2. Hozzon létre egy új fájlt diagnosticSetting.bicep néven.

3. Adja meg a következő Bicep-sablontartalmat, amely üzembe helyezi az Azure Cosmos DB-erőforrás diagnosztikai beállítását.

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

   Fontos

   Ez a minta beállítja a tulajdonságot az logAnalyticsDestinationTypeDedicated erőforrás-specifikus táblák engedélyezéséhez.

4. A sablon üzembe helyezése a következővel 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>"
   

   Tipp.

   az bicep build A parancs használatával konvertálhatja a Bicep-sablont Azure Resource Manager-sablonná.

ARM-sablon

Hozzon létre egy Azure Resource Manager-sablont a diagnosztikai beállítás létrehozásához.

1. Győződjön meg arról, hogy bejelentkezett az Azure CLI-be. További információ: bejelentkezés az Azure CLI-vel.

2. Hozzon létre egy új fájlt diagnosticSetting.bicep néven.

3. Adja meg a következő Azure Resource Manager-sablontartalmat, amely üzembe helyezi az Azure Cosmos DB-erőforrás diagnosztikai beállítását.

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

   Fontos

   Ez a minta beállítja a tulajdonságot az logAnalyticsDestinationTypeDedicated erőforrás-specifikus táblák engedélyezéséhez.

4. A sablon üzembe helyezése a következővel 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>"
   

   Tipp.

   az bicep decompile A parancs használatával az Azure Resource Manager-sablont Bicep-sablonná alakíthatja.

Teljes szöveges lekérdezés engedélyezése lekérdezésszöveg naplózásához

Az Azure Cosmos DB speciális naplózást biztosít a részletes hibaelhárításhoz. A teljes szöveges lekérdezés engedélyezésével megtekintheti az Azure Cosmos DB-fiókban lévő összes kéréshez tartozó le nem szűrt lekérdezést. Engedélyt is ad az Azure Cosmos DB-nek az adatok elérésére és a naplókban való felszínre hozására.

Figyelmeztetés

A funkció engedélyezése további naplózási költségeket eredményezhet, a díjszabás részleteiért látogasson el az Azure Monitor díjszabására. Javasoljuk, hogy a hibaelhárítás után tiltsa le ezt a funkciót.

Azure Portalra

1. A meglévő Azure Cosmos DB-fióklapon válassza a Szolgáltatások lehetőséget az erőforrás menü Beállítások szakaszában. Ezután válassza ki a Diagnostics teljes szöveges lekérdezési funkciót.

   

2. A párbeszédpanelen válassza a lehetőséget Enable. Ezt a beállítást néhány percen belül alkalmazza a rendszer. Most már minden újonnan betöltött napló teljes vagy PIICommand szövegekkel rendelkezik az egyes kérésekhez.

   

Azure CLI / REST API / Bicep / ARM-sablon

Az Azure CLI használatával engedélyezheti a teljes szöveges lekérdezést az Azure Cosmos DB-fiókhoz.

1. Engedélyezze ismét a teljes szöveges lekérdezést az rest EGY HTTP-paranccsal PATCH és egy JSON hasznos adattal.

   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árjon néhány percet, amíg a művelet befejeződik. Ellenőrizze a teljes szöveges lekérdezés állapotát a HTTP GETismételt használatávalaz rest.

   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}"
   

   A kimenetnek ehhez a példához hasonlónak kell lennie.

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

Kapcsolódó tartalom

• Diagnosztikai lekérdezések a NoSQL API-ban
• Diagnosztikai lekérdezések a MongoDB API-ban
• Diagnosztikai lekérdezések az Apache Cassandra API-ban