analyseShardKey (comando de base de datos)

Métricas sobre las características de la clave de partición

keyCharacteristic Consiste en las métricas sobre la cardinalidad, frecuencia y monotonía de la clave del fragmento. Estas métricas solo se devuelven cuando keyCharacteristics es verdadero.

Las métricas se calculan cuando se ejecuta analyzeShardKey en función de los documentos muestreados de la colección. El cálculo requiere que la clave de partición tenga un índice de soporte. Si no hay un índice de apoyo, no se devuelven métricas.

Puedes configurar el muestreo con los campos sampleRate y sampleSize. Ambos son opcionales, pero solo se puede especificar uno. Cuando ni sampleRate ni sampleSize están especificados, MongoDB utiliza el valor del parámetro analyzeShardKeyCharacteristicsDefaultSampleSize, que tiene un valor por defecto de 10 millones.

Para calcular métricas basadas en todos los documentos de la colección, establece el sampleRate en 1.

Métricas sobre la distribución de lectura y escritura

readWriteDistribution contiene métricas sobre los patrones de enrutamiento de consultas y la popularidad de los rangos de claves de fragmentos. Estas métricas se basan en consultas de muestra.

Para configurar el muestreo de query para una colección, usa el comando configureQueryAnalyzer. Las métricas de distribución de lectura y guardado solo se devuelven si readWriteDistribution es true. Las métricas se calculan cuando analyzeShardKey se ejecuta y las métricas usan las consultas de lectura y escritura seleccionadas. Si no hay queries muestreadas, no se devuelven las métricas de distribución de lectura y escritura.

• Si no hay consultas de lectura muestreadas, el comando devuelve writeDistribution pero omite readDistribution.

• Si no hay queries de guardar muestreadas, el comando devuelve readDistribution pero omite writeDistribution.

Para devolver métricas de distribución de lectura y guardado para una colección usando analyzeShardKey, debes configurar el analizador de querys para muestrear las querys ejecutadas en la colección. De lo contrario, analyzeShardKey devuelve las métricas de distribución de lectura y escritura como valores 0. Para configurar el analizador de consultas, consulta configureQueryAnalyzer (comando de base de datos).

Comportamiento sin bloqueo

analyzeShardKey no bloquea lecturas ni escrituras en la colección.

Muestreo de query

La calidad de las métricas sobre la distribución de lectura y escritura se determina por cuán representativo es la carga de trabajo cuando ocurre el muestreo de consultas. Para algunas aplicaciones, devolver métricas representativas puede requerir mantener el muestreo de query activado durante varios días.

Índices de soporte

El índice de soporte requerido por analyzeShardKey es diferente del índice de soporte requerido por el shardCollection comando.

Esta tabla muestra los índices de soporte para la misma clave de fragmento tanto para analyzeShardKey como para shardCollection:

Esto permite analizar una clave de partición que puede que aún no tenga un índice compatible necesario para particionarla.

Tanto analyzeShardKey como shardCollection tienen los siguientes requisitos de índice:

• El índice tiene una intercalaciónsencilla

• El índice no es multiclave

• El índice no es parcial

• El índice no es parcial

Para crear índices de apoyo, utilice el db.collection.createIndex() método.

preferencia de lectura

Para minimizar el rendimiento, ejecuta analyzeShardKey con la preferencia de lectura secondary o secondaryPreferred. En un clúster fragmentado, mongos establece automáticamente la preferencia de lectura en secondaryPreferred si no se especifica.

Limitaciones

• No puedes ejecutar analyzeShardKey en Atlas clústeres flexibles.

• No se puede ejecutar analyzeShardKey en implementaciones autónomas.

• No puedes ejecutar analyzeShardKey directamente contra un --shardsvr set de réplicas. Al ejecutarse en un clúster fragmentado, analyzeShardKey debe ejecutarse contra un mongos.

• No se puede ejecutar analyzeShardKey en colecciones de series temporales.

• No se puede ejecutar analyzeShardKey en colecciones con Queryable Encryption.

keyCharacteristics

Esta es la estructura del documento keyCharacteristics que se devuelve cuando se establece keyCharacteristics en true:

