Configurar mongot

Configurações de autenticação do conjunto de réplicas

syncSource.replicaSet.x509

Tipo: objeto

Necessidade: Obrigatório se você não usar syncSource.replicaSet.scramAuth

Configurações de certificado X.509 para autenticar mongot com mongod.

syncSource.replicaSet.x509.caFile

Tipo: string

Necessidade: obrigatório se você usar syncSource.replicaSet.x509

Arquivo da Autoridade de Certificação (CA) que contém certificados confiáveis para verificar o certificado apresentado por mongod. O arquivo deve conter uma coleção de certificados X.509 no formato PEM.

syncSource.replicaSet.x509.tlsCertificateKeyFile

Tipo: string

Necessidade: obrigatório se você usar syncSource.replicaSet.x509

Caminho para o arquivo PEM que contém o certificado X.509 e a chave privada para autenticar mongot com mongod. Obrigatório ao configurar syncSource.replicaSet.x509.

syncSource.replicaSet.x509.tlsCertificateKeyFilePasswordFile

Tipo: string

Necessidade: opcional

Caminho para o arquivo que contém a senha para descriptografar o arquivo de chave de certificado especificado em syncSource.replicaSet.x509.tlsCertificateKeyFile.

syncSource.replicaSet.scramAuth

Tipo: objeto

Necessidade: Obrigatório se você não usar syncSource.replicaSet.x509

Configurações para autenticação SCRAM.

syncSource.replicaSet.scramAuth.username

Tipo: string

Necessidade: obrigatório

O nome de usuário para autenticar.

syncSource.replicaSet.scramAuth.passwordFile

Tipo: string

Necessidade: obrigatório

Caminho para um arquivo que contém a senha para autenticar.

syncSource.replicaSet.scramAuth.authSource

Tipo: string

Necessidade: opcional

Padrão: admin

Nome do banco de dados associado às credenciais de autenticação do mongot.

syncSource.replicaSet.scramAuth.tls

Tipo: objeto

Necessidade: opcional

Padrão: false

Configurações para TLS.

syncSource.replicaSet.scramAuth.tls.enabled

Tipo: Booleano

Necessidade: obrigatório se você especificar syncSource.replicaSet.scramAuth.tls

Sinalizador para habilitar a autenticação TLS. Defina como true para habilitar a autenticação TLS.

syncSource.replicaSet.scramAuth.tls.caFile

Tipo: string

Necessidade: opcional

Arquivo da Autoridade de Certificação (CA) que contém certificados confiáveis para verificar o certificado apresentado por mongod. O arquivo deve conter uma coleção de certificados X.509 no formato PEM.

syncSource.replicaSet.scramAuth.tls.tlsCertificateKeyFile

Tipo: string

Necessidade: opcional

Caminho para o arquivo PEM que contém o certificado x.509 e a chave privada para autenticar mongot com mongod.

syncSource.replicaSet.scramAuth.tls.tlsCertificateKeyFilePasswordFile

Tipo: string

Necessidade: opcional

Caminho para o arquivo que contém a senha para descriptografar o arquivo de chave de certificado especificado em syncSource.replicaSet.scramAuth.tls.tlsCertificateKeyFile.

Configurações de cluster fragmentado

syncSource.router

Tipo: objeto

Conexões de replicação para mongos para mongot. Se omitido, mongot assume que está sendo executado em um ambiente não sharded. Obrigatório para implantações de cluster sharded.

syncSource.router.x509

Tipo: objeto

Necessidade: Obrigatório se você não usar syncSource.router.scramAuth

Configurações de certificado X.509 para autenticar mongot com mongos.

syncSource.router.x509.caFile

Tipo: string

Necessidade: obrigatório se você usar syncSource.router.x509

Arquivo da Autoridade de Certificação (CA) que contém certificados confiáveis para verificar o certificado apresentado por mongos. O arquivo deve conter uma coleção de certificados X.509 no formato PEM.

syncSource.router.x509.tlsCertificateKeyFile

Tipo: string

Necessidade: obrigatório se você usar syncSource.router.x509

Caminho para o arquivo PEM que contém o certificado X.509 e a chave privada para autenticar mongot com mongos. Obrigatório ao configurar syncSource.router.x509.

