Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs

Configurações do MongoDB Agent

Esta página descreve possíveis configurações para o MongoDB Agent. Esses valores são definidos após a primeira inicialização do Ops Manager e não por meio da edição manual desses arquivos.

Para saber mais sobre as configurações do Ops Manager e seus valores, consulte Definições de configuração do Ops Manager.

Aviso

Se você editar as configurações de autenticação ou TLS por meio de Settings ou Deployments na interface do Ops Manager, essas alterações substituirão quaisquer alterações manuais nesse arquivo de configuração.

A localização do arquivo de configuração do MongoDB Agent é C:\MMSData\Automation\automation-agent.config.

Observação

O arquivo de configuração do MongoDB Agent é chamado automation-agent.config como uma forma de facilitar as atualizações para aqueles que usam agentes legados.

A localização do arquivo de configuração do MongoDB Agent é /etc/mongodb-mms/automation-agent.config.

Observação

O arquivo de configuração do MongoDB Agent é chamado automation-agent.config como uma forma de facilitar as atualizações para aqueles que usam agentes legados.

A localização do arquivo de configuração do MongoDB Agent é /etc/mongodb-mms/automation-agent.config.

Observação

O arquivo de configuração do MongoDB Agent é chamado automation-agent.config como uma forma de facilitar as atualizações para aqueles que usam agentes legados.

A localização do arquivo de configuração do MongoDB Agent é /path/to/install/local.config.

Você pode definir configurações adicionais de monitoramento e Configurações de backup por meio do console do Ops Manager.

mmsGroupId

Tipo: string

Especifica o ID do seu projeto do Ops Manager. Encontre o ID do projeto na página Project Settings (Settings > Project Settings).

O Ops Manager configura essa configuração quando você instala o MongoDB Agent. Se você precisar configurar o Monitoramento separadamente, inclua essa configuração para vincular o servidor a um projeto.

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
mmsApiKey

Tipo: string

Especifica a chave de API do MongoDB Agent do seu projeto do Ops Manager.

Você pode usar uma chave de API do agente que já tenha gerado para o projeto. Caso contrário, você pode gerar uma nova chave de API do agente. Um projeto pode ter mais de uma chave de API do agente, e qualquer um dos agentes do projeto pode usar qualquer uma das chaves. Para obter mais informações, consulte Gerenciar chaves de API do agente.

Para gerar uma chave de API do agente, acesse a guia Agent API Keys . Para navegar até a guia, na visualização Deployment, clique na guia Agents e depois na guia Agent API Keys .

Importante

Quando você gera uma chave de API do agente, o Ops Manager a exibe somente uma vez. Você deve copiar esta chave. Trate isso como uma senha; guarde-o em um local seguro. O Ops Manager nunca mais exibe a chave completa.

O Ops Manager configura essa configuração quando você instala o MongoDB Agent. Se você precisar configurar o Monitoramento separadamente, inclua essa configuração.

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem
mmsBaseUrl

Tipo: string

Especifica a URL do aplicativo Ops Manager.

mmsBaseUrl=http://example.com:8080
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 logs 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

PorlogLevel padrão,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 está definido como 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.

Por padrão, o valor de é configurado maxLogFileSize para 268435456 bytes. Você pode alterar o valor para atribuir um tamanho máximo diferente para um arquivo de log.

maxLogFileSize=536870912
maxUncompressedLogFiles

Tipo: inteiro

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

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

maxUncompressedLogFiles=10
dialTimeoutSeconds

Tipo: inteiro

Especifica o número de segundos de espera antes que uma conexão expire. Para aumentar o tempo limite de conexão do MongoDB Agent, aumente o valor de dialTimeoutSeconds. 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 do MongoDB Agent para evitar tempos limite de conexão prematuros dialTimeoutSeconds 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
httpProxy

Tipo: string

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

httpProxy=http://proxy.example.com:8080
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

Especifique o uso das configurações que o MongoDB Agent usa ao se comunicar com o Ops Manager usando o 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,tlsRequireValidMMSServerCertificates use.

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,tlsMMSServerClientCertificate use.

tlsMMSServerClientCertificate

Tipo: string

Especifica o caminho para o arquivo contendo a chave privada do cliente, o 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.

A chave privada criptografada para o .pem arquivo de certificado do deve estar no formato PKCS #. O MongoDB Agent não1 é compatível com o formato PKCS8 #.

tlsMMSServerClientCertificate=/path/to/client.pem
sslMMSServerClientCertificatePassword