{
   keyCharacteristics: {
      numDocsTotal: <integer>,
      numOrphanDocs: <integer>,
      avgDocSizeBytes: <integer>,
      numDocsSampled: <integer>,
      isUnique: <bool>,
      numDistinctValues: <integer>,
      mostCommonValues: [
        { value: <shardkeyValue>, frequency: <integer> },
        ...
      ],
      monotonicity: {
        recordIdCorrelationCoefficient: <double>,
        type: "monotonic"|"not monotonic"|"unknown",
    }
  }
}

readWriteDistribution

Esta es la estructura del documento que se devuelve cuando readWriteDistribution está configurado en true:

{
   readDistribution: {
     sampleSize: {
       total: <integer>,
       find: <integer>,
       aggregate: <integer>,
       count: <integer>,
       distinct: <integer>
     },
     percentageOfSingleShardReads: <double>,
     percentageOfMultiShardReads: <double>,
     percentageOfScatterGatherReads: <double>,
     numReadsByRange: [
       <integer>,
       ...
     ]
   },
   writeDistribution: {
     sampleSize: {
       total: <integer>,
       update: <integer>,
       delete: <integer>,
       findAndModify: <integer>
     },
     percentageOfSingleShardWrites: <double>,
     percentageOfMultiShardWrites: <double>,
     percentageOfScatterGatherWrites: <double>,
     numWritesByRange: [
       <integer>,
       ...
     ],
     percentageOfShardKeyUpdates: <double>,
     percentageOfSingleWritesWithoutShardKey: <double>,
     percentageOfMultiWritesWithoutShardKey: <double>
   }
}

Para devolver métricas de distribución de lectura y guardado para una colección usando analyzeShardKey, debes configurar el analizador de querys para muestrear las querys ejecutadas en la colección. De lo contrario, analyzeShardKey devuelve las métricas de distribución de lectura y escritura como valores 0. Para configurar el analizador de consultas, consulta configureQueryAnalyzer (comando de base de datos).

Información de segundo plano

• La aplicación tiene 1500 usuarios.

• Hay 30 apellidos y 45 nombres, algunos más comunes que otros.

• Hay tres usuarios famosos.

• Cada usuario sigue exactamente a cinco usuarios más y tiene una probabilidad muy alta de seguir al menos a un usuario famoso.

Carga de trabajo de muestra

• Cada usuario publica alrededor de dos publicaciones al día en horarios aleatorios. Editan cada publicación una vez, justo después de que se haya publicado.

• Cada usuario inicia sesión cada seis horas para leer su propio perfil y las publicaciones de los usuarios que sigue de las últimas 24 horas. También responden bajo una publicación aleatoria de las últimas tres horas.

• Para cada usuario, la aplicación remueve las publicaciones que tienen más de tres días a la medianoche.

Patrones de consulta de carga de trabajo

Esta carga de trabajo tiene los siguientes patrones de query:

• find comando con filtro { userId: , firstName: , lastName: }

• find comando con filtro { $or: [ { userId: , firstName: , lastName: , date: { $gte: } }, ... , { userId: , date: } ] }

• findAndModify comando con filtro { userId: , firstName: , lastName: , date: } para actualizar el cuerpo y la fecha del campo.

• update comando con multi: false y filtro { userId: , firstName: , lastName: , date: { $gte: , $lt: } } para actualizar el cuerpo y el campo de fecha.

• delete comando con multi: true y filtro { userId: , firstName: , lastName: , date: { $lt: } }

A continuación se muestran métricas de ejemplo devueltas por el comando analyzeShardKey para algunas claves de fragmentos candidatas, con consultas de muestra recopiladas durante siete días de carga de trabajo.

{ _id: 1 } keyCharacteristics

Este ejemplo utiliza el comando analyzeShardKey para proporcionar métricas sobre la clave de partición { _id: 1 } en la colección social.post.

El siguiente bloque de código utiliza para activar el muestreo de db.collection.configureQueryAnalyzer() consultas:

use social
db.post.configureQueryAnalyzer(
   {
      mode: "full",
      samplesPerSecond: 5
   }
)

Después de que db.collection.configureQueryAnalyzer() recopila muestras de consultas, el siguiente bloque de código usa el comando analyzeShardKey para muestrear documentos 10,000 y calcular resultados:

use social
db.post.analyzeShardKey(
   { _id: 1 },
   {
      keyCharacteristics: true,
      readWriteDistribution: false,
      sampleSize: 10000
   }
)

{ lastName: 1 } keyCharacteristics

Este comando analyzeShardKey proporciona métricas sobre la clave de partición { lastName: 1 } de la colección social.post:

use social
db.post.analyzeShardKey(
   { lastName: 1 },
   {
      keyCharacteristics: true,
      readWriteDistribution: false
   }
)

La salida para este ejemplo se asemeja a lo siguiente:

{
   "keyCharacteristics": {
     "numDocsTotal" : 9039,
     "avgDocSizeBytes" : 153,
     "numDocsSampled" : 9039,
     "isUnique" : false,
     "numDistinctValues" : 30,
     "mostCommonValues" : [
         {
           "value" : {
               "lastName" : "Smith"
           },
           "frequency" : 1013
         },
         {
           "value" : {
               "lastName" : "Johnson"
           },
           "frequency" : 984
         },
         {
           "value" : {
               "lastName" : "Jones"
           },
           "frequency" : 962
         },
         {
           "value" : {
               "lastName" : "Brown"
           },
           "frequency" : 925
         },
         {
           "value" : {
               "lastName" : "Davies"
           },
           "frequency" : 852
         }
     ],
     "monotonicity" : {
       "recordIdCorrelationCoefficient" : 0.0771959161,
       "type" : "not monotonic"
   },
 }
}

{ userId: 1 } keyCharacteristics

Este comando analyzeShardKey proporciona métricas sobre la clave de partición { userId: 1 } de la colección social.post:

use social
db.post.analyzeShardKey(
   { userId: 1 },
   {
      keyCharacteristics: true,
      readWriteDistribution: false
   }
)

La salida para este ejemplo se asemeja a lo siguiente:

{
  "keyCharacteristics": {
    "numDocsTotal" : 9039,
    "avgDocSizeBytes" : 162,
    "numDocsSampled" : 9039,
    "isUnique" : false,
    "numDistinctValues" : 1495,
    "mostCommonValues" : [
      {
        "value" : {
          "userId" : UUID("aadc3943-9402-4072-aae6-ad551359c596")
        },
        "frequency" : 15
      },
     {
       "value" : {
         "userId" : UUID("681abd2b-7a27-490c-b712-e544346f8d07")
       },
       "frequency" : 14
     },
     {
       "value" : {
         "userId" : UUID("714cb722-aa27-420a-8d63-0d5db962390d")
       },
       "frequency" : 14
     },
     {
       "value" : {
         "userId" : UUID("019a4118-b0d3-41d5-9c0a-764338b7e9d1")
       },
       "frequency" : 14
     },
     {
       "value" : {
         "userId" : UUID("b9c9fbea-3c12-41aa-bc69-eb316047a790")
       },
       "frequency" : 14
     }
   ],
   "monotonicity" : {
     "recordIdCorrelationCoefficient" : -0.0032039729,
     "type" : "not monotonic"
   },
 }
}

{ userId: 1 } lecturaEscribirDistribución

Este comando analyzeShardKey proporciona métricas sobre la clave de partición { userId: 1 } de la colección social.post:

use social
db.post.analyzeShardKey(
   { userId: 1 },
   {
      keyCharacteristics: false,
      readWriteDistribution: true
   }
)

La salida para este ejemplo se asemeja a lo siguiente:

{
   "readDistribution" : {
     "sampleSize" : {
       "total" : 61363,
       "find" : 61363,
       "aggregate" : 0,
       "count" : 0,
       "distinct" : 0
     },
     "percentageOfSingleShardReads" : 50.0008148233,
     "percentageOfMultiShardReads" : 49.9991851768,
     "percentageOfScatterGatherReads" : 0,
     "numReadsByRange" : [
       688,
       775,
       737,
       776,
       652,
       671,
       1332,
       1407,
       535,
       428,
       985,
       573,
       1496,
       ...
       ],
     },
   "writeDistribution" : {
     "sampleSize" : {
       "total" : 49638,
       "update" : 30680,
       "delete" : 7500,
       "findAndModify" : 11458
     },
     "percentageOfSingleShardWrites" : 100,
     "percentageOfMultiShardWrites" : 0,
     "percentageOfScatterGatherWrites" : 0,
     "numWritesByRange" : [
       389,
       601,
       430,
       454,
       462,
       421,
       668,
       833,
       493,
       300,
       683,
       460,
       ...
      ],
      "percentageOfShardKeyUpdates" : 0,
      "percentageOfSingleWritesWithoutShardKey" : 0,
      "percentageOfMultiWritesWithoutShardKey" : 0
    }
}