syncSource.router.x509.tlsCertificateKeyFilePasswordFile

Tipo: string

Necessidade: opcional

Caminho para o arquivo que contém a senha para descriptografar o arquivo de chave de certificado especificado em syncSource.router.x509.tlsCertificateKeyFile.

syncSource.router.scramAuth

Tipo: objeto

Necessidade: Obrigatório se você não usar syncSource.router.x509

Configurações para autenticação SCRAM.

syncSource.router.scramAuth.username

Tipo: string

Necessidade: obrigatório

O nome de usuário para autenticar.

syncSource.router.scramAuth.passwordFile

Tipo: string

Necessidade: obrigatório

Caminho para um arquivo que contém a senha para autenticar.

syncSource.router.scramAuth.authSource

Tipo: string

Necessidade: opcional

Nome do banco de dados associado às credenciais de autenticação do mongot. Se não for especificado, authSource padronizará para admin.

syncSource.router.scramAuth.tls

Tipo: objeto

Necessidade: opcional

Padrão: false

Configurações para TLS.

syncSource.router.scramAuth.tls.enabled

Tipo: Booleano

Necessidade: obrigatório se você especificar syncSource.router.scramAuth.tls

Sinalizador para habilitar a autenticação TLS. Defina como true para habilitar a autenticação TLS.

syncSource.router.scramAuth.tls.caFile

Tipo: string

Necessidade: opcional

Arquivo da Autoridade de Certificação (CA) que contém certificados confiáveis para verificar o certificado apresentado por mongos. O arquivo deve conter uma coleção de certificados X.509 no formato PEM.

syncSource.router.scramAuth.tls.tlsCertificateKeyFile

Tipo: string

Necessidade: opcional.

Caminho para o arquivo PEM que contém o certificado x.509 e a chave privada para autenticar mongot com mongos.

syncSource.router.scramAuth.tls.tlsCertificateKeyFilePasswordFile

Tipo: string

Caminho para o arquivo que contém a senha para descriptografar o arquivo de chave de certificado especificado em syncSource.router.scramAuth.tls.tlsCertificateKeyFile.

Configurações de preferência de leitura de replicação

syncSource.replicationReader

Tipo: objeto

Controla a preferência de leitura que mongot usa ao ler do conjunto de réplicas para replicação.

Para filtrar as leituras por tags de nó do conjunto de réplicas, especifique syncSource.replicationReader.tagSets.

syncSource.replicationReader.readPreference

Tipo: string

Padrão: secondaryPreferred

A preferência de leitura mongot é usada para operações de replicação. Você pode especificar os seguintes valores:

• primary

• primaryPreferred

• secondary

• secondaryPreferred

• nearest

Observação

Comandos de gerenciamento de índice sempre usam primary preferência de leitura, independentemente dessa configuração.

syncSource.replicationReader.tagSets

Type: Array

Array de conjuntos de tags que filtram quais membros do conjunto de réplicas recebem leituras de replicação. Você não pode configurar essa configuração se syncSource.replicationReader.readPreference for primary.

Cada elemento de tagSets é um array de { name: <name>, value: <value> } objetos que correspondem às tags de membro do conjunto de réplicas. mongot avalia conjuntos de tags em ordem e usa o primeiro conjunto de tags que corresponde a um nó. Por exemplo:

tagSets:
  - [ { name: hostname, value: mongod1 },
      { name: region, value: us-east-1 } ]

Configurações do servidor gRPC

A configuração server.grpc.address é necessária. Todas as outras configurações server.grpc são opcionais.

server.grpc.tls

Tipo: objeto

TLS configuration options for the gRPC listen server.

server.grpc.tls.mode

Tipo: string

TLS mode for the gRPC server. Must be one of the following values:

• "TLS"

• "mTLS"

• "disabled"

Obrigatório ao configurar server.grpc.tls.

server.grpc.tls.certificateKeyFile

Tipo: string

Arquivo PEM que contém um certificado X.509 válido para mongot usando uma chave privada PKCS#8. mongod valida este certificado usando um arquivo de Autoridade de Certificação (CA) que você especifica com a opção --tlsCAFile. Obrigatório quando server.grpc.tls.mode for "TLS" ou "mTLS".

