Monitorowanie danych usługi Azure Cosmos DB przy użyciu ustawień diagnostycznych usługi Azure Monitor Log Analytics

DOTYCZY: NoSQL MongoDB Kasandra Gremlin Stół

Ustawienia diagnostyczne na platformie Azure umożliwiają zbieranie dzienników zasobów. Zasoby emitują dzienniki zasobów platformy Azure i udostępniają rozbudowane, częste dane dotyczące działania tego zasobu. Te dzienniki są przechwytywane na żądanie i są również nazywane dziennikami płaszczyzny danych. Niektóre przykłady operacji płaszczyzny danych obejmują usuwanie, wstawianie i odczytFeed. Zawartość tych dzienników różni się w zależności od typu zasobu.

Aby dowiedzieć się więcej na temat ustawień diagnostycznych, zobacz Ustawienia diagnostyczne w usłudze Azure Monitor.

Uwaga

Zalecamy utworzenie ustawienia diagnostycznego w trybie specyficznym dla zasobów (dla wszystkich interfejsów API z wyjątkiem interfejsu API dla tabeli) zgodnie z instrukcjami na karcie interfejsu API REST. Ta opcja zapewnia dodatkowe optymalizacje kosztów z ulepszonym widokiem obsługi danych.

Wymagania wstępne

• Istniejące konto usługi Azure Cosmos DB.
  • Jeśli masz subskrypcję platformy Azure, utwórz nowe konto.
  • Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.
  • Alternatywnie możesz wypróbować usługę Azure Cosmos DB bezpłatnie przed zatwierdzeniem.
• Istniejący obszar roboczy usługi Azure Monitor Log Analytics.

Ostrzeżenie

Jeśli musisz usunąć zasób, zmienić nazwę lub przenieść zasób albo zmigrować go między grupami zasobów lub subskrypcjami, najpierw usuń jego ustawienia diagnostyczne. W przeciwnym razie, jeśli ponownie utworzysz ten zasób, ustawienia diagnostyczne usuniętego zasobu mogą być dołączone do nowego zasobu, w zależności od konfiguracji zasobu dla każdego zasobu. Jeśli ustawienia diagnostyczne są dołączone do nowego zasobu, wznawia to zbieranie dzienników zasobów zgodnie z definicją w ustawieniu diagnostycznym i wysyła odpowiednie dane metryki i dziennika do wcześniej skonfigurowanego miejsca docelowego.

Dobrym rozwiązaniem jest również usunięcie ustawień diagnostycznych zasobu, który zamierzasz usunąć i nie planujesz używać go ponownie, aby zachować czyste środowisko.

Tworzenie ustawień diagnostycznych

W tym miejscu przeprowadzimy proces tworzenia ustawień diagnostycznych dla Twojego konta.

Uwaga

Metryka do rejestrowania eksportu jako kategoria nie jest obecnie obsługiwana.

Witryna Azure Portal

1. Zaloguj się w witrynie Azure Portal.

2. Przejdź do istniejącego konta usługi Azure Cosmos DB.

3. W sekcji Monitorowanie w menu zasobów wybierz pozycję Ustawienia diagnostyczne. Następnie wybierz opcję Dodaj ustawienie diagnostyczne.

   

   Ważne

   Może zostać wyświetlony monit o włączenie zapytania pełnotekstowego [...] aby uzyskać bardziej szczegółowe rejestrowanie", jeśli funkcja zapytania pełnotekstowego nie jest włączona na Twoim koncie. Jeśli nie chcesz włączyć tej funkcji, możesz bezpiecznie zignorować to ostrzeżenie. Aby uzyskać więcej informacji, zobacz włączanie zapytania pełnotekstowego.

4. W okienku Ustawienia diagnostyczne nazwij ustawienie przykładowe, a następnie wybierz kategorię QueryRuntimeStatistics. Zaznacz pole wyboru Wyślij do obszaru roboczego usługi Log Analytics, wybierając istniejący obszar roboczy. Na koniec wybierz pozycję Zasób określony jako opcja docelowa.

   

Interfejs wiersza polecenia platformy Azure

Użyj polecenia , az monitor diagnostic-settings create aby utworzyć ustawienie diagnostyczne za pomocą interfejsu wiersza polecenia platformy Azure. Zapoznaj się z dokumentacją tego polecenia, aby uzyskać opisy jego parametrów.

1. Upewnij się, że zalogowano się do interfejsu wiersza polecenia platformy Azure. Aby uzyskać więcej informacji, zobacz Logowanie się za pomocą interfejsu wiersza polecenia platformy Azure.

2. Użyj az monitor diagnostic-settings create polecenia , aby utworzyć ustawienie.

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

   Ważne

   W tym przykładzie użyto argumentu --export-to-resource-specific w celu włączenia tabel specyficznych dla zasobów.

3. Przejrzyj wyniki tworzenia nowego ustawienia przy użyciu polecenia 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" \
     )
   

Interfejs API REST