Tipo: string

Importante

Obsoleto. Em vez disso,tlsMMSServerClientCertificatePassword use.

tlsMMSServerClientCertificatePassword

Tipo: string

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

A chave privada criptografada para o .pem arquivo de certificado do deve estar no formato PKCS #. O MongoDB Agent não1 é compatível com o formato PKCS8 #.

Observação

Use a opção tlsMMSServerClientCertificatePasswordExec tlsMMSServerClientCertificatePassword em vez de 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, o 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

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
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 log de sincronização no disco. Provisione armazenamento suficiente no diretório especificado para o armazenamento em buffer do log.

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 true como, o MongoDB Agent não gravará o mmsConfigBackup arquivo.

Não defina essa opção como true se seus bancos de dados do MongoDB estiverem FCV 4 executando.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
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 true ser.

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 de agente API do Ops Manager do seu projeto do Ops Manager.

mmsApiKeyExec=echo $myKey
sslMMSServerClientCertificatePasswordExec

Tipo: string

Importante

Obsoleto. Em vez disso,tlsMMSServerClientCertificatePasswordExec use.

tlsMMSServerClientCertificatePasswordExec

Tipo: string

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

tlsMMSServerClientCertificatePasswordExec=python /path/to/PEMPassword.py

O MongoDB Agent permite que você desative o Transparent Huge Pages (THP) por processo para evitar a degradação acidental do desempenho. Para desativar o THP, execute as seguintes etapas:

  1. Atualize a versão do MongoDB Agent para 108.0.x.

  2. Modifique o arquivo de configuração de automação para incluir enableAgentManagingTHPSettings=true.

  3. Reinicie o MongoDB Agent e os processos mongod e mongos gerenciados. Agora você pode ativar o THP em todo o sistema.

    Observação

    Isso pode gerar um aviso de inicialização falso positivo.

  4. (Opcional) Atualize para 8.0.

enableAgentManagingTHPSettings

Tipo: booleano

Especifica se o MongoDB Agent gerencia a desativação do Transparent Huge Pages (THP) para os processos do MongoDB . Consulte Desativar hugepages transparentes (THP) para saber mais.

esta opção é padronizada como false.

Quando definido true como, o MongoDB Agent desativa o THP por processo, substituindo quaisquer configurações de THP no nível do sistema operacional. Essa opção afetará somente os mongod processos e implantados em sistemas Linux usando uma versão do MongoDB anterior mongos 8 0a..

enableAgentManagingTHPSettings=false

As seguintes definições de configuração são usadas para autenticação em clusters automatizados.

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

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

Use a interface do Ops Manager para definir as configurações de monitoramento.

  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.

  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:

mmsGroupId

Tipo: string

Especifica o ID do seu projeto do Ops Manager. Encontre o ID do projeto na página Project Settings (Settings > Project Settings).

O Ops Manager configura essa configuração quando você instala o MongoDB Agent. Se você precisar configurar o Monitoramento separadamente, inclua essa configuração para vincular o servidor a um projeto.

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
mmsApiKey

Tipo: string

Especifica a chave de API do MongoDB Agent do seu projeto do Ops Manager.

Você pode usar uma chave de API do agente que já tenha gerado para o projeto. Caso contrário, você pode gerar uma nova chave de API do agente. Um projeto pode ter mais de uma chave de API do agente, e qualquer um dos agentes do projeto pode usar qualquer uma das chaves. Para obter mais informações, consulte Gerenciar chaves de API do agente.

Para gerar uma chave de API do agente, acesse a guia Agent API Keys . Para navegar até a guia, na visualização Deployment, clique na guia Agents e depois na guia Agent API Keys .

Importante

Quando você gera uma chave de API do agente, o Ops Manager a exibe somente uma vez. Você deve copiar esta chave. Trate isso como uma senha; guarde-o em um local seguro. O Ops Manager nunca mais exibe a chave completa.

O Ops Manager configura essa configuração quando você instala o MongoDB Agent. Se você precisar configurar o Monitoramento separadamente, inclua essa configuração.

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem
mmsBaseUrl

Tipo: string

Especifica a URL do aplicativo Ops Manager.

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

Tipo: string

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

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

Especifique essa configuração para enviar métricas de implantação para um backend OpenTelemetry (OTel) de terceiros, além do Ops Manager. Para saber mais, consulte Enviar métricas para OpenTelemetry (OTel).

otelConfig

Tipo: string (codificado em JSON)