server.grpc.tls.certificateKeyFilePasswordFile

Tipo: string

Caminho para o arquivo que contém a senha para descriptografar o arquivo de chave de certificado especificado em server.grpc.tls.certificateKeyFile.

server.grpc.tls.caFile

Tipo: string

Arquivo da Autoridade de Certificação (CA) que contém certificados confiáveis para verificar o certificado apresentado por mongod. O arquivo deve conter uma coleção de certificados X.509 no formato PEM. Obrigatório quando server.grpc.tls.mode for "mTLS".

server.name

Tipo: string

Nome fornecido pelo usuário para identificar uma instância mongot. O MongoDB usa server.name para identificar mongot hosts em interfaces programáticas, como $listSearchIndexes. Se você omitir esta configuração, o MongoDB gerará um nome automaticamente.

Configurações de métricas

metrics

Tipo: objeto

Configurações para o ouvinte de métricas endpoint mongot do Prometeus.

metrics.enabled

Tipo: Booleano

Padrão: false

Sinalizador que ativa o ponto de extremidade de métricas do Prometheus. Se você definir isso como false, o MongoDB analisará e validará a sintaxe das outras configurações no bloco metrics, mas não iniciará o ouvinte de métricas do Prometheus. Obrigatório ao configurar metrics.

metrics.address

Tipo: string

Padrão: localhost:9946

Endereço de soquete (IPv4 ou IPv6) no qual o Prometheus ponto de extremidade /metrics está exposto. Use o seguinte formato:

<host>:<port>

Configurações de verificação de integridade

healthCheck

Tipo: objeto

Configurações para o ponto de extremidade de verificação de integridade do mongot. Não é possível desabilitar o ponto de extremidade de verificação de integridade, mas você pode configurar seu endereço de escuta.

healthCheck.address

Tipo: string

Padrão: localhost:8080

Endereço no qual o ouvinte da verificação de integridade escuta. Use o seguinte formato:

<host>:<port>

Configurações de registro

logging

Tipo: objeto

Opções de registro.

logging.verbosity

Tipo: string

Padrão: INFO

Detalhamento do log. O valor deve ser um nível de log Logback válido.

logging.logPath

Tipo: string

Caminho para um arquivo onde mongot grava logs usando um anexador de arquivo Logback. Se você omitir essa configuração, o MongoDB não criará nem configurará um anexador de arquivo de log.

Configurações de embedding automatizado

Configurações avançadas de indexação

advancedConfigs.indexing.lucene.refresh.intervalMs

Tipo: inteiro

Necessidade: opcional

Padrão: 1000

Intervalo, em milissegundos, que o mongot aguarda antes de atualizar um índice para tornar as alterações indexadas recentemente visíveis para queries. Valores mais baixos reduzem o atraso entre a gravação de um documento e a possibilidade de query, à custa de um trabalho de atualização mais frequente. Deve ser um número inteiro positivo.

advancedConfigs.indexing.lucene.mergePolicy.tiered.vectorMergePolicy.mergeBudgetMb

Tipo: inteiro

Necessidade: opcional

Padrão: 10% da memória total do hospedar

Orçamento de memória, em megabytes, disponível para mesclagens em segundo plano de segmentos de índice de vetor. Um orçamento maior permite que mais segmentos sejam mesclados de uma só vez, o que pode melhorar o desempenho da query, mas usa mais memória durante as mesclagens. Deve ser um número inteiro positivo.

advancedConfigs.indexing.lucene.mergeScheduler.concurrent.maxThreadCount

Tipo: inteiro

Necessidade: opcional

Padrão: O número de núcleos de CPU disponíveis para o host

Número máximo de threads que podem executar mesclagens de segmentos de índice simultaneamente. Valores mais altos permitem que mais mesclagens sejam executadas em paralelo. Deve ser um número inteiro positivo.

advancedConfigs.indexing.lucene.fieldLimit

Tipo: inteiro

Necessidade: opcional

Default: No limit

Número máximo de campos indexados permitidos em um índice. Use essa configuração para proteger contra o crescimento ilimitado de campos em índices. Deve ser pelo menos 3.

Configurações de consulta avançada

