Configurações do MongoDB Agent

Configurações de registro

logFile

Tipo: string

Especifica o caminho para o qual o Ops Manager deve escrever o registro do MongoDB Agent.

O caminho padrão depende da sua plataforma. O MongoDB Agent usa o nome de arquivo padrão automation-agent.log se a sistema usa ou não Automação.

Importante

A rotação automática dos registros do MongoDB Agent ocorre somente quando é feita uma atualização no arquivo de log. Para rotacionar manualmente os registros do MongoDB Agent, consulte Rotacionar manualmente os registros do MongoDB Agent para obter mais informações.

Plataforma	Caminho padrão
Linux	/var/log/mongodb-mms-automation/automation-agent.log
Windows	C:\MMSAutomation\log\mongodb-mms-automation\automation-agent.log

logFile=/path/to/mongodb-mms-automation/automation-agent.log

logLevel

Tipo: string

Especifica o nível de granularidade de registro.

Aviso

As Configurações do Projeto Admin para Monitoring Agent Log Level e Automation Agent Log Level substituem este parâmetro.

Escolha entre os seguintes níveis de gravidade, da maior para a menor quantidade de informações:

• DEBUG

• INFO

• WARN

• ERROR

• FATAL

Por padrão, logLevel é INFO.

logLevel=ROUTINE

Cada nível inclui os itens de log incluídos nos níveis seguintes.

Exemplo

• Se você escolher DEBUG, o MongoDB Agent registrará todas as mensagens, incluindo INFO, WARN, ERROR e FATAL.

• Se você escolher FATAL, o MongoDB Agent somente registrará FATAL mensagens.

maxLogFiles

Tipo: inteiro

Especifica o número máximo de arquivos de registro rotacionados a serem mantidos.

Por padrão, o valor de maxLogFiles é configurado para 10. Você pode alterar o valor para manter um número diferente de arquivos de log rotacionados.

maxLogFiles=15

maxLogFileDurationHrs

Tipo: flutuação

Especifica o número de horas após as quais osregistros são girados.

Observação

Girar manualmente osregistros do MongoDB Agent

Em sistemas baseados em UNIX e Linux, você pode girar manualmente os registros do MongoDB Agent. Emitir um comando kill com o sinal SIGUSR1 para o processo do agente:

kill -SIGUSR1 <AgentID>

Em sistemas baseados em Windows, você pode reiniciar manualmente o MongoDB Agent com um serviço reiniciado:

1. Clique no menu Start.

2. Pesquise por services.

3. Encontre o MongoDB Agent.

4. Clique com o botão direito do mouse no agente e clique em Restart.

Isso gira os registros do MongoDB Agent.

maxLogFileSize

Tipo: inteiro

Especifica o tamanho máximo, em bytes, de um arquivo de registro antes de rotacionar os registros. Se não especificado, o MongoDB Agent não gira registros com base no tamanho do arquivo.

maxLogFileSize=536870912

maxUncompressedLogFiles

Tipo: inteiro

Especifica o número máximo de arquivos de log rotacionados para manter a descompactação. MongoDB Agent comprime automaticamente quaisquer arquivos de log retidos adicionais até o valor maxLogFiles .

Por padrão, o valor de maxUncompressedLogFiles é configurado para 2. Você pode alterar o valor para comprimir um número diferente de arquivos de log rotacionados.

maxUncompressedLogFiles=10

Configurações de conexão

dialTimeoutSeconds

Tipo: inteiro

Especifica o número de segundos de espera antes que uma conexão expire. Por padrão, as conexões atingem o tempo limite após 40 segundos. No entanto, o MongoDB Agent pode frequentemente atingir o tempo limite das conexões por um ou mais dos seguintes motivos:

• Alta latência de rede

• Alta carga do servidor

• Chaves TLS grandes

• Falta de acelerador TLS

• Velocidade insuficiente da CPU

O MongoDB recomenda aumentar gradualmente o valor da configuração dialTimeoutSeconds do MongoDB Agent para evitar tempos limite de conexão prematuros frequentes.

dialTimeoutSeconds=40

Observação

Aumentar esse valor também aumenta o tempo necessário para implantar alterações de configuração no MongoDB Agent. Experimente com pequenos aumentos incrementais até determinar o valor ideal para sua sistema.

serverSelectionTimeoutSeconds

Tipo: inteiro

Especifica o número de segundos que o MongoDB Agent espera antes de parar de tentar estabelecer uma conexão com um processo MongoDB. Por padrão, o MongoDB Agent abandona as tentativas de estabelecer uma conexão após 10 segundos.