Especifica a configuração de exportação OTel como uma única string codificada em JSON. O objeto JSON tem os seguintes campos:

Campo
Tipo
necessidade
Descrição

enabled

booleano

Opcional

Habilita ou desabilita o caminho de exportação do OTel. O padrão é false.

metricsExportIntervalSec

inteiro

Opcional

Cadência de exportação em segundos. O padrão é 30.

backends

array

Obrigatório quando enabled é true

Array de backends de métricas OTLP. Exatamente um backend é suportado nesta versão. Configurar mais de um backend resulta em um erro grave.

backends[].endpoint

string

Obrigatório quando enabled é true

URL do ponto de extremidade OTLP/HTTP. Deve incluir um esquema http:// ou https://. O esquema determina se o MongoDB Agent usa TLS.

backends[].headers

string

Opcional

Cabeçalhos de solicitação key=value separados por vírgula, como tokens de autenticação exigidos pelo backend. Os valores podem ser criptografados em repouso. Para saber mais, consulte Criptografia de configuração de automação.

backends[].compression

string

Opcional

Compactação de carga útil para solicitações de exportação: none ou gzip. O padrão é none.

backends[].caCertPath

string

Opcional

Caminho para um arquivo PEM de certificado de Autoridade de Certificação usado para verificar o certificado TLS do endpoint, como um certificado de Coletor autoassinado.

backends[].clientCertPath

string

Opcional

Caminho para um arquivo PEM de certificado do cliente para TLS mútuo (mTLS). Deve ser definido junto com backends[].clientKeyPath.

backends[].clientKeyPath

string

Opcional

Caminho para o arquivo PEM da chave privada do cliente para TLS mútuo (mTLS). Deve ser definido junto com backends[].clientCertPath.

backends[].clientKeyPassword

string

Opcional

Senha usada para descriptografar o arquivo PEM da chave privada do cliente , se criptografado. Requer que backends[].clientCertPath e backends[].clientKeyPath sejam definidos.

otelConfig={"enabled":true,"metricsExportIntervalSec":30,"backends":[{"endpoint":"https://collector.example.com:4318","headers":"Authorization=Bearer <token>","caCertPath":"/etc/ssl/ca.pem"}]}

Especifique essas configurações se o Monitoramento autenticar para hosts usando Kerberos.

Para configurar Kerberos, consulte Configurar o MongoDB Agent para Kerberos. Os mesmos procedimentos e requisitos se aplicam, use somente um UPN diferente para monitoramento.

Observação

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

krb5Principal

Tipo: string

Especifica o principal Kerberos que o Monitoramento usa.

krb5Principal=monitoring/myhost@EXAMPLE.COM
krb5Keytab

Tipo: string

Especifica o caminho absoluto para o arquivo keytab do Kerberos principal.

krb5Keytab=/path/to/mms-monitoring.keytab
krb5ConfigLocation

Tipo: string

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

krb5ConfigLocation=/path/to/krb_custom.conf
gssapiServiceName

Tipo: string

Especifica o nome do serviço com a gssapiServiceName configuração.

Por padrão, o MongoDB usa mongodb como seu nome de serviço.

Especifique essas configurações quando o Monitoring se conectar a sistemas do MongoDB usando TLS.

Para saber mais, consulte Configurar o MongoDB Agent para usar TLS.

useSslForAllConnections

Tipo: booleano

Especifica se todas as conexões com sistemas do MongoDB devem ou não ser criptografadas usando TLS.

Importante

Definir isso como true substitui qualquer configuração de TLS por host definida na interface do Ops Manager.

sslClientCertificate

Tipo: string

Especifica o caminho absoluto para a chave privada, certificado do cliente e certificados intermediários opcionais no formato PEM. O monitoramento usa o certificado do cliente para se conectar a qualquer implementação configurada do MongoDB que use TLS e exija certificados do cliente . (A implantação é executada com a configuração --tlsCAFile.)

Exemplo

Se você quiser se conectar a uma sistema do MongoDB que usa TLS e validação de certificado usando mongosh:

mongosh --tls --tlsCertificateKeyFile /path/to/client.pem --tlsCAFile /path/to/ca.pem example.net:27017

Você deve definir estas configurações em seu Custom Settings:

sslTrustedServerCertificates=/path/to/ca.pem
sslClientCertificate=/path/to/client.pem
sslClientCertificatePassword

Tipo: string

Especifica a senha necessária para descriptografar a chave privada no arquivo sslClientCertificate. Inclua essa configuração se você criptografou o arquivo PEM do certificado do cliente .