advancedConfigs.querying.lucene.maxClauseLimit

Tipo: inteiro

Necessidade: opcional

Padrão: 1024

Número máximo de cláusulas que uma única query pode expandir. mongot rejeita query que se expandem além desse limite. Aumentar esse limite permite query maiores, mas aumenta o custo de memória e CPU. Deve ser um número inteiro positivo.

advancedConfigs.querying.lucene.vectorFloorSegmentMB

Tipo: double

Necessidade: opcional

Padrão: 64.0

Tamanho do segmento do piso, em megabytes, usado pela política de mesclagem para índices de pesquisa vetorial do MongoDB. mongot mescla segmentos menores que advancedConfigs.querying.lucene.vectorFloorSegmentMB de forma mais agressiva para reduzir o número total de segmentos e melhorar o desempenho da query. O valor deve ser um número positivo.

Configurações avançadas de replicação

advancedConfigs.replication.mongodb.numConcurrentInitialSyncs

Tipo: inteiro

Necessidade: opcional

Padrão: o menor número de núcleos de CPU do host e 2

Número máximo de índices que podem executar sua sincronização inicial ao mesmo tempo. A limitação da simultaneidade reduz a carga colocada no nó mongod de origem enquanto muitas construção de índices simultaneamente. Deve ser um número inteiro positivo.

advancedConfigs.replication.mongodb.numConcurrentChangeStreams

Tipo: inteiro

Necessidade: opcional

Padrão: 2 vezes a contagem de núcleos de CPU do host

Número máximo de fluxos de alteração de estado estável que podem ter solicitações pendentes para o nó mongod de origem a qualquer momento. Essa configuração controla quantos índices podem extrair atualizações simultaneamente após a conclusão da sincronização inicial. Deve ser um número inteiro positivo.

advancedConfigs.replication.mongodb.numIndexingThreads

Tipo: inteiro

Necessidade: opcional

Padrão: Metade da contagem de núcleos de CPU do host, com um mínimo de 1

Número de threads usados para gravar documentos replicados e alterações em índices. Valores mais altos podem melhorar a taxa de transferência de indexação, mas podem aumentar o uso da CPU e da memória. O valor deve ser um número inteiro positivo.

advancedConfigs.replication.mongodb.numConcurrentSynonymSyncs

Tipo: inteiro

Necessidade: opcional

Padrão: 2

Número máximo de coleções de origem de sinônimos que podem ter sincronização simultânea. Deve ser um número inteiro positivo.

advancedConfigs.replication.mongodb.pauseAllInitialSyncs

Tipo: Booleano

Necessidade: opcional

Padrão: false

Flag that pauses all new initial-sync operations when set to true. Use this setting to prevent additional index builds from increasing disk or resource usage during recovery or maintenance.

This setting applies across the deployment and does not provide per-host control. To apply a change to this setting, perform a rolling restart of your mongot instances.

advancedConfigs.replication.mongodb.pauseInitialSyncOnIndexIds

Type: Array of Strings

Necessidade: opcional

Padrão: nenhum

Index IDs for which mongot pauses initial sync. Use this setting to defer selected index builds while allowing other indexes to continue synchronizing.

Each value must identify a search index. This setting applies across the deployment rather than to an individual host. To apply a change to this setting, perform a rolling restart of your mongot instances.

advancedConfigs.replication.mongodb.changeStreamMaxTimeMs

Tipo: inteiro

Necessidade: opcional

Padrão: 500

Maximum time, in milliseconds, that mongot allows an individual change-stream request to run before it times out.

Lower values can cause mongot to retry or resume change streams more frequently. Higher values can reduce request churn but may delay detection of stalled operations. Must be a positive integer.

advancedConfigs.replication.mongodb.changeStreamCursorMaxTimeSec

Tipo: inteiro

Necessidade: opcional

Padrão: 900

Maximum lifetime, in seconds, of a replication change-stream cursor.

Adjust this value only when tuning change-stream resource usage or cursor stability. Higher values can reduce cursor recreation. Lower values can detect long-lived or stalled cursors sooner. Must be a positive integer.

advancedConfigs.replication.mongodb.numChangeStreamDecodingThreads

Tipo: inteiro

Necessidade: opcional

Padrão: 4