serverSelectionTimeoutSeconds=10

Configurações de proxy HTTP

httpProxy

Tipo: string

Especifica a URL de um servidor proxy HTTP que o MongoDB Agent pode usar.

httpProxy=http://proxy.example.com:8080

Configurações de backup de configuração

mmsConfigBackup

Tipo: string

Especifica o caminho para o arquivo de backup de configuração do Ops Manager. Este arquivo descreve o estado desejado da sistema.

Se você não especificar a configuração do mmsConfigBackup , o MongoDB Agent gravará o arquivo mongodb-mms-automation-cluster-backup.json em uma pasta temporária no sistema operacional.

Se você configurar enableLocalConfigurationServer para true, o MongoDB Agent não gravará o arquivo mmsConfigBackup .

mmsConfigBackup=/path/to/mms-cluster-config-backup.json

Observação

Quando o Ops Manager é instalado, ele armazena o arquivo de backup de configuração em um dos seguintes locais, dependendo da sua plataforma:

Plataforma	Caminho do arquivo de backup de configuração
Linux	/var/lib/mongodb-mms-automation/
Windows	%SystemDrive%\MMSAutomation

Configurações de TLS do Ops Manager

Especifique as configurações que o MongoDB Agent usa ao se comunicar com o Ops Manager usando TLS.

httpsCAFile

Tipo: string

Especifica o caminho absoluto que contém os certificados de Autoridade de Certificação confiáveis no formato PEM . Este certificado verifica se o MongoDB Agent está se comunicando com a instância designada do Ops Manager.

httpsCAFile=/path/to/ca.pem

Observação

Adicione a autoridade de certificação para o certificado downloads.mongodb.com a este arquivo .pem se você:

1. Precisa que seus MongoDB Agents baixem seus instaladores MongoDB da Internet,

2. Use TLS para criptografar conexões, e

3. Assinou os seus certificados com uma Autoridade de Certificação privada. (Você definiu a opção httpsCAFile.)

Para saber como baixar certificados TLS de outro site, consulte a entrada OpenSSL Cookbook.

Importante

Quando o Ops Manager começa, ele armazena em cache a autoridade de certificação fornecida. Se você alterar seu certificado de autoridade de certificação, reinicie o Ops Manager.

sslRequireValidMMSServerCertificates

Tipo: booleano

Importante

Obsoleto. Em vez disso, use tlsRequireValidMMSServerCertificates .

tlsRequireValidMMSServerCertificates

Tipo: booleano

Especifica se o MongoDB Agent deve validar os certificados TLS apresentados pelo Ops Manager.

Aviso

Definir essa opção como false desativa a verificação de certificados e torna as conexões entre o MongoDB Agent e o Ops Manager suscetíveis a ataques do tipo man-in-the-middle. Definir essa opção como false só é recomendado para fins de teste.

tlsRequireValidMMSServerCertificates=true

sslMMSServerClientCertificate

Tipo: string

Importante

Obsoleto. Em vez disso, use tlsMMSServerClientCertificate .

tlsMMSServerClientCertificate

Tipo: string

Especifica o caminho para o arquivo contendo a chave privada do cliente, certificado e certificados intermediários opcionais no formato PEM . The MongoDB Agent usa o certificado do cliente ao se conectar ao Ops Manager via TLS se o Ops Manager exigir certificados de cliente, como quando o Ops Manager é executado com Client Certificate Mode definido como Required for Agents Only ou Required for All Requests.

Dica

Veja também:

Para saber como definir Client Certificate Mode, consulte Definições de configuração do Ops Manager.

A chave privada criptografada para o .pem arquivo de certificado deve estar em PKCS #1 formato. O MongoDB Agent não é compatível com o PKCS #8 formato.

tlsMMSServerClientCertificate=/path/to/client.pem

sslMMSServerClientCertificatePassword

Tipo: string

Importante

Obsoleto. Em vez disso, use tlsMMSServerClientCertificatePassword .

tlsMMSServerClientCertificatePassword

Tipo: string

Especifica a senha necessária para descriptografar a chave privada no arquivo tlsMMSServerClientCertificate . Essa configuração é necessária quando o arquivo de certificado do cliente PEM é criptografado.

A chave privada criptografada para o .pem arquivo de certificado deve estar em PKCS #1 formato. O MongoDB Agent não é compatível com o PKCS #8 formato.

Observação

