Azure İzleyici Log Analytics tanılama ayarlarını kullanarak Azure Cosmos DB verilerini izleme

ŞUNLAR IÇIN GEÇERLIDIR: NoSQL MongoDB Cassandra Gremlin Masa

Kaynak günlüklerini toplamak için Azure'daki tanılama ayarları kullanılır. Kaynaklar Azure kaynak günlüklerini yayar ve bu kaynağın işlemi hakkında zengin ve sık kullanılan veriler sağlar. Bu günlükler istek başına yakalanır ve "veri düzlemi günlükleri" olarak adlandırılır. Veri düzlemi işlemlerine örnek olarak delete, insert ve readFeed verilebilir. Bu günlüklerin içeriği, kaynak türüne göre değişir.

Platform ölçümleri ve Etkinlik günlükleri otomatik olarak toplanırken, kaynak günlüklerini toplamak veya Azure İzleyici'nin dışına iletmek için bir tanılama ayarı oluşturmanız gerekir. Azure Cosmos DB hesapları için tanılama ayarını açabilir ve kaynak günlüklerini aşağıdaki kaynaklara gönderebilirsiniz:

• Azure İzleyici Log Analytics çalışma alanları
  • Log Analytics'e gönderilen veriler Azure Tanılama (eski) veya Kaynağa özgü (önizleme) tablolara yazılabilir
• Olay hub'ı
• Depolama Hesabı

Not

REST API aracılığıyla tanılama ayarı oluşturma yönergelerimizi izleyerek tanılama ayarını kaynağa özgü modda (Tablo api'leri dışındaki tüm API'ler için) oluşturmanızı öneririz. Bu seçenek, verileri işlemek için geliştirilmiş bir görünümle ek maliyet iyileştirmeleri sağlar.

Önkoşullar

• Mevcut bir Azure Cosmos DB hesabı.
  • Azure aboneliğiniz varsa yeni bir hesap oluşturun.
  • Azure aboneliğiniz yoksa başlamadan önce ücretsiz bir hesap oluşturun.
  • Alternatif olarak, işlemeden önce Azure Cosmos DB'yi ücretsiz deneyebilirsiniz.
• Mevcut bir Azure İzleyici Log Analytics çalışma alanı.

Tanılama ayarlarını oluşturma

Burada, hesabınız için tanılama ayarları oluşturma işleminde size yol gösteririz.

Not

Günlüklerin kategori olarak dışarı aktarılma ölçümü şu anda desteklenmiyor.

Azure portalı

1. Azure Portal’ında oturum açın.

2. Mevcut Azure Cosmos DB hesabınıza gidin.

3. Kaynak menüsünün İzleme bölümünde Tanılama ayarları'nı seçin. Ardından Tanılama ayarı ekle seçeneğini belirleyin.

   

   Önemli

   "Tam metin sorgusunu etkinleştirme [...] daha ayrıntılı günlüğe kaydetme için", hesabınızda tam metin sorgu özelliği etkinleştirilmediyse. Bu özelliği etkinleştirmek istemiyorsanız bu uyarıyı güvenle yoksayabilirsiniz. Daha fazla bilgi için bkz . Tam metin sorgusunu etkinleştirme.

4. Tanılama ayarları bölmesinde, ayara örnek ayarını adlandırın ve ardından QueryRuntimeStatistics kategorisini seçin. Mevcut çalışma alanınızı seçerek günlükleri Log Analytics Çalışma Alanına gönderin. Son olarak hedef seçenek olarak Kaynağa özgü seçeneğini belirleyin.

   

Azure CLI

Komutunu kullanarak az monitor diagnostic-settings create Azure CLI ile bir tanılama ayarı oluşturun. Parametrelerinin açıklamaları için bu komutun belgelerine bakın.

1. Azure CLI'da oturum açtığınızdan emin olun. Daha fazla bilgi için bkz . Azure CLI ile oturum açma.

2. Ayarı oluşturmak için kullanın 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
       }
     ]'
   

   Önemli

   Bu örnek, kaynağa özgü tabloları etkinleştirmek için bağımsız değişkenini --export-to-resource-specific kullanır.

3. kullanarak az monitor diagnostics-settings showyeni ayarınızı oluşturmanın sonuçlarını gözden geçirin.

   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

Etkileşimli konsol aracılığıyla tanılama ayarı oluşturmak için Azure İzleyici REST API'sini kullanın.