Number of threads mongot uses to decode replication change-stream events. Higher values can improve change-stream processing throughput but increase CPU usage. Must be a positive integer.

advancedConfigs.replication.initialSync.bufferless.enableNaturalOrderScan

Tipo: Booleano

Necessidade: opcional

Padrão: false

Flag that enables natural-order scans for bufferless initial sync when set to true.

Natural-order scans change how mongot reads documents during initial sync. Evaluate the effect on initial-sync performance and source-node load before you enable this setting in production.

Advanced Disk Monitor Settings

The disk-monitor settings use a fraction of disk capacity. For example, 0.90 represents 90% disk usage. Configure the resume thresholds below their corresponding pause thresholds to prevent repeated pause and resume cycles.

advancedConfigs.diskMonitor.pauseReplicationThreshold

Tipo: double

Necessidade: opcional

Padrão: 0.90

Disk-utilization threshold at which mongot pauses replication. Pausing replication prevents additional replicated index data from increasing disk usage while the host is under disk pressure.

advancedConfigs.diskMonitor.resumeReplicationThreshold

Tipo: double

Necessidade: opcional

Padrão: 0.85

Disk-utilization threshold below which mongot resumes replication after disk pressure causes replication to pause. Set this value lower than advancedConfigs.diskMonitor.pauseReplicationThreshold.

advancedConfigs.diskMonitor.crashThreshold

Tipo: double

Necessidade: opcional

Padrão: 0.95

Critical disk-utilization threshold at which mongot crashes to protect the host from disk exhaustion. Set this threshold as a last-resort safety limit above the pause thresholds.

advancedConfigs.diskMonitor.pauseInitialSyncThreshold

Tipo: double

Necessidade: opcional

Padrão: 0.85

Disk-utilization threshold at which mongot pauses initial-sync operations. Use this setting to prevent new index builds from consuming additional disk space when the host is already under disk pressure.

advancedConfigs.diskMonitor.resumeInitialSyncThreshold

Tipo: double

Necessidade: opcional

Padrão: 0.80

Disk-utilization threshold below which mongot resumes initial-sync operations after disk pressure causes them to pause. Set this value lower than advancedConfigs.diskMonitor.pauseInitialSyncThreshold.

Advanced Cursor Settings

advancedConfigs.cursor.idleCursorHandlingRateMs

Tipo: inteiro

Necessidade: opcional

Padrão: 1800000

Interval, in milliseconds, at which mongot checks for idle cursors. Lower values allow mongot to identify idle cursors sooner but increase cursor-management work. Must be a positive integer.

advancedConfigs.cursor.cursorIdleTimeMs

Tipo: inteiro

Necessidade: opcional

Padrão: 3600000

Duration, in milliseconds, that a cursor can remain idle before mongot treats it as idle. Lower values allow mongot to reclaim cursor resources sooner but may affect clients that intentionally wait between requests. Must be a positive integer.

Configurações avançadas do FTDC

advancedConfigs.ftdc.enabled

Tipo: Booleano

Necessidade: opcional

Padrão: true

Sinalizador que permite a captura de dados de diagnóstico em tempo integral (FTDC). A coleta de dados de diagnóstico FTDC está habilitada por padrão. Quando false, mongot não cria nenhum relatório FTDC na inicialização, portanto, não captura dados de diagnóstico.

advancedConfigs.ftdc.directorySizeMb

Tipo: inteiro

Necessidade: opcional

Padrão: 100

Tamanho total máximo, em megabytes, do diretório de arquivo FTDC. Deve ser pelo menos 10 e maior que advancedConfigs.ftdc.fileSizeMb.

advancedConfigs.ftdc.fileSizeMb

Tipo: inteiro

Necessidade: opcional

Padrão: 10

Tamanho máximo, em megabytes, de um arquivo de arquivo FTDC individual. Deve ser pelo menos 1 e menos de advancedConfigs.ftdc.directorySizeMb.

advancedConfigs.ftdc.collectionPeriodMillis

Tipo: inteiro

Necessidade: opcional

Padrão: 1000

Intervalo de amostragem, em milissegundos, que controla a frequência com que mongot coleta métricas no FTDC. Deve ser pelo menos 100.