Utilize a opção tlsMMSServerClientCertificatePasswordExec ao invés de tlsMMSServerClientCertificatePassword para especificar a senha de um comando de shell.

tlsMMSServerClientCertificatePassword=password

sslServerClientCertificate

Tipo: string

Especifica o caminho para o arquivo contendo a chave privada do cliente, certificado e certificados intermediários opcionais no formato PEM . The MongoDB Agent usa o certificado do cliente ao se conectar ao Ops Manager via TLS se o Ops Manager exigir certificados de cliente, como quando o Ops Manager é executado com Client Certificate Mode definido como Required for Agents Only ou Required for All Requests.

Dica

Veja também:

• Consulte Client Certificate Mode em Definições de configuração do Ops Manager para saber como especificar essa configuração no aplicativo Ops Manager.

• Consulte Configurar o MongoDB Agent para usar TLS para habilitar conexões TLS para o MongoDB Agent.

sslServerClientCertificate=/path/to/client.pem

sslServerClientCertificatePassword

Especifica a senha necessária para descriptografar a chave privada no arquivo sslServerClientCertificate. Essa configuração é necessária quando o arquivo PEM do certificado do cliente é criptografado.

sslServerClientCertificatePassword=password

sslRequireValidMMSBackupServerCertificate

Especifica se o MongoDB Agent deve validar certificados TLS do Ops Manager.

Aviso

Definir essa opção como false desativa a verificação de certificados e torna as conexões entre o MongoDB Agent e o Ops Manager suscetíveis a ataques do tipo man-in-the-middle. Definir essa opção como false só é recomendado para fins de teste.

sslRequireValidMMSBackupServerCertificate=true

Configurações de migração push live

agentFeatureCloudMigrationEnabled

Tipo: booleano

Opcional.

Especifica se o MongoDB Agent no host de migração está configurado para executar o processo de Migração em Tempo Real de uma sistema do Gerenciador de Operações de origem para um cluster de destino no Atlas.

Essa opção tem como padrão false, o que impede o uso do MongoDB Agent nesse host para a migração ao vivo para o Atlas.

Para habilitar o processo de migração ao vivo, provisione um host de migração e defina agentFeatureCloudMigrationEnabled como true.

cloudMigrationOplogPath

Tipo: string

Opcional.

Caminho para os arquivos oplog . Se especificada, essa configuração armazena em buffer a janela inicial do oplog de sincronização no disco. Provisione armazenamento suficiente no diretório especificado para o armazenamento em buffer do oplog .

Definições de configuração de origem externa

enableLocalConfigurationServer

Tipo: booleano

Especifica se o MongoDB Agent armazena os arquivos de configuração do processo MongoDB em disco ou em cache na memória.

Esta opção padroniza para false, que armazena os arquivos de configuração no disco. Definir esta opção para true armazena em cache a configuração na memória.

Se você definir essa opção como true, o MongoDB Agent não gravará o arquivo mmsConfigBackup .

Não defina essa opção como true se seus bancos de dados do MongoDB estiverem executando o FCV 4.2 ou anterior.

Aviso

Configurar esta opção para true afeta a disponibilidade da sua sistema.

Quando esse recurso está habilitado, o MongoDB Agent não armazena a configuração do processo MongoDB no disco. Se o servidor de aplicativos do Ops Manager não estiver disponível e o MongoDB Agent tentar reiniciar, o MongoDB Agent interromperá a execução porque não terá as informações de configuração necessárias. Se um processo MongoDB falhar enquanto o MongoDB Agent não estiver em execução, o MongoDB Agent não poderá reiniciar o processo.

enableLocalConfigurationServer=false

Dica

Veja também:

Configurar como o MongoDB Agent gerencia arquivos de configuração e senhas

keepUnusedMongodbVersions

Tipo: booleano

Sinalizador que indica se o MongoDB Agent retém binários de versão MongoDB não utilizados que ele baixa. Por padrão, keepUnusedMongodbVersions é falso.

keepUnusedMongodbVersions=false

localConfigurationServerPort

Tipo: inteiro

Especifica a porta para atender à configuração do processo MongoDB ao utilizar o servidor de configuração local. Para definir esta opção, enableLocalConfigurationServer deve ser true.

Se não especificado, o MongoDB Agent escolhe uma porta disponível automaticamente.

localConfigurationServerPort=20128

mmsApiKeyExec

Tipo: string

Especifica um comando shell para chamar a chave API do agente do Ops Manager do seu projeto do Ops Manager.

mmsApiKeyExec=echo $myKey

sslMMSServerClientCertificatePasswordExec

Tipo: string

Importante

Obsoleto. Em vez disso, use tlsMMSServerClientCertificatePasswordExec .

tlsMMSServerClientCertificatePasswordExec

Tipo: string

Especifica um comando shell para chamar a senha necessária para descriptografar a chave privada no arquivo MMSServerClientCertificate . Essa configuração ou tlsMMSServerClientCertificatePassword são necessárias quando o arquivo PEM do certificado do cliente é criptografado.

tlsMMSServerClientCertificatePasswordExec=python /path/to/PEMPassword.py

Configurações do MongoDB Kerberos

Especifique essas configurações se a automação for autenticada para hosts usando Kerberos. Para configurar Kerberos, consulte Configurar o MongoDB Agent para Kerberos.

krb5ConfigLocation

Tipo: string

Especifica um caminho absoluto para um local não padrão do sistema para o arquivo de configuração Kerberos.

krb5ConfigLocation=/path/to/krb_custom.conf

Observação

MongoDB Ops Manager cria um Cache de Credenciais Kerberos (Ticket) para cada agente automaticamente quando Kerberos está habilitado. Se você deseja substituir a localização do Cache de Credenciais Kerberos, você deve definir a KRB5CCNAME variável de ambiente para o nome e o caminho de arquivo desejados antes de executar o agente.

backupAgentKrb5CCName

Digite string

Especifica a variável de ambiente do KRB5CC que o MongoDB Agent define para o processo de backup. Usado somente para autenticar o Backup para sua sistema MongoDB quando o MongoDB Agent iniciar a função Backup.

backupAgentKrb5CCName=/path/to/credentials_cache_file

monitoringAgentKrb5CCName

Digite string

Especifica a variável de ambiente do KRB5CC que o MongoDB Agent define para a função Monitoramento. Usado apenas para autenticar o monitoramento em sua sistema MongoDB quando o MongoDB Agent iniciar a função de monitoramento.

monitoringAgentKrb5CCName=/path/to/credentials_cache_file

Configurações de registro

1. Na navegação, clique em Deployment.

2. Clique na aba Agents.

3. Clique em Downloads & Settings.

4. Na seção Agent Log Settings, clique em ao lado de Monitoring Log Settings.

5. Edite as configurações do registro de monitoramento:

   Contexto	Valor padrão	Valor sugerido do console
   Caminho do arquivo de registro do Linux	/var/log/mongodb-mms-automation/monitoring-agent.log
   Caminho do arquivo de registro do Windows	%SystemDrive%\MMSAutomation\log\mongodb-mms-automation\monitoring-agent.log
   Rotacionar registros	sim
   Limite de tamanho (MB)	1000
   Limite de tempo (horas)	24
   Máximo de arquivos descompactados		5
   Porcentagem Máxima de Disco		2
   Número total de arquivos de registro	0

6. Clique em Save.

Configurações personalizadas

1. Na navegação, clique em Deployment.

2. Clique na aba Agents.

3. Clique em Downloads & Settings.

4. Na seção Custom Configuration, ao lado de Edit Custom Configurations, clique em .

5. Insira a definição e o valor da configuração de monitoramento.

6. Clique em Save and Close.

Você pode definir as seguintes configurações de monitoramento:

Configurações de registro

1. Na navegação, clique em Deployment.

2. Clique na aba Agents.

3. Clique em Downloads & Settings.

4. Na seção Agent Log Settings, clique em ao lado de Backup Log Settings.

5. Edite as configurações do log de backup:

   Contexto	Valor padrão	Valor sugerido do console
   Caminho do arquivo de registro do Linux	/var/log/mongodb-mms-automation/backup-agent.log
   Caminho do arquivo de registro do Windows	%SystemDrive%\MMSAutomation\log\mongodb-mms-automation\backup-agent.log
   Rotacionar registros	sim
   Limite de tamanho (MB)	1000
   Limite de tempo (horas)	24
   Máximo de arquivos descompactados		5
   Porcentagem Máxima de Disco		2
   Número total de arquivos de registro	0

6. Clique em Save.

Configurações personalizadas

1. Na navegação, clique em Deployment.

2. Clique na aba Agents.

3. Clique em Downloads & Settings.

4. Na seção Custom Configuration, ao lado de Edit Custom Configurations, clique em .

5. Insira uma configuração e um valor de backup.

6. Clique em Save and Close.

Você pode definir as seguintes configurações de backup: