低速クエリを返す
Performance Advisorとクエリプロファイラーが特定した低速クエリのログ行を返します。Performance Advisor は MongoDB が遅いと判断したクエリをモニターし、クエリ パフォーマンスを改善するための新しいインデックスを提案します。MongoDB Cloud では、クラスターでの平均操作時間に基づいて低速クエリのしきい値が決定されます。これにより、ワークロードに適した推奨が可能になります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに、いずれかのプロジェクト データアクセス ロールまたはプロジェクト オブザーバビリティ ビューア ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
MongoDB プロセスを提供するホストとポートの組み合わせ。ホストは、MongoDB プロセス（
mongodまたはmongos）を実行するホストのホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスである必要があります。ポートは MongoDB プロセスがリクエストをリッスンする IANA ポートである必要があります。形式は次のパターンと一致する必要があります:
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint -
クラスター内の管理対象名前空間内で、クエリが低速クエリと判断されるまでの時間の長さ。このパラメータは、その値をミリ秒単位で表します。
- sinceパラメーターを指定しない場合、エンドポイントは現在の時刻より前の期間に該当するデータを返します。
- durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。
-
低速クエリを取得する名前空間。名前空間は 1 件のデータベースと 1 件のコレクション リソースで構成され、
.:<database>.<collection>と記述されます。複数の名前空間を含めるには、各名前空間の間をアンパサンド (&) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、すべての名前空間の結果が返されます。 -
ログから返される最大行数。
最小値は
0、最大値は20000です。デフォルト値は20000です。 -
クエリが低速クエリを検索する日時。このパラメータは、 UNIXエポックから経過したミリ秒数で値を表します。
- durationパラメーターを指定しない場合、エンドポイントはsince値から現在の時刻までのデータを返します。
- durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。
の最小値は
1199145600000です。 -
低速クエリログから抽出されたメトリクスを別のフィールドとして含めるかどうか。
デフォルト値は
falseです。 -
低速クエリログが別のフィールドとして生成されたときのホストのレプリカ状態を含めるかどうか。
デフォルト値は
falseです。 -
低速クエリログから抽出された操作タイプ（読み取り/書込み/コマンド）を別のフィールドとして含めるかどうか。
デフォルト値は
falseです。
atlas api performanceAdvisor listGroupProcessPerformanceAdvisorSlowQueryLogs --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ListGroupProcessPerformanceAdvisorSlowQueryLogsApiParams{}
sdkResp, httpResp, err := client.PerformanceAdvisorApi.
ListGroupProcessPerformanceAdvisorSlowQueryLogsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true"{
"slowQueries": [
{
"line": "string",
"metrics": {
"docsExamined": 42,
"docsExaminedReturnedRatio": 42.0,
"docsReturned": 42,
"fromUserConnection": true,
"hasIndexCoverage": true,
"hasSort": true,
"keysExamined": 42,
"keysExaminedReturnedRatio": 42.0,
"numYields": 42,
"operationExecutionTime": 42,
"responseLength": 42
},
"namespace": "string",
"opType": "string",
"replicaState": "string"
}
]
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}