Cosmos DB 基本情報採取

Last Update: feedback 共有

こんにちは。Cosmos DB サポートチームです。

本記事では Cosmos DB のトラブルシュートの際に必要となる情報を案内します。

問題やご相談いただく内容により必要となる情報は異なってまいりますが、今回は共通して必要となる情報について案内します。

基本情報

1.Subscription Id:  サブスクリプション ID

2.Cosmos DB Account 名

3.Database 名

4.Container 名

5.Cosmos DB API (NoSQL/MongoDB/Table/Gremlin/Cassandra)

6.本番環境 (Yes/No)

参考


エラーの情報

  1. エラーが発生した場合の詳細な時間 (日本時間の場合その旨明記。もしくは UTC 時間）   

  2. Activity ID ならびにスタックトレース含むエラーメッセージ。なお、本情報は画像のみでなくテキスト形式もあわせて送付ください。
    Activity ID が不明な場合、Activity ID の項目を参照ください。

  3. 事象の発生頻度。また以前動作していたか。

  4. (お気づきの場合) エラーの発生契機

  5. エラーが発生するまでの手順
    毎回事象が発生する場合、エラーが発生するまでの手順を PSR で採取ください。
    https://support.microsoft.com/en-us/help/22878/windows-10-record-steps

  6. (可能であれば) アプリケーションからでなくポータルからの操作で同様にエラーが発生するかお知らせください。

Client ・Application 情報

  1. Cosmos DB に接続しているサービス (例: Azure Functions / Azure Web App Service / Azure Kubernetes Service (AKS) , 他)

Note

問題の内容に応じて利用サービスの Subscription Id や名前などの情報を依頼することがございます。

また問題によっては該当サービス観点でのお問い合わせを相談させていただくことがございます。

  1. Cosmos DB SDK とそのバージョン情報 (.Net/.Net Core/Java/Node.js/Python 他)

  2. 事象が発生する最小単位のコードおよびクエリ(内容によってはサンプルデータ)

  3. (アプリケーションで Diagnostics を取得している場合) Diagnostics
    *SDK により取得方法異なります。

Activity ID

Cosmos DB に接続・操作するアプリケーションのログで Activity ID を取得していない場合、対象の Cosmos DB アカウントに対して診断設定をすることで Log Analytics 等から Activity ID 含む診断ログの取得が可能です。

診断ログの設定方法は https://learn.microsoft.com/ja-jp/azure/cosmos-db/monitor-resource-logs?tabs=azure-portal を参照ください。

下記はリクエストの種類 (Query / Data Plane / Control Plane) ならびに診断ログの設定 (Azure diagnostics or Resource specific) に応じたログ取得のクエリならびにその出力結果（サンプル）となります。

Note

Azure diagnostics を選択すると、各種の診断情報が１つのテーブル（AzureDiagnostics) に出力されます。各種の診断は、 Category カラムを指定して個別に抽出が可能です。

一方で、 Resource specific を選択すると、各種の診断情報がそれぞれ別のテーブルに出力されます。

Query Requests

Azure diagnostics

1
2
3
AzureDiagnostics
| where ResourceProvider =="MICROSOFT.DOCUMENTDB" and Category == "QueryRuntimeStatistics"
| project TimeGenerated, activityId_g, querytext_s,databasename_s,collectionname_s,ResourceId,ResourceType,regionname_s,authtype_s,numberofrowsreturned_s,queryexecutionstatus_s,userAgent_s,partialipaddress_s,partitionKeyRangeId_s

Resource specific

1
2
CDBQueryRuntimeStatistics 
|project TimeGenerated,ActivityId,AccountName,DatabaseName,CollectionName,PartitionKeyRangeId,QueryText,SourceSystem,Type,_ResourceId


Data plane requests

Azure diagnostics

1
2
3
4
AzureDiagnostics
| where ResourceProvider=="MICROSOFT.DOCUMENTDB" and Category=="DataPlaneRequests"
//| where statusCode_s !in(200,201)
| project TimeGenerated,activityId_g,statusCode_s,ResourceId,requestCharge_s,ResourceType,OperationName,requestResourceType_s,connectionMode_s,userAgent_s,clientIpAddress_s,duration_s,requestLength_s,responseLength_s,regionname_s,databasename_s

Resource specific

1
2
CDBDataPlaneRequests
| project TimeGenerated,ActivityId,StatusCode,_ResourceId,RequestCharge,OperationName,RequestResourceType,RequestResourceId,ConnectionMode,UserAgent,ClientIpAddress,DurationMs,RequestLength,ResponseLength,RegionName,DatabaseName,CollectionName,PartitionId,KeyType,AuthTokenType


Control plane requests

Azure diagnostics

1
2
3
AzureDiagnostics
| where ResourceProvider=="MICROSOFT.DOCUMENTDB" and Category=="ControlPlaneRequests"
| project TimeGenerated,activityId_g,statusCode_s,ResourceId,requestCharge_s,ResourceType,OperationName,requestResourceType_s,connectionMode_s,userAgent_s,clientIpAddress_s,duration_s,requestLength_s,responseLength_s,regionname_s,databasename_s

Resource specific

1
2
CDBControlPlaneRequests
|project TimeGenerated,ActivityId,AccountName,OperationName,OperationType,HttpStatusCode,Result,HttpMethod,ApiKind,ApiKindResourceType,ResourceUri,ResourceDetails,Type,_ResourceId

補足

上記採取情報をテキスト形式でもまとめています。(診断ログの項目除く)

必要に応じてこちらもご活用ください。

cosmosdbbasicinformationtocollect.txt

※本情報の内容（添付文書、リンク先などを含む）は、作成日時点でのものであり、予告なく変更される場合があります。