1. Azure CLI'da oturum açtığınızdan emin olun. Daha fazla bilgi için bkz . Azure CLI ile oturum açma.

2. bir HTTP PUT isteği ve az restkullanarak Azure Cosmos DB kaynağınız için tanılama ayarını oluşturun.

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

   Önemli

   Bu örnek, kaynağa özgü tabloları etkinleştirmek için Dedicated özelliğini olarak ayarlarlogAnalyticsDestinationType.

3. Tanılama ayarının özelliklerini almak için bir HTTP GET fiiliyle yeniden kullanınaz rest.

   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

Tanılama ayarını oluşturmak için bicep şablonu kullanın.

1. Azure CLI'da oturum açtığınızdan emin olun. Daha fazla bilgi için bkz . Azure CLI ile oturum açma.

2. diagnosticSetting.bicep adlı yeni bir dosya oluşturun.

3. Azure Cosmos DB kaynağınız için tanılama ayarını dağıtan aşağıdaki Bicep şablonu içeriğini girin.

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

   Önemli

   Bu örnek, kaynağa özgü tabloları etkinleştirmek için Dedicated özelliğini olarak ayarlarlogAnalyticsDestinationType.

4. kullanarak az deployment group createşablonu dağıtın.

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

   İpucu

   az bicep build Bicep şablonunu Azure Resource Manager şablonuna dönüştürmek için komutunu kullanın.

ARM Şablonu

Tanılama ayarını oluşturmak için bir Azure Resource Manager şablonu kullanın.

1. Azure CLI'da oturum açtığınızdan emin olun. Daha fazla bilgi için bkz . Azure CLI ile oturum açma.

2. diagnosticSetting.bicep adlı yeni bir dosya oluşturun.

3. Azure Cosmos DB kaynağınız için tanılama ayarını dağıtan aşağıdaki Azure Resource Manager şablon içeriğini girin.

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

   Önemli

   Bu örnek, kaynağa özgü tabloları etkinleştirmek için Dedicated özelliğini olarak ayarlarlogAnalyticsDestinationType.

4. kullanarak az deployment group createşablonu dağıtın.

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

   İpucu

   az bicep decompile Azure Resource Manager şablonunu Bicep şablonuna dönüştürmek için komutunu kullanın.

Sorgu metnini günlüğe kaydetmek için tam metin sorgusunu etkinleştirme

Azure Cosmos DB, ayrıntılı sorun giderme işlemleri için gelişmiş günlük kaydı sağlar. Tam metin sorgusunu etkinleştirerek Azure Cosmos DB hesabınızdaki tüm istekler için engelsiz sorguyu görüntüleyebilirsiniz. Ayrıca Azure Cosmos DB'nin bu verilere erişmesine ve günlüklerinizde bu verilere erişmesine izin verirsiniz.

Uyarı

Bu özelliğin etkinleştirilmesi ek günlüğe kaydetme maliyetlerine neden olabilir. Fiyatlandırma ayrıntıları için Azure İzleyici fiyatlandırması bölümünü ziyaret edin. Sorun giderme sonrasında bu özelliği devre dışı bırakması önerilir.

Azure portalı

1. Mevcut Azure Cosmos DB hesabı sayfasında, kaynak menüsünün Ayarlar bölümünde Özellikler seçeneğini belirleyin. Ardından Tanılama tam metin sorgu özelliğini seçin.

   

2. İletişim kutusunda öğesini seçin Enable. Bu ayar birkaç dakika içinde uygulanır. Yeni alınan tüm günlüklerde artık her istek için tam metin veya PIICommand metni bulunur.

   

Azure CLI / REST API / Bicep / ARM Şablonu

Azure Cosmos DB hesabınız için tam metin sorgusunu etkinleştirmek için Azure CLI'yi kullanın.

1. HTTP PATCH fiili ve JSON yükü ile yeniden kullanarak az rest tam metin sorgusunu etkinleştirin.

   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. İşlemin tamamlanması için birkaç dakika bekleyin. HTTP GETile yeniden kullanarak az rest tam metin sorgusunun durumunu denetleyin.

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

   Çıktı bu örneğe benzer olmalıdır.

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

İlgili içerik

• NoSQL için API'de tanılama sorguları
• MongoDB için API'de tanılama sorguları
• Apache Cassandra için API'de tanılama sorguları