Użyj interfejsu API REST usługi Azure Monitor do utworzenia ustawienia diagnostycznego za pośrednictwem konsoli interaktywnej.

1. Upewnij się, że zalogowano się do interfejsu wiersza polecenia platformy Azure. Aby uzyskać więcej informacji, zobacz Logowanie się za pomocą interfejsu wiersza polecenia platformy Azure.

2. Utwórz ustawienie diagnostyczne dla zasobu usługi Azure Cosmos DB przy użyciu żądania HTTP PUT i 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"
       }
     }'
   

   Ważne

   W tym przykładzie logAnalyticsDestinationType właściwość jest ustawiana w celu Dedicated włączenia tabel specyficznych dla zasobów.

3. Użyj az rest ponownie z czasownikiem HTTP GET , aby uzyskać właściwości ustawienia diagnostycznego.

   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

Użyj szablonu Bicep, aby utworzyć ustawienie diagnostyczne.

1. Upewnij się, że zalogowano się do interfejsu wiersza polecenia platformy Azure. Aby uzyskać więcej informacji, zobacz Logowanie się za pomocą interfejsu wiersza polecenia platformy Azure.

2. Utwórz nowy plik o nazwie diagnosticSetting.bicep.

3. Wprowadź następującą zawartość szablonu Bicep, która wdraża ustawienie diagnostyczne dla zasobu usługi 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
         }
       ]
     }
   }    
   

   Ważne

   W tym przykładzie logAnalyticsDestinationType właściwość jest ustawiana w celu Dedicated włączenia tabel specyficznych dla zasobów.

4. Wdróż szablon przy użyciu polecenia 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>"
   

   Napiwek

   Użyj polecenia , az bicep build aby przekonwertować szablon Bicep na szablon usługi Azure Resource Manager.

Szablon ARM

Użyj szablonu usługi Azure Resource Manager, aby utworzyć ustawienie diagnostyczne.

1. Upewnij się, że zalogowano się do interfejsu wiersza polecenia platformy Azure. Aby uzyskać więcej informacji, zobacz Logowanie się za pomocą interfejsu wiersza polecenia platformy Azure.

2. Utwórz nowy plik o nazwie diagnosticSetting.bicep.

3. Wprowadź następującą zawartość szablonu usługi Azure Resource Manager, która wdraża ustawienie diagnostyczne dla zasobu usługi 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
             }
           ]
         }
       }
     ]
   }
   

   Ważne

   W tym przykładzie logAnalyticsDestinationType właściwość jest ustawiana w celu Dedicated włączenia tabel specyficznych dla zasobów.

4. Wdróż szablon przy użyciu polecenia 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>"
   

   Napiwek

   Użyj polecenia , az bicep decompile aby przekonwertować szablon usługi Azure Resource Manager na szablon Bicep.

Włączanie zapytania pełnotekstowego na potrzeby rejestrowania tekstu zapytania

Usługa Azure Cosmos DB udostępnia zaawansowane rejestrowanie na potrzeby szczegółowego rozwiązywania problemów. Włączając zapytanie pełnotekstowe, możesz wyświetlić zapytanie deobfuscated dla wszystkich żądań na koncie usługi Azure Cosmos DB. Możesz również przyznać usłudze Azure Cosmos DB uprawnienia do uzyskiwania dostępu do tych danych i wyświetlania ich w dziennikach.

Ostrzeżenie

Włączenie tej funkcji może spowodować dodatkowe koszty rejestrowania, aby uzyskać szczegółowe informacje o cenach, odwiedź stronę Cennik usługi Azure Monitor. Zaleca się wyłączenie tej funkcji po rozwiązaniu problemów.

Witryna Azure Portal

1. Na istniejącej stronie konta usługi Azure Cosmos DB wybierz opcję Funkcje w sekcji Ustawienia menu zasobu. Następnie wybierz funkcję kwerendy pełnotekstowej Diagnostyka.

   

2. W oknie dialogowym wybierz pozycję Enable. To ustawienie jest stosowane w ciągu kilku minut. Wszystkie nowo pozyskane dzienniki mają teraz pełny tekst lub tekst PIICommand dla każdego żądania.

   

Interfejs wiersza polecenia platformy Azure / interfejs API REST / Bicep / szablon usługi ARM

Użyj interfejsu wiersza polecenia platformy Azure, aby włączyć zapytanie pełnotekstowe dla konta usługi Azure Cosmos DB.

1. Włącz zapytanie pełnotekstowe przy użyciu az rest ponownie z czasownikiem HTTP PATCH i ładunkiem 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. Poczekaj kilka minut na ukończenie operacji. Sprawdź stan zapytania pełnotekstowego, używając ponownie polecenia az rest 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}"
   

   Dane wyjściowe powinny być podobne do tego przykładu.

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

Powiązana zawartość

• Zapytania diagnostyczne w interfejsie API dla noSQL
• Zapytania diagnostyczne w interfejsie API dla bazy danych MongoDB
• Zapytania diagnostyczne w interfejsie API dla systemu Apache Cassandra