sslClientCertificatePassword=password
sslTrustedServerCertificates

Tipo: string

Especifica o caminho absoluto que contém os certificados de autoridade de certificação confiáveis no formato PEM. Esses certificados verificam o certificado do servidor retornado de qualquer implantação do MongoDB em execução com TLS.

sslTrustedServerCertificates=/path/to/ca.pem
sslRequireValidServerCertificates

Tipo: booleano

Especifica se o Monitoramento deve validar os certificados TLS que os bancos de dados MongoDB apresentam.

sslRequireValidServerCertificates=true

Por padrão, o Ops Manager define sslRequireValidServerCertificates como true. Você precisa de um certificado confiável válido para se conectar às instâncias do MongoDB usando TLS.

Aviso

Alterar essa configuração para false desativa a verificação do certificado e torna as conexões entre as sistemas do Monitoring e do MongoDB suscetíveis a ataques do tipo man-in-the-middle. Altere esta configuração para false apenas para fins de teste.

Especifique o uso das configurações que o monitoramento usa ao se comunicar com o Ops Manager usando o TLS.

httpsCAFile

Tipo: string

Especifica o caminho absoluto que contém os certificados de autoridade de certificação confiáveis no formato PEM. O monitoramento usa esse certificado para verificar se o agente pode se comunicar com a instância do Ops Manager designado.

Por padrão, o Monitoramento usa a raiz confiável Autoridades de Certificado instaladas no host.

Se o agente não conseguir encontrar as Autoridades de Certificado raiz confiáveis, defina essas configurações manualmente.

Se a instância do Ops Manager usar um certificado TLS autoassinado, você deverá especificar um valor httpsCAFile.

httpsCAFile=/path/to/mms-certs.pem
sslRequireValidMMSServerCertificates

Tipo: booleano

Especifica se o monitoramento deve validar certificados TLS do Ops Manager.

Aviso

Alterar essa configuração para false desativa a verificação do certificado e torna as conexões entre o Monitoring e o Ops Manager suscetíveis a ataques intermediários. Altere esta configuração para false apenas para fins de teste.

sslServerClientCertificate

Tipo: string

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

Dica

Para saber como especificar essa configuração no aplicativo Ops Manager, consulte Client Certificate Mode em Definições de configuração do Ops Manager.

sslServerClientCertificate=/path/to/client.pem
sslServerClientCertificatePassword

Especifica a senha necessária para descriptografar a chave privada no arquivo sslServerClientCertificate. Inclua essa configuração se você criptografou o arquivo PEM do certificado do cliente .

sslServerClientCertificatePassword=password

Use a interface do Ops Manager para definir as configurações de backup.

  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.

  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:

mmsGroupId

Tipo: string

Especifica o ID do seu projeto do Ops Manager. Encontre o ID do projeto na página Project Settings (Settings > Project Settings).

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
mmsApiKey

Tipo: string

Especifica a chave de API do MongoDB Agent do seu projeto do Ops Manager.

Você pode usar uma chave de API do agente que já tenha gerado para o projeto. Caso contrário, você pode gerar uma nova chave de API do agente. Um projeto pode ter mais de uma chave de API do agente, e qualquer um dos agentes do projeto pode usar qualquer uma das chaves. Para obter mais informações, consulte Gerenciar chaves de API do agente.

Para gerar uma chave de API do agente, acesse a guia Agent API Keys . Para navegar até a guia, na visualização Deployment, clique na guia Agents e depois na guia Agent API Keys .

Importante

Quando você gera uma chave de API do agente, o Ops Manager a exibe somente uma vez. Você deve copiar esta chave. Trate isso como uma senha; guarde-o em um local seguro. O Ops Manager nunca mais exibe a chave completa.

O Ops Manager configura essa configuração quando você instala o MongoDB Agent. Se você precisar configurar o Backup separadamente, inclua essa configuração.

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem
mothership

Tipo: string

Especifica o nome do host e a porta do aplicativo Ops Manager usado pelo agente de Backup.

Observação

Não inclua o protocolo (http:// https://ou) na mothership configuração.

mothership=example.com:8080
mothershipResponseHeaderTimeout

Tipo: inteiro

Especifica o tempo, em segundos, de espera que o aplicativo Ops Manager responda. Se o MongoDB Agent não receber uma resposta, ele redefinirá e tentará novamente a conexão com o aplicativo Ops Manager. Este valor é padronizado para 90 segundos.

backupSocketTimeoutMs

Tipo: inteiro

Especifica o período de tempo, em milésimos de segundo, que um soquete entre o Backup e o Ops Manager pode permanecer inativo antes que o Ops Manager interrompa a conexão. Se omitido, o padrão é 180000 milésimos de segundo (3 minutos).

https

Tipo: booleano

Especifica se a comunicação com o servidor da web do Ops Manager utiliza ou não HTTP seguro.

httpProxy

Tipo: string

Especifica a URL de um proxy HTTP que o Backup pode usar.

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

Para configurar Kerberos, consulte Configurar o MongoDB Agent para Kerberos. Os mesmos procedimentos e requisitos se aplicam, mas use um UPN diferente para o Backup

Observação

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

krb5Principal

Tipo: string

Especifica o principal Kerberos que o Backup usa.

krb5Principal=backup/myhost@EXAMPLE.COM
krb5Keytab

Tipo: string

Especifica o caminho absoluto para o arquivo de guia de chave do Kerberos principal.

krb5Keytab=/path/to/mms-backup.keytab
krb5ConfigLocation

Tipo: string

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

krb5ConfigLocation=/path/to/krb_custom.conf
gsapiServiceName

Tipo: string

Especifica o nome do serviço com a gsapiServiceName configuração.

Por padrão, o MongoDB usa mongodb como seu nome de serviço.

Especifique essas configurações quando o Backup se conectar aos sistemas do MongoDB usando TLS.

Para saber mais, consulte Configurar o MongoDB Agent para usar TLS.

sslClientCertificate

Tipo: string

Especifica o caminho para a chave privada, certificado do cliente e certificados intermediários opcionais no formato PEM. O Backup usa o certificado do cliente ao se conectar a uma sistema do MongoDB que usa TLS e exige certificados do cliente . (A implantação é executada com a configuração--tlsCAFile.)

sslClientCertificatePassword

Tipo: string

Especifica a senha necessária para descriptografar a chave privada no arquivo sslClientCertificate. Inclua essa configuração se você criptografou o arquivo PEM do certificado do cliente .

sslTrustedServerCertificates

Tipo: string

Especifica o caminho que contém os certificados CA confiáveis no formato PEM. Esses certificados verificam o certificado do servidor retornado de qualquer implantação do MongoDB em execução com TLS.

sslTrustedServerCertificates=/path/to/mongodb-certs.pem
sslRequireValidServerCertificates

Tipo: booleano

Especifica se o Backup deve validar os certificados TLS apresentados pelas sistemas do MongoDB.

Aviso

Alterar essa configuração para false desativa a verificação do certificado e torna as conexões entre as sistemas do Backup e do MongoDB suscetíveis a ataques do tipo man-in-the-middle. Defina esta configuração como false apenas para fins de teste.

Especifique o uso das configurações que o backup usa ao se comunicar com o Ops Manager usando o TLS.

sslTrustedMMSBackupServerCertificate

Especifica o caminho absoluto que contém os certificados de autoridade de certificação confiáveis no formato PEM. O backup usa esse certificado para validar se o MongoDB Agent pode se comunicar com a instância do Ops Manager designado.

Por padrão, o Backup usa a raiz confiável Autoridades de Certificado instaladas no sistema.

Se o Backup não conseguir encontrar as Autoridades de Certificado raiz confiáveis, defina essas configurações manualmente.

Se o Ops Manager utilizar um certificado TLS auto assinado, forneça um valor para esta configuração.

sslTrustedMMSBackupServerCertificate=/path/to/mms-certs.pem
sslRequireValidMMSBackupServerCertificate

Especifica se o backup deve validar certificados TLS do Ops Manager.

Aviso

Alterar esta configuração para false desabilita a verificação de certificado e faz conexões entre o Backup Agent e o Ops Manager suscetíveis a ataques man-in-the-middle. Altere esta configuração para false apenas para fins de teste.

sslRequireValidMMSBackupServerCertificate=true
sslServerClientCertificate

Tipo: string

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

Dica

Para saber como especificar essa configuração no aplicativo Ops Manager, consulte Client Certificate Mode em Definições de configuração do Ops Manager.

sslServerClientCertificate=/path/to/client.pem
sslServerClientCertificatePassword

Tipo: string

Especifica a senha necessária para descriptografar a chave privada no arquivo sslServerClientCertificate. Inclua essa configuração se você criptografou o arquivo PEM do certificado do cliente .

sslServerClientCertificatePassword=password