Monitorování dat služby Azure Cosmos DB pomocí nastavení diagnostiky služby Azure Monitor Log Analytics

PLATÍ PRO: NoSQL MongoDB Cassandra Skřítek Stůl

Nastavení diagnostiky v Azure slouží ke shromažďování protokolů prostředků. Prostředky generují protokoly prostředků Azure a poskytují bohaté a časté údaje o provozu tohoto prostředku. Tyto protokoly se zaznamenávají na každý požadavek a označují se také jako protokoly roviny dat. Mezi příklady operací roviny dat patří odstranění, vložení a čteníFeed. Obsah těchto protokolů se liší podle typu prostředku.

Další informace o nastavení diagnostiky najdete v tématu Nastavení diagnostiky ve službě Azure Monitor.

Poznámka:

Doporučujeme vytvořit nastavení diagnostiky v režimu specifickém pro prostředky (pro všechna rozhraní API s výjimkou rozhraní API pro tabulku) podle pokynů na kartě REST API . Tato možnost poskytuje další optimalizace nákladů s vylepšeným zobrazením pro zpracování dat.

Požadavky

• Existující účet služby Azure Cosmos DB.
  • Pokud máte předplatné Azure, vytvořte nový účet.
  • Pokud ještě nemáte předplatné Azure, vytvořte si napřed bezplatný účet.
  • Alternativně můžete před potvrzením vyzkoušet službu Azure Cosmos DB zdarma .
• Existující pracovní prostor služby Azure Monitor Log Analytics

Upozorňující

Pokud potřebujete odstranit prostředek, přejmenovat nebo přesunout prostředek nebo ho migrovat mezi skupinami prostředků nebo předplatnými, nejprve odstraňte jeho nastavení diagnostiky. Jinak, pokud tento prostředek znovu vytvoříte, může být nastavení diagnostiky odstraněného prostředku součástí nového prostředku v závislosti na konfiguraci prostředků pro každý prostředek. Pokud jsou nastavení diagnostiky součástí nového prostředku, obnoví se shromažďování protokolů prostředků, jak je definováno v nastavení diagnostiky, a odešle příslušná metrika a data protokolu do dříve nakonfigurovaného cíle.

Také je vhodné odstranit nastavení diagnostiky pro prostředek, který budete odstraňovat, a neplánovat použití znovu, aby vaše prostředí nebylo čisté.

Vytvoření nastavení diagnostiky

Tady si projdeme proces vytváření nastavení diagnostiky pro váš účet.

Poznámka:

Metrika pro export protokolů jako kategorie se v současné době nepodporuje.

Azure Portal

1. Přihlaste se k portálu Azure.

2. Přejděte k existujícímu účtu služby Azure Cosmos DB.

3. V části Monitorování v nabídce prostředků vyberte Nastavení diagnostiky. Pak vyberte možnost Přidat nastavení diagnostiky.

   

   Důležité

   Může se zobrazit výzva k povolení fulltextového dotazu [...] pro podrobnější protokolování, pokud není ve vašem účtu povolená funkce fulltextového dotazu . Toto upozornění můžete bezpečně ignorovat, pokud nechcete tuto funkci povolit. Další informace najdete v tématu povolení fulltextového dotazu.

4. V podokně Nastavení diagnostiky pojmenujte nastavení příkladu nastavení a pak vyberte kategorii QueryRuntimeStatistics. Zaškrtněte políčko Odeslat do pracovního prostoru služby Log Analytics a vyberte existující pracovní prostor. Nakonec jako cílovou možnost vyberte Prostředek specifický .

   

Azure CLI

az monitor diagnostic-settings create Pomocí příkazu vytvořte nastavení diagnostiky pomocí Azure CLI. Popis jeho parametrů najdete v dokumentaci k tomuto příkazu.

1. Ujistěte se, že jste se přihlásili k Azure CLI. Další informace najdete v tématu Přihlášení pomocí Azure CLI.

2. Slouží az monitor diagnostic-settings create k vytvoření nastavení.

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

   Důležité

   Tato ukázka používá --export-to-resource-specific argument k povolení tabulek specifických pro prostředky.

3. Prohlédněte si výsledky vytváření nového nastavení pomocí 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

K vytvoření nastavení diagnostiky prostřednictvím interaktivní konzoly použijte rozhraní REST API služby Azure Monitor.

1. Ujistěte se, že jste se přihlásili k Azure CLI. Další informace najdete v tématu Přihlášení pomocí Azure CLI.

2. Vytvořte nastavení diagnostiky pro prostředek služby Azure Cosmos DB pomocí požadavku HTTP PUT a 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"
       }
     }'
   

   Důležité

   Tato ukázka nastaví logAnalyticsDestinationType vlastnost tak, aby Dedicated umožňovala tabulky specifické pro prostředky.

3. Znovu použijte az rest příkaz HTTP GET k získání vlastností nastavení diagnostiky.

   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

K vytvoření nastavení diagnostiky použijte šablonu Bicep.

1. Ujistěte se, že jste se přihlásili k Azure CLI. Další informace najdete v tématu Přihlášení pomocí Azure CLI.

2. Vytvořte nový soubor s názvem diagnosticSetting.bicep.

3. Zadejte následující obsah šablony Bicep, který nasadí nastavení diagnostiky pro váš prostředek Azure Cosmos DB.

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

   Důležité

   Tato ukázka nastaví logAnalyticsDestinationType vlastnost tak, aby Dedicated umožňovala tabulky specifické pro prostředky.

4. Nasaďte šablonu pomocí 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

   az bicep build Pomocí příkazu převeďte šablonu Bicep na šablonu Azure Resource Manageru.

Šablona ARM

K vytvoření nastavení diagnostiky použijte šablonu Azure Resource Manageru.

1. Ujistěte se, že jste se přihlásili k Azure CLI. Další informace najdete v tématu Přihlášení pomocí Azure CLI.

2. Vytvořte nový soubor s názvem diagnosticSetting.bicep.

3. Zadejte následující obsah šablony Azure Resource Manageru, který nasadí nastavení diagnostiky pro váš prostředek Azure Cosmos DB.

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

   Důležité

   Tato ukázka nastaví logAnalyticsDestinationType vlastnost tak, aby Dedicated umožňovala tabulky specifické pro prostředky.

4. Nasaďte šablonu pomocí 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

   az bicep decompile Pomocí příkazu převeďte šablonu Azure Resource Manageru na šablonu Bicep.

Povolení fulltextového dotazu pro protokolování textu dotazu

Azure Cosmos DB poskytuje rozšířené protokolování pro podrobné řešení potíží. Povolením fulltextového dotazu můžete zobrazit deobfuscovaný dotaz pro všechny požadavky v rámci účtu služby Azure Cosmos DB. Také udělíte oprávnění ke službě Azure Cosmos DB pro přístup k datům a jejich zpřístupnění v protokolech.

Upozorňující

Povolení této funkce může vést k dalším nákladům na protokolování. Podrobnosti o cenách najdete na stránce s cenami služby Azure Monitor. Po řešení potíží doporučujeme tuto funkci zakázat.

Azure Portal

1. Na stránce existujícího účtu služby Azure Cosmos DB vyberte možnost Funkce v části Nastavení nabídky prostředků. Pak vyberte funkci fulltextového dotazu Diagnostika.

   

2. V dialogovém okně vyberte Enable. Toto nastavení se použije během několika minut. Všechny nově přijaté protokoly teď mají pro každý požadavek úplný text nebo text PIICommand.

   

Azure CLI / REST API / Bicep / Šablona ARM

Pomocí Azure CLI povolte fulltextový dotaz pro váš účet služby Azure Cosmos DB.

1. Povolte fulltextový dotaz znovu s az rest příkazem HTTP PATCH a datovou částí JSON.

   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. Počkejte několik minut, než se operace dokončí. Zkontrolujte stav fulltextového dotazu pomocí az rest příkazu HTTP GETznovu .

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

   Výstup by měl být podobný tomuto příkladu.

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

Související obsah

• Diagnostické dotazy v rozhraní API pro NoSQL
• Diagnostické dotazy v rozhraní API pro MongoDB
• Diagnostické dotazy v rozhraní API pro Apache Cassandra