Você está na página 1de 750

Introdução ao MongoDB 5

Comece com Atlas 7


Crie uma conta Atlas 8
Implante um cluster gratuito 12
Adicione o endereço IP da sua conexão à sua lista de acesso IP 14
Crie um usuário de banco de dados para seu cluster 16
Conecte-se ao seu cluster 18
Inserir e visualizar um documento 22
Carregar dados de amostra 25
Exemplo de conjunto de dados de listagens AirBnB 30
Exemplo de conjunto de dados analíticos 36
Exemplo de conjunto de dados geoespaciais 40
Exemplo de conjunto de dados geoespaciais 42
Exemplo de conjunto de dados Mflix 43
Exemplo de conjunto de dados de restaurantes 50
Exemplo de conjunto de dados de treinamento 56
Exemplo de conjunto de dados meteorológicos 66
Crie uma implantação de banco de dados 70
Crie um cluster 74
Crie uma instância sem servidor 77
Crie um cluster global 78
Provedores de nuvem e regiões 86
Conecte-se a uma implantação de banco de dados 88
Conecte-se através do seu aplicativo 94
Conecte-se via bússola 101
Conecte-se via mongosh 105
Conecte-se via BI Connector para Atlas 110
Crie um DSN de sistema 112
Conecte-se a partir do Excel 115
Conectar-se pelo Tableau Desktop 117
Conecte-se a partir do Qlik Sense 119
Conecte-se a partir do MySQL Workbench 121
Conecte-se a um cluster usando ferramentas de linha de comando 124
Conecte-se via código VS 130
Testar failover primário 131
Simular interrupção regional 135
Gerenciar conexões com AWS Lambda 137
Gerenciar conexões com Azure Functions 141
Solucionar problemas de conexão 146
Configurar recursos de segurança para implantações de banco de dados 153
Configurar o acesso ao cluster com o assistente de início rápido 162
Configurar entradas da lista de acesso IP 165
Configurar uma conexão de peering de rede 169
Configurar pontos finais privados 177
Saiba mais sobre endpoints privados no Atlas 178
Configurar um endpoint privado para um cluster dedicado 186
Configurar um endpoint privado para uma instância sem servidor 192
Gerencie e conecte-se a partir de endpoints privados 199
Solucionar problemas de conexão de endpoint privado 203
Configurar o acesso unificado da AWS 207
Configurar autenticação e autorização de implantação de banco de dados 211
Configurar usuários do banco de dados 213
Configurar funções de banco de dados personalizadas 225
Configurar autenticação e autorização de usuário com LDAP 237
Configurar autenticação e autorização de usuário com interface Okta LDAP 258
Configurar a autenticação federada do PingOne 268
Opções avançadas para autenticação federada 278
Gerencie suas opções de autenticação multifator 283
Autenticação legada de dois fatores 285
Autorização da IU do Atlas 287
Gerenciar o acesso da organização 296
Gerenciar organizações 301
Gerenciar usuários da organização 306
Gerenciar equipes da organização 309
Gerenciar configurações da organização 313
Gerenciar acesso ao projeto 316
Gerenciar o acesso a um projeto 321
Gerenciar configurações do projeto 326
Gerenciar a página inicial do projeto 330
Convites para organizações e projetos 332
Ver feed de atividades 334
Gerencie sua conta MongoDB Atlas 336
Personalize os recursos da interface do Atlas 345
Configurar o acesso de suporte do MongoDB à infraestrutura de back-end do Atlas
348
Migrar ou importar dados 350
Migração ao vivo (extração) de um cluster MongoDB 6.0.8 ou posterior para o Atlas
353
Migração ao vivo (envio) de um cluster MongoDB 6.0.8 ou posterior monitorado pelo
Cloud Manager para o Atlas 368
Migração ao vivo: coloque seus dados no Atlas 386
Migração ao vivo (extração) de um conjunto de réplicas para o Atlas 386
Migração ao vivo (puxar) um cluster fragmentado para o Atlas 402
Solucionar problemas de migração ao vivo (Pull) 417
Migração ao vivo: envie seus dados do Cloud Manager ou do Ops Manager para o
Atlas 421
Migração em tempo real (envio por push) de um conjunto de réplicas monitorado pelo
Ops Manager ou Cloud Manager 422
Migrar um conjunto de réplicas do MongoDB da AWS para o MongoDB Atlas na AWS
438
Migrar dados com ferramentas autogerenciadas 443
Migrar com mongomirror 452
mongomirror 464
mongomirror Registo de alterações 480
mongomirror Versões anteriores 488
Semente com mongorestore 493
Importar e exportar dados 502
Interaja com seus dados 506
Criar, visualizar e descartar bancos de dados 509
Criar, visualizar, descartar e coleções de fragmentos 512
Criar, visualizar, atualizar e excluir documentos 517
Criar, visualizar, eliminar e ocultar índices 525
Execute pipelines de agregação 528
Configurar gatilhos de banco de dados 534
Enviar eventos de gatilho para AWS EventBridge 542
Dependências Externas 549
Lago de dados do Atlas 552
Configurar e consultar a federação de dados 556
Visão geral da Federação de Dados Atlas 558
Iniciar 562
Implantar uma instância de banco de dados federado 562
Configure a conexão para sua instância de banco de dados federado 571
Adicione seu endereço IP à lista de acesso IP 573
Configurar um endpoint privado para uma instância de banco de dados federado 574
Configurar a autenticação X.509 autogerenciada 576
Conecte-se à sua instância de banco de dados federado 584
Execute consultas em sua instância de banco de dados federado 586
O que é a pesquisa do Atlas do MongoDB? 591
Visão geral da pesquisa do Atlas 592
Práticas recomendadas de pesquisa do Atlas 598
Atualize consultas de $text com Atlas Search para melhorar o desempenho de
pesquisa 603
Use Atlas Search para consultas Regex de texto completo 611
Configurar e resolver alertas 615
Revise as condições de alerta 617
Definir configurações de alerta 641
Resolver alertas 653
Corrigir problemas de pesquisa do Atlas 656
Corrigir problemas de conexão 660
Corrigir problemas de IOPS 661
Corrigir problemas de armazenamento 664
Corrigir problemas de consulta 666
Corrigir Primário Perdido 670
Corrigir problemas de Oplog 672
Revise as métricas de implantação de banco de dados 674
Corrigir problemas de uso da CPU 677
Revise as métricas de implantação de banco de dados 679
Revise a visão geral do projeto 684
Revise as métricas sem servidor 688
Revise os clusters do conjunto de réplicas 691
Revise as métricas em tempo real 704
Revise as métricas de pesquisa do Atlas 705
Revise as métricas disponíveis 710
Integrar com serviços de terceiros 721
Integrar com Datadog 724
Integre-se com equipes da Microsoft 734
Integrar com PagerDuty 737
Integrar com Prometheus 739
Visualizar e baixar logs do MongoDB 749
Introdução ao MongoDB
Nesta página

Banco de dados de documentos


Características principais
Você pode criar um banco de dados MongoDB nos seguintes ambientes:

Atlas MongoDB
: O serviço totalmente gerenciado para implantações do MongoDB na nuvem

MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB

Comunidade MongoDB: a versão disponível na fonte, de uso gratuito e autogerenciada do


MongoDB

Para saber mais sobre como criar um banco de dados MongoDB com a UI do Atlas,
consulte
Comece com o Atlas.

Banco de dados de documentos


Um registro no MongoDB é um documento, que é uma estrutura de dados composta por
pares de campos e valores. Os documentos MongoDB são semelhantes aos objetos JSON.
Os valores dos campos podem incluir outros documentos, matrizes e matrizes de
documentos.

As vantagens de usar documentos são:

Os documentos correspondem a tipos de dados nativos em muitas linguagens de


programação.

Documentos e matrizes incorporados reduzem a necessidade de junções dispendiosas.

O esquema dinâmico suporta polimorfismo fluente.

Coleções/Visualizações/Visualizações materializadas sob demanda


MongoDB armazena documentos em coleções. As coleções são análogas às tabelas em
bancos de dados relacionais.

Além das coleções, o MongoDB suporta:

Visualizações somente leitura (a partir do MongoDB 3.4)

Visualizações materializadas sob demanda (a partir do MongoDB 4.2).

Características principais
Alta performance
MongoDB fornece persistência de dados de alto desempenho. Em particular,

O suporte para modelos de dados incorporados reduz a atividade de E/S no sistema de


banco de dados.

Os índices suportam consultas mais rápidas e podem incluir chaves de documentos e


matrizes incorporados.

API de consulta
A API de consulta do MongoDB oferece suporte a operações de leitura e gravação (CRUD),
bem como:

Agregação de dados

Pesquisa de texto e consultas geoespaciais.

DICA
Veja também:
Gráfico de mapeamento SQL para MongoDB

Gráfico de mapeamento de SQL para agregação

Saiba mais sobre os recursos mais recentes da linguagem de consulta com o


Linguagem de consulta MongoDB: novidades
apresentação do MongoDB.live 2020.

Alta disponibilidade
O recurso de replicação do MongoDB, chamado conjunto de réplicas, fornece:

failover automático

redundância de dados.

Um conjunto de réplicas é um grupo de servidores MongoDB que mantêm o mesmo


conjunto de dados, fornecendo redundância e aumentando a disponibilidade dos dados.

Escalabilidade horizontal
O MongoDB fornece escalabilidade horizontal como parte de sua funcionalidade principal:

A fragmentação distribui dados em um cluster de máquinas.

A partir da versão 3.4, o MongoDB oferece suporte à criação de zonas de dados com base
na chave de fragmento. Em um cluster balanceado, o MongoDB direciona leituras e
gravações cobertas por uma zona apenas para os fragmentos dentro da zona. Consulte a
página do manual Zonas para obter mais informações.

Suporte para vários mecanismos de armazenamento


MongoDB oferece suporte a vários mecanismos de armazenamento:
WiredTiger Storage Engine (incluindo suporte para criptografia em repouso)

Mecanismo de armazenamento na memória.

Além disso, o MongoDB fornece uma API de mecanismo de armazenamento conectável


que permite que terceiros desenvolvam mecanismos de armazenamento para o MongoDB.

Comece com Atlas


Nesta página

Visão geral

Visão geral
MongoDB Atlas oferece uma maneira fácil de hospedar e gerenciar seus dados na nuvem.
Este tutorial orienta você na criação de um cluster Atlas, na conexão com ele e no
carregamento de dados de amostra.

Você pode começar a usar o Atlas através do


CLI do Atlas
ou a interface do usuário do Atlas. Selecione uma guia com base em como você gostaria
de começar:

CLI do Atlas

IU do Atlas
Para criar e autenticar com sua conta Atlas, crie um banco de dados gratuito, carregue
dados de amostra, adicione seu endereço IP à lista de acesso IP do projeto, crie um usuário
MongoDB e visualize sua string de conexão usando a CLI do Atlas, execute o seguinte
comando:

configuração do atlas [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para a configuração do atlas.

Para obter instruções passo a passo sobre como usar este comando, consulte
Comece a usar o Atlas na CLI do Atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Você também pode executar a configuração do atlas se tiver uma conta do Atlas e uma
organização/projeto, mas não tiver configurado um cluster.

Crie uma conta Atlas


Nesta página

Considerações
Pré-requisitos
Registre uma nova conta Atlas
Faça login na sua conta Atlas
Crie uma organização e um projeto Atlas
Próximos passos

Tempo estimado de conclusão: 5 minutos

Registre-se para uma conta Atlas usando sua conta GitHub, sua conta Google ou seu
endereço de e-mail.

Considerações
Para se registrar e fazer login no Atlas, você pode usar uma – e apenas uma – das
seguintes opções:

Sua conta de e-mail


Sua conta GitHub
Sua conta do Google

OBSERVAÇÃO
Se sua empresa usar Autenticação Federada, você deverá usar o endereço de e-mail da
sua empresa.

Contas GitHub
Se você se registrar com sua conta GitHub, as seguintes diferenças se aplicarão ao usar
sua conta GitHub com Atlas:

GitHub gerencia seus detalhes de usuário, endereço de e-mail e senha. Você não pode
alterar essas informações usando o console ou a API do Atlas.

GitHub gerencia seu 2FA. Você não pode usar a autenticação multifator do Atlas e não será
solicitada uma verificação Atlas 2FA ao fazer login no Atlas. GitHub deve verificar sua
identidade usando
Verificação em duas etapas do GitHub.
Se você vincula sua conta Atlas para sua conta GitHub, você pode desvincular essas contas
no Atlas.

Contas do Google
Se você se registrar com sua Conta do Google, as seguintes diferenças se aplicarão ao
usar sua conta do Google com o Atlas:

O Google gerencia seus detalhes de usuário, endereço de e-mail e senha. Você não pode
alterar essas informações usando o console ou a API do Atlas.

O Google gerencia seu 2FA. Você não pode usar a autenticação multifator do Atlas e não
será solicitada uma verificação Atlas 2FA ao fazer login no Atlas. O Google deve verificar
sua identidade usando a verificação em duas etapas do Google.

Se você vincula sua conta Atlas à sua Conta do Google, você poderá desvincular essas
contas no Atlas.

Usuários do MongoDB Cloud Manager


Se você usa o MongoDB Cloud Manager, use suas credenciais do Cloud Manager para
Conecte-se no Atlas. Você pode então criar um novo projeto Atlas no Cloud Manager.

Pré-requisitos
Adicione o host Atlas CDN à sua lista de permissões
Atlas usa um CDN para fornecer conteúdo rapidamente. Se sua organização usa um
firewall, adicione o seguinte host Atlas CDN à lista de permissões do firewall para evitar
problemas de acesso à UI do Atlas: https://assets.mongodb-cdn.com/.

As contas GitHub exigem um endereço de e-mail público


Se você tentar se registrar no Github, deverá ter um endereço de e-mail público associado à
sua conta GitHub. O Atlas retornará um erro se você tentar se registrar sem um endereço
de e-mail público.

Para definir um endereço de e-mail público do GitHub:

Depois de fazer login no GitHub, clique em Configurações no menu do seu perfil. Sua
página de perfil público deve ser exibida.

Selecione um endereço de e-mail no menu suspenso E-mail público em seu perfil público.

Se o GitHub deixar este menu suspenso esmaecido:

Clique em E-mails no menu do lado esquerdo.

Desmarque a caixa Manter meus endereços de e-mail privados.

Retorne à página Perfil público e selecione um endereço de e-mail no menu suspenso


E-mail público.
Clique em Atualizar perfil para salvar as alterações.

Registre uma nova conta Atlas


Selecione uma guia com base em como você gostaria de registrar sua conta:

CLI do Atlas

IU do Atlas
Para registrar-se no Atlas usando a CLI do Atlas, execute o seguinte comando:

atlas auth register [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
registro de autenticação atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

OBSERVAÇÃO
Se você executar a configuração do atlas com as seleções padrão, não será necessário
executar o registro de autenticação do atlas.

Faça login na sua conta Atlas


Selecione uma guia com base em como você gostaria de fazer login:

CLI do Atlas

IU do Atlas
Para autenticar com o Atlas usando a CLI do Atlas, execute o seguinte comando:

atlas auth login [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
login de autenticação do atlas.
DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Para obter instruções passo a passo sobre como fazer login usando a CLI do Atlas, consulte
Conecte-se a partir da CLI do Atlas.

Crie uma organização e um projeto Atlas


Crie uma organização Atlas e, em seguida, crie um projeto nesta organização. Você
implantará seu primeiro cluster neste projeto.

Próximos passos
Com sua conta Atlas, abra a organização e seu projeto e prossiga para Implantar um
Cluster Gratuito.

DICA
Veja também:
Para saber mais sobre os atalhos que você pode usar para navegar em sua nova conta do
Atlas, consulte Atlas Goto.
Implante um cluster gratuito
Nesta página

Procedimento
Próximos passos
Tempo estimado de conclusão: 3 minutos

Os clusters gratuitos do Atlas fornecem um ambiente de desenvolvimento em pequena


escala para hospedar seus dados. Os clusters gratuitos nunca expiram e fornecem acesso
a um subconjunto de recursos e funcionalidades do Atlas.

Clusters pagos fornecem acesso total aos recursos, opções de configuração e capacidades
operacionais do Atlas. Para obter mais informações sobre clusters pagos, incluindo
instruções de implantação, consulte Criar um cluster.

OBSERVAÇÃO
Você pode implantar apenas um cluster gratuito por projeto Atlas.

Procedimento
Você pode criar clusters gratuitos por meio do CLI do Atlas, Interface de usuário do Atlas e
API de administração do Atlas. Selecione a guia apropriada com base em como você
gostaria de criar os clusters gratuitos.

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para criar um cluster, carregue dados de amostra, adicione seu endereço IP à lista de
acesso IP do projeto e crie um usuário MongoDB para seu cluster usando o Atlas CLI,
execute o seguinte comando:

atlas setup [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
configuração do atlas.

Para obter instruções passo a passo sobre como usar este comando, consulte
Crie e configure um cluster Atlas usando o Atlas CLI.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Próximos passos
Agora que seu cluster está provisionado, prossiga para Adicionar seu endereço IP de
conexão à sua lista de acesso IP.
Adicione o endereço IP da sua conexão à sua
lista de acesso IP
Nesta página

Acesso obrigatório
Procedimento
Próximos passos
Tempo estimado de conclusão: 2 minutos

Um IP é um identificador numérico exclusivo para um dispositivo conectado a uma rede. No


Atlas, você só pode se conectar a um cluster a partir de um endereço IP confiável. No Atlas,
você pode criar uma lista de endereços IP confiáveis, conhecida como lista de acesso IP,
que pode ser usada para conectar-se ao seu cluster e acessar seus dados.

Acesso obrigatório
Para adicionar seu endereço IP a uma lista de acesso IP, você deve ter acesso de
leitura/gravação do Project Data Access ou superior ao projeto.

Procedimento
Você deve adicionar seu endereço IP à lista de acesso IP antes de poder se conectar ao
cluster. Para adicionar seu endereço IP à lista de acesso IP:

CLI do Atlas

IU do Atlas
Para criar uma lista de acesso IP para o seu projeto usando o Atlas CLI, execute o seguinte
comando:

atlas accessLists create [entry] [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atlas accessLists criam.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

OBSERVAÇÃO
Se você executar atlas setup com as seleções padrão, não será necessário executar [atlas
accessLists create]
Para saber mais sobre listas de acesso IP, consulte Configurar entradas da lista de acesso
IP.

Próximos passos
Agora que você adicionou seu endereço IP de conexão à lista de acesso IP, prossiga para
Criar um usuário de banco de dados para seu cluster.
Crie um usuário de banco de dados para seu
cluster
Nesta página

Acesso obrigatório
Procedimento
Próximos passos
Tempo estimado de conclusão: 2 minutos

Você deve criar um usuário de banco de dados para acessar seu cluster. Por motivos de
segurança, o Atlas exige que os clientes se autentiquem como usuários do banco de dados
MongoDB para acessar clusters.

Os usuários do banco de dados são separados dos usuários do Atlas:

Os usuários do banco de dados podem acessar bancos de dados hospedados no Atlas.

Os usuários do Atlas podem fazer login no Atlas, mas não têm acesso aos bancos de dados
MongoDB.

Acesso obrigatório
Para criar um usuário de banco de dados, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao projeto.

Procedimento
Para adicionar um usuário de banco de dados ao cluster:

CLI do Atlas

IU do Atlas
Para criar um usuário de banco de dados para seu projeto usando a CLI do Atlas, execute o
seguinte comando:

atlas dbusers create [builtInRole]... [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para [atlas dbusers create.].

DICA
Veja: Links Relacionados
Instale a CLI do Atlas
Conecte-se à CLI do Atlas

OBSERVAÇÃO
Se você executar [atlas setup] com as seleções padrão, não será necessário executar [atlas
dbusers create].

Para saber mais sobre como configurar usuários de banco de dados adicionais em seu
cluster, consulte Configurar usuários de banco de dados.

Próximos passos
Agora que você tem um usuário de banco de dados para seu cluster, prossiga para
Conectar-se ao seu cluster.
Conecte-se ao seu cluster
selecione sua lingua
Node.js

Nesta página

Acesso obrigatório
Pré-requisitos
Conecte-se ao seu cluster Atlas
Próximos passos
Tempo estimado de conclusão: 5 minutos

Você pode se conectar ao seu cluster de diversas maneiras. Neste tutorial, você usa um dos
seguintes métodos:

O shell do MongoDB é uma interface de linha de comando interativa para MongoDB. Você
pode usar mangusto para inserir e interagir com dados em seu cluster Atlas.

Bússola MongoDB é uma GUI para seus dados do MongoDB. Você pode usar o Compass
para explorar, modificar e visualizar seus dados.

Um driver MongoDB para se comunicar com seu banco de dados MongoDB


programaticamente. Para ver todos os idiomas suportados, consulte a Documentação do
driver MongoDB.

➤ Use o menu suspenso Selecione seu idioma para definir o método de conexão para este
tutorial.

OBSERVAÇÃO
Se você estiver usando os comandos atlas setup ou atlas quickstart com opções padrão
para começar a usar o Atlas, a CLI do Atlas fornece uma comando mangusto para se
conectar ao seu cluster.

Acesso obrigatório
Para se conectar a um cluster, você deve ser um usuário do banco de dados.

Pré-requisitos
Antes de começar, verifique se você tem:

Uma conta Atlas.

Uma organização com um projeto.

Um cluster ativo criado na sua conta.

Um endereço IP adicionado à sua lista de acesso IP.


Um usuário de banco de dados em seu cluster.

OBSERVAÇÃO
Você deve ter um usuário de banco de dados configurado em seu cluster para acessar sua
implementação. Por motivos de segurança, o Atlas exige que os clientes se autentiquem
como usuários de banco de dados para acessar clusters:

Um terminal

Um editor de texto

npm

Node.js

Para instalar o Driver Node.js, execute o seguinte comando em um prompt do terminal:

npm install mongodb --save

Node.js

Conecte-se ao seu cluster Atlas


Nesta seção, você obtém os dados do seu cluster
cadeia de conexão
na UI do Atlas e conecte-se ao seu cluster usando seu método de conexão preferido.

Para saber mais sobre todos os métodos suportados, consulte Conectar-se à implantação
do seu banco de dados em nuvem. Para obter exemplos de drivers adicionais, consulte
Conectar por meio do seu aplicativo.

1
Na UI do Atlas, selecione sua implantação de banco de dados.
Clique em Banco de dados no canto superior esquerdo do Atlas.

Na visualização Implementações de Banco de Dados, clique em Conectar para a


implementação de banco de dados à qual deseja se conectar.

2
Clique em Escolher um método de conexão.
3
Clique em Conectar seu aplicativo.
4
Selecione Node.js no menu suspenso Driver.
Selecione sua versão do driver no menu suspenso. A cadeia de conexão é exibida.
5
Copie a cadeia de conexão fornecida.
6
Configure a cadeia de conexão fornecida.
Substitua <password> pela senha especificada quando você criou o usuário do banco de
dados.

OBSERVAÇÃO
Se suas senhas, nomes de bancos de dados ou cadeias de conexão contiverem caracteres
de URI reservados, você deverá escapar dos caracteres. Por exemplo, se sua senha for
@bc123, você deverá escapar do caractere @ ao especificar a senha na cadeia de
conexão, como %40bc123. Para saber mais, consulte Caracteres especiais na senha da
string de conexão.

7
Conecte-se com o aplicativo de exemplo.
O aplicativo de exemplo a seguir se conecta ao cluster Atlas com sua cadeia de conexão e
retorna uma mensagem de confirmação. Para testar o aplicativo de amostra, copie o código
a seguir em um arquivo chamado connect.js.

Substitua o espaço reservado pela string de conexão atualizada:

const { MongoClient } = require("mongodb");

// Substitua o seguinte pela string de conexão do Atlas

const url =
"mongodb+srv://<username>:<password>@<clusterName>.mongodb.net/?retryWrites=tru
e&w=majority";

// Conecte-se ao seu cluster Atlas


const client = new MongoClient(url);

async function run() {


try {
await client.connect();
console.log("Successfully connected to Atlas");

} catch (err) {
console.log(err.stack);
}
finally {
await client.close();
}
}

run().catch(console.dir);
Node.js

Para executar o aplicativo de amostra, use o seguinte comando:

node connect.js

Node.js

OCULTAR SAÍDA
Conectado com sucesso ao Atlas

Próximos passos
Agora que você se conectou ao seu cluster, prossiga para Inserir e visualizar dados no seu
cluster.
Inserir e visualizar um documento
selecione sua lingua
Node.js

Nesta página

Acesso obrigatório
Pré-requisitos
Inserir e visualizar dados
Próximos passos
Tempo estimado de conclusão: 5 minutos

Depois de se conectar ao cluster do Atlas, você poderá interagir com ele. Neste tutorial,
você insere dados em seu cluster e lê os novos dados usando mongosh, a IU do Atlas,
Bússola MongoDB , ou um suporte Driver MongoDB.

➤ Use o menu suspenso Selecione seu idioma para definir o método para este tutorial.

Acesso obrigatório
Para interagir com um cluster, você deve ser um usuário de banco de dados.

Pré-requisitos
Antes de começar, você deve configurar seu método de conexão preferido. Para saber
mais, consulte Conectar-se ao seu cluster.

Inserir e visualizar dados


O seguinte aplicativo de exemplo:

Estabelece uma conexão com seu cluster Atlas.

Insere um documento em uma coleção chamada people no banco de dados GettingStarted.

Pesquisa na coleção de pessoas documentos que possuem um valor name.last de Turing e


retorna o documento.

Crie um arquivo chamado insert-data.js e copie o seguinte código no arquivo:

OBSERVAÇÃO
Substitua o espaço reservado pela string de conexão do Atlas.

const { MongoClient } = require("mongodb");

// Replace the following with your Atlas connection string

const url = "<connection-string>"


const client = new MongoClient(url);

// Faça referência ao banco de dados a ser usado


const dbName = "gettingStarted";

async function run() {


try {
// Faça referência ao banco de dados a ser usado
await client.connect();
const db = client.db(dbName);

// Faça referência à coleção "pessoas" no banco de dados especificado


const col = db.collection("people");

// Criar um novo documento

let personDocument = {
"name": { "first": "Alan", "last": "Turing" },
"birth": new Date(1912, 5, 23), // May 23, 1912

"death": new Date(1954, 5, 7), // May 7, 1954

"contribs": [ "Turing machine", "Turing test", "Turingery" ],


"views": 1250000
}

// Insert the document into the specified collection


const p = await col.insertOne(personDocument);

// Encontre e devolva o documento


const filter = { "name.last": "Turing" };
const document = await col.findOne(filter);
console.log("Document found:\n" + JSON.stringify(document));

} catch (err) {
console.log(err.stack);
}

finally {
await client.close();
}
}

run().catch(console.dir);

Node.js

Para executar o aplicativo de amostra, use o seguinte comando:


node insert-data.js

Node.js

OCULTAR SAÍDA
Documento encontrado:

{"_id":"64d52c3c3db2144fc00791b9","name":{"primeiro":"Alan","último":"Turing"},"nascime
nto":"1912-06-23T06:00:00.000Z","morte
":"1954-06-07T05:00:00.000Z","contribs":["Máquina de Turing","Teste de
Turing","Turingery"],"views":1250000}

OBSERVAÇÃO
Você pode ver um valor diferente para o ID do objeto, porque é um valor gerado pelo
sistema.

DICA
Para saber mais sobre como consultar dados com Node.js, consulte o
Documentação do Node.js.

Próximos passos
Se você continuar a expandir seu cluster, considere dimensioná-lo para dar suporte a mais
usuários e operações.

Para continuar experimentando no Atlas, considere carregar dados de amostra.


Carregar dados de amostra
Nesta página

Carregar dados de amostra


Conjuntos de dados de amostra disponíveis
Exemplos de namespaces de dados
Tutoriais usando dados de amostra
Cursos universitários MongoDB que usam dados de amostra
Tempo estimado de conclusão: 5 minutos

O Atlas fornece dados de amostra que você pode carregar em suas implantações de banco
de dados Atlas. Você pode usar esses dados para começar rapidamente a experimentar
dados no MongoDB e usar ferramentas como Atlas UI e
Gráficos MongoDB.

Para obter uma lista de conjuntos de dados na amostra e uma descrição de cada um,
consulte os Conjuntos de dados de amostra disponíveis. Cada página do conjunto de dados
contém informações sobre os bancos de dados, coleções e índices do conjunto de dados.

Carregar dados de amostra


Acesso obrigatório
Para carregar dados de amostra, você deve ter acesso de proprietário do projeto ao projeto.

Os usuários com acesso de Proprietário da Organização devem adicionar-se ao projeto


como Proprietário do Projeto.

Pré-requisitos
Para utilizar os dados de amostra fornecidos pelo Atlas, você deve criar uma implantação
de banco de dados Atlas para carregar os dados. Para saber mais, consulte Criar uma
implantação de banco de dados.

Procedimento
Você pode carregar dados de amostra em sua implantação de banco de dados Atlas a partir
da CLI do Atlas ou da UI do Atlas.

Selecione a guia apropriada com base em como você gostaria de carregar os dados de
amostra:

CLI do Atlas

IU do Atlas
Para carregar dados de amostra no cluster especificado usando a CLI do Atlas, execute o
seguinte comando:
atlas clusters sampleData load <clusterName> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para clusters atlas sampleData load.

Depois de executar o comando para carregar dados de amostra, você pode usar os
seguintes comandos da CLI do Atlas para monitorar o status do trabalho de carregamento
de dados de amostra:

Para retornar os detalhes do trabalho de carregamento de dados de amostra especificado


usando a CLI do Atlas, execute o seguinte comando:

atlas clusters sampleData describe <id> [options]

Para observar o trabalho de dados de amostra especificado em seu cluster até que ele seja
concluído usando a CLI do Atlas, execute o seguinte comando:

atlas clusters sampleData watch <id> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para amostra de clusters do atlasDados descrevem e clusters
atlas sampleData watch.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Conjuntos de dados de amostra disponíveis


A tabela a seguir mostra os conjuntos de dados de amostra disponíveis para implantações
de banco de dados Atlas. Clique em um conjunto de dados de amostra para saber mais
sobre ele.

Para obter instruções sobre como carregar esses dados de amostra na implantação do
banco de dados Atlas, consulte Carregar dados de amostra.

Nome do conjunto de dados


Descrição
Exemplo de conjunto de dados de listagens AirBnB
Contém detalhes sobre
AirBnB
listagens.
Exemplo de conjunto de dados analíticos
Contém dados de treinamento para um aplicativo simulado de serviços financeiros.
Exemplo de conjunto de dados geoespaciais
Contém dados de naufrágios.
Conjunto de dados de guias de amostra
Contém dados do planeta.
Exemplo de conjunto de dados Mflix
Contém dados de filmes.
Exemplo de conjunto de dados de restaurantes
Contém dados do restaurante.
Exemplo de conjunto de dados de loja de suprimentos
Contém dados de uma loja simulada de materiais de escritório.
Exemplo de conjunto de dados de treinamento
Contém conjunto de dados de serviços de treinamento MongoDB.
Exemplo de conjunto de dados meteorológicos
Contém relatórios meteorológicos detalhados.
Exemplos de namespaces de dados
Quando você carrega os dados de amostra, o Atlas cria os seguintes namespaces na
implantação do seu banco de dados:

AVISO
Se algum desses namespaces já existir na implantação do banco de dados quando você
tentar carregar os dados de amostra, a operação falhará e nenhum dado de amostra será
carregado na implantação do banco de dados.

Base de dados
Coleção
amostra_airbnb
listagens e comentários
amostra_analytics
contas
amostra_analytics
clientes
amostra_analytics
transações
amostra_geoespacial
naufrágios
amostras_guias
planetas
amostra_mflix
comentários
amostra_mflix
filmes_embutidos
amostra_mflix
filmes
amostra_mflix
teatros
amostra_mflix
Usuários
amostras_suprimentos
vendas
exemplo_treinamento
empresas
exemplo_treinamento
notas
exemplo_treinamento
inspeções
exemplo_treinamento
Postagens
exemplo_treinamento
rotas
exemplo_treinamento
viagens
exemplo_treinamento
zíperes
amostra_weatherdata
dados
Tutoriais usando dados de amostra
Tutoriais do Atlas
O tutorial Introdução ao Atlas explica como configurar um cluster Atlas e preencher esse
cluster com dados de amostra.

Tutoriais de pesquisa do Atlas


Comece com a Pesquisa Atlas

Crie um índice do Atlas Search usando dados do banco de dados de amostra sample_mflix
e execute consultas na coleção de filmes no banco de dados de amostra.

Tutoriais de pesquisa do Atlas


Configure e consulte um índice do Atlas Search. A seção Tutoriais do Atlas Search contém
muitos tutoriais para orientá-lo nas etapas de uso do Atlas Search. Você pode aprender
sobre tudo, desde como usar o preenchimento automático com pesquisa no Atlas até como
executar consultas de pesquisa no Atlas com um filtro de intervalo de datas ou como
executar consultas de pesquisa multilíngues no Atlas e muito mais. Muitos desses tutoriais
usam o banco de dados de amostra sample_mflix.

Tutoriais de gráficos MongoDB


A seguir

Gráficos MongoDB
tutoriais orientam você na visualização de dados de amostra fornecidos pelo Atlas:

Visualizando dados de pedidos


Visualize o exemplo de conjunto de dados de loja de suprimentos, que contém dados de
pedidos de vendas de uma empresa simulada de materiais de escritório.
Visualizando Detalhes do Filme
Visual

Veja o Sample Mflix Dataset, que contém dados sobre filmes e cinemas.

DICA
Para visualizar dados em gráficos do MongoDB na UI do Atlas, clique em Visualizar seus
dados ao visualizar um banco de dados ou coleção específica. Gráficos carrega a fonte de
dados e você pode começar a criar um gráfico na visualização Gráficos. Para etapas
detalhadas, consulte

Crie gráficos.

Cursos universitários MongoDB que usam dados de amostra

A seguir

Universidade MongoDB

cursos e treinamentos utilizam os dados de amostra fornecidos pelo Atlas.

M001: Noções básicas do MongoDB


O MongoDB Basics foi projetado para alunos novos no MongoDB.
M121: A estrutura de agregação MongoDB
Aprenda como usar o MongoDB Aggregation Framework em suas práticas de
desenvolvimento de aplicativos.
M220J: MongoDB para desenvolvedores Java
Aprenda como usar o MongoDB como banco de dados para uma aplicação Java.
M220JS: MongoDB para desenvolvedores Javascript
Aprenda como usar o MongoDB como banco de dados para um aplicativo Node.js.
M220P: MongoDB para desenvolvedores Python
Aprenda como usar o MongoDB como banco de dados para um aplicativo Python.
Todos

Treinamento Presencial
Obtenha rapidamente acesso ao MongoDB com programas abrangentes de treinamento
privado para desenvolvedores e equipes de operações.
Exemplo de conjunto de dados de listagens
AirBnB
Nesta página

Coleções
Índices
Exemplo de documento
O banco de dados sample_airbnb é uma compilação de listagens e avaliações de casas de
férias disponíveis em
Por dentro do AirBnB
.

Para saber como carregar os dados de amostra fornecidos pelo Atlas em seu cluster,
consulte Carregar dados de amostra.

Coleções
Este banco de dados contém uma única coleção chamada listagensAndReviews.

A coleção sample_airbnb.listingsAndReviews contém documentos que representam os


detalhes do anúncio da casa de férias e avaliações de clientes sobre o anúncio. Esses
documentos refletem um subconjunto aleatório da fonte original disponível publicamente, de
diversas cidades ao redor do mundo.

Índices
Esta coleção contém os seguintes índices:

Nome
Índice
Descrição
Propriedades
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
propriedade_type_1_room_type_1_camas_1
{
"tipo_de_propriedade": 1,
"tipo_de_quarto": 1,
"camas": 1
}
Índice composto
nos campos property_type, room_type e camas.
Composto
nome_1
{"nome": 1}
Índice ascendente de campo único no campo de nome para consultas sobre o nome da
listagem.
endereço.location_2dsphere
{
"address.location": "2dsphere"
}
Geoespacial
2desfera
índice no campo de formato address.location GeoJSON.
Escasso

Exemplo de documento

"_id": "10006546",
"listing_url": "https://www.airbnb.com/rooms/10006546",
"name": "Ribeira Charming Duplex",
"summary": "Fantastic duplex apartment with three bedrooms, located in the historic
area of Porto, Ribeira (Cube)...",
"interaction": "Cot - 10 € / night Dog - € 7,5 / night",
"house_rules": "Make the house your home...",
"property_type": "House",
"room_type": "Entire home/apt",
"bed_type": "Real Bed",
"minimum_nights": "2",
"maximum_nights": "30",
"cancellation_policy": "moderate",
"last_scraped": {
"$date": {
"$numberLong": "1550293200000"
}
},
"calendar_last_scraped": {
"$date": {
"$numberLong": "1550293200000"
}
},
"first_review": {
"$date": {
"$numberLong": "1451797200000"
}
},
"last_review": {
"$date": {
"$numberLong": "1547960400000"
}
},
"accommodates": {
"$numberInt": "8"
},
"bedrooms": {
"$numberInt": "3"
},
"beds": {
"$numberInt": "5"
},
"number_of_reviews": {
"$numberInt": "51"
},
"bathrooms": {
"$numberDecimal": "1.0"
},
"amenities": [
"TV",
"Cable TV",
"Wifi",
"Kitchen",
"Paid parking off premises",
"Smoking allowed",
"Pets allowed",
"Buzzer/wireless intercom",
"Heating",
"Family/kid friendly",
"Washer",
"First aid kit",
"Fire extinguisher",
"Essentials",
"Hangers",
"Hair dryer",
"Iron",
"Pack ’n Play/travel crib",
"Room-darkening shades",
"Hot water",
"Bed linens",
"Extra pillows and blankets",
"Microwave",
"Coffee maker",
"Refrigerator",
"Dishwasher",
"Dishes and silverware",
"Cooking basics",
"Oven",
"Stove",
"Cleaning before checkout",
"Waterfront"
],
"price": {
"$numberDecimal": "80.00"
},
"security_deposit": {
"$numberDecimal": "200.00"
},
"cleaning_fee": {
"$numberDecimal": "35.00"
},
"extra_people": {
"$numberDecimal": "15.00"
},
"guests_included": {
"$numberDecimal": "6"
},
"images": {
"thumbnail_url": "",
"medium_url": "",
"picture_url":
"https://a0.muscache.com/im/pictures/e83e702f-ef49-40fb-8fa0-6512d7e26e9b.jpg?aki
_policy=large",
"xl_picture_url": ""
},
"host": {
"host_id": "51399391",
"host_url": "https://www.airbnb.com/users/show/51399391",
"host_name": "Ana&Gonçalo",
"host_location": "Porto, Porto District, Portugal",
"host_about": "Gostamos de passear, de viajar, de conhecer pessoas e locais novos,
gostamos de desporto e animais! Vivemos na cidade mais linda do mundo!!!",
"host_response_time": "within an hour",
"host_thumbnail_url":
"https://a0.muscache.com/im/pictures/fab79f25-2e10-4f0f-9711-663cb69dc7d8.jpg?aki_
policy=profile_small",
"host_picture_url":
"https://a0.muscache.com/im/pictures/fab79f25-2e10-4f0f-9711-663cb69dc7d8.jpg?aki_
policy=profile_x_medium",
"host_neighbourhood": "",
"host_response_rate": {
"$numberInt": "100"
},
"host_is_superhost": false,
"host_has_profile_pic": true,
"host_identity_verified": true,
"host_listings_count": {
"$numberInt": "3"
},
"host_total_listings_count": {
"$numberInt": "3"
},
"host_verifications": [
"email",
"phone",
"reviews",
"jumio",
"offline_government_id",
"government_id"
]
},
"address": {
"street": "Porto, Porto, Portugal",
"suburb": "",
"government_area": "Cedofeita, Ildefonso, Sé, Miragaia, Nicolau, Vitória",
"market": "Porto",
"country": "Portugal",
"country_code": "PT",
"location": {
"type": "Point",
"coordinates": [
{
"$numberDouble": "-8.61308"
},
{
"$numberDouble": "41.1413"
}
],
"is_location_exact": false
}
},
"availability": {
"availability_30": {
"$numberInt": "28"
},
"availability_60": {
"$numberInt": "47"
},
"availability_90": {
"$numberInt": "74"
},
"availability_365": {
"$numberInt": "239"
}
},
"review_scores": {
"review_scores_accuracy": {
"$numberInt": "9"
},
"review_scores_cleanliness": {
"$numberInt": "9"
},
"review_scores_checkin": {
"$numberInt": "10"
},
"review_scores_communication": {
"$numberInt": "10"
},
"review_scores_location": {
"$numberInt": "10"
},
"review_scores_value": {
"$numberInt": "9"
},
"review_scores_rating": {
"$numberInt": "89"
}
},
"reviews": [
{
"_id": "362865132",
"date": {
"$date": {
"$numberLong": "1545886800000"
}
},
"listing_id": "10006546",
"reviewer_id": "208880077",
"reviewer_name": "Thomas",
"comments": "Very helpful hosts. Cooked traditional..."
},
{
"_id": "364728730",
"date": {
"$date": {
"$numberLong": "1546232400000"
}
},
"listing_id": "10006546",
"reviewer_id": "91827533",
"reviewer_name": "Mr",
"comments": "Ana & Goncalo were great on communication..."
},
{
"_id": "403055315",
"date": {
"$date": {
"$numberLong": "1547960400000"
}
},
"listing_id": "10006546",
"reviewer_id": "15138940",
"reviewer_name": "Milo",
"comments": "The house was extremely well located..."
}
]
}
Exemplo de conjunto de dados analíticos
Nesta página

Coleções
sample_analytics.accounts
sample_analytics.clientes
sample_analytics.transactions
O banco de dados sample_analytics contém três coleções para um aplicativo típico de
serviços financeiros. Possui clientes, contas e transações. Eles são usados como parte dos
exercícios do Treinamento MongoDB em Análise de Dados.

Para saber como carregar os dados de amostra fornecidos pelo Atlas em seu cluster,
consulte Carregar dados de amostra.

Coleções
O banco de dados sample_analytics contém as seguintes coleções:

Nome da coleção
Descrição
contas
Contém detalhes sobre contas de clientes.
clientes
Contém detalhes sobre clientes.
transações
Contém transações do cliente.
sample_analytics.accounts
Esta coleção contém detalhes da conta para
Usuários
. Cada documento contém um ID de conta, um limite e os produtos que um cliente comprou.

Índices
A coleção sample_analytics.accounts contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"account_id": 470650,
"limit": 10000,
"products": [
"CurrencyService",
"Commodity",
"InvestmentStock"
]
}

sample_analytics.clientes
Esta coleção contém detalhes dos clientes, incluindo quais contas eles possuem usuários.
Cada documento contém nome de usuário, nome, endereço, data de nascimento, endereço
de e-mail, uma lista das contas mantidas e detalhes sobre os níveis e benefícios
relacionados aos quais têm direito.

Índices
A coleção sample_analytics.customers contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"username": "lejoshua",
"name": "Michael Johnson",
"address": "15989 Edward Inlet\nLake Maryton, NC 39545",
"birthdate": {"$date": 54439275000},
"email": "courtneypaul@gmail.com",
"accounts": [
470650,
443178
],
"tier_and_details": {
"b5f19cb532fa436a9be2cf1d7d1cac8a": {
"tier": "Silver",
"benefits": [
"dedicated account representative"
],
"active": true,
"id": "b5f19cb532fa436a9be2cf1d7d1cac8a"
}
}
}

sample_analytics.transactions
Esta coleção contém detalhes de transações para
Usuários
. Cada documento contém um ID de conta, uma contagem de quantas transações estão
neste conjunto, as datas de início e término das transações cobertas por este documento e
uma lista de subdocumentos. Cada subdocumento representa uma única transação e as
informações relacionadas a essa transação.

Índices
A coleção sample_analytics.transactions contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"account_id": 794875,
"transaction_count": 6,
"bucket_start_date": {"$date": 693792000000},
"bucket_end_date": {"$date": 1473120000000},
"transactions": [
{
"date": {"$date": 1325030400000},
"amount": 1197,
"transaction_code": "buy",
"symbol": "nvda",
"price":
"12.7330024299341033611199236474931240081787109375",
"total": "15241.40390863112172326054861"
},
{
"date": {"$date": 1465776000000},
"amount": 8797,
"transaction_code": "buy",
"symbol": "nvda",
"price":
"46.53873172406391489630550495348870754241943359375",
"total": "409401.2229765902593427995271"
},
{
"date": {"$date": 1472601600000},
"amount": 6146,
"transaction_code": "sell",
"symbol": "ebay",
"price":
"32.11600884852845894101847079582512378692626953125",
"total": "197384.9903830559086514995215"
},
{
"date": {"$date": 1101081600000},
"amount": 253,
"transaction_code": "buy",
"symbol": "amzn",
"price":
"37.77441226157566944721111212857067584991455078125",
"total": "9556.926302178644370144411369"
},
{
"date": {"$date": 1022112000000},
"amount": 4521,
"transaction_code": "buy",
"symbol": "nvda",
"price":
"10.763069758141103449133879621513187885284423828125",
"total": "48659.83837655592869353426977"
},
{
"date": {"$date": 936144000000},
"amount": 955,
"transaction_code": "buy",
"symbol": "csco",
"price":
"27.992136535152877030441231909207999706268310546875",
"total": "26732.49039107099756407137647"
}
]
}
Exemplo de conjunto de dados geoespaciais
Nesta página

Coleções
Índices
Exemplo de documento
O banco de dados sample_geospatial contém dados projetados especificamente para
ajudar você a se familiarizar com dados GeoJSON.

Para saber como carregar os dados de amostra fornecidos pelo Atlas em seu cluster,
consulte Carregar dados de amostra.

Coleções
Este banco de dados contém uma única coleção chamada naufrágios.

A coleção sample_geospatial.shipwrecks contém todos os dados de naufrágios no conjunto


de dados. Cada documento da coleção representa um naufrágio e contém detalhes como
onde ocorreu o naufrágio e o tipo de naufrágio ocorrido.

Índices
A coleta de dados contém os seguintes índices:

Nome
Índice
Descrição
Propriedades
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
coordenadas_2dsphere
{ "coordenadas": "2dsphere" }
Geoespacial
2desfera
índice no campo de formato GeoJSON de coordenadas.
Escasso
Exemplo de documento

"_id": {
"$oid": "578f6fa2df35c7fbdbaed8c6"
},
"recrd": "",
"vesslterms": "",
"feature_type": "Wrecks - Submerged, dangerous",
"chart": "US,U1,graph,DNC H1409860",
"latdec": {
"$numberDouble": "9.3560572"
},
"londec": {
"$numberDouble": "-79.9074173"
},
"gp_quality": "",
"depth": "",
"sounding_type": "",
"history": "",
"quasou": "depth unknown",
"watlev": "always under water/submerged",
"coordinates": [
{
"$numberDouble": "-79.9074173"
},
{
"$numberDouble": "9.3560572"
}
]
}
Exemplo de conjunto de dados geoespaciais
Nesta página

Coleções
Índices
Exemplo de documento
O banco de dados sample_geospatial contém dados projetados especificamente para
ajudar você a se familiarizar com
GeoJSON
dados.

Para saber como carregar os dados de amostra fornecidos pelo Atlas em seu cluster,
consulte Carregar dados de amostra.

Coleções
Este banco de dados contém uma única coleção chamada naufrágios.

A coleção sample_geospatial.shipwrecks contém todos os dados de naufrágios no conjunto


de dados. Cada documento da coleção representa um naufrágio e contém detalhes como
onde ocorreu o naufrágio e o tipo de naufrágio ocorrido.

Índices
A coleta de dados contém os seguintes índices:

Nome
Índice
Descrição
Propriedades
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
coordenadas_2dsphere
{ "coordenadas": "2dsphere" }
Geoespacial
2desfera
índice no campo de formato GeoJSON de coordenadas.
Escasso
Exemplo de documento

{
_id: new ObjectId("6220f6b78a733c51b416c80e"),
name: 'Uranus',
orderFromSun: 7,
hasRings: true,
mainAtmosphere: [ 'H2', 'He', 'CH4' ],
surfaceTemperatureC: { min: null, max: null, mean: -197.2 }
}
Exemplo de conjunto de dados Mflix
Nesta página

Coleções
sample_mflix.comments
sample_mflix.embedded_movies
sample_mflix.movies
sample_mflix.sessions
sample_mflix.theaters
sample_mflix.users

O banco de dados sample_mflix contém dados sobre filmes e cinemas. O banco de dados
também contém coleções de determinados metadados, incluindo usuários e comentários
sobre filmes específicos.

Para saber como carregar os dados de amostra fornecidos pelo Atlas em seu cluster,
consulte Carregar dados de amostra.

Coleções
O banco de dados sample_mflix contém as seguintes coleções:

Nome da coleção
Descrição
comentários
Contém comentários associados a filmes específicos.
filmes_embutidos
Contém informações sobre filmes dos gêneros Faroeste, Ação e Fantasia de
amostra_mflix.movies
coleção com um campo plot_embedding adicionado com embeddings criados usando o
modelo de incorporação text-embedding-ada-002 da OpenAI que você pode usar para
consultar com a pesquisa vetorial do Atlas Search.
filmes
Contém informações do filme, incluindo ano de lançamento, diretor e resenhas.
sessões
Campo de metadados. Contém usuários
Tokens da Web JSON.
teatros
Contém localizações de salas de cinema.
Usuários
Contém informações do usuário.
amostra_mflix.comments
Esta coleção contém comentários associados a filmes específicos. Cada documento contém
o texto do comentário, o usuário que o enviou e o filme ao qual o comentário se aplica.

Índices
Esta coleção contém os seguintes índices:
Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"_id": {
"$oid": "5a9427648b0beebeb69579cc"
},
"name": "Andrea Le",
"email": "andrea_le@fakegmail.com",
"movie_id": {
"$oid": "573a1390f29313caabcd418c"
},
"text": "Rem officiis eaque repellendus amet eos doloribus. Porro
dolor voluptatum voluptates neque culpa molestias. Voluptate unde
nulla temporibus ullam.",
"date": {
"$date": {
"$numberLong": "1332804016000"
}
}
}

sample_mflix.embedded_movies
Esta coleção contém detalhes sobre filmes com gêneros de faroeste, ação ou fantasia.
Cada documento contém um único filme e informações como título, ano de lançamento e
elenco.

Além disso, os documentos nesta coleção incluem um campo plot_embedding que contém
embeddings criados usando o modelo de incorporação text-embedding-ada-002 da OpenAI
que você pode usar com o recurso de pesquisa vetorial Atlas Search.

Índices
Esta coleção contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

OBSERVAÇÃO
O número de dimensões na amostra foi truncado para facilitar a leitura.
{
"_id": {
"$oid": "573a1396f29313caabce582d"
},
"plot": "A young swordsman comes to Paris and faces villains, romance, adventure and
intrigue with three Musketeer friends.",
"genres": ["Action", "Adventure", "Comedy"],
"runtime": {
"$numberInt": "106"
},
"rated": "PG",
"cast": ["Oliver Reed", "Raquel Welch", "Richard Chamberlain", "Michael York"],
"num_mflix_comments": {
"$numberInt": "0"
},
"poster":
"https://m.media-amazon.com/images/M/MV5BODQwNmI0MDctYzA5Yy00NmJkLWIxN
GMtYzgyMDBjMTU0N2IyXkEyXkFqcGdeQXVyMjI4MjA5MzA@._V1_SY1000_SX677_
AL_.jpg",
"title": "The Three Musketeers",
"lastupdated": "2015-09-16 06:21:07.210000000",
"languages": ["English"],
"released": {
"$date": {
"$numberLong": "133747200000"
}
},
"directors": ["Richard Lester"],
"writers": ["George MacDonald Fraser (screenplay)", "Alexandre Dumas père (novel)"],
"awards": {
"wins": {
"$numberInt": "4"
},
"nominations": {
"$numberInt": "7"
},
"text": "Won 1 Golden Globe. Another 3 wins & 7 nominations."
},
"year": {
"$numberInt": "1973"
},
"imdb": {
"rating": {
"$numberDouble": "7.3"
},
"votes": {
"$numberInt": "11502"
},
"id": {
"$numberInt": "72281"
}
},
"countries": ["Spain", "USA", "Panama", "UK"],
"type": "movie",
"tomatoes": {
"viewer": {
"rating": {
"$numberDouble": "3.5"
},
"numReviews": {
"$numberInt": "9600"
},
"meter": {
"$numberInt": "78"
}
},
"dvd": {
"$date": {
"$numberLong": "982022400000"
}
},
"critic": {
"rating": {
"$numberDouble": "7.1"
},
"numReviews": {
"$numberInt": "11"
},
"meter": {
"$numberInt": "82"
}
},
"lastUpdated": {
"$date": {
"$numberLong": "1441307415000"
}
},
"rotten": {
"$numberInt": "2"
},
"production": "Live Home Video",
"fresh": {
"$numberInt": "9"
}
},
"plot_embedding": [
-0.004237316,
-0.022958077,
-0.005921211,
-0.020323543,
0.010051459
]
}

sample_mflix.movies
Esta coleção contém detalhes sobre filmes. Cada documento contém um único filme e
informações como título, ano de lançamento e elenco.

Índices
Esta coleção contém os seguintes índices:

Nome
_id_ { "_id": 1 }

Exemplo de documento

{
"_id": {
"$oid": "573a1390f29313caabcd413b"
},
"title": "The Arrival of a Train",
"year": {
"$numberInt": "1896"
},
"runtime": {
"$numberInt": "1"
},
"released": {
"$date": {
"$numberLong": "-2335219200000"
}
},
"poster":
"http://ia.media-imdb.com/images/M/MV5BMjEyNDk5MDYzOV5BMl5BanBnXkFtZTgw
NjIxMTEwMzE@._V1_SX300.jpg",
"plot": "A group of people are standing in a straight line along the
platform of a railway station, waiting for a train, which is seen
coming at some distance. When the train stops at the platform, ...",
"fullplot": "A group of people are standing in a straight line along
the platform of a railway station, waiting for a train, which is
seen coming at some distance. When the train stops at the platform,
the line dissolves. The doors of the railway-cars open, and people
on the platform help passengers to get off.",
"lastupdated": "2015-08-15 00:02:53.443000000",
"type": "movie",
"directors": [
"Auguste Lumière",
"Louis Lumière"
],
"imdb": {
"rating": {
"$numberDouble": "7.3"
},
"votes": {
"$numberInt": "5043"
},
"id": {
"$numberInt": "12"
}
},
"cast": [
"Madeleine Koehler"
],
"countries": [
"France"
],
"genres": [
"Documentary",
"Short"
],
"tomatoes": {
"viewer": {
"rating": {
"$numberDouble": "3.7"
},
"numReviews": {
"$numberInt": "59"
}
},
"lastUpdated": {
"$date": {
"$numberLong": "1441993589000"
}
}
},
"num_mflix_comments": {
"$numberInt": "1"
}
}

sample_mflix.users Esta coleção contém informações sobre usuários mflix. Cada


documento contém um único usuário e seu nome, email e senha.
Índices
Nome
Índice
Descrição
Propriedades
_eu ia_ { "_id": 1}
Índice de chave primária no campo _id. e-mail_1 { "e-mail: 1} Índice ascendente exclusivo
no campo de e-mail. Exclusivo
Exemplo de documento

{
"_id": {
"$oid": "59b99db4cfa9a34dcd7885b6"
},
"name": "Ned Stark",
"email": "sean_bean@gameofthron.es",
"password":
"$2b$12$UREFwsRUoyF0CRqGNK0LzO0HM/jLhgUCNNIJ9RJAqMUQ74crlJ1Vu"
}
Exemplo de conjunto de dados de restaurantes
Nesta página

Coleções
sample_restaurants.restaurants
sample_restaurants.neighborhoods
O banco de dados sample_restaurants contém duas coleções projetadas especificamente
para ajudar você a se familiarizar com dados GeoJSON.

Para saber como carregar os dados de amostra fornecidos pelo Atlas em seu cluster,
consulte Carregar dados de amostra.

Coleções
O banco de dados sample_restaurants contém as seguintes coleções:

Nome da coleção
Descrição
restaurantes
Contém detalhes sobre restaurantes.
bairros
Contém detalhes sobre bairros.
amostra_restaurantes.restaurantes
Esta coleção contém detalhes de contas de restaurantes. Cada documento contém detalhes
sobre o restaurante, como endereço, bairro, pontuação das avaliações, nome e tipo de
comida que serve.

Índices
A coleção sample_restaurants.restaurants contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.

Exemplo de documento

{
"address": {
"building": "8825",
"coord": [-73.8803827, 40.7643124],
"street": "Astoria Boulevard",
"zipcode": "11369"
},
"borough": "Queens",
"cuisine": "American",
"grades": [ {
"date": {"$date": "2014-11-15T00:00:00.000Z"},
"grade": "Z",
"score": 38
},
{
"date": {"$date": "2014-05-02T00:00:00.000Z"},
"grade": "A",
"score": 10
},
{
"date": {"$date": "2013-03-02T00:00:00.000Z"},
"grade": "A",
"score": 7
},
{
"date": {"$date": "2012-02-10T00:00:00.000Z"},
"grade": "A",
"score": 13
}],
"name": "Brunos On The Boulevard",
"restaurant_id": "40356151"
}

sample_restaurants.neighborhoods
Esta coleção contém detalhes sobre os vários bairros da cidade de Nova York. Cada
documento contém o nome da vizinhança e um subdocumento de geometria que contém a
forma da vizinhança.

Essas matrizes de coordenadas são normalmente usadas com o operador $geoWithin para
consultar dados que existem dentro de um limite especificado.

Índices
A coleção sample_restaurants.neighborhoods contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.

Exemplo de documento

{
"geometry": {
"coordinates": [[
[-73.94193078816193, 40.70072523469547],
[-73.9443878859649, 40.70042452378256],
[-73.94424286147482, 40.69969927964773],
[-73.94409591260093, 40.69897295461309],
[-73.94394947271304, 40.69822127983908],
...
[-73.94193078816193, 40.70072523469547]
]]},
"name":"Bedford"
}
Exemplo de conjunto de dados de loja de suprimentos
Nesta página

Coleções
Índices
Exemplo de documento
O banco de dados sample_supplies contém dados de uma empresa simulada de materiais
de escritório. A empresa rastreia informações de clientes e dados de vendas e possui
diversas lojas em todo o mundo.

Para saber como carregar os dados de amostra fornecidos pelo Atlas em seu cluster,
consulte Carregar dados de amostra.

Coleções
Este banco de dados contém uma única coleção chamada vendas.

Cada documento da coleção sample_supplies.sales representa uma única venda de uma


loja administrada pela empresa fornecedora. Cada documento contém os itens adquiridos,
informações do cliente que realizou a compra e diversos outros detalhes da venda.

Índices
A coleção sample_supplies.sales contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"_id": {
"$oid": "5bd761dcae323e45a93ccfe8"
},
"saleDate": {
"$date": {
"$numberLong": "1427144809506"
}
},
"items": [
{
"name": "notepad",
"tags": [
"office",
"writing",
"school"
],
"price": {
"$numberDecimal": "35.29"
},
"quantity": {
"$numberInt": "2"
}
},
{
"name": "pens",
"tags": [
"writing",
"office",
"school",
"stationary"
],
"price": {
"$numberDecimal": "56.12"
},
"quantity": {
"$numberInt": "5"
}
},
{
"name": "envelopes",
"tags": [
"stationary",
"office",
"general"
],
"price": {
"$numberDecimal": "19.95"
},
"quantity": {
"$numberInt": "8"
}
},
{
"name": "binder",
"tags": [
"school",
"general",
"organization"
],
"price": {
"$numberDecimal": "14.16"
},
"quantity": {
"$numberInt": "3"
}
}
],
"storeLocation": "Denver",
"customer": {
"gender": "M",
"age": {
"$numberInt": "42"
},
"email": "cauho@witwuta.sv",
"satisfaction": {
"$numberInt": "4"
}
},
"couponUsed": true,
"purchaseMethod": "Online"
}
Exemplo de conjunto de dados de treinamento
Nesta página

Coleções
sample_training.companies
sample_training.grades
sample_training.inspections
sample_training.posts
sample_training.routes
sample_training.trips
sample_training.zips

O banco de dados sample_training contém um conjunto de dados realistas usados em


Ofertas de treinamento privado do MongoDB. Este conjunto de dados é baseado em fontes
de dados disponíveis publicamente, como:

Dados do Crunchbase,

OpenData de Nova York,

Voos abertos
e

Dados da Citibike.

Esses conjuntos de dados realistas são usados por nossos alunos para explorar a
funcionalidade do MongoDB em nossos laboratórios e exercícios de treinamento privados.

Para saber como carregar os dados de amostra fornecidos pelo Atlas em seu cluster,
consulte Carregar dados de amostra.

Coleções
O banco de dados sample_training contém as seguintes coleções:

Nome da coleção
Descrição
empresas
Contém uma lista de
Dados do Crunchbase
Informações da Empresa.
notas
Contém informações sobre as notas dos alunos em uma determinada turma, incluindo
pontuações em diferentes avaliações.
inspeções
Contém uma lista de inspeções comerciais da cidade de Nova York, incluindo se a empresa
foi reprovada ou aprovada na inspeção.
Postagens
Contém discursos aleatórios no Senado dos EUA, organizados como postagens de blog
com comentários gerados aleatoriamente.
rotas
Contém informações de rotas aéreas, com aeroportos de origem e destino, companhia
aérea prestadora de serviço e tipo de avião. Esta coleção é usada em laboratórios que
exploram o
$graphLookup
fase de agregação.
viagens
Contém a cidade de Nova York
Dados da Citibike
dados de viagens. Esses dados são úteis para explorar
$graphLookup
palco de agregação e vitrine
Consultas geoespaciais
.
zíperes
Contém dados de códigos postais/cepais de cidades gerais dos Estados Unidos.
sample_training.companies
Esta coleção contém informações sobre empresas listadas no Crunchbase. Ele contém uma
variedade de informações, como o site da empresa e/ou blogs sobre a empresa, rodadas de
financiamento e indivíduos conhecidos associados à empresa.

Índices
Esta coleção contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"_id": {
"$oid": "52cdef7c4bab8bd675298291"
},
"acquisition": null,
"acquisitions": [],
"alias_list": null,
"blog_feed_url": "http://mobiance.wordpress.com/feed/",
"blog_url": "http://mobiance.wordpress.com/",
"category_code": "web",
"competitions": [],
"created_at": "Tue Feb 12 17:31:58 UTC 2008",
"crunchbase_url": "http://www.crunchbase.com/company/mobiance",
"deadpooled_day": null,
"deadpooled_month": null,
"deadpooled_url": null,
"deadpooled_year": null,
"description": null,
"email_address": "info@mobiance.com",
"external_links": [],
"founded_day": {
"$numberInt": "1"
},
"founded_month": {
"$numberInt": "10"
},
"founded_year": {
"$numberInt": "2004"
},
"funding_rounds": [],
"homepage_url": "http://www.mobiance.com",
"image": {
"attribution": null,
"available_sizes": [
[
[
{
"$numberInt": "150"
},
{
"$numberInt": "43"
}
],
"assets/images/resized/0001/1859/11859v1-max-150x150.png"
],
[
[
{
"$numberInt": "208"
},
{
"$numberInt": "60"
}
],
"assets/images/resized/0001/1859/11859v1-max-250x250.png"
],
[
[
{
"$numberInt": "208"
},
{
"$numberInt": "60"
}
],
"assets/images/resized/0001/1859/11859v1-max-450x450.png"
]
]
},
"investments": [],
"ipo": null,
"milestones": [],
"name": "Mobiance",
"number_of_employees": {
"$numberInt": "5"
},
"offices": [
{
"address1": "BC-3, Atrium Business Center,",
"address2": "Coles Road, Frazer Town,",
"city": "Bangalore",
"country_code": "IND",
"description": null,
"latitude": null,
"longitude": null,
"state_code": null,
"zip_code": "560005"
}
],
"overview": "<p>Mobiance provides the technology to track cell phones ...",
"partners": [],
"permalink": "mobiance",
"phone_number": "+91-80- 41264756",
"products": [],
"providerships": [],
"relationships": [
{
"is_past": true,
"person": {
"first_name": "Ritesh",
"last_name": "Ambastha",
"permalink": "ritesh-ambastha"
},
"title": "Product Manager"
}
],
"screenshots": [],
"tag_list": null,
"total_money_raised": "$0",
"twitter_username": null,
"updated_at": "Thu Dec 01 07:37:10 UTC 2011",
"video_embeds": []
}

sample_training.grades
Esta coleção foi aleatoriamente gerando notas dos alunos avaliadas. Cada documento
contém um class_id que identifica a turma e um student_id que identifica o aluno. Todas as
pontuações dos exames das turmas dos alunos são armazenadas na matriz de pontuações,
que contém subdocumentos com dois campos que representam o tipo de avaliação e a
pontuação do aluno para essa avaliação.

Índices
Esta coleção contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"_id": {
"$oid": "56d5f7eb604eb380b0d8d8fa"
},
"class_id": {
"$numberDouble": "173"
},
"scores": [
{
"score": {
"$numberDouble": "19.81430597438296"
},
"type": "exam"
},
{
"score": {
"$numberDouble": "16.851404299968642"
},
"type": "quiz"
},
{
"score": {
"$numberDouble": "60.108751761488186"
},
"type": "homework"
},
{
"score": {
"$numberDouble": "22.886167083915776"
},
"type": "homework"
}
],
"student_id": {
"$numberDouble": "4"
}
}

sample_training.inspections
A arrecadação das fiscalizações foi retirada do
Dados abertos de Nova York
conjunto de dados. Cada documento de inspeção contém informações sobre:
A razão social, setor e endereço inspecionados,

ID da inspeção, resultado, data e número do certificado.

Índices
Esta coleção contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"_id": {
"$oid": "56d61033a378eccde8a8357e"
},
"address": {
"city": "LAWRENCE",
"number": 1,
"street": "BAY BLVD",
"zip": 11559
},
"business_name": "SPRAGUE OPERATING RESOURCES LLC.",
"certificate_number": 3019422,
"date": "Mar 3 2015",
"id": "11247-2015-ENFO",
"result": "Fail",
"sector": "Fuel Oil Dealer - 814"
}

sample_training.posts
A coleção de postagens é um conjunto de postagens de blog geradas aleatoriamente,
criadas usando discursos do Senado dos EUA como semente para o campo do corpo do
documento. Em cada documento você encontrará:

Informações sobre as postagens do blog, como corpo do texto, autor, link permanente, data
e título,

Lista de tags gerada aleatoriamente,

Lista gerada aleatoriamente de subdocumentos de comentários.

Índices
Esta coleção contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"_id": {
"$oid": "50ab0f8bbcf1bfe2536dc3f9"
},
"author": "machine",
"body": "Amendment I\n<p>Congress shall make no law respecting ... ",
"comments": [
{
"author": "Santiago Dollins",
"body": "Lorem ipsum dolor sit amet, consectetur adipisicing...",
"email": "HvizfYVx@pKvLaagH.com"
},
{
"author": "Jaclyn Morado",
"body": "Lorem ipsum dolor sit amet, consectetur adipisicing...",
"email": "WpOUCpdD@hccdxJvT.com"
}
...
],
"date": {
"$date": {
"$numberLong": "1332804016000"
}
},
"permalink": "aRjNnLZkJkTyspAIoRGe",
"tags": [
"watchmaker",
"santa",
"xylophone",
"math",
"handsaw",
"dream",
"undershirt",
"dolphin",
"tanker",
"action"
],
"title": "Bill of Rights"
}

sample_training.routes
Os dados de coleta de rotas foram provenientes do
Voos abertos dados. Os documentos desta coleção trazem informações sobre rotas
aéreas entre aeroportos.

Cada documento contém informações sobre:


Dados da companhia aérea em subdocumento contendo nome, apelido, identificador
exclusivo e código IATA da companhia aérea,

Os aeroportos de origem e destino, identificaram seus


Código IATA do aeroporto,

Rota codeshare e o número de paradas.

Índices
Esta coleção contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"_id": {
"$oid": "56e9b39b732b6122f877fa5c"
},
"airline": {
"alias": "2G",
"iata": "CRG",
"id": 1654,
"name": "Cargoitalia"
},
"airplane": "A81",
"codeshare": "",
"dst_airport": "OVB",
"src_airport": "BTK",
"stops": 0
}

sample_training.trips
A coleção de viagens contém dados de viagens de bicicleta do serviço Citibike da cidade de
Nova York. Os documentos são compostos por:

Identificador exclusivo de bicicleta,

Hora e data de início e parada da viagem,

Nomes das estações de início e fim da viagem e localização geoespacial,

Informações do usuário como sexo, ano de nascimento e tipo de serviço (Cliente ou


Assinante).
Índices
Esta coleção contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"_id": {
"$oid": "572bb8222b288919b68abf82"
},
"bikeid": 14785,
"birth year": 1977,
"end station id": 433,
"end station location": {
"coordinates": [
-73.98057249,
40.72955361
],
"type": "Point"
},
"end station name": "E 13 St & Avenue A",
"gender": 1,
"start station id": 518,
"start station location": {
"coordinates": [
-73.9734419,
40.74780373
],
"type": "Point"
},
"start station name": "E 39 St & 2 Ave",
"start time": {
"$date": {
"$numberLong": "1332804016000"
}
},
"stop time": {
"$date": {
"$numberLong": "1352114016000"
}
},
"tripduration": 812,
"usertype": "Subscriber"
}
sample_training.zips
A coleção zips contém informações de cidades dos EUA e seus códigos postais/cepais de
área. Os documentos contêm informações sobre o nome da cidade, CEP da área,
coordenadas geográficas do centro da cidade (latitude e longitude), estado e população.
Este conjunto de dados é usado para explorar Índice 2d criação e consultas. Índices Esta
coleção contém os seguintes índices:
Nome
Índice
Descrição _eu ia_ { "_id": 1}
Índice de chave primária no campo _id.

Exemplo de documento

{
"_id": {
"$oid": "5c8eccc1caa187d17ca6ed29"
},
"city": "CLEVELAND",
"loc": {
"x": 86.559355,
"y": 33.992106
},
"pop": 2369,
"state": "AL",
"zip": "35049"
}
Exemplo de conjunto de dados meteorológicos
Nesta página

Coleções
Índices
Exemplo de documento
O banco de dados sample_weatherdata contém relatórios meteorológicos detalhados de
vários locais. Cada relatório contém leituras como temperatura do ar, vento e visibilidade.
Cada relatório contém um local que é armazenado como GeoJSON.

Para saber como carregar os dados de amostra fornecidos pelo Atlas em seu cluster,
consulte Carregar dados de amostra.

Coleções
Este banco de dados contém uma única coleção chamada dados.

A coleção sample_weatherdata.data contém todos os boletins meteorológicos do conjunto


de dados. Cada documento da coleção representa um único boletim meteorológico. As
diversas observações meteorológicas contidas no documento normalmente existem em
objetos incorporados.

Índices
A coleção sample_weatherdata.data contém os seguintes índices:

Nome
Índice
Descrição
_eu ia_
{ "_id": 1}
Índice de chave primária no campo _id.
Exemplo de documento

{
"_id": {
"$oid": "5553a998e4b02cf7151190c9"
},
"st": "x+51900+003200",
"ts": {
"$date": {
"$numberLong": "447354000000"
}
},
"position": {
"type": "Point",
"coordinates": [
{
"$numberDouble": "3.2"
},
{
"$numberDouble": "51.9"
}
]
},
"elevation": {
"$numberInt": "9999"
},
"callLetters": "PLAT",
"qualityControlProcess": "V020",
"dataSource": "4",
"type": "FM-13",
"airTemperature": {
"value": {
"$numberDouble": "4.8"
},
"quality": "1"
},
"dewPoint": {
"value": {
"$numberDouble": "4.6"
},
"quality": "1"
},
"pressure": {
"value": {
"$numberDouble": "1032.6"
},
"quality": "1"
},
"wind": {
"direction": {
"angle": {
"$numberInt": "170"
},
"quality": "1"
},
"type": "N",
"speed": {
"rate": {
"$numberDouble": "0.5"
},
"quality": "1"
}
},
"visibility": {
"distance": {
"value": {
"$numberInt": "999999"
},
"quality": "9"
},
"variability": {
"value": "N",
"quality": "9"
}
},
"skyCondition": {
"ceilingHeight": {
"value": {
"$numberInt": "99999"
},
"quality": "9",
"determination": "9"
},
"cavok": "N"
},
"sections": [
"AG1",
"MD1",
"OA1",
"SA1"
],
"precipitationEstimatedObservation": {
"discrepancy": "2",
"estimatedWaterDepth": {
"$numberInt": "999"
}
},
"atmosphericPressureChange": {
"tendency": {
"code": "2",
"quality": "1"
},
"quantity3Hours": {
"value": {
"$numberDouble": "1.2"
},
"quality": "1"
},
"quantity24Hours": {
"value": {
"$numberDouble": "99.9"
},
"quality": "9"
}
},
"seaSurfaceTemperature": {
"value": {
"$numberDouble": "5.5"
},
"quality": "9"
}
}
Criar e conectar-se a implantações de banco de dados
Nesta página

Escolha um tipo de implantação de banco de dados.


Crie a implantação do banco de dados.
Conecte-se à implantação do banco de dados.
Crie implantações de banco de dados no Atlas para armazenar e gerenciar facilmente seus
dados. Depois de criar uma implantação de banco de dados, conecte-se à implantação de
banco de dados por meio do método de conexão de sua preferência.

Crie e conecte-se a uma implantação de banco de dados com as seguintes etapas:

1
Escolha um tipo de implantação de banco de dados.
Compare casos de uso e suporte de recursos para selecionar o melhor tipo de implantação
de banco de dados para você.

2
Crie a implantação do banco de dados.
Crie um cluster, uma instância sem servidor ou um cluster global com base na sua escolha
de implantação de banco de dados.

3
Conecte-se à implantação do banco de dados.
Conecte-se à implantação do seu banco de dados. Você pode:

Navegue pelos dados por meio da interface do Atlas.

Conecte-se por meio do seu aplicativo.

Conecte-se via bússola.

Conecte-se via mongosh.

Conecte-se via BI Connector para Atlas.


Crie uma implantação de banco de dados
Nesta página

Escolha um tipo de implantação de banco de dados


Dê os próximos passos
Use esses recursos para escolher e criar clusters e instâncias sem servidor.

Escolha um tipo de implantação de banco de dados


O MongoDB Atlas pode implantar dois tipos de bancos de dados em nuvem: instâncias sem
servidor e clusters. Você pode usar clusters e instâncias sem servidor no mesmo projeto
Atlas.

Você também pode criar uma implantação local do Atlas com a CLI do Atlas.

Aglomerados
Crie um cluster se quiser:

Escolha uma configuração de banco de dados específica com base nos requisitos da sua
carga de trabalho.

Defina o comportamento de dimensionamento do banco de dados.

Execute cargas de trabalho de produção de alto rendimento.

Tenha sempre capacidade disponível.

Você pode:

Defina a camada do cluster.

Use recursos avançados, como


fragmentação.

Distribua seus dados para diversas regiões e provedores de nuvem.

Dimensione seu cluster sob demanda.

Ative o escalonamento automático. Ao contrário das instâncias sem servidor, o


escalonamento automático para clusters requer pré-configuração.

O MongoDB cobra clusters com base na configuração de implantação e na camada do


cluster.

Instâncias sem servidor


Crie uma instância sem servidor se desejar:
Comece rapidamente com configuração mínima de banco de dados.

Faça com que seu banco de dados seja dimensionado de forma automática e dinâmica para
atender à sua carga de trabalho.

Execute cargas de trabalho pouco frequentes ou esparsas.

Desenvolva ou teste em um ambiente de nuvem.

O Atlas dimensiona automaticamente a capacidade de armazenamento, a taxa de


transferência de armazenamento e o poder de computação para uma instância sem servidor
de forma integrada para atender aos seus requisitos de carga de trabalho. As instâncias
sem servidor sempre executam o que há de mais recente
Versão do MongoDB
e você paga apenas pelas operações executadas.

Clusters Globais
Crie um cluster global se quiser oferecer suporte a operações de leitura e gravação com
reconhecimento de localização. As operações de leitura e gravação com reconhecimento de
localização são ideais para instâncias e clientes de aplicativos distribuídos globalmente.

Clusters globais são uma implementação altamente selecionada de um cluster fragmentado


que oferece:

Operações de leitura e gravação de baixa latência para clientes distribuídos globalmente.

Proteção de tempo de atividade durante interrupções regionais parciais ou totais.

Armazenamento de dados com reconhecimento de localização em regiões geográficas


específicas.

Isolamento de carga de trabalho com base em tipos de membros de cluster.

Você pode habilitar gravações globais no Atlas ao implantar um cluster fragmentado M30 ou
superior. Para conjuntos de réplicas, dimensione o cluster para pelo menos uma camada
M30 e habilite Gravações Globais. Todos os nós de fragmentos são implementados com o
cluster selecionado.

IMPORTANTE
Não é possível desabilitar Gravações Globais para um cluster depois de implantado.

Implantações locais
Crie uma implantação local
para experimentar os recursos do Atlas em um conjunto de réplicas de nó único
hospedado em seu computador local.

Suporte e comparação de recursos


A tabela a seguir indica se clusters ou instâncias sem servidor oferecem suporte à
configuração ou capacidade listada no MongoDB Atlas.

OBSERVAÇÃO
O MongoDB planeja adicionar suporte para mais configurações e recursos em instâncias
sem servidor ao longo do tempo. Para ver as limitações atuais da instância sem servidor e
saber mais sobre o suporte planejado, consulte Limitações da instância sem servidor.

Para obter as atualizações mais recentes do produto, consulte o Atlas Changelog.

Configurações
Configuração
Aglomerados
Instâncias sem servidor
Lançamentos rápidos
Regiões AWS
Selecione apenas regiões
Regiões do Google Cloud
Selecione apenas regiões
Regiões do Microsoft Azure
Selecione apenas regiões
Implantações multirregionais
Implantações em várias nuvens
Fragmentado
implantações
Aglomerados globais
Lista de acesso IP
Peering de rede
Pontos de extremidade privados
Somente AWS e Azure
Recursos avançados de segurança empresarial (incluindo LDAP e auditoria de banco de
dados)
Capacidades
Capacidade
Aglomerados
Instâncias sem servidor
Use a API Atlas
Monitore métricas
Configure alertas sobre métricas ou faturamento disponíveis
Configurar backups
Execute restaurações pontuais ou automatizadas a partir de snapshots de backup
Use a UI do Atlas (Localizar, Índices, Schema Advisor e Aggregation Pipeline Builder)
Obtenha sugestões de índice e esquema sob demanda
Carregar dados de amostra
Use gatilhos
Use a pesquisa do Atlas
Usar arquivo online
Execute consultas federadas
Usar
Conector BI
Usar
Gráficos MongoDB
Usar
Serviços de aplicativos Atlas
Apoio Seletivo
IMPORTANTE
Não é possível migrar para clusters a partir de instâncias sem servidor.

Para obter uma lista completa das limitações de instância sem servidor, consulte Limitações
de instância sem servidor.

Dê os próximos passos
Depois de selecionar um tipo de implantação de banco de dados, você poderá:

Crie uma implantação na nuvem


Para criar uma implantação na nuvem, use os seguintes recursos:

Crie um cluster.

Crie uma instância sem servidor.

Crie um cluster global.

Crie uma implantação local com o Atlas CLI


Para criar uma implantação local ou na nuvem do Atlas usando a CLI do Atlas, execute o
seguinte comando:

configuração de implantações do atlas [deploymentName] [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
configuração de implantações do atlas.

Para obter instruções passo a passo sobre como usar este comando, consulte
Crie uma implantação local.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Crie um cluster
Este tutorial orienta você pelas etapas para criar um novo cluster Atlas. Para saber como
modificar um cluster Atlas existente, consulte Modificar um cluster.

Os clusters podem ser um conjunto de réplicas ou um cluster fragmentado. Este tutorial


orienta você na criação de um conjunto de réplicas.

Acesso obrigatório
Para criar um cluster, você deve ter acesso de Proprietário da Organização ou Proprietário
do Projeto ao projeto.

Considerações
Para minimizar a latência da rede e os custos de transferência de dados e para aumentar a
estabilidade e a segurança gerais, use o mesmo provedor de nuvem e região para hospedar
seu aplicativo e cluster quando possível.

Os clusters podem abranger regiões e provedores de serviços em nuvem. O número total


de nós em clusters que abrangem regiões tem uma restrição específica por projeto.

O Atlas limita o número total de nós em outras regiões em um projeto a um total de 40. Este
total exclui:

Regiões do Google Cloud se comunicando entre si

Clusters gratuitos ou clusters compartilhados

Instâncias sem servidor

O número total de nós entre quaisquer duas regiões deve atender a esta restrição.

EXEMPLO
Se um projeto Atlas tiver nós em clusters espalhados por três regiões:

30 nós na região A

10 nós na região B

5 nós na região C

Você só pode adicionar mais 5 nós à Região C porque:

Se você excluir a Região C, Região A + Região B = 40.

Se você excluir a Região B, Região A + Região C = 35, <= 40.

Se você excluir a Região A, Região B + Região C = 15, <= 40.


Cada combinação de regiões com os 5 nós adicionados ainda atende à restrição por
projeto:

Região A + B = 40

Região A + C = 40

Região B + C = 20

Não será possível criar um cluster multirregional em um projeto se ele tiver um ou mais
clusters abrangendo 40 ou mais nós em outras regiões.

Entre em contato com a Atlas


apoiar
para perguntas ou assistência para aumentar esse limite.

Cada projeto Atlas oferece suporte a até 25 implantações de banco de dados. Entre em
contato com o suporte do Atlas para tirar dúvidas ou receber assistência em relação ao
limite de implantação do banco de dados. Para entrar em contato com o suporte, selecione
Suporte na barra de navegação esquerda da UI do Atlas.

Se o seu projeto Atlas contiver uma função personalizada que usa ações introduzidas em
uma versão específica do MongoDB, você deverá excluir essa função antes de criar clusters
com uma versão anterior do MongoDB.

Os clusters Atlas criados após julho de 2020 usam o TLS versão 1.2 por padrão.

Quando você cria um cluster, o Atlas cria um contêiner de rede no projeto do provedor de
nuvem no qual você implantará o cluster, se ainda não existir um.

Se você tiver uma Política de Conformidade de Backup habilitada, todos os clusters novos e
existentes terão o Backup em Nuvem habilitado automaticamente e usarão a Política de
Conformidade de Backup em nível de projeto. O Atlas aumenta quaisquer políticas
preexistentes em nível de cluster para atender aos requisitos mínimos da Política de
Conformidade de Backup. Todos os novos clusters usam a Política de Conformidade de
Backup, a menos que os requisitos mínimos da política de backup em nível de cluster se
expandam além dos requisitos mínimos da Política de Conformidade de Backup.

Procedimento

CLI do Atlas

IU do Atlas
Para criar um cluster no projeto especificado usando a CLI do Atlas, execute o seguinte
comando:
atlas clusters create [name] [options]

Para observar a disponibilização de um cluster específico usando a CLI do Atlas, execute o


seguinte comando:

atlas clusters watch <clusterName> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
clusters atlas criam e relógio de aglomerados de atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Ver regiões disponíveis


Para listar as regiões disponíveis que o Atlas suporta para novas implantações usando a
CLI do Atlas, execute o seguinte comando:

clusters atlas disponíveisLista de regiões [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
Lista de clusters atlas disponíveis.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

[1] (1, 2) Para conjuntos de réplicas, os servidores que contêm dados são os servidores que
hospedam os nós do conjunto de réplicas. Para clusters fragmentados, os servidores que
suportam dados são os servidores que hospedam os fragmentos. Para clusters
fragmentados, a Atlas também implanta servidores para o servidores de configuração; estes
são cobrados a uma taxa separada dos custos do cluster.
Crie uma instância sem servidor
Este tutorial orienta você pelas etapas para criar uma nova instância sem servidor do Atlas.

Para converter seu cluster compartilhado existente em uma instância sem servidor, consulte
Converter um cluster compartilhado em uma instância sem servidor.

Acesso obrigatório
Para criar uma instância sem servidor, você deve ter acesso de proprietário do projeto ao
projeto. Os usuários com acesso de Proprietário da Organização devem adicionar-se ao
projeto como Proprietário do Projeto.

Procedimento

CLI do Atlas

IU do Atlas
Para criar uma instância sem servidor no projeto especificado usando a CLI do Atlas,
execute o seguinte comando:

atlas serverless create <instanceName> [options]

Para monitorar o status de uma instância sem servidor usando a CLI do Atlas, execute o
seguinte comando:

atlas serverless watch <instanceName> [options]

O comando watch verifica o estado da instância sem servidor periodicamente até que a
instância atinja um estado inativo. Assim que a instância atingir o estado esperado, o
comando imprimirá Instância disponível. Você pode interromper a pesquisa do comando a
qualquer momento com CTRL + C.

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para a criação sem servidor do atlas e relógio atlas sem
servidor.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Crie um cluster global
Nesta página

Acesso obrigatório
Considerações
Procedimento
Esta seção aborda a habilitação de gravações globais em um cluster Atlas.

Acesso obrigatório
Para criar um Cluster Global, você deve ter acesso de Proprietário da Organização ou
Proprietário do Projeto ao projeto.

Considerações
Antes de criar um Cluster Global, revise Visão Geral de Clusters Globais e Referência de
Fragmentação de Clusters Globais.

Você pode habilitar gravações globais no Atlas ao implantar um cluster fragmentado M30 ou
superior.

Depois de implantar o cluster, não será possível converter um cluster global em um cluster
fragmentado padrão.

Devido aos requisitos de fragmentação, não é possível carregar dados de amostra em um


cluster global.

Se este for o primeiro cluster pago dedicado para a região ou regiões selecionadas e você
planeja criar uma ou mais conexões de peering de VPC, revise Conexões de peering de
VPC antes de continuar.

Procedimento
1
Navegue até a página Implantações de banco de dados do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Se a página Implantações de banco de dados ainda não estiver exibida, clique em Banco de
dados na barra lateral.

2
Abra a caixa de diálogo Criar nova implantação de banco de dados.
Se você já tiver uma ou mais implantações de banco de dados, clique em Criar para exibir a
caixa de diálogo Criar Nova Implantação de Banco de Dados.
Se esta for sua primeira implantação de banco de dados:

Clique em Construir um banco de dados.

Clique em opções de configuração avançada na parte superior da tela para exibir a caixa de
diálogo Criar nova implantação de banco de dados.

3
Habilite gravações globais para seu cluster.
Na caixa de diálogo Criar novo cluster, selecione o tipo de cluster dedicado. Para obter mais
informações, consulte Criar um cluster.

Clique em Configuração Global de Cluster para expandir a seção.

Alterne Ativar gravações globais (M30 e superior) para Ativado para exibir a configuração do
cluster global.

4
Selecione seu provedor de nuvem preferido.
OBSERVAÇÃO
Cada provedor de nuvem possui uma seleção de regiões globais nas quais o Atlas pode
implantar uma zona. A escolha do provedor de nuvem pode apoiar ou restringir sua
capacidade de implantar uma zona em locais geográficos específicos. As opções de
configuração disponíveis e o custo de execução do cluster também podem variar
dependendo da seleção do provedor de nuvem.

5
Configure suas zonas de cluster globais.
O Atlas oferece três opções para configurar suas zonas de cluster global:

Configurar zonas de gravação global usando um modelo

Configurar uma zona de região única de gravações globais

Configurar uma zona multirregional de gravações globais

Selecione a guia apropriada com base em como você gostaria de configurar suas zonas de
cluster global.

Use um modelo

Zona de região única

Zona multirregional
O Atlas fornece dois modelos para configurar zonas de gravação global para o cluster, cada
um com uma descrição da finalidade de sua configuração subjacente. Clique em um modelo
para visualizar o mapa de zonas desse modelo. O Mapa de Zona fornece uma descrição
visual da configuração da zona do cluster, incluindo estimativas de latência geográfica e
cobertura.

Clique em Resumo da configuração da zona abaixo do mapa de zonas para visualizar um


resumo de cada zona no cluster global. O Atlas fornece as seguintes validações para cada
zona:

Validação
Orientação
Leituras e gravações de baixa latência em <geography>
Indica a localidade geográfica para a qual a zona oferece suporte a leituras e gravações de
baixa latência. A localidade geográfica exata especificada depende da região preferencial
para essa zona. Você pode modificar a região preferencial da zona na seção Configuração
da zona.
Leituras locais em todas as outras zonas
Indica se os dados nesta zona são replicados para todas as outras zonas para leituras
secundárias locais por clientes nessas zonas.

Clique no botão Configurar leituras locais em todas as zonas no resumo da configuração da


zona para configurar automaticamente todas as zonas do cluster para leituras locais.

(Não) Disponível durante interrupção parcial da região


Indica se a zona dá suporte à alta disponibilidade, de modo que a maioria dos nós elegíveis
permaneçam íntegros e acessíveis no caso de uma interrupção parcial da região. As
regiões marcadas como Recomendadas na UI do Atlas suportam alta disponibilidade
durante interrupções regionais parciais.

DICA
Veja também:
Zonas de disponibilidade da Amazon.

Zonas GCP.

Zonas de disponibilidade do Azure.

(Não) Disponível durante interrupção total da região


Indica se a zona dá suporte à alta disponibilidade, de modo que a maioria dos nós elegíveis
permaneçam íntegros e acessíveis no caso de uma interrupção regional completa.
Por padrão, cada modelo implanta uma série de zonas de região única e cria um mapa de
locais de países e subdivisões geograficamente próximos de cada zona. O MongoDB usa
esse mapa de zona de localização para rotear operações de leitura e gravação que contêm
dados de localização para o fragmento ou fragmentos na zona correspondente.

Clique em Configurar mapeamentos de localização no mapa de zona para visualizar a lista


de mapeamentos de zona de localização. Para personalizar o mapeamento da zona de
localização, clique no menu suspenso Zona para um determinado nome de local e selecione
uma nova zona. Clique no botão Redefinir para redefinir um mapeamento personalizado
para qualquer local. Clique no botão Redefinir todos os mapeamentos de zona para redefinir
todos os mapeamentos personalizados do cluster.

Você pode fazer alterações adicionais na configuração de cada zona após selecionar um
modelo de zona. Para obter instruções, consulte a guia Zona de região única.

Você também pode criar zonas multirregionais. Para obter instruções, consulte a guia Zona
multirregional. Clicar em Configurar leituras locais em todas as zonas converte todas as
zonas em multirregiões.

Clique em Visualizar modelos de zona no mapa de zonas para retornar à seleção de


modelos.

6
Selecione a camada do cluster.
Para usar Clusters Globais, você deve selecionar uma camada de cluster M30 ou superior.

A camada selecionada determina a especificação de memória, armazenamento, vCPUs e


IOPS para cada servidor que contém dados no cluster.

Para obter mais informações sobre como selecionar uma camada de cluster apropriada e
configurações de armazenamento para sua carga de trabalho, consulte Selecionar camada
de cluster e personalizar armazenamento de cluster.

7
Selecione quaisquer configurações adicionais.
Na seção Configurações adicionais para clusters globais, você pode:

Selecione a versão MongoDB do cluster

Configurar opções de backup para o cluster

Habilitar conector de BI para Atlas

Gerencie suas próprias chaves de criptografia

Configurar opções adicionais

8
Especifique o nome do cluster.
Este é o nome do cluster conforme aparece no Atlas. Você não poderá alterar o nome do
cluster depois que o Atlas implantar o cluster.

Os nomes dos clusters não podem exceder 64 caracteres.

IMPORTANTE
Atlas trunca o nome do cluster para 23 caracteres em suas interações internas. Na prática,
isso significa:
Nomes de cluster com menos de 23 caracteres não podem terminar com hífen ou traço (-).

Nomes de cluster com 23 caracteres ou mais não podem usar hífen ou traço (-) como 23º
caractere.

Os primeiros 23 caracteres em um nome de cluster devem ser exclusivos em um projeto.

Não inclua informações confidenciais no nome do cluster.

9
Fazer o check-out.
Clique em Criar Cluster abaixo do formulário e preencha as informações de cobrança
somente se elas ainda não existirem. Se sua organização já tiver as informações de
cobrança, o Atlas implantará seu cluster.

10
Opcional: atualize os detalhes do seu endereço de cobrança conforme necessário.
Campo
Necessidade
Ação
Endereço de e-mail de cobrança
Opcional
Digite o endereço de e-mail para o qual o Atlas deve enviar alertas de cobrança.

Por padrão, o Atlas envia alertas de cobrança aos proprietários da organização e aos
administradores de cobrança.

Se você deixar o endereço de e-mail de cobrança em branco, o Atlas enviará alertas de


cobrança aos proprietários da organização e aos administradores de cobrança.

Se você especificar um endereço de e-mail de cobrança e desmarcar Enviar somente


e-mails de fatura para o endereço de e-mail de cobrança, o Atlas enviará alertas de
cobrança para o endereço de e-mail de cobrança, proprietários da organização e
administradores de cobrança.

Se você especificar um endereço de e-mail de cobrança e marcar a caixa Enviar e-mails de


fatura somente para o endereço de e-mail de cobrança, o Atlas enviará alertas de cobrança
apenas para o endereço de e-mail de cobrança.

nome da empresa
Opcional
Digite o nome da empresa para seu endereço de cobrança.
País
Obrigatório
Selecione o país do seu endereço de cobrança. Você também pode começar a digitar o
nome do país e selecioná-lo na lista filtrada de países.
Endereço da Rua
Obrigatório
Digite o endereço do seu endereço de cobrança.
Apto/Suíte/Andar
Opcional
Digite o apartamento, suíte ou andar do seu endereço de cobrança.
Cidade
Obrigatório
Digite o nome da cidade do seu endereço de cobrança.
Estado / Província / Região
Obrigatório
Digite ou selecione a subdivisão política na qual existe seu endereço de cobrança. O rótulo
e o campo mudam dependendo do que você selecionou como país:

Se você selecionar Estados Unidos como seu país, esse rótulo mudará para Estado. O
campo muda para um menu suspenso de estados dos EUA. Você também pode começar a
digitar o nome do estado e selecioná-lo na lista filtrada de estados.

Se você selecionar Canadá como seu país, esse rótulo mudará para Província. O campo
muda para um menu suspenso de províncias canadenses. Você também pode começar a
digitar o nome da província e selecioná-la na lista filtrada de províncias.

Se você selecionar qualquer outro país como seu País, esse rótulo mudará para
Estado/Província/Região. O campo muda para uma caixa de texto. Digite o nome da sua
província, estado ou região nesta caixa.

CEP ou Código postal


Obrigatório
Digite o CEP (EUA) ou o Código Postal (outros países) do seu endereço de cobrança.
Número de IVA
Condicional
O Atlas exibe o campo ID do IVA se você selecionar um país que não seja os Estados
Unidos.

Para saber mais sobre o IVA, consulte ID do IVA.

Se o endereço de cobrança da sua empresa estiver em um país que não seja os Estados
Unidos (EUA), a Atlas normalmente cobrará IVA se você não inserir um número de
identificação de IVA válido em seu perfil de cobrança.

IMPORTANTE
Se o seu endereço de cobrança estiver na Irlanda ou em determinadas províncias
canadenses, a Atlas sempre cobrará IVA, mesmo com um número de identificação de IVA
válido.

Para saber mais sobre o IVA por região, consulte Uso e tributação internacional.

11
Opcional: atualize os detalhes da sua forma de pagamento conforme necessário.
Clique no botão de opção para cartão de crédito ou Paypal.

Se você selecionou Cartão de Crédito, digite valores para os seguintes campos:

Campo
Necessidade
Ação
Nome no cartão
Obrigatório
Digite o nome que aparece no seu cartão de crédito.
Número do cartão
Obrigatório
Digite o número de 16 dígitos que aparece no seu cartão de crédito. American Express usa
um número de 15 dígitos.
Data de validade
Obrigatório
Digite a data de vencimento do seu cartão de crédito no formato de mês de dois dígitos e
ano de dois dígitos.
CVC

Obrigatório
Digite o número de três dígitos no verso do seu cartão de crédito. American Express usa um
número de 4 dígitos encontrado na frente do cartão de crédito.
Se você selecionou PayPal:

Clique em Pagar com PayPal.

Conclua as ações no site do PayPal.

Todos os projetos da sua organização compartilham as mesmas configurações de


faturamento, incluindo a forma de pagamento.

12
Revise o custo do projeto.
Na seção Carrinho, revise o seguinte:

Campo
Descrição
Camada de cluster
Exibe o custo do nível de cluster selecionado e detalhes de configuração. Para saber mais,
consulte Provedor de Serviços de Nuvem e Região e Nível de Cluster.
Recursos incluídos
Exibe recursos incluídos na configuração de cluster selecionada.
Configurações adicionais
Exibe configurações adicionais que você ativou, como backups em nuvem, fragmentação,
Conector BI
, e mais. Para saber mais, consulte Backups na nuvem.
13
Implante seu cluster.
Clique em Confirmar e implantar cluster abaixo do formulário para implantar seu cluster.

IMPORTANTE
Cada projeto Atlas oferece suporte a até 25 implantações de banco de dados. Entre em
contato com o suporte do Atlas para tirar dúvidas ou receber assistência em relação ao
limite de implantação do banco de dados. Para entrar em contato com o suporte, selecione
Suporte na barra de navegação esquerda da UI do Atlas.

14
Fragmente uma coleção global.
Após a implantação, você deve configurar
chaves de fragmento
para o aglomerado. Para saber como fragmentar uma coleção para gravações globais,
consulte Fragmentar uma coleção global.

DICA
Veja também:
Gerenciar clusters globais
Provedores de nuvem e regiões
Nesta página

Provedores de nuvem e regiões para instâncias sem servidor


Provedores de nuvem e regiões para clusters compartilhados
A escolha do provedor de nuvem e da região afeta a latência da rede para clientes que
acessam a implantação do seu banco de dados e o custo de execução da implantação do
banco de dados. Para clusters, essa escolha também afeta as opções de configuração das
camadas de cluster disponíveis. A região refere-se à localização física da implantação do
seu banco de dados MongoDB.

Provedores de nuvem e regiões para instâncias sem servidor


O Atlas oferece suporte à implantação de instâncias sem servidor em todos os provedores
de nuvem, mas apenas em um subconjunto das regiões de cada provedor de nuvem. Para
obter uma lista de regiões que oferecem suporte a instâncias sem servidor, consulte:

Amazon Web Services (AWS)

Google Cloud Platform (GCP)

Microsoft Azure

Provedores de nuvem e regiões para clusters compartilhados


O Atlas oferece suporte à implantação de clusters gratuitos M0 e clusters compartilhados
M2/M5 em todos os provedores de nuvem, mas apenas em um subconjunto das regiões de
cada provedor de nuvem. Para obter uma lista de regiões que suportam clusters M0 ou
M2/M5, consulte:

Amazon Web Services (AWS)

Google Cloud Platform (GCP)

Microsoft Azure

Na página Criar novo cluster:

As regiões marcadas como ★ são regiões recomendadas que oferecem maior


disponibilidade em comparação com outras regiões.

As regiões marcadas como Camada compartilhada não estão disponíveis para clusters de
camada compartilhada e, portanto, aparecem esmaecidas. Estas regiões estão disponíveis
apenas para clusters dedicados.

Para mais informações, veja:

Regiões recomendadas pela AWS


Regiões recomendadas pelo GCP

Regiões recomendadas do Azure

DICA
Veja também:
Para obter mais informações sobre configurações multirregionais para maior
disponibilidade, consulte Configurar alta disponibilidade e isolamento de carga de trabalho.
Conecte-se a uma implantação de banco de
dados
Nesta página

Considerações
Pré-requisitos
Conecte-se à implantação do seu banco de dados em nuvem
Conecte-se a uma implantação local com o Atlas CLI
Solução de problemas
Considerações
A Atlas não garante que os nomes de host permaneçam consistentes em relação aos tipos
de nós durante alterações de topologia.

EXEMPLO
Se você tiver um cluster chamado foo123 contendo um nó analítico
foo123-shard-00-03-a1b2c.mongodb.net:27017, o Atlas não garante que o nome do host
específico continuará a se referir a um nó analítico após uma alteração de topologia, como
dimensionar um cluster para modificar seu número de nós ou regiões.

Melhore o desempenho da conexão para clusters fragmentados atrás de um endpoint


privado
O Atlas pode gerar uma cadeia de conexão SRV otimizada para clusters fragmentados
usando os balanceadores de carga do seu serviço de endpoint privado. Quando você usa
uma cadeia de conexão otimizada, o Atlas limita o número de conexões por mongos entre
seu aplicativo e seu cluster fragmentado. As conexões limitadas por mongos melhoram o
desempenho durante picos na contagem de conexões.

OBSERVAÇÃO
O Atlas não oferece suporte a cadeias de conexão otimizadas para clusters executados no
Google Cloud ou no Azure.

Para usar uma cadeia de conexão otimizada, você deve atender a todos os critérios a
seguir:

Configure um cluster fragmentado.

Certifique-se de que o cluster fragmentado seja executado na AWS.

Certifique-se de que o cluster fragmentado execute o MongoDB versão 5.0 ou posterior. Se


o seu cluster executa atualmente uma versão anterior do MongoDB, atualize a versão do
MongoDB do cluster para a versão 5.0 ou posterior para usar uma cadeia de conexão SRV
otimizada.

Configure um ponto final privado para o seu cluster.

Use:
Um cluster de região única ou

Um cluster multirregional com endpoints privados regionalizados habilitados. Somente as


regiões da AWS em um cluster multirregional oferecem suporte a uma string de conexão
SRV otimizada.

O Atlas não dá suporte a conexões otimizadas para clusters multirregionais usando um


único registro SRV.

Conecte-se usando um dos seguintes métodos:

Conecte-se usando um driver que atenda ou exceda a versão mínima do driver para
conexões otimizadas.

Conecte-se usando a bússola.

Conecte-se usando o mongosh.

OBSERVAÇÃO
Se o seu cluster atender aos critérios para strings SRV otimizadas, o Atlas gerará uma
string de conexão SRV otimizada para você. Se o seu cluster já teve cadeias de conexão
herdadas, o Atlas mantém essas cadeias indefinidamente e inclui uma cadeia de conexão
SRV herdada quando você seleciona o tipo de conexão Private Endpoint. Considere mudar
para a conexão SRV otimizada para obter desempenho ideal e atualizar sua cadeia de
conexão onde quer que você a use.

Se você criar o cluster e habilitar pontos finais privados após o Atlas lançar esse recurso, o
Atlas exibirá a cadeia de conexão otimizada por padrão quando você selecionar o tipo de
conexão Ponto Final Privado. Você pode identificar uma cadeia de conexão otimizada
adicionando lb à cadeia de conexão, conforme mostrado no exemplo a seguir:

mongodb+SRV://Usuário1:P@ssword@cluster0-pl-0-lb.oq123.mongodb-dev.net/

Para desabilitar cadeias de conexão otimizadas para clusters que não têm a opção
Conexão SRV herdada, entre em contato com o suporte.

Use strings de conexão otimizadas com um driver


Para saber como se conectar usando um driver e uma cadeia de conexão otimizada,
selecione a guia Private Endpoint Connection na seção
Conecte seu procedimento de inscrição.

Use strings de conexão otimizadas com o Compass


Para saber como se conectar usando o Compass e uma cadeia de conexão otimizada,
selecione a guia Private Endpoint Connection na seção
Conecte-se ao seu procedimento de implantação de banco de dados.

Use strings de conexão otimizadas com mongosh


Para saber como se conectar usando o mongosh e uma cadeia de conexão otimizada,
selecione a guia Private Endpoint Connection na seção
Conecte-se ao seu procedimento de implantação de banco de dados.

Pré-requisitos
Lista de acesso IP
Para acessar uma implantação de banco de dados, você deve se conectar a partir de um
endereço IP na lista de acesso IP do projeto Atlas. Se precisar adicionar um endereço IP à
lista de acesso IP, você poderá fazê-lo na caixa de diálogo Conectar. Você também pode
adicionar o endereço IP na guia Acesso à rede.

Usuário do banco de dados


Para acessar uma implantação de banco de dados, você deve criar um
usuário do banco de dados
com acesso aos bancos de dados desejados em sua implantação de banco de dados
Atlas. Os usuários do banco de dados são separados dos usuários do Atlas. Os usuários do
banco de dados têm acesso aos bancos de dados MongoDB, enquanto os usuários do Atlas
têm acesso ao próprio aplicativo Atlas.

Você pode criar um usuário de banco de dados para acessar a implantação do banco de
dados Atlas na caixa de diálogo Conectar. Também é possível incluir o usuário do banco de
dados na visualização Implementação do Banco de Dados.

Abra as portas 27015 a 27017 para acessar bancos de dados Atlas


Certifique-se de que seu aplicativo possa alcançar seu ambiente MongoDB Atlas. Para
adicionar o acesso à rede de entrada do seu ambiente de aplicativo ao Atlas, siga um
destes procedimentos:

Adicione os endereços IP públicos à sua lista de acesso IP

Use peering VPC/VNet para adicionar endereços IP privados.

Adicione pontos finais privados.

DICA
Veja também:
Lista de acesso IP

Se o seu firewall bloquear conexões de rede de saída, você também deverá abrir o acesso
de saída do ambiente do seu aplicativo para Atlas. Você deve configurar seu firewall para
permitir que seus aplicativos façam conexões de saída às portas 27015 a 27017 para
tráfego TCP em hosts Atlas. Isso concede aos seus aplicativos acesso aos bancos de
dados armazenados no Atlas.

OBSERVAÇÃO
Por padrão, os clusters MongoDB Atlas não precisam ser capazes de iniciar conexões com
seus ambientes de aplicativos. Se desejar habilitar clusters Atlas com autenticação e
autorização LDAP, você deverá permitir o acesso à rede dos clusters Atlas diretamente para
seu LDAP seguro. Você pode permitir o acesso ao seu LDAP usando IPs públicos ou
privados, desde que um nome de host DNS público aponte para um IP que os clusters Atlas
possam acessar.

Se você não estiver usando peering VPC/VNet e planeja se conectar ao Atlas usando
endereços IP públicos, consulte as páginas a seguir para obter informações adicionais:

Posso especificar meu próprio VPC para meu projeto MongoDB Atlas?

Os IPs públicos dos clusters Atlas mudam alguma vez?

Conecte-se à implantação do seu banco de dados em nuvem


Para se conectar à implantação do seu banco de dados, você deve obter o código da sua
implantação
cadeia de conexão
. Depois de ter a cadeia de conexão, você poderá se conectar à sua implantação usando os
seguintes métodos de conexão:

Conecte-se através do seu aplicativo

Conecte-se via bússola

Conecte-se via mongosh

Conecte-se via código VS

OBSERVAÇÃO
Para conectar usando
mongodump
ou
mongorestore
, use a guia Ferramentas de linha de comando. A guia cria um modelo gerado
automaticamente para conectar-se à implantação do banco de dados Atlas com sua
ferramenta preferida.

Para obter a cadeia de conexão da sua implantação, você pode usar a CLI do Atlas ou a
interface do usuário do Atlas:

CLI do Atlas

IU do Atlas
Você pode usar a CLI do Atlas para obter a cadeia de conexão padrão da sua implantação.

Para retornar as strings de conexão SRV para seu cluster Atlas usando a CLI do Atlas,
execute o seguinte comando:

atlas clusters connectionStrings descrevem <clusterName> [opções]


Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do
Atlas CLI para
atlas clusters connectionStrings descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Por exemplo, se a CLI do Atlas retornar a seguinte string de conexão:

mongodb+srv://mycluster.abcd1.mongodb.net

Você pode se conectar à sua implantação usando o seguinte comando:

mongosh "mongodb+srv://mycluster.abcd1.mongodb.net/myFirstDatabase" --apiVersion 1


--username <username>

OBSERVAÇÃO
Para se conectar com êxito ao Atlas, você deve adicionar seu nome de usuário e nome do
banco de dados à cadeia de conexão. Em alguns casos, como quando você está usando
mangusto do terminal, o Atlas solicita que você insira a senha do usuário do banco de
dados.

Conecte-se a uma implantação local com o Atlas CLI


Para se conectar a uma implantação do Atlas usando a CLI do Atlas, execute o seguinte
comando:

atlas deployments connect [deploymentName] [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
As implantações do Atlas se conectam.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas
Conecte-se à CLI do Atlas

Solução de problemas
Se você estiver enfrentando problemas para se conectar à implantação do seu banco de
dados, consulte Solucionar problemas de conexão.

DICA
Veja também:
Conecte-se através do seu aplicativo

Conecte-se via bússola

Conecte-se via mongosh

Conecte-se via BI Connector para Atlas

Navegue pelos dados por meio da interface do Atlas

Testar failover primário

Gerenciar conexões com AWS Lambda

Limites de conexão e nível de cluster

Conecte-se via código VS


Conecte-se através do seu aplicativo
selecione sua lingua

Node.js
Nesta página

Pré-requisitos
Conecte seu aplicativo
Exemplos de motoristas
Solução de problemas
A caixa de diálogo Conectar para uma implantação de banco de dados fornece os detalhes
para conectar-se a uma implantação de banco de dados com um aplicativo usando um
Driver MongoDB.

OBSERVAÇÃO
No momento, as instâncias sem servidor não oferecem suporte à conexão por meio de
determinados drivers ou versões de driver. Para saber mais, consulte Limitações de
instância sem servidor.

➤ Use o menu suspenso Selecione seu idioma para definir o idioma do exemplo nesta
página.

Pré-requisitos
Versão do driver
A versão do seu driver deve ser compatível com a sua versão do servidor MongoDB.
Recomendamos escolher o driver mais recente compatível com a versão do servidor
MongoDB para usar os recursos de banco de dados mais recentes e se preparar para
futuras atualizações de versão.

Para obter uma lista de versões de driver que contêm o conjunto completo de
funcionalidades para sua versão do servidor MongoDB, verifique a matriz de
compatibilidade do seu
Driver MongoDB.

Para obter uma lista de versões de driver que você pode usar para se conectar a instâncias
sem servidor, consulte Versões mínimas de driver para instâncias sem servidor.

IMPORTANTE
Quando você atualiza a versão do driver, alguns comandos, métodos ou opções podem
ficar obsoletos e removidos. Verifique o seu
Driver MongoDB
Documentação da API para garantir uma transição tranquila.

Os aplicativos executados com drivers da série 4.0 funcionarão com implantações de banco
de dados MongoDB executando o MongoDB 4.4, desde que:
Os drivers recomendados para o MongoDB 4.4 nas matrizes de compatibilidade de driver
são testados no MongoDB 4.4. Verifica a
Página de documentação do driver MongoDB
para a matriz de compatibilidade de driver para o seu idioma.

Nenhuma funcionalidade nova para


MongoDB 4.2
, ou
MongoDB 4.4
está sendo usado e

Nenhum comando, método ou opção removido em


MongoDB 4.2
(incluindo db.collection.geoNear(), db.collection.group() e db.eval()), ou
MongoDB 4.4
estão sendo usados, e

Outro
mudanças de compatibilidade no MongoDB 4.4
para projeções (incluindo projeções $slice), $sort, pesquisa de texto e mapReduce não os
afetam.

Recomendamos o uso de drivers da série MongoDB 4.4 com o MongoDB 4.4 para usar
recursos de banco de dados mais recentes e se preparar para futuras atualizações de
versão.

Strings de conexão otimizadas para clusters fragmentados atrás de um endpoint privado


Para se conectar ao cluster fragmentado usando um driver e uma cadeia de conexão
otimizada, você deve usar pelo menos uma das seguintes versões de driver:

Motorista
Versão
C
1.19.0
C++
3.7.0beta1
C#
2.13.0
Ir
1.6.0
Java
4.3.0
Kotlin
4.10.0
Motor
2.5.0
Node.js
4.1.0
PHP
1.11.0 (Extensão)
1.10.0 (Biblioteca)
PyMongo
3.12.0
Rubi
2.16.0
Ferrugem
2.1.0
escala
4.3.0
Rápido
1.2.0
TLS
Os clientes devem suportar TLS para se conectarem a uma implantação de banco de dados
Atlas.

Os clientes devem apoiar o


SNI
Extensão TLS para conectar-se a um cluster gratuito Atlas M0 ou cluster compartilhado
M2/M5. Para verificar se o seu Driver MongoDB
suporta a extensão SNI TLS, consulte a seção Compatibilidade da documentação do seu
driver. Se o driver for compatível com MongoDB 4.2 e posterior, ele suportará a extensão
SNI TLS.

Lista de acesso IP
Para acessar uma implantação de banco de dados, você deve se conectar a partir de um
endereço IP na lista de acesso IP do projeto Atlas. Se precisar adicionar um endereço IP à
lista de acesso IP, você poderá fazê-lo na caixa de diálogo Conectar. Você também pode
adicionar o endereço IP na guia Acesso à rede.

Usuário do banco de dados


Para acessar uma implantação de banco de dados, você deve criar um
usuário do banco de dados
com acesso aos bancos de dados desejados em sua implantação de banco de dados
Atlas. Os usuários do banco de dados são separados dos usuários do Atlas. Os usuários do
banco de dados têm acesso aos bancos de dados MongoDB, enquanto os usuários do Atlas
têm acesso ao próprio aplicativo Atlas.

Você pode criar um usuário de banco de dados para acessar a implantação do banco de
dados Atlas na caixa de diálogo Conectar. Também é possível incluir o usuário do banco de
dados na visualização Implementação do Banco de Dados.

Conecte seu aplicativo


1
Na UI do Atlas, selecione sua implantação de banco de dados.
Clique em Banco de dados no canto superior esquerdo do Atlas.
Na visualização Implementações de Banco de Dados, clique em Conectar para a
implementação de banco de dados à qual deseja se conectar.

2
Escolha sua segurança de conexão.
Escolha Tipo de conexão no conjunto de botões disponíveis.

OBSERVAÇÃO
Opções são exibidas se o recurso estiver ativado
O Atlas exibe as opções de tipo de conexão depois que você habilita o IP privado para
peering, ponto final privado ou ambos. Se você não tiver habilitado nenhum dos recursos,
nenhum botão será exibido e o Tipo de conexão será padronizado como Padrão.

Conexão Padrão

IP privado para peering

Conexão de endpoint privado


Use este tipo de conexão para endereços IP públicos permitidos.

3
Escolha como você deseja limitar as conexões à implantação do seu banco de dados.
Adicionar um endereço IP de conexão

IMPORTANTE
Ignore esta etapa se o Atlas indicar na etapa Configurar segurança da conexão que você já
configurou uma entrada da lista de acesso IP na implantação do seu banco de dados. Para
gerenciar a lista de acesso IP, consulte Adicionar entradas à lista de acesso.

O Atlas permite conexões de clientes padrão para a implantação do banco de dados a partir
de entradas na lista de acesso IP do projeto. A lista de acesso IP do projeto difere da API
lista de acesso, que restringe o acesso da API a endereços IP ou CIDR específicos.

Se a lista de acesso IP estiver vazia, o Atlas solicitará que você adicione um endereço IP à
lista de acesso IP do projeto. Você também pode:

Clique em Adicionar seu endereço IP atual para permitir o acesso a partir do seu endereço
IP atual.

Clique em Adicionar um endereço IP para adicionar um único endereço IP ou um intervalo


de endereços com notação CIDR.

Forneça uma descrição opcional para o endereço IP ou intervalo CIDR recém-adicionado.


Clique em Adicionar endereço IP para adicionar o endereço à lista de acesso IP.

4
Crie um usuário de banco de dados.
IMPORTANTE
Pule esta etapa se o Atlas indicar na etapa Configurar segurança da conexão que você tem
pelo menos um usuário de banco de dados configurado em seu projeto. Para gerenciar
usuários de banco de dados existentes, consulte Configurar usuários de banco de dados.

Para acessar a implantação do banco de dados, você precisa de um usuário MongoDB com
acesso ao banco de dados desejado ou aos bancos de dados na implantação do banco de
dados em seu projeto. Se o seu projeto não tiver usuários MongoDB, o Atlas solicitará que
você crie um novo usuário com a função Atlas Admin.

Insira o nome de usuário do novo usuário.

Insira uma senha para esse novo usuário ou clique em Gerar senha segura
automaticamente.

Clique em Criar usuário do banco de dados para salvar o usuário.

Use esse usuário para se conectar à implantação do seu banco de dados na etapa a seguir.

Depois de adicionar um endereço IP à sua lista de acesso IP e adicionar um usuário do


banco de dados, clique em Escolher seu método de conexão.

5
Selecione Conecte seu aplicativo.
Na etapa Escolha um método de conexão, selecione Conecte seu aplicativo.

6
Selecione seu driver e versão.
Selecione seu driver e versão nos menus suspensos. O exemplo de código contendo uma
cadeia de conexão é exibido. Substitua <password> pela senha especificada quando você
criou o usuário do banco de dados.

OBSERVAÇÃO
Se suas senhas, nomes de bancos de dados ou cadeias de conexão contiverem caracteres
de URI reservados, você deverá escapar dos caracteres. Por exemplo, se sua senha for
@bc123, você deverá escapar do caractere @ ao especificar a senha na cadeia de
conexão, como %40bc123. Para saber mais, consulte Caracteres especiais na senha da
string de conexão.

Para saber mais, consulte


Compatibilidade de drivers.

Exemplos de driver
No exemplo a seguir, você autentica e se conecta a uma implantação de banco de dados
Atlas usando uma Cadeia de conexão URI
. Substitua os espaços reservados no exemplo pelas suas credenciais e detalhes de
implantação.
OBSERVAÇÃO
Para se conectar a um cluster gratuito Atlas M0 ou cluster compartilhado M2/M5, você deve
usar uma versão do driver Node.js que suporte MongoDB 4.0 e posterior. Para obter
documentação completa sobre compatibilidade entre o driver Node.js e o MongoDB,
consulte o
Matriz de compatibilidade do MongoDB
. Recomendamos que você atualize para a versão mais recente do driver.

import mongodb from 'mongodb';

const MongoClient = mongodb.MongoClient;


const uri =
"mongodb+srv://<username>:<password>@<clusterName>.mongodb.net/?retryWrites=tru
e&w=majority";
const client = new MongoClient(uri, { useNewUrlParser: true });
client.connect(err => {
const collection = client.db("<databaseName>").collection("<collectionName>");
// perform actions on the collection object
client.close();
});

Node.js

Para se conectar a um banco de dados diferente de admin, mas ainda assim autenticar no
banco de dados admin, atualize o componente de banco de dados da cadeia de conexão.

mongodb://username:password@host1:port1,...,hostN:portN/database?authSource=admi
n&...

Node.js

EXEMPLO
A cadeia de conexão a seguir especifica o componente de implantação e teste do banco de
dados cluster0 e inclui a opção authSource=admin.

var uriTestDb =
"mongodb+srv://<username>:<password>@cluster0.mongodb.net/test?ssl=true&authSour
ce=admin&w=majority";
MongoClient.connect(uriTestDb, function(err, db) {
db.close();
});
Node.js

Versão do MongoDB
Versões de driver recomendadas
Todos
Veja o
Matriz de compatibilidade do MongoDB
para obter as versões de driver recomendadas mais recentes.
MongoDB 4.4 e posterior
Versão 3.1 e posterior
Solução de problemas
Se você estiver enfrentando problemas para se conectar à implantação do seu banco de
dados, consulte Solucionar problemas de conexão.

DICA
Veja também:
Limites de conexão e nível de cluster
Conecte-se via bússola
Nesta página

Pré-requisitos
Conecte-se à implantação do seu banco de dados
Solução de problemas
A caixa de diálogo Conectar para uma implantação de banco de dados fornece os detalhes
para conectar-se a uma implantação de banco de dados usando
Bússola.

Pré-requisitos
TLS
Use o MongoDB Compass 1.5 ou posterior para conectar-se às implantações de banco de
dados Atlas. Essas versões suportam a extensão SNI TLS necessária.

Bússola MongoDB
Para concluir este procedimento, siga um destes procedimentos:

Instale a bússola do MongoDB. Ver


Instalação da bússola.

Atualize para a versão mais recente do MongoDB Compass baixando o MongoDB Compass
nos links da caixa de diálogo Atlas Connect. Para acessar esses links, clique em Conectar
para a implantação de banco de dados à qual deseja se conectar e, em seguida, clique em
Conectar com o MongoDB Compass.

Lista de acesso IP
Para acessar uma implantação de banco de dados, você deve se conectar a partir de um
endereço IP na lista de acesso IP do projeto Atlas. Se precisar adicionar um endereço IP à
lista de acesso IP, você poderá fazê-lo na caixa de diálogo Conectar. Você também pode
adicionar o endereço IP na guia Acesso à rede.

Usuário do banco de dados


Para acessar uma implantação de banco de dados, você deve criar um
usuário do banco de dados
com acesso aos bancos de dados desejados em sua implantação de banco de dados
Atlas. Os usuários do banco de dados são separados dos usuários do Atlas. Os usuários do
banco de dados têm acesso aos bancos de dados MongoDB, enquanto os usuários do Atlas
têm acesso ao próprio aplicativo Atlas.

Você pode criar um usuário de banco de dados para acessar a implantação do banco de
dados Atlas na caixa de diálogo Conectar. Também é possível incluir o usuário do banco de
dados na visualização Implementação do Banco de Dados.

Conecte-se à implantação do seu banco de dados


Bússola 1.8 e posterior

Bússola 1.7 ou anterior


Use o procedimento a seguir para conectar o MongoDB Compass 1.8 ou versões
posteriores à implantação do banco de dados Atlas.

1
Na UI do Atlas, selecione sua implantação de banco de dados.
Clique em Banco de dados no canto superior esquerdo do Atlas.

Na visualização Implementações de Banco de Dados, clique em Conectar para a


implementação de banco de dados à qual deseja se conectar.

2
Escolha sua segurança de conexão.
Escolha Tipo de conexão no conjunto de botões disponíveis.

OBSERVAÇÃO
Opções são exibidas se o recurso estiver ativado
O Atlas exibe as opções de tipo de conexão depois que você habilita o IP privado para
peering, ponto final privado ou ambos. Se você não tiver habilitado nenhum dos recursos,
nenhum botão será exibido e o Tipo de conexão será padronizado como Padrão.

Conexão Padrão

IP privado para peering

Conexão de endpoint privado


Use este tipo de conexão para endereços IP públicos permitidos.

3
Escolha como você deseja limitar as conexões à implantação do seu banco de dados.
Adicionar um endereço IP de conexão

IMPORTANTE
Ignore esta etapa se o Atlas indicar na etapa Configurar segurança da conexão que você já
configurou uma entrada da lista de acesso IP na implantação do seu banco de dados. Para
gerenciar a lista de acesso IP, consulte Adicionar entradas à lista de acesso.

O Atlas permite conexões de clientes padrão para a implantação do banco de dados a partir
de entradas na lista de acesso IP do projeto. A lista de acesso IP do projeto difere da lista
de acesso API, que restringe o acesso API a endereços IP ou CIDR específicos.

Se a lista de acesso IP estiver vazia, o Atlas solicitará que você adicione um endereço IP à
lista de acesso IP do projeto. Você também pode:
Clique em Adicionar seu endereço IP atual para permitir o acesso a partir do seu endereço
IP atual.

Clique em Adicionar um endereço IP para adicionar um único endereço IP ou um intervalo


de endereços com notação CIDR.

Forneça uma descrição opcional para o endereço IP ou intervalo CIDR recém-adicionado.


Clique em Adicionar endereço IP para adicionar o endereço à lista de acesso IP.

4
Crie um usuário de banco de dados.
IMPORTANTE
Pule esta etapa se o Atlas indicar na etapa Configurar segurança da conexão que você tem
pelo menos um usuário de banco de dados configurado em seu projeto. Para gerenciar
usuários de banco de dados existentes, consulte Configurar usuários de banco de dados.

Para acessar a implantação do banco de dados, você precisa de um usuário MongoDB com
acesso ao banco de dados desejado ou aos bancos de dados na implantação do banco de
dados em seu projeto. Se o seu projeto não tiver usuários MongoDB, o Atlas solicitará que
você crie um novo usuário com a função Atlas Admin.

Insira o nome de usuário do novo usuário.

Insira uma senha para esse novo usuário ou clique em Gerar senha segura
automaticamente.

Clique em Criar usuário do banco de dados para salvar o usuário.

Use esse usuário para se conectar à implantação do seu banco de dados na etapa a seguir.

Depois de adicionar um endereço IP à sua lista de acesso IP e adicionar um usuário do


banco de dados, clique em Escolher seu método de conexão.

5
Obtenha a string de conexão para MongoDB Compass do Atlas.
Clique em Tenho o MongoDB Compass.

Escolha sua versão do MongoDB Compass no menu suspenso. Para verificar a versão do
MongoDB Compass que você instalou em seu sistema, clique em Sobre o MongoDB
Compass no aplicativo.

Copie a cadeia de conexão apresentada na caixa de diálogo Atlas Connect.

6
Abra o MongoDB Compass e conecte-se ao Atlas.

Colar string de conexão


Preencha os campos de conexão individualmente
Use a cadeia de conexão copiada para conectar-se ao MongoDB Compass se sua
implantação usar um único provedor de nuvem ou não usar nenhum dos seguintes: SSL,
certificados de autenticação ou um túnel SSH.

Clique em Nova conexão e cole a cadeia de conexão no campo Colar sua cadeia de
conexão.

(opcional) Para salvar esta conexão para uso futuro, clique em Criar favorito e adicione um
nome para esta conexão. Você pode encontrar conexões favoritas salvas em Favoritos no
painel esquerdo da janela do MongoDB Compass Connect.

Clique em Conectar.

Solução de problemas
Se você estiver enfrentando problemas para se conectar à implantação do seu banco de
dados, consulte Solucionar problemas de conexão.
Conecte-se via mongosh
Nesta página

Pré-requisitos
Conecte-se à implantação do seu banco de dados
Solução de problemas
A caixa de diálogo Conectar para uma implantação de banco de dados fornece os detalhes
para conectar-se a uma implantação de banco de dados por meio do shell do MongoDB,
mangusto.

Pré-requisitos
TLS
Os clientes devem suportar TLS para se conectarem a uma implantação de banco de dados
Atlas.

Os clientes devem apoiar o


SNI
Extensão TLS para conectar-se a um cluster gratuito Atlas M0 ou um cluster compartilhado
M2/M5. MongoDB 4.0 e shell posterior suportam a extensão SNI TLS.

Lista de acesso IP
Para acessar uma implantação de banco de dados, você deve se conectar a partir de um
endereço IP na lista de acesso IP do projeto Atlas. Se precisar adicionar um endereço IP à
lista de acesso IP, você poderá fazê-lo na caixa de diálogo Conectar. Você também pode
adicionar o endereço IP na guia Acesso à rede.

Usuário do banco de dados


Para acessar uma implantação de banco de dados, você deve criar um
usuário do banco de dados
com acesso aos bancos de dados desejados em sua implantação de banco de dados
Atlas. Os usuários do banco de dados são separados dos usuários do Atlas. Os usuários do
banco de dados têm acesso aos bancos de dados MongoDB, enquanto os usuários do Atlas
têm acesso ao próprio aplicativo Atlas.

Você pode criar um usuário de banco de dados para acessar a implantação do banco de
dados Atlas na caixa de diálogo Conectar. Também é possível incluir o usuário do banco de
dados na visualização Implementação do Banco de Dados.

Conecte-se à implantação do seu banco de dados


1
Na UI do Atlas, selecione sua implantação de banco de dados.
Clique em Banco de dados no canto superior esquerdo do Atlas.

Na visualização Implementações de Banco de Dados, clique em Conectar para a


implementação de banco de dados à qual deseja se conectar.
2
Escolha sua segurança de conexão.
Escolha Tipo de conexão no conjunto de botões disponíveis.

OBSERVAÇÃO
Opções são exibidas se o recurso estiver ativado
O Atlas exibe as opções de tipo de conexão depois que você habilita o IP privado para
peering, ponto final privado ou ambos. Se você não tiver habilitado nenhum dos recursos,
nenhum botão será exibido e o Tipo de conexão será padronizado como Padrão.

Conexão Padrão

IP privado para peering

Conexão de endpoint privado


Use este tipo de conexão para endereços IP públicos permitidos.

3
Escolha como você deseja limitar as conexões à implantação do seu banco de dados.
Adicionar um endereço IP de conexão

IMPORTANTE
Ignore esta etapa se o Atlas indicar na etapa Configurar segurança da conexão que você já
configurou uma entrada da lista de acesso IP na implantação do seu banco de dados. Para
gerenciar a lista de acesso IP, consulte Adicionar entradas à lista de acesso.

O Atlas permite conexões de clientes padrão para a implantação do banco de dados a partir
de entradas na lista de acesso IP do projeto. A lista de acesso IP do projeto difere da lista
de acesso API, que restringe o acesso API a endereços IP ou CIDR específicos.

Se a lista de acesso IP estiver vazia, o Atlas solicitará que você adicione um endereço IP à
lista de acesso IP do projeto. Você também pode:

Clique em Adicionar seu endereço IP atual para permitir o acesso a partir do seu endereço
IP atual.

Clique em Adicionar um endereço IP para adicionar um único endereço IP ou um intervalo


de endereços com notação CIDR.

Forneça uma descrição opcional para o endereço IP ou intervalo CIDR recém-adicionado.


Clique em Adicionar endereço IP para adicionar o endereço à lista de acesso IP.

4
Crie um usuário de banco de dados.
IMPORTANTE
Pule esta etapa se o Atlas indicar na etapa Configurar segurança da conexão que você tem
pelo menos um usuário de banco de dados configurado em seu projeto. Para gerenciar
usuários de banco de dados existentes, consulte Configurar usuários de banco de dados.

Para acessar a implantação do banco de dados, você precisa de um usuário MongoDB com
acesso ao banco de dados desejado ou aos bancos de dados na implantação do banco de
dados em seu projeto. Se o seu projeto não tiver usuários MongoDB, o Atlas solicitará que
você crie um novo usuário com a função Atlas Admin.

Insira o nome de usuário do novo usuário.

Insira uma senha para esse novo usuário ou clique em Gerar senha segura
automaticamente.

Clique em Criar usuário do banco de dados para salvar o usuário.

Use esse usuário para se conectar à implantação do seu banco de dados na etapa a seguir.

Depois de adicionar um endereço IP à sua lista de acesso IP e adicionar um usuário do


banco de dados, clique em Escolher seu método de conexão.

5
Conecte-se à implantação do seu banco de dados Atlas com
mangusto
.
Selecione Conectar-se ao Shell do MongoDB.

A próxima tela oferece opções para prosseguir com base se você já possui ou não
mangusto
instalado em seu sistema.

Não tenho o MongoDB Shell instalado

Eu tenho o MongoDB Shell instalado


Selecione seu sistema operacional no menu suspenso.

janelas

Mac OS

Linux
Baixe usando uma das seguintes opções:

Clique em Baixar mongosh para iniciar o download.


Clique em Copiar URL de download para copiar um URL de download para sua área de
transferência e:

Use curl para buscar o arquivo do instalador no URL ou

Cole o URL em uma janela do navegador.

Baixe o instalador do
Shell do MongoDB
página.

Extraia os arquivos do arquivo baixado.

Adicione o
mangusto
binário para sua variável de ambiente PATH.

Certifique-se de que o binário extraído do MongoDB Shell esteja no local desejado em seu
sistema de arquivos e adicione esse local à sua variável de ambiente PATH.

Abra o Painel de Controle.

Na categoria Sistema e Segurança, clique em Sistema.

Clique em Configurações avançadas do sistema. O modal Propriedades do sistema é


exibido.

Clique em Variáveis de ambiente.

Selecione Caminho e clique em Editar.

Clique em Novo a e adicione o caminho do arquivo ao seu


mangusto
binário.

A etapa 3 do modal Atlas exibe uma string de conexão copiável. Essa string inclui o nome
do usuário MongoDB que pode autenticar com a implantação do banco de dados. Copie
esta sequência. Para se conectar como um usuário diferente do MongoDB, altere o
--nome de usuário
opção.

Cole o
mangusto
comando e string de conexão em um terminal. Execute o comando. O shell solicita o
senha.

OBSERVAÇÃO
Se o dispositivo de entrada não for um terminal,
mangusto
não solicita uma senha. Em vez de,
mangusto
interpreta qualquer entrada no stdin após a string de conexão como uma senha.

Solução de problemas
Se você estiver enfrentando problemas para se conectar à implantação do seu banco de
dados, consulte Solucionar problemas de conexão.
Conecte-se via BI Connector para Atlas
Nesta página

Considerações sobre clusters multinuvem


IMPORTANTE
Recurso indisponível em instâncias sem servidor
As instâncias sem servidor não oferecem suporte a esse recurso no momento. Para saber
mais, consulte Limitações de instância sem servidor.

É possível ativar o BI Connector for Atlas ao criar ou dimensionar um cluster M10 ou maior.

OBSERVAÇÃO
O Conector MongoDB para Business Intelligence para Atlas (
Conector BI
) está disponível apenas para clusters M10 e maiores.

O BI Connector é uma ferramenta poderosa que fornece aos usuários acesso baseado em
SQL aos seus bancos de dados MongoDB. Como resultado, o BI Connector executa
operações que podem consumir muita CPU e memória. Dados os recursos de hardware
limitados nas camadas de cluster M10 e M20, você poderá enfrentar degradação do
desempenho do cluster ao ativar o BI Connector. Se isso ocorrer, atualize para um cluster
M30 ou maior ou desative o BI Connector.

Para se conectar ao BI Connector para Atlas:

1
Clique no botão Conectar do seu cluster.

2
Selecione Conexão padrão e clique em Escolha um método de conexão.

3
Clique em Conectar sua ferramenta de Business Intelligence e use as informações de
conexão fornecidas para conectar-se à sua ferramenta de BI.

Para obter mais informações sobre como se conectar ao BI Connector for Atlas, consulte
Tutoriais de conexão.

O Conector MongoDB para Business Intelligence para Atlas (


Conector BI
) está disponível apenas para clusters M10 e maiores.

O BI Connector é uma ferramenta poderosa que fornece aos usuários acesso baseado em
SQL aos seus bancos de dados MongoDB. Como resultado, o BI Connector executa
operações que podem consumir muita CPU e memória. Dados os recursos de hardware
limitados nas camadas de cluster M10 e M20, você poderá enfrentar degradação do
desempenho do cluster ao ativar o BI Connector. Se isso ocorrer, atualize para um cluster
M30 ou maior ou desative o BI Connector.

Considerações sobre clusters multinuvem


Se você tiver um cluster multinuvem, a cadeia de conexão do BI Connector poderá incluir o
tipo de provedor de nuvem (.gcp ou .azure). No caso de um failover em que os nós de um
provedor de nuvem falham e as solicitações são roteadas para nós em outro provedor de
nuvem, a cadeia de conexão do BI Connector pode mudar.

Para mitigar esse risco, adicione nós de análise a clusters implantados apenas em um
provedor de nuvem e defina a preferência de leitura do BI Connector como Análise. Isso
garante que sua cadeia de conexão permaneça constante.

Tutoriais de conexão
Use as informações exibidas para conectar-se a partir de vários clientes usando o BI
Connector for Atlas:

Crie um DSN de sistema

Conecte-se a partir do Excel

Conectar-se pelo Tableau Desktop

Conecte-se a partir do Qlik Sense

Conecte-se a partir do MySQL Workbench

Conectar-se pelo Power BI Desktop (Windows)

Referência Adicional
Para obter mais informações sobre o Conector MongoDB para Business Intelligence,
consulte
Manual do Conector MongoDB para BI
.
Crie um DSN de sistema
Nesta página

Pré-requisitos
Procedimento
IMPORTANTE
Recurso indisponível em instâncias sem servidor
As instâncias sem servidor não oferecem suporte a esse recurso no momento. Para saber
mais, consulte Limitações de instância sem servidor.

As etapas a seguir descrevem como criar um nome de fonte de dados (DSN) do sistema
para o BI Connector for Atlas. Um DSN é uma configuração salva que descreve uma
conexão de banco de dados a ser usada por um driver ODBC. Depois que o DSN for criado,
você poderá configurar uma ampla variedade de clientes SQL e ferramentas de BI para usar
o DSN e importar dados do MongoDB.

janelas

Mac OS
Pré-requisitos
Antes de criar um DSN, você deve:

Baixar e instalar
Visual C++ redistribuível para Visual Studio 2015

Baixe e instale o
Driver MongoDB ODBC para conector BI
para sua plataforma.

Procedimento
1
Inicie o programa Fontes de dados ODBC da Microsoft.
Escolha a versão do programa (64 bits ou 32 bits) apropriada para o seu sistema e versão
do driver ODBC.

2
Selecione DSN do sistema e clique em Adicionar.
3
Selecione um driver MongoDB ODBC na lista de drivers disponíveis.
Selecione o driver MongoDB ODBC ANSI ou o driver MongoDB ODBC Unicode e clique em
OK.

OBSERVAÇÃO
Os conectores/ODBC ANSI oferecem melhor desempenho, mas possuem um conjunto de
caracteres limitado. Conectores/ODBC Unicode suportam um conjunto de caracteres mais
amplo, mas podem ter menos desempenho.

4
Preencha os campos necessários do formulário.
Clique no botão Detalhes para expor a metade inferior do formulário.

Os seguintes campos do formulário são obrigatórios:

Nome do campo
Descrição
Nome da fonte de dados
Um nome à sua escolha.
Servidor TCP/IP
O nome do host especificado na caixa de diálogo de conexão do Atlas.
Porta
A IANA
número da porta
especificado na caixa de diálogo de conexão do Atlas. O padrão é 27015.
Base de dados
O nome do banco de dados ao qual você deseja se conectar.
Do utilizador
Insira o usuário especificado na caixa de diálogo de conexão do Atlas ou outro usuário do
banco de dados com acesso ao banco de dados.

O usuário é especificado no seguinte formato:

<nome de usuário>?source=<nome do banco de dados>

onde <database-name> é o banco de dados de autenticação do usuário. Se admin for o


banco de dados de autenticação, você poderá omitir ?source=<database-name>.

Se você estiver usando a autenticação de nome de usuário e senha (SCRAM-SHA-256), o


banco de dados de autenticação esperado será admin.

Se você estiver usando autenticação LDAP (PLAIN), o banco de dados de autenticação


esperado é $external:

EXEMPLO
meuTestUser?source=$externo

Senha
A senha que corresponde ao usuário especificado.
5
Clique em Testar para validar a conexão ODBC.
Se a conexão for bem-sucedida, clique em OK para adicionar o DSN. Se a conexão falhar,
verifique se o usuário do banco de dados está autenticado corretamente para o banco de
dados nomeado na conexão.
Conecte-se a partir do Excel
IMPORTANTE
Recurso indisponível em instâncias sem servidor
As instâncias sem servidor não oferecem suporte a esse recurso no momento. Para saber
mais, consulte Limitações de instância sem servidor.

Para clusters M10+ que ativaram o BI Connector for Atlas, a caixa de diálogo Conectar
fornece os detalhes para conexão por meio do BI Connector for Atlas.

Para se conectar ao BI Connector para Atlas:

1
Clique no botão Conectar do seu cluster.

2
Selecione Conexão padrão e clique em Escolha um método de conexão.

3
Clique em Conectar sua ferramenta de Business Intelligence e use as informações de
conexão fornecidas para conectar-se à sua ferramenta de BI.

Para obter mais informações sobre como conectar-se ao BI Connector for Atlas, consulte
Tutoriais de conexão.

Pré-requisitos

janelas

Mac OS
Aglomerado Atlas com
Conector BI para Atlas
habilitado

Crie um nome de fonte de dados (DSN) do sistema

Conecte-se a partir do Microsoft Excel

janelas

Mac OS
1
Inicie o Microsoft Excel.
Inicie o Microsoft Excel e abra uma planilha em branco.

2
Use o Assistente de Conexão de Dados para configurar a conexão.
Clique na guia Dados.

Selecione De outras fontes >

Da opção Assistente de conexão de dados.

Selecione ODBC DSN na lista de opções de origem de dados e clique em Avançar.

Selecione o DSN criado para seu cluster Atlas e clique em Avançar.

Selecione um banco de dados e uma coleção dos quais deseja importar dados e clique em
Avançar.

Salve o arquivo de conexão de dados e clique em Concluir.

Se desejar reutilizar esta conexão no futuro, você pode selecioná-la no menu Dados > Obter
dados externos > Conexões existentes.

Na janela final do assistente, especifique um formato para sua planilha. Clique em OK


quando terminar.

Referência Adicional
Para obter mais informações sobre o Conector MongoDB para Business Intelligence,
consulte
Manual do Conector MongoDB para BI
.
Conectar-se pelo Tableau Desktop
IMPORTANTE
Recurso indisponível em instâncias sem servidor
As instâncias sem servidor não oferecem suporte a esse recurso no momento. Para saber
mais, consulte Limitações de instância sem servidor.

Para clusters M10+ que ativaram o BI Connector for Atlas, a caixa de diálogo Conectar
fornece os detalhes para conexão por meio do BI Connector for Atlas.

Para se conectar ao BI Connector para Atlas:

1
Clique no botão Conectar do seu cluster.

2
Selecione Conexão padrão e clique em Escolha um método de conexão.

3
Clique em Conectar sua ferramenta de Business Intelligence e use as informações de
conexão fornecidas para conectar-se à sua ferramenta de BI.

Para obter mais informações sobre como conectar-se ao BI Connector for Atlas, consulte
Tutoriais de conexão.

O Conector MongoDB para Business Intelligence para Atlas (


Conector BI
) está disponível apenas para clusters M10 e maiores.

O BI Connector é uma ferramenta poderosa que fornece aos usuários acesso baseado em
SQL aos seus bancos de dados MongoDB. Como resultado, o BI Connector executa
operações que podem consumir muita CPU e memória. Dados os recursos de hardware
limitados nas camadas de cluster M10 e M20, você poderá enfrentar degradação do
desempenho do cluster ao ativar o BI Connector. Se isso ocorrer, atualize para um cluster
M30 ou maior ou desative o BI Connector.

Pré-requisitos

janelas

Mac OS
Aglomerado Atlas com
Conector BI para Atlas
habilitado

Crie um nome de fonte de dados (DSN) do sistema que use o driver MongoDB ODBC
Tableau versão 10.3
ou mais tarde

Procedimento

janelas

Mac OS
1
Inicie o Tableau Desktop.
2
Conecte-se ao Conector BI para Atlas.
Selecione o conector MongoDB BI como fonte de dados para seu livro do Tableau.

Na navegação à esquerda, em Para um servidor, clique em Mais... e selecione Outros


bancos de dados (ODBC).

Selecione o DSN que você acabou de criar na lista de DSN.

Insira os seguintes campos no painel Atributos de Conexão:

Campo
Ação
Servidor
Insira o nome do host especificado na caixa de diálogo de conexão do Atlas.
Porta
Insira a porta especificada na caixa de diálogo de conexão do Atlas.
Nome de usuário
Insira o usuário especificado na caixa de diálogo Atlas Connect ou um usuário de banco de
dados diferente para o cluster.

O usuário é especificado no formato:

<nome de usuário>?source=<nome do banco de dados>

onde <database-name> é o banco de dados de autenticação do usuário.

Senha
Digite a senha correspondente ao usuário inserido.
Clique em Entrar.

Referência Adicional
Para obter mais informações sobre o Conector MongoDB para Business Intelligence,
consulte
Manual do Conector MongoDB para BI
.
Conecte-se a partir do Qlik Sense
IMPORTANTE
Recurso indisponível em instâncias sem servidor
As instâncias sem servidor não oferecem suporte a esse recurso no momento. Para saber
mais, consulte Limitações de instância sem servidor.

Para clusters M10+ que ativaram o BI Connector for Atlas, a caixa de diálogo Conectar
fornece os detalhes para conexão por meio do BI Connector for Atlas.

Para se conectar ao BI Connector para Atlas:

1
Clique no botão Conectar do seu cluster.

2
Selecione Conexão padrão e clique em Escolha um método de conexão.

3
Clique em Conectar sua ferramenta de Business Intelligence e use as informações de
conexão fornecidas para conectar-se à sua ferramenta de BI.

Para obter mais informações sobre como conectar-se ao BI Connector for Atlas, consulte
Tutoriais de conexão.

Pré-requisitos
Aglomerado Atlas com
Conector BI para Atlas
habilitado

Crie um nome de fonte de dados (DSN) do sistema

Qlik Sense Desktop

Procedimento
1
Inicie o Qlik Sense Desktop.
Inicie o aplicativo de desktop Qlik Sense.

2
Crie uma conexão de dados com o BI Connector para Atlas.
Clique em Criar um novo aplicativo.

Insira um nome para o aplicativo e crie. Se criado com sucesso, abra o aplicativo.

Clique em Adicionar dados de arquivos e outras fontes.


Selecione ODBC na lista de fontes de dados.

Na janela Criar Nova Conexão, no DSN do Sistema, selecione o DSN que você criou
anteriormente.

Deixe os campos Nome de usuário e Senha em branco, pois o aplicativo utiliza o nome de
usuário e a senha especificados no DSN durante a configuração do ODBC.

Clique em Criar.

Referência Adicional
Para obter mais informações sobre o Conector MongoDB para Business Intelligence,
consulte
Manual do Conector MongoDB para BI
.
Conecte-se a partir do MySQL Workbench
IMPORTANTE
Recurso indisponível em instâncias sem servidor
As instâncias sem servidor não oferecem suporte a esse recurso no momento. Para saber
mais, consulte Limitações de instância sem servidor.

Para clusters M10+ que ativaram o BI Connector for Atlas, a caixa de diálogo Conectar
fornece os detalhes para conexão por meio do BI Connector for Atlas.

Para se conectar ao BI Connector para Atlas:

1
Clique no botão Conectar do seu cluster.

2
Selecione Conexão padrão e clique em Escolha um método de conexão.

3
Clique em Conectar sua ferramenta de Business Intelligence e use as informações de
conexão fornecidas para conectar-se à sua ferramenta de BI.

Para obter mais informações sobre como conectar-se ao BI Connector for Atlas, consulte
Tutoriais de conexão.

Pré-requisitos
Aglomerado Atlas com
Conector BI para Atlas
habilitado

Ambiente de trabalho MySQL 6.3


ou mais tarde

OBSERVAÇÃO
Versões do MySQL Workbench compatíveis com o servidor MySQL versão 5.7 também são
compatíveis com o BI Connector for Atlas.

Recomendamos que você use uma versão do MySQL Workbench entre e incluindo as
versões 6.3 e 8.0.31 para garantir a compatibilidade.

Procedimento
O tutorial a seguir descreve as etapas para conectar-se usando MySQL Workbench 6.3.
Atlas oferece suporte às edições comunitária e comercial.

1
Inicie o ambiente de trabalho MySQL.
Inicie o MySQL Workbench 6.3.
2
Crie uma nova conexão MySQL.
Na página de boas-vindas, clique no sinal de mais (+):

Como alternativa, você pode criar uma nova conexão na tela Gerenciar conexões....

Digite o nome da sua conexão.

Configure os parâmetros da conexão. Na seção Parâmetros, atualize os seguintes campos:

Nome do campo
Descrição
nome de anfitrião
Insira o nome do host especificado na caixa de diálogo de conexão do Atlas.
Porta
Insira a porta especificada na caixa de diálogo de conexão do Atlas.
Nome de usuário
Insira o usuário especificado na caixa de diálogo Atlas Connect ou um usuário de banco de
dados diferente para o cluster.

O usuário é especificado no formato:

<nome de usuário>?source=<nome do banco de dados>

onde <database-name> é o banco de dados de autenticação do usuário.

Senha
Armazene a senha no chaveiro.
Esquema padrão
Opcional. O nome de um banco de dados no cluster a ser conectado.
Defina as configurações SSL para a conexão. Na seção SSL, atualize o seguinte campo:

Nome do campo
Descrição
Usar SSL
Selecione Se disponível.
Defina as configurações avançadas para a conexão. Na seção Avançado, atualize o
seguinte campo:

Nome do campo
Descrição
Habilitar plug-in de autenticação de texto simples
Selecione.
3
Clique em Test Connection para testar a conexão.
Se a conexão for bem-sucedida, clique em OK e feche a tela de configuração da conexão e
retorne à página de boas-vindas.
Se a conexão falhar, verifique as configurações, incluindo as credenciais do usuário do
banco de dados MongoDB e a lista de acesso IP.

4
Conectar.
Na página de boas-vindas, clique duas vezes na conexão recém-criada para conectar e
abrir o Editor SQL.

Referência Adicional
Para obter mais informações sobre o Conector MongoDB para Business Intelligence,
consulte
Manual do Conector MongoDB para BI
.
Conecte-se a um cluster usando ferramentas
de linha de comando
Nesta página

Acesse a guia Ferramentas de linha de comando


Navegue até a página Implantações de banco de dados do seu projeto.
Escolha Ferramentas de linha de comando para o cluster desejado.
Conecte-se com mongorestore
Conecte-se com mongodump
Conecte-se com mongoimport
Conecte-se com mongoexport
Conecte-se com mongostato
Conecte-se com mongotop
Solução de problemas
Atlas fornece instruções para conectar-se a um cluster Atlas usando ferramentas de linha de
comando selecionadas do MongoDB na guia Ferramentas de linha de comando.

Para instâncias sem servidor, use


Ferramentas MongoDB
versão 100.5.x ou posterior. Para saber mais, consulte Versão mínima das ferramentas do
MongoDB para instâncias sem servidor.

OBSERVAÇÃO
As seções Acesso obrigatório no
Ferramentas de banco de dados MongoDB
referência de documentação Funções e privilégios do MongoDB que correspondem às
funções, privilégios e ações de privilégio do Atlas.

Acesse a guia Ferramentas de linha de comando


Para acessar a guia Ferramentas de linha de comando do Atlas:

1
Navegue até a página Implantações de banco de dados do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Se a página Implantações de banco de dados ainda não estiver exibida, clique em Banco de
dados na barra lateral.

2
Escolha Ferramentas de linha de comando para o cluster desejado.
No menu do cluster, clique em Ferramentas de Linha de Comando.
Conecte-se com mongorestore
OBSERVAÇÃO
Como o Atlas não oferece uma função de restauração individual, privilégio ou ação de
privilégio, você deve ter a função de administrador do Atlas para usar o mongorestore.

A seção Ferramentas Binárias de Importação e Exportação da guia Ferramentas de Linha


de Comando exibe um modelo copiável com as opções mínimas necessárias para conexão
mongorestore
para o seu cluster Atlas. Para obter instruções sobre como encontrar a guia Ferramentas
de linha de comando, consulte
Acesse a guia Ferramentas de linha de comando.

O modelo inclui valores de espaço reservado para determinadas opções. Você deve
substituir esses espaços reservados pelos valores apropriados para seu cluster Atlas:

<SENHA> - substitua pela senha do usuário especificado em --username. O modelo inclui


um usuário de banco de dados para o projeto como --username. Se você deseja autenticar
como um usuário diferente, substitua o valor de --username e especifique a senha desse
usuário em --password.

Se sua senha contiver caracteres especiais, coloque-a entre aspas duplas ou simples. Por
exemplo, se sua senha for @bc123, você deverá colocá-la entre aspas, como "@bc123".

Incluir qualquer outro


mongorestore
opções de linha de comando conforme necessário antes de copiar e colar o comando no
terminal do sistema e executar o comando completo. Ver
mongorestore
para obter documentação completa sobre as opções de linha de comando disponíveis e
como usá-las.

OBSERVAÇÃO
Conectando-se a um cluster Atlas do Microsoft Windows
Para usuários do Windows, especifique mongorestore.exe

Pode ser necessário fornecer o caminho completo do arquivo para mongorestore.exe.

Conecte-se com mongodump


A seção Importação e Exportação Binária da guia Ferramentas de Linha de Comando exibe
um modelo copiável com as opções mínimas necessárias para conexão
mongodump
para o seu cluster Atlas. Para obter instruções sobre como encontrar a guia Ferramentas
de linha de comando, consulte
Acesse a guia Ferramentas de linha de comando.

O modelo inclui valores de espaço reservado para determinadas opções. Você deve
substituir esses espaços reservados pelos valores apropriados para seu cluster Atlas:
<SENHA> - substitua pela senha do usuário especificado em --username. O modelo inclui
um usuário de banco de dados para o projeto como --username. Se você deseja autenticar
como um usuário diferente, substitua o valor de --username e especifique a senha desse
usuário em --password.

Se sua senha contiver caracteres especiais, coloque-a entre aspas duplas ou simples. Por
exemplo, se sua senha for @bc123, você deverá colocá-la entre aspas, como "@bc123".

<DATABASE> - substitua pelo nome do banco de dados do qual você deseja exportar os
dados

Incluir qualquer outro


mongodump
opções de linha de comando conforme necessário antes de copiar e colar o comando no
terminal do sistema e executar o comando completo. Ver
mongodump
para obter documentação completa sobre as opções de linha de comando disponíveis e
como usá-las.

OBSERVAÇÃO
Conectando-se a um cluster Atlas do Microsoft Windows
Para usuários do Windows, especifique mongodump.exe

Pode ser necessário fornecer o caminho completo do arquivo para mongodump.exe.

Conecte-se com mongoimport


A seção Ferramentas de importação e exportação de dados da guia Ferramentas de linha
de comando exibe um modelo copiável com as opções mínimas necessárias para conexão
mongoimportação
para o seu cluster Atlas. Para obter instruções sobre como encontrar a guia Ferramentas
de linha de comando, consulte
Acesse a guia Ferramentas de linha de comando.

O modelo inclui valores de espaço reservado para determinadas opções. Você deve
substituir esses espaços reservados pelos valores apropriados para seu cluster Atlas:

<SENHA> - substitua pela senha do usuário especificado em --username. O modelo inclui


um usuário de banco de dados para o projeto como o – nome de usuário. Se você deseja
autenticar como um usuário diferente, substitua o valor de --username e especifique a
senha desse usuário em --password.

Se sua senha contiver caracteres especiais, coloque-a entre aspas duplas ou simples. Por
exemplo, se sua senha for @bc123, você deverá colocá-la entre aspas, como "@bc123".

<DATABASE> - o nome do banco de dados para o qual você deseja importar os dados.

<COLLECTION> - o nome da coleção para a qual você deseja importar dados.


<FILETYPE> - o tipo de arquivo da fonte de dados da qual você está importando dados. Ver
--tipo
Para maiores informações.

<FILENAME> - o nome da fonte de dados da qual você está importando dados. Ver
--arquivo
Para maiores informações.

Incluir qualquer outro


mongoimportação
opções de linha de comando conforme necessário antes de copiar e colar o comando no
terminal do sistema e executar o comando completo. Ver
mongoimportação
para obter documentação completa sobre as opções de linha de comando disponíveis e
como usá-las.

OBSERVAÇÃO
Conectando-se a um cluster Atlas do Microsoft Windows
Para usuários do Windows, especifique mongoimport.exe

Pode ser necessário fornecer o caminho completo do arquivo para mongoimport.exe.

Conecte-se com mongoexport


A seção Ferramentas de importação e exportação de dados da guia Ferramentas de linha
de comando exibe um modelo copiável com as opções mínimas necessárias para conexão
mongoexportação
para o seu cluster Atlas. Para obter instruções sobre como encontrar a guia Ferramentas
de linha de comando, consulte
Acesse a guia Ferramentas de linha de comando.

O modelo inclui valores de espaço reservado para determinadas opções. Você deve
substituir esses espaços reservados pelos valores apropriados para seu cluster Atlas:

<SENHA> - substitua pela senha do usuário especificado em --username. O modelo inclui


um usuário de banco de dados para o projeto como --username. Se você deseja autenticar
como um usuário diferente, substitua o valor de --username e especifique a senha desse
usuário em --password.

Se sua senha contiver caracteres especiais, coloque-a entre aspas duplas ou simples. Por
exemplo, se sua senha for @bc123, você deverá colocá-la entre aspas, como "@bc123".

<DATABASE> - o nome do banco de dados do qual você deseja exportar os dados.

<COLLECTION> - o nome da coleção da qual você deseja exportar dados.

<FILETYPE> - o tipo de arquivo da fonte de dados para a qual você está exportando dados.
Ver
--tipo
Para maiores informações.

<FILENAME> - o nome da fonte de dados para a qual você está exportando dados. Ver
--arquivo
Para maiores informações.

Incluir qualquer outro


mongoexportação
opções de linha de comando conforme necessário antes de copiar e colar o comando no
terminal do sistema e executar o comando completo. Ver
mongoexportação
para obter documentação completa sobre as opções de linha de comando disponíveis e
como usá-las.

OBSERVAÇÃO
Conectando-se a um cluster Atlas do Microsoft Windows
Para usuários do Windows, especifique mongoexport.exe

Pode ser necessário fornecer o caminho completo do arquivo para mongoexport.exe.

Conecte-se com mongostato


A seção Configurar diagnóstico da guia Ferramentas de linha de comando exibe um modelo
copiável com as opções mínimas necessárias para conectar
mongostato
para o seu cluster Atlas. Para obter instruções sobre como encontrar a guia Ferramentas
de linha de comando, consulte
Acesse a guia Ferramentas de linha de comando.

O modelo inclui valores de espaço reservado para determinadas opções. Você deve
substituir esses espaços reservados pelos valores apropriados para seu cluster Atlas:

<SENHA> - substitua pela senha do usuário especificado em --username. O modelo inclui


um usuário de banco de dados para o projeto como --username. Se você deseja autenticar
como um usuário diferente, substitua o valor de --username e especifique a senha desse
usuário em --password.

Se sua senha contiver caracteres especiais, coloque-a entre aspas duplas ou simples. Por
exemplo, se sua senha for @bc123, você deverá colocá-la entre aspas, como "@bc123".

Incluir qualquer outro


mongostato
opções de linha de comando conforme necessário antes de copiar e colar o comando no
terminal do sistema e executar o comando completo. Ver
mongostato
para obter documentação completa sobre as opções de linha de comando disponíveis e
como usá-las.

OBSERVAÇÃO
Conectando-se a um cluster Atlas do Microsoft Windows
Para usuários do Windows, especifique mongostat.exe

Pode ser necessário fornecer o caminho completo do arquivo para mongostat.exe.

Conecte-se com mongotop


A seção Configurar diagnóstico da guia Ferramentas de linha de comando exibe um modelo
copiável com as opções mínimas necessárias para conectar
mongotop
para o seu cluster Atlas. Para obter instruções sobre como encontrar a guia Ferramentas
de linha de comando, consulte
Acesse a guia Ferramentas de linha de comando.

O modelo inclui valores de espaço reservado para determinadas opções. Você deve
substituir esses espaços reservados pelos valores apropriados para seu cluster Atlas:

<SENHA> - substitua pela senha do usuário especificado em --username. O modelo inclui


um usuário de banco de dados para o projeto como --username. Se você deseja autenticar
como um usuário diferente, substitua o valor de --username e especifique a senha desse
usuário em --password.

Se a sua senha contiver caracteres especiais, coloque-a entre caracteres duplos ou aspas
simples. Por exemplo, se sua senha for @bc123, você deverá colocá-la entre aspas, como
"@bc123".

Incluir qualquer outro


mongotop
opções de linha de comando conforme necessário antes de copiar e colar o comando no
terminal do sistema e executar o comando completo. Ver
mongotop
para obter documentação completa sobre as opções de linha de comando disponíveis e
como usá-las.

OBSERVAÇÃO
Conectando-se a um cluster Atlas do Microsoft Windows
Para usuários do Windows, especifique mongotop.exe

Pode ser necessário fornecer o caminho completo do arquivo para mongotop.exe.

Solução de problemas
Se você estiver enfrentando problemas para se conectar à implantação do seu banco de
dados, consulte Solucionar problemas de conexão.
Conecte-se via código VS
Nesta página

Copie as informações de conexão da sua implantação


Crie uma conexão com uma implantação
Para se conectar a uma implantação de banco de dados com o VS Code,
copie suas informações de conexão
do Atlas e usá-lo para
conectar usando o código VS
. Você pode se conectar a um host de cluster autônomo, de conjunto de réplicas ou
fragmentado.

Copie as informações de conexão da sua implantação


Para localizar e copiar as informações de conexão da sua implantação:

1
Navegue até a Visão Geral do Cluster.
Clique em Banco de dados próximo à parte superior do console do Atlas.

2
Localize a implantação de banco de dados à qual deseja se conectar na lista de
implantações de banco de dados.
3
Clique no botão Conectar à direita do nome da implantação do seu banco de dados.
Uma caixa de diálogo Conectar aparece com uma lista de métodos de conexão disponíveis.

4
Selecione Conectar usando VS Code.
Siga as instruções em Conectar usando o VS Code para criar uma conexão com a
implantação do seu banco de dados.

Crie uma conexão com uma implantação


Para obter instruções sobre como criar uma conexão com a implantação do seu banco de
dados usando o VS Code, consulte
Conecte-se à sua implantação do MongoDB
na documentação do MongoDB para VS Code. Se você copiou a cadeia de conexão do
Atlas no procedimento anterior, siga as etapas para usar a cadeia de conexão do Atlas.

DICA
Conecte-se à sua implantação do MongoDB
também fornece informações sobre como se desconectar de uma implantação e
informações sobre como ativar, renomear e remover uma conexão.
Testar failover primário
Nesta página

Acesso obrigatório
Teste o processo de failover primário
Verifique o failover
Solucionar problemas de failover
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber mais
sobre quais recursos não estão disponíveis, consulte Limitações do Atlas M0 (cluster
gratuito), M2 e M5.

Atlas conduz
réplicas de eleições definidas quando faz alterações na configuração, como atualizações de
patches, eventos de escalabilidade e quando ocorrem falhas. Seus aplicativos devem lidar
com eleições de conjuntos de réplicas sem qualquer tempo de inatividade. Para saber como
construir um aplicativo resiliente, consulte Construir um aplicativo resiliente com o MongoDB
Atlas.

Você pode ativar gravações repetíveis adicionando


retryWrites = verdadeiro
à sua string de conexão URI do Atlas. Para saber mais, consulte
Gravações que podem ser repetidas.

Você pode usar a interface do usuário e a API do Atlas para testar a falha do conjunto de
réplicas primário em seu cluster Atlas e observar como seu aplicativo lida com um failover
do conjunto de réplicas.

Acesso obrigatório
Para iniciar um teste de failover, você deve ter acesso de Proprietário da Organização ou
Proprietário do Projeto ao projeto.

Teste o processo de failover primário


Quando você envia uma solicitação para testar o failover primário, o Atlas simula um evento
de failover. Durante este processo:

Atlas desliga o primário atual.

Os membros do conjunto de réplicas possuem um


eleição
para escolher qual dos secundários se tornará o novo primário.

Atlas traz o primário original de volta ao conjunto de réplicas como um


secundário
. Quando o antigo primário se juntar novamente ao conjunto de réplicas, ele será
sincronizado com o novo primário para recuperar quaisquer gravações que tenham ocorrido
durante o tempo de inatividade.

As declarações a seguir descrevem o comportamento do Atlas durante rollovers e ao testar


failover em clusters fragmentados:

Se o primário original aceitou operações de gravação que não foram replicadas com êxito
para os secundários quando o primário foi desativado, o primário reverte essas operações
de gravação quando se juntar novamente ao conjunto de réplicas e começar a sincronizar.
Para saber mais, consulte
Reversões durante failover do conjunto de réplicas
. Contato
Suporte MongoDB
para obter assistência na resolução de reversões.

Apenas o
mongos
os processos que estão nas mesmas instâncias que os primários dos conjuntos de réplicas
no cluster fragmentado são reiniciados.

As primárias dos conjuntos de réplicas no cluster fragmentado são reiniciadas em paralelo.

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para iniciar um teste de failover para o cluster especificado em seu projeto usando a CLI do
Atlas, execute o seguinte comando:

atlas clusters failover <clusterName> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
failover de clusters atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Verifique o failover
Para verificar se o failover foi bem-sucedido:

Faça login na UI do Atlas e clique em Banco de dados.

Clique no nome do cluster para o qual você executou o teste de failover.

Observe as seguintes alterações na lista de nós na guia Visão geral:

O nó PRIMÁRIO original agora é um nó SECUNDÁRIO.

Um antigo nó SECUNDÁRIO agora é o nó PRIMÁRIO.

Solucionar problemas de failover


Se o seu aplicativo não lidar com o failover normalmente, certifique-se do seguinte:

Você está usando o


Formato de conexão SRV.

Você está usando a versão mais recente do driver.

Você implementou a lógica de nova tentativa apropriada em seu aplicativo.


Simular interrupção regional
Nesta página

Acesso obrigatório
Simular processo de interrupção regional
Simular interrupção regional usando a IU do Atlas
Simular interrupção regional usando a API
Verifique a interrupção
Solucionar problemas de interrupção
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber
mais, consulte Limitações do Atlas M0 (cluster gratuito), M2 e M5.

No momento, esse recurso não é compatível com instâncias sem servidor. Para saber mais,
consulte Limitações de instância sem servidor.

Você pode usar a interface do usuário e a API do Atlas para simular uma interrupção no
cluster multirregional do Atlas e observar como seu aplicativo lida com uma interrupção em
uma ou mais regiões.

Acesso obrigatório
Para iniciar uma simulação de interrupção, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao projeto.

Simular processo de interrupção regional


Quando você envia uma solicitação para testar uma interrupção usando a UI ou API do
Atlas, o Atlas simula um evento de interrupção. Durante este processo, o Atlas remove a
conectividade de rede aos nós nas regiões selecionadas.

Se seu aplicativo demorar mais de 15 minutos para perceber a perda de conexão em alguns
nós, recomendamos que você reduza os valores de tempo limite de retransmissão TCP.
Para saber mais, consulte
modifique o valor tcp_retries2.

Simular interrupção regional usando a IU do Atlas


Para simular uma interrupção regional na UI do Atlas:

Faça login na interface do Atlas.

Clique em Banco de Dados.

Para o cluster que você deseja realizar testes de interrupção, clique no botão ....

Clique em Testar resiliência.


Selecione Interrupção Regional. O Atlas exibe um modal de teste de resiliência com as
etapas que o Atlas executa para simular um evento de interrupção. Para saber mais,
consulte
Simule o processo de interrupção regional.

Clique em Selecionar regiões.

Selecione a aba correspondente ao tipo de interrupção que deseja simular:

Minoria de nós elegíveis

Maioria dos nós elegíveis


Selecione menos da metade dos seus nós elegíveis.

Selecione Simular interrupção regional para iniciar o teste. O Atlas notifica você quando
ocorre uma interrupção.

Selecione uma guia correspondente ao tipo de interrupção que você está realizando:

Minoria de nós elegíveis

Maioria dos nós elegíveis


Ao terminar de testar a interrupção, clique em Finalizar simulação.

Simular interrupção regional usando a API


Você pode usar o
Interrupção de teste
Endpoint da API para simular um evento de interrupção. Para saber mais sobre o processo
de interrupção, consulte
Simule o processo de interrupção regional.

Verifique a interrupção
Para verificar se a interrupção foi bem-sucedida, monitore seu aplicativo e certifique-se de
que suas operações de leitura e gravação estejam funcionando conforme o esperado.

Solucionar problemas de interrupção


Uma interrupção regional ou simulação de interrupção regional que afete as regiões de
maior prioridade em um cluster fragmentado pode fazer com que o cluster fique inoperante
para operações de leitura. Para restaurar os servidores de configuração, faça o seguinte:

Configurar uma preferência de leitura que é adequada para consultar nós secundários para
leituras.

Reconfigure o cluster para recuperar nós elegíveis.


Gerenciar conexões com AWS Lambda
selecione sua lingua

Node.js
Nesta página

Melhores Práticas
Exemplo de conexão
Autenticação AWS IAM
Outra autenticação
Autenticação AWS IAM
Outra autenticação
Autenticação AWS IAM
Outra autenticação
Melhores Práticas
Use as práticas recomendadas a seguir para gerenciar adequadamente as conexões entre
AWS Lambda
e Atlas:

Defina o cliente para o servidor MongoDB fora do


Função manipuladora do AWS Lambda.

Não defina um novo objeto MongoClient cada vez que invocar sua função. Isso faz com que
o driver crie uma nova conexão de banco de dados com cada chamada de função. Isso
pode ser caro e fazer com que seu aplicativo exceda os limites de conexão com o banco de
dados. Ao definir um novo MongoClient, você deve:

Crie o objeto MongoClient uma vez.

Armazene o objeto para que sua função possa reutilizar o MongoClient em invocações de
função.

O
Exemplo de conexão
reutiliza conexões de banco de dados existentes para acelerar a comunicação com o
banco de dados e manter a contagem de conexões com o banco de dados em um nível
razoável em relação ao tráfego do aplicativo.

Se o seu manipulador receber um retorno de chamada como último argumento, defina a


propriedade callbackWaitsForEmptyEventLoop no
Contexto AWS Lambda
objetar a falso.

context.callbackWaitsForEmptyEventLoop = falso;

Node.js
Isso permite que uma função Lambda retorne seu resultado ao chamador sem exigir que a
conexão com o banco de dados MongoDB seja fechada. A configuração desta propriedade
não é aplicável para
manipuladores assíncronos.

Se você tiver uma função Lambda que se conecta a um cluster fragmentado com muitos
fragmentos, poderá enfrentar problemas de desempenho. Por exemplo, com um cluster de
dez fragmentos, o driver se conecta a todos os trinta
mongos
instâncias por padrão. Você pode usar a opção srvMaxHosts na cadeia de conexão para
definir o número máximo de hosts aos quais o driver se conecta. Para melhorar o
desempenho do driver, defina srvMaxHosts=3. Por exemplo:

mongodb+srv://<nome de
usuário>:<senha>@<nomedocluster>.mongodb.net/?retryWrites=true&w=majority&srvMaxH
osts=3

Para saber mais, consulte


Opções de conexão.

Restrinja o acesso à rede ao seu cluster Atlas.

Conecte-se ao cluster Atlas por meio de rede privada usando uma conexão de peering de
rede entre o cluster Atlas e a função AWS Lambda ou, alternativamente, um endpoint
privado, para que você possa permitir apenas endereços IP privados da sua lista de acesso
IP.

Se você não usa rede privada, considere conectar-se ao seu cluster Atlas por meio de um
Gateway NAT
com um endereço Elastic IP mapeado. Caso contrário, você deverá permitir que todos os
endereços IP (0.0.0.0/0) acessem seu cluster de serviço.

AVISO
Adicionar 0.0.0.0/0 à sua lista de acesso IP permite o acesso ao cluster de qualquer lugar
na Internet pública. Certifique-se de usar credenciais fortes para todos os usuários do banco
de dados ao permitir o acesso de qualquer lugar.

Configure o Unified AWS Access e use a autenticação AWS IAM sempre que possível.

Você pode se conectar aos seus clusters Atlas usando AWS


Funções do IAM
em vez de codificar suas credenciais no Lambda. As credenciais codificadas podem ser
visualizadas por qualquer pessoa que acesse seu ambiente AWS Lambda, o que pode
representar um risco à segurança. Com a autenticação AWS IAM, o Atlas acessa o AWS
Lambda por meio de um
assumiu a função do IAM
, então você não precisa de credenciais em suas cadeias de conexão.
O Atlas oferece suporte à autenticação AWS IAM para clusters que executam o MongoDB
versão 4.4 ou superior. É altamente recomendável usar a autenticação AWS IAM para
conexões Lambda se o seu cluster atender aos requisitos.

A quantidade de memória alocada para uma função Lambda é padronizada como 128 MB.
Você pode configurar a quantidade de memória alocada para uma função Lambda, entre
128 MB e 10.240 MB. Certifique-se de alocar memória suficiente. Aumente a memória para
aumentar a quantidade de CPU virtual disponível e melhorar o desempenho do driver
MongoDB. Para saber mais, consulte
Memória e poder de computação
.

Defina seu
AWS_STS_REGIONAL_ENDPOINTS
e
AWS_REGION
variáveis ​ambientais.

Exemplo de conexão
Autenticação AWS IAM

const { MongoClient } = require('mongodb');

// Get the URI for the cluster then set AWS_ACCESS_KEY_ID as the username in the
// URI and AWS_SECRET_ACCESS_KEY as the password, then set the appropriate auth
// options. Note that MongoClient now auto-connects so no need to store the connect()
// promise anywhere and reference it.
const client = new MongoClient(process.env.MONGODB_URI, {
auth: {
username: process.env.AWS_ACCESS_KEY_ID,
password: process.env.AWS_SECRET_ACCESS_KEY
},
authSource: '$external',
authMechanism: 'MONGODB-AWS'
});

module.exports.handler = async function () {


const databases = await client.db('admin').command({ listDatabases: 1 });
return {
statusCode: 200,
databases: databases
};
};

Node.js

Outra autenticação
const { MongoClient } = require('mongodb');

// MongoClient now auto-connects so no need to store the connect()


// promise anywhere and reference it.
const client = new MongoClient(process.env.MONGODB_URI);

module.exports.handler = async function () {


const databases = await client.db('admin').command({ listDatabases: 1 });
return {
statusCode: 200,
databases: databases
};
};
Gerenciar conexões com Azure Functions
Nesta página

Melhores Práticas
Exemplo de conexão
Você pode usar
Funções do Azure
com Atlas.

Melhores Práticas
Use as práticas recomendadas a seguir para gerenciar adequadamente as conexões entre
Funções do Azure
e Atlas:

Defina o cliente para o servidor MongoDB fora do método Run do seu


Manipulador de funções do Azure.

Não defina um novo objeto MongoClient cada vez que invocar sua função. Isso faz com que
o driver crie uma nova conexão de banco de dados com cada chamada de função. Isso
pode ser caro e fazer com que seu aplicativo exceda os limites de conexão com o banco de
dados. Ao definir um novo MongoClient, você deve:

Crie o objeto MongoClient uma vez.

Armazene o objeto para que sua função possa reutilizar o MongoClient em invocações de
função.

O exemplo de conexão reutiliza conexões de banco de dados existentes para acelerar a


comunicação com o banco de dados e manter a contagem de conexões com o banco de
dados em um nível razoável em relação ao tráfego do aplicativo.

Restrinja o acesso à rede ao seu cluster Atlas a partir das suas Funções Azure.

Ligue-se ao seu cluster Atlas através de uma rede privada utilizando uma ligação de peering
de rede entre o seu cluster Atlas e as suas Funções Azure ou, em alternativa, um ponto final
privado, para que possa permitir apenas endereços IP privados da sua lista de acesso IP.

OBSERVAÇÃO
Esta configuração requer um Plano Premium de Funções do Azure com uma Integração de
rede virtual (VNet) configurada.

Se você não usa rede privada, considere conectar-se ao seu cluster Atlas usando um
Gateway NAT. Análise alterações de endereço IP de saída e estratégias para garantir
endereços IP de saída estáticos.

Exemplo de conexão
O
Exemplo de funções do Azure no repositório mongodb-developer contém código de
exemplo que mostra como trabalhar com o driver C# do MongoDB e o Azure Functions
usando clusters Atlas.

Para saber mais sobre como usar o Azure Functions com Visual Studio Code, consulte
Guia de início rápido: criar uma função C# no Azure usando o Visual Studio Code

Para saber mais sobre como usar o Azure Functions com o Visual Studio, consulte
Início Rápido: Crie sua primeira função C# no Azure usando o Visual Studio.
Gerencie conexões com o Google Cloud
Nesta página

Melhores Práticas
Exemplo de conexão do Google Cloud
Você pode interagir com suas implantações de banco de dados Atlas usando
Funções do Google Cloud
e
Google Cloud Run.

Melhores Práticas
Use as seguintes práticas recomendadas para gerenciar adequadamente as conexões entre
as funções do Google Cloud e o Atlas:

Crie sua função do Cloud com uma conexão de banco de dados com escopo global, em vez
de uma conexão de banco de dados com escopo de função.

Não defina um novo objeto MongoClient cada vez que invocar sua função. Isso faz com que
o driver crie uma nova conexão de banco de dados com cada chamada de função. Isso
pode ser caro e fazer com que seu aplicativo exceda os limites de conexão com o banco de
dados. Ao definir um novo MongoClient, você deve:

Crie o objeto MongoClient uma vez.

Armazene o objeto para que sua função possa reutilizar o MongoClient em invocações de
função.

O
exemplo de conexão
reutiliza conexões de banco de dados existentes para acelerar a comunicação com o
banco de dados e manter a contagem de conexões com o banco de dados em um nível
razoável em relação ao tráfego do aplicativo.

Se você tiver uma função que se conecta a um cluster fragmentado com muitos fragmentos,
poderá enfrentar problemas de desempenho. Por exemplo, com um cluster Atlas de dez
fragmentos, o driver se conecta a todos os trinta
mongos
instâncias por padrão. Você pode usar a opção srvMaxHosts na cadeia de conexão para
definir o número máximo de hosts aos quais o driver se conecta. Para melhorar o
desempenho do driver, defina srvMaxHosts=3. Por exemplo:

mongodb+srv://<nome de
usuário>:<senha>@<nomedocluster>.mongodb.net/?retryWrites=true&w=majority&srvMaxH
osts=3

Para saber mais, consulte


Opções de conexão.
Restrinja o acesso à rede ao seu cluster Atlas.

Conecte-se ao cluster Atlas por meio de rede privada usando uma conexão de peering de
rede entre o cluster Atlas e a função do Google Cloud ou, como alternativa, um endpoint
privado, para que você possa permitir apenas endereços IP privados da sua lista de acesso
IP.

Se você não usa rede privada, considere conectar-se ao seu cluster Atlas por meio de um
Gateway NAT
. Caso contrário, você deverá permitir que todos os endereços IP (0.0.0.0/0) acessem seu
cluster Atlas.

AVISO
Adicionar 0.0.0.0/0 à sua lista de acesso IP permite o acesso ao cluster de qualquer lugar
na Internet pública. Certifique-se de usar credenciais fortes para todos os usuários do banco
de dados ao permitir o acesso de qualquer lugar.

Configurar simultaneidade. Ao criar uma nova função do Google Cloud:

Selecione o ambiente de 2ª geração, que pode lidar com diversas solicitações simultâneas.
A 2ª geração também reduz a carga de conexão no servidor, permitindo que a função
compartilhe um único MongoClient com muitas invocações simultâneas.

Aumente a configuração de simultaneidade para minimizar inicializações a frio e melhorar a


latência.

OBSERVAÇÃO
Se você aumentar a configuração de simultaneidade, poderá ser necessário aumentar a
CPU para obter melhor desempenho. Para saber mais, consulte
Simultaneidade.

Exemplo de conexão do Google Cloud


O exemplo a seguir conecta uma função Node.js do Google Cloud a uma implantação do
Atlas. Substitua <YOUR-ATLAS-CONNECTION-STRING> pela string de conexão do Atlas.

const { MongoClient } = require('mongodb');

let client;
async function getConnection() {
if (!client) {

const client = new MongoClient('<YOUR-ATLAS-CONNECTION-STRING>');


client.on('connectionCreated', () => {
console.log('New connection created successfully.');
});

// Connect to the database in the global scope


await client.connect();
}

return client;
}
Solucionar problemas de conexão
selecione sua lingua

Node.js
Nesta página

O botão Conectar de implantação do banco de dados está desabilitado


Conectando endereço IP que não está na lista de acesso IP
Falha na autenticação na implantação do banco de dados
Muitas conexões abertas para a implantação do seu banco de dados
Desempenho degradado em clusters fragmentados durante picos nas contagens de
conexões
Tentando se conectar atrás de um firewall
Disponibilidade de implantação de banco de dados
Solução de problemas do MongoDB Compass
Problemas de cadeia de conexão
Esta página descreve problemas comuns de conexão e possíveis soluções.

Para saber mais sobre como se conectar a um cluster Atlas, consulte o tutorial Introdução
ao Atlas.

OBSERVAÇÃO
Se você é um cliente corporativo em busca de suporte, arquivar um ticket. Para apoio da
comunidade, visite Recursos da comunidade MongoDB.

OBSERVAÇÃO
No momento, as instâncias sem servidor não oferecem suporte à conexão por meio de
determinados drivers ou versões de driver. Para saber mais, consulte Limitações de
instância sem servidor.

O botão Conectar de implantação do banco de dados está desabilitado


O botão Conectar da implantação do banco de dados poderá ser desabilitado se a
implantação do banco de dados estiver no estado de provisionamento. A implantação do
seu banco de dados precisa ser provisionada quando for implantada pela primeira vez. Os
clusters também devem ser provisionados quando você os amplia ou reduz. O processo de
provisionamento pode levar até 10 minutos, após os quais o botão Conectar será ativado.

Conectando endereço IP que não está na lista de acesso IP


Antes de se conectar à implantação do seu banco de dados Atlas, verifique se você
adicionou o endereço IP do seu host à lista de acesso IP do projeto de implantação do seu
banco de dados. O Atlas permite conexões de clientes somente de endereços IP e
intervalos de endereços CIDR na lista de acesso IP.

Falha na autenticação na implantação do banco de dados


Para se conectar ao Atlas, você deve se autenticar com um usuário do banco de dados
MongoDB. Para criar um usuário de banco de dados para sua implantação de banco de
dados, consulte Configurar usuários de banco de dados.

Soluções possíveis
Se você criou um usuário e está tendo problemas para autenticar, tente o seguinte:

Verifique se você está usando o nome de usuário e a senha corretos para o usuário do
banco de dados e se está se conectando à implantação correta do banco de dados.

Verifique se você está especificando o banco de dados authSource correto em sua cadeia
de conexão.

Se você tiver um caractere especial em sua senha, consulte


Caracteres especiais na senha da cadeia de conexão.

Muitas conexões abertas para a implantação do seu banco de dados


O Atlas define limites para conexões de entrada simultâneas para uma implantação de
banco de dados. Para clusters, isso se baseia na camada do cluster. Se você tentar se
conectar quando estiver nesse limite, o MongoDB exibirá um erro informando que a
conexão foi recusada porque há muitas conexões abertas.

Para obter uma comparação detalhada das camadas de cluster e suas conexões
simultâneas máximas, consulte Limites de conexão e camada de cluster.

Soluções possíveis
Feche todas as conexões abertas com a implantação do seu banco de dados que não
esteja em uso no momento.

Dimensione seu cluster para um nível mais alto para dar suporte a mais conexões
simultâneas.

Reinicie seu aplicativo.

Para evitar esse problema no futuro, considere usar o


maxPoolSize
opção de cadeia de conexão para limitar o número de conexões no pool de conexões.

Para saber como corrigir esse problema, consulte Corrigir problemas de conexão.

Desempenho degradado em clusters fragmentados durante picos nas contagens de


conexões
O Atlas pode gerar uma cadeia de conexão SRV otimizada para clusters fragmentados
usando os balanceadores de carga do seu serviço de endpoint privado. Quando você usa
uma cadeia de conexão otimizada, o Atlas limita o número de conexões por mongos entre
seu aplicativo e seu cluster fragmentado. As conexões limitadas por mongos melhoram o
desempenho durante picos na contagem de conexões.
OBSERVAÇÃO
O Atlas não oferece suporte a cadeias de conexão otimizadas para clusters executados no
Google Cloud ou no Azure.

Para saber mais sobre cadeias de conexão otimizadas para clusters fragmentados atrás de
um ponto final privado, consulte Melhorar o desempenho da conexão para clusters
fragmentados atrás de um ponto final privado.

Tentando se conectar atrás de um firewall


Conectando-se à interface do Atlas
Atlas usa um CDN para fornecer conteúdo rapidamente. Se sua organização usa um
firewall, adicione o seguinte host Atlas CDN à lista de permissões do firewall para evitar
problemas de acesso à UI do Atlas: https://assets.mongodb-cdn.com/.

Conectando-se a uma implantação de banco de dados


As implantações de banco de dados Atlas operam na porta 27017. Você deve conseguir
acessar essa porta para se conectar às implantações de banco de dados. Além disso,
certifique-se de que as portas apropriadas estejam abertas para o seguinte:

Para clusters fragmentados, conceda acesso à porta 27016.

Para o BI Connector, conceda acesso à porta 27015.

Você pode verificar sua capacidade de acessar uma porta usando o testador de porta de
saída de terceiros.

EXEMPLO
Para verificar sua capacidade de chegar à porta 27017, visite
http://portquiz.net:27017.

Se você não conseguir acessar essas portas, verifique as configurações do firewall do


sistema e certifique-se de que elas não estejam bloqueando o acesso a essas portas.

Disponibilidade de implantação de banco de dados


Se você estiver usando um mongodb+srv://
cadeia de conexão
e seu driver ou shell não consegue encontrar o host DNS do banco de dados Atlas
momento, a implantação do banco de dados poderá ser pausada ou excluída. Verifique se a
implantação do banco de dados existe. Se este for um cluster pausado, será possível
retomá-lo, se necessário.

OBSERVAÇÃO
O Atlas pausa automaticamente clusters M0 ociosos após 60 dias sem conexões.

Solução de problemas do MongoDB Compass


Se você usar o MongoDB Compass para se conectar ao seu cluster e tiver problemas,
consulte:
Conexão recusada usando string de conexão SRV
nesta secção.

Erros de conexão da bússola


na documentação do MongoDB Compass.

Se você usar um certificado X.509 autogerenciado ou um


certificado X.509 gerado automaticamente
gerenciado pelo Atlas para autenticar no banco de dados MongoDB, ao se conectar ao
MongoDB Compass, você deve:

No MongoDB Compass, escolha Preencher campos de conexão individualmente.

No menu suspenso Autenticação, selecione X.509.

Selecione Mais opções.

No menu suspenso SSL, selecione Validação de servidor e cliente.

Adicione o mesmo caminho ao certificado gerenciado pelo Atlas baixado ou ao certificado


autogerenciado (dependendo de qual você usa) a cada um destes campos: Autoridade de
Certificação, Certificado de Cliente e Chave Privada do Cliente.

Para saber mais, consulte


Conecte-se ao MongoDB
na documentação do MongoDB Compass.

Problemas de cadeia de conexão


Formato de cadeia de conexão incorreto
O
formato de string de conexão
que você usa para se conectar ao Atlas depende de vários fatores, incluindo:

Seu
mangusto
versão. Para saber mais, consulte Conectar via mongosh.

Sua versão do driver. Para saber mais, consulte Conectar-se por meio do seu aplicativo.

Verifique sua cadeia de conexão em um ambiente de teste antes de colocá-la em produção.

Caracteres especiais na senha da string de conexão


Se sua senha incluir caracteres especiais e você estiver usando sua senha em um URI de
cadeia de conexão, codifique os caracteres especiais.

OBSERVAÇÃO
Os seguintes caracteres devem ser convertidos usando
codificação percentual
se incluído em um nome de usuário ou senha:

:/?#[]@

Por exemplo, se sua senha em texto simples for p@ssw0rd'9'!, você precisará codificá-la
como:

p%40ssw0rd%279%27%21
➤ Use o menu suspenso Selecione seu idioma para definir o idioma do exemplo de
codificação nesta seção.

const { MongoClient } = require("mongodb");

const username = encodeURIComponent("<username>");


const password = encodeURIComponent("<password>");
const cluster = "<clusterName>";
const authSource = "<authSource>";
const authMechanism = "<authMechanism>";

let uri =

`mongodb+srv://${username}:${password}@${cluster}/?authSource=${authSource}&auth
Mechanism=${authMechanism}`;

const client = new MongoClient(uri);

async function run() {


try {
await client.connect();

const database = client.db("<dbName>");


const ratings = database.collection("<collName>");

const cursor = ratings.find();

await cursor.forEach(doc => console.dir(doc));


} finally {
await client.close();
}
}
run().catch(console.dir);

Node.js

IMPORTANTE
Não codifique caracteres especiais em sua senha se você estiver usando sua senha fora de
um URI de cadeia de conexão (por exemplo, colando-a em
mangusto
).
String de conexão incompatível com a versão do driver
Se você vir esta mensagem de erro, seu driver provavelmente está desatualizado. Para
obter instruções sobre como atualizar seu driver, consulte seu
Documentação do motorista.

O DNS do provedor de serviços de Internet bloqueia a string de conexão


Quando você usa o Formato da string de conexão da lista de sementes DNS para se
conectar ao Atlas, você poderá ver o seguinte erro:

DNSHostNotFound: Falha ao procurar o serviço “<nome do serviço MongoDB>”


Este erro pode ocorrer ao usar o servidor DNS padrão fornecido pelo seu ISP. Esse servidor
DNS pode não suportar pesquisas SRV usadas pelo formato de cadeia de conexão da lista
de valores iniciais de DNS.

Para resolver o problema, você pode tentar alterar a configuração do DNS para usar um
servidor DNS público.

EXEMPLO
Você pode definir suas configurações de rede para usar DNS público do Google em vez dos
servidores DNS do seu ISP.

Depois de atualizar as configurações de rede para usar um servidor DNS público,


conecte-se à implantação do banco de dados.

Erro de string de conexão com ferramentas de banco de dados no Ubuntu 18.04


Se estiver executando o Ubuntu 18.04 e usando o String de conexão da lista de sementes
DNS formato (mongodb+srv://) para conectar-se ao Atlas a partir de uma das Ferramentas
de banco de dados MongoDB (mongodump, mongorestore, etc), você poderá ver o seguinte
erro:

lookup nta8e.mongodb.net on 123.45.67.8:27017: cannot unmarshal DNS message

Nesse caso, use uma das seguintes opções de conexão:

use a opção --uri com um


cadeia de conexão não SRV
(mongodb://).

use a opção --host para especificar o host para conectar.

Conexão recusada usando string de conexão SRV


Ao usar o String de conexão da lista de formato de sementes DNS (mongodb+srv://) com
um driver ou bússola, você poderá receber o seguinte erro:
Error: querySrv ECONNREFUSED _mongodb._tcp.<SRV Record>

Para solucionar esse problema, use o Formato de cadeia de conexão padrão com o
Compass ou esse driver. Com o Compass, não defina o valor do registro SRV; em vez
disso, defina os valores Hostname e Port.
Configurar recursos de segurança para
implantações de banco de dados
Nesta página

Recursos de segurança pré-configurados


Criptografia em trânsito
Nuvem privada virtual
Criptografia em repouso
Recursos de segurança necessários
Requisitos de rede e firewall
Lista de acesso IP
Autenticação ou autorização do usuário
Recursos de segurança opcionais
Conexão de peering de rede
Pontos finais privados
Acesso unificado à AWS
Autenticação e autorização de implantação de banco de dados
Criptografia em repouso usando seu gerenciamento de chaves
Criptografia em nível de campo do lado do cliente
Auditoria de banco de dados
Rastreamento de acesso
Autenticação multifator para acesso Atlas UI
Permitir acesso de ou para o plano de controle Atlas
Permitir acesso à federação de dados
Verificação de revogação de certificado OCSP
Você pode usar o Atlas com segurança fora da caixa. O Atlas vem pré-configurado com
configurações padrão seguras. Você pode ajustar os recursos de segurança das
implantações de banco de dados para atender às suas necessidades e preferências
exclusivas de segurança. Revise os seguintes recursos e considerações de segurança para
implantações de banco de dados.

IMPORTANTE
Como prática recomendada de segurança, não inclua informações confidenciais em
namespaces e nomes de campos. Atlas não ofusca essas informações.

Recursos de segurança pré-configurados


Os seguintes recursos de segurança fazem parte do produto Atlas:

Criptografia em trânsito
O Atlas requer TLS/SSL para criptografar as conexões com seus bancos de dados.

Para configurar a verificação de revogação de certificado SSL ou TLS OCSP, consulte


Verificação de revogação de certificado OCSP.

Nuvem privada virtual


Todos os projetos Atlas com um ou mais clusters dedicados M10+ recebem seu próprio
VPC dedicado (ou VNet se você usar o Azure). O Atlas implanta todos os clusters
dedicados dentro desta VPC ou VNet.

Criptografia em repouso
Por padrão, o Atlas criptografa todos os dados armazenados nas implantações do banco de
dados Atlas. O Atlas também suporta criptografia em repouso usando seu gerenciamento
de chaves.

Recursos de segurança necessários


Você deve configurar os seguintes recursos de segurança:

Requisitos de rede e firewall


Certifique-se de que seu aplicativo possa alcançar seu ambiente MongoDB Atlas. Para
adicionar o acesso à rede de entrada do seu ambiente de aplicativo ao Atlas, siga um
destes procedimentos:

Adicione os endereços IP públicos à sua lista de acesso IP

Use peering VPC/VNet para adicionar endereços IP privados.

Adicione pontos finais privados.

DICA
Veja também:
Lista de acesso IP

Se o seu firewall bloquear conexões de rede de saída, você também deverá abrir o acesso
de saída do seu ambiente de aplicativo para o Atlas. Você deve configurar seu firewall para
permitir que seus aplicativos façam conexões de saída às portas 27015 a 27017 para
tráfego TCP em hosts Atlas. Isso concede aos seus aplicativos acesso aos bancos de
dados armazenados no Atlas.

OBSERVAÇÃO
Por padrão, os clusters MongoDB Atlas não precisam ser capazes de iniciar conexões com
seus ambientes de aplicativos. Se desejar habilitar clusters Atlas com autenticação e
autorização LDAP, você deverá permitir o acesso à rede dos clusters Atlas diretamente para
seu LDAP seguro. Você pode permitir o acesso ao seu LDAP usando IPs públicos ou
privados, desde que um nome de host DNS público aponte para um IP que os clusters Atlas
possam acessar.

Se você não estiver usando peering VPC/VNet e planeja se conectar ao Atlas usando
endereços IP públicos, consulte as páginas a seguir para obter informações adicionais:

Posso especificar meu próprio VPC para meu projeto MongoDB Atlas?

Os IPs públicos dos clusters Atlas mudam alguma vez?


Lista de acesso IP
O Atlas só permite conexões de clientes para a implantação do banco de dados a partir de
entradas na lista de acesso IP do projeto. Para conectar, você deve adicionar uma entrada à
lista de acesso IP. Para configurar a lista de acesso IP para o projeto, consulte Configurar
entradas da lista de acesso IP.

Para clusters Atlas implantados no Google Cloud Platform (GCP) ou Microsoft Azure,
adicione os endereços IP dos seus serviços Google Cloud ou Azure à lista de acesso IP do
projeto Atlas para conceder acesso a esses serviços ao cluster.

Autenticação ou autorização do usuário


O Atlas exige que os clientes se autentiquem para se conectar ao banco de dados. Você
deve criar usuários de banco de dados para acessar o banco de dados. Para configurar
usuários de banco de dados para suas implantações de banco de dados, consulte
Configurar usuários de banco de dados. Atlas oferece muitos recursos de segurança para
autenticação e autorização de implantação de banco de dados.

Para acessar implantações de banco de dados em um projeto, os usuários devem pertencer


a esse projeto. Os usuários podem pertencer a vários projetos.

DICA
Veja também:
Configure o acesso à UI do Atlas.

Recursos de segurança opcionais


Você pode configurar os seguintes recursos de segurança:

Conexão de peering de rede


O Atlas oferece suporte a conexões de peering com outras conexões de peering de rede
AWS, Azure ou Google Cloud. Para saber mais, consulte Configurar uma conexão de
peering de rede.

IMPORTANTE
Se este for o primeiro cluster pago dedicado M10+ para a região ou regiões selecionadas e
você planeja criar uma ou mais conexões de peering de VPC, revise a documentação sobre
conexões de peering de VPC antes de continuar.

Pontos finais privados


Atlas oferece suporte a endpoints privados em:

AWS usando o
AWS PrivateLink
recurso

Azure usando o
Link Privado do Azure
recurso
Google Cloud usando o
Conexão de serviço privado
recurso

Para usar endp privado pontos, consulte Saiba mais sobre endpoints privados no Atlas.

Acesso unificado à AWS


Alguns recursos do Atlas, incluindo Federação de dados e criptografia em repouso usando
gerenciamento de chaves do cliente, usam AWS
Funções do IAM
para autenticação.

Para configurar uma função AWS IAM para uso do Atlas, consulte Configurar o Unified AWS
Access.

Autenticação e autorização de implantação de banco de dados


O Atlas oferece os seguintes recursos de segurança para autenticação e autorização de
implantação de banco de dados.

Autenticação ou autorização de usuário do banco de dados


O Atlas exige que os clientes se autentiquem para acessar implantações de banco de
dados. Você deve criar usuários de banco de dados para acessar o banco de dados. Para
configurar usuários de banco de dados para suas implantações de banco de dados,
consulte Configurar usuários de banco de dados.

Funções personalizadas para autorização de banco de dados


O Atlas oferece suporte à criação de funções personalizadas para autorização de banco de
dados nos casos em que as funções integradas do Atlas não concedem o conjunto
desejado de privilégios.

Autenticação sem senha com AWS IAM


Você pode configurar a autenticação sem senha para usuários do AWS IAM das seguintes
maneiras:

Configure funções do AWS IAM para tornar opcionais os campos de nome de usuário ou
senha. Para saber mais, consulte Configurar a autenticação sem senha com funções do
AWS IAM.

Use credenciais temporárias obtidas com o


Operação da API AssumeRoleWithSAML
. Para saber mais, consulte Configurar autenticação sem senha usando SAML.

Autenticação ou autorização de usuário com LDAP


Atlas oferece suporte à autenticação e autorização de usuário com LDAP. Para usar o
LDAP, consulte Configurar autenticação e autorização do usuário com LDAP.

Autenticação de usuário com X.509


Os certificados de cliente X.509 fornecem aos usuários do banco de dados acesso às
implantações de banco de dados em seu projeto. As opções para autenticação X.509
incluem autenticação X.509 gerenciada pelo Atlas e autenticação X.509 autogerenciada.
Para saber mais sobre a autenticação X.509 autogerenciada, consulte Configurar a
autenticação X.509 autogerenciada.

Restringir o acesso de suporte do MongoDB à infraestrutura de back-end do Atlas


Os proprietários da organização podem restringir o acesso dos funcionários de suporte à
produção do MongoDB à infraestrutura de back-end do Atlas para qualquer implantação de
banco de dados Atlas em sua organização. Os proprietários da organização podem
conceder um desvio de 24 horas à restrição de acesso no nível de implantação do banco de
dados Atlas.

IMPORTANTE
Bloquear o acesso à infraestrutura do suporte MongoDB pode aumentar o tempo de
resposta e resolução de problemas de suporte e impactar negativamente a disponibilidade
da implantação do seu banco de dados.

Para ativar esta opção, consulte Configurar o acesso de suporte do MongoDB à


infraestrutura de backend do Atlas.

Criptografia em repouso usando seu gerenciamento de chaves


Atlas oferece suporte ao uso de AWS KMS, Azure Key Vault e Google Cloud para
criptografar mecanismos de armazenamento e backups de provedores de nuvem. Para usar
a criptografia em repouso, consulte Criptografia em repouso usando o gerenciamento de
chaves do cliente.

Criptografia em nível de campo do lado do cliente


Suportes Atlas
criptografia em nível de campo do lado do cliente
, Incluindo
automático
criptografia de campos. Todos os usuários do Atlas têm direito a usar os recursos
automáticos de criptografia em nível de campo do lado do cliente do MongoDB.

Para saber mais, consulte


Requisitos de criptografia em nível de campo do lado do cliente.

OBSERVAÇÃO
Bússola MongoDB
, a IU do Atlas e o
Shell do MongoDB
(mongosh) não suporta a descriptografia de campos criptografados em nível de campo do
lado do cliente.

DICA
Veja também:
Criptografia em nível de campo do lado do cliente
Guia de casos de uso para criptografia em nível de campo do lado do cliente

Auditoria de banco de dados


Atlas oferece suporte à auditoria de todas as ações de eventos do sistema. Para usar a
auditoria de banco de dados, consulte Configurar auditoria de banco de dados.

Rastreamento de acesso
O Atlas apresenta logs de autenticação diretamente na UI do Atlas para que você possa
revisar facilmente tentativas de autenticação bem-sucedidas e malsucedidas feitas em suas
implantações de banco de dados. Para visualizar seu histórico de acesso ao banco de
dados, consulte Exibir histórico de acesso ao banco de dados.

Autenticação multifator para acesso Atlas UI


Atlas oferece suporte a MFA para ajudá-lo a controlar o acesso às suas contas Atlas. Para
configurar a MFA, consulte Gerenciar suas opções de autenticação multifator.

Permitir acesso de ou para o plano de controle Atlas


Se você usar qualquer um dos seguintes recursos do Atlas, talvez seja necessário adicionar
endereços IP do Atlas à lista de acesso IP da sua rede:

Webhooks de alerta

Criptografia em repouso usando gerenciamento de chaves do cliente

OBSERVAÇÃO
Se você ativar o recurso Criptografia em repouso, deverá permitir o acesso de IPs públicos
para todos os seus hosts em sua implantação, incluindo
CSRS (conjuntos de réplicas do servidor de configuração)
se você estiver usando clusters fragmentados.

Acesso de saída obrigatório


Se sua rede permitir solicitações HTTP de saída apenas para endereços IP específicos,
você deverá permitir acesso aos seguintes endereços IP para que suas solicitações de API
possam alcançar o plano de controle do Atlas:

3.93.83.52
3.214.160.189
13.248.140.125
13.248.203.97
13.248.214.115
18.210.185.2
18.210.245.203
18.232.30.107
18.235.209.93
34.192.82.120
34.194.131.15
34.194.251.66
34.195.55.18
34.195.194.204
34.203.104.26
34.227.138.166
34.230.213.36
34.233.152.179
34.233.179.140
35.172.148.213
35.172.245.18
44.216.169.184
54.147.76.65
54.204.237.208
75.2.1.110
76.223.14.2
76.223.77.37
76.223.84.31
99.83.223.45

Acesso de entrada necessário


Se a sua rede permitir solicitações HTTP de entrada somente de endereços IP específicos,
você deve permitir o acesso dos seguintes endereços IP para que o Atlas possa se
comunicar com seus webhooks e KMS:

3.92.113.229
3.208.110.31
3.211.96.35
3.212.79.116
3.214.203.147
3.215.10.168
3.215.143.88
3.232.182.22
18.214.178.145
18.235.30.157
18.235.48.235
18.235.145.62
34.193.91.42
34.193.242.51
34.194.7.70
34.196.80.204
34.196.151.229
34.200.66.236
34.235.52.68
34.236.228.98
34.237.40.31
34.238.35.12
35.153.40.82
35.169.184.216
35.171.106.60
35.173.54.44
35.174.179.65
35.174.230.146
35.175.93.3
35.175.94.38
35.175.95.59
44.206.200.18
44.207.9.197
44.207.12.57
50.19.91.100
52.7.232.43
52.71.233.234
52.73.214.87
52.87.98.128
52.203.106.167
54.145.247.111
54.163.55.77
54.167.217.16
100.26.2.217
107.20.0.247
107.20.107.166
107.22.44.69

Permitir acesso à federação de dados


Se sua rede permitir solicitações de saída somente para endereços IP específicos, você
deverá permitir acesso aos seguintes endereços IP na porta TCP 27017 para que suas
solicitações possam alcançar a instância do banco de dados federado:

18.204.47.197
34.237.78.67
54.91.120.155
34.217.220.13
54.203.115.97
54.69.142.129
108.129.35.102
18.200.7.156
99.81.123.21
3.8.218.156
3.9.125.156
3.9.90.17
18.196.201.253
3.122.67.212
35.158.226.227
13.54.14.65
52.64.205.136
3.6.3.105
65.1.222.250
Verificação de revogação de certificado OCSP
Se a sua rede permitir solicitações de saída apenas para endereços IP específicos, para
permitir a verificação de revogação de certificado SSL ou TLS OCSP, você deverá permitir o
acesso aos servidores OCSP Responder CA (Autoridade de Certificação) da Atlas que
podem ser encontrados na URL OCSP do SSL ou TLS certificado.

Para desabilitar a verificação de revogação de certificado OCSP, consulte a documentação


da versão Driver MongoDB que seu aplicativo usa.
Configurar o acesso ao cluster com o
assistente de início rápido
Nesta página

Procedimento
A UI do Atlas inclui uma página de início rápido para configurar o acesso ao seu cluster.
Para configurar o acesso ao seu cluster, você deve fazer o seguinte:

Configurar usuários do banco de dados

Configurar entradas da lista de acesso IP

Procedimento
Para configurar o acesso ao seu cluster na página de início rápido:

1
Navegue até a página de início rápido.
Na seção Segurança da navegação esquerda, clique em Início rápido. Se o Início rápido
não estiver disponível na navegação à esquerda da interface do usuário, adicione o Início
rápido à interface do usuário na página Configurações do projeto, alternando o Início rápido
do Atlas Security para Ativado na página Configurações do projeto.

2
Especifique como você gostaria de autenticar a conexão com seu cluster Atlas.
Na seção Como você gostaria de autenticar sua conexão? da página Início rápido, você
pode configurar uma das opções a seguir para seu cluster.

Usuário e senha

Certificado
Clique em Nome de usuário e Senha.

Defina o nome de usuário e a senha do novo usuário.

OBSERVAÇÃO
Se você usar caracteres especiais em sua senha, deverá escapá-los na cadeia de conexão
usada para se conectar ao cluster. Para saber mais, consulte Caracteres especiais na
senha da string de conexão.

Você não pode alterar um nome de usuário depois de criá-lo. Você pode clicar no botão
Editar para editar a senha.

Clique em Criar usuário.

DICA
Veja também:
Configurar usuários do banco de dados

Configurar autenticação X.509 autogerenciada

3
Especifique de onde você gostaria de se conectar ao cluster Atlas.
Você pode habilitar o acesso para qualquer rede que precise ler e gravar dados em seu
cluster. Para ativar o acesso, você pode configurar o acesso do seu ambiente local ou do
ambiente de nuvem para o seu cluster.

Ambiente local

Ambiente em nuvem
Escolha Meu ambiente local para adicionar endereços IP de rede à lista de acesso IP do
projeto. O Atlas permite apenas conexões de clientes para a implantação do banco de
dados a partir de entradas na lista de acesso IP do projeto. Você pode modificar os
endereços IP na lista de acesso a qualquer momento.

Insira o endereço IP e uma descrição para associar ao endereço IP nos campos Endereço
IP e Descrição, respectivamente, ou clique em Adicionar meu endereço IP atual.

Você pode especificar um único endereço IP ou um intervalo de endereços com notação


CIDR.

Clique em Adicionar entrada.

DICA
Veja também:
Configurar entradas da lista de acesso IP

Configurar uma conexão de peering de rede

Configurar pontos finais privados

4
Clique em Concluir e Fechar.
Depois de concluir a configuração do banco de dados e do acesso à rede para o primeiro
cluster do seu projeto, o Atlas desabilita o acesso ao Quickstart. Você pode habilitá-lo para
revisitar essas configurações a partir de uma página consolidada.

Uma caixa de diálogo é exibida solicitando que você especifique se deseja ver a página de
início rápido em sua navegação. Você pode marcar ou desmarcar a caixa de seleção
Ocultar guia de início rápido na navegação para ocultar ou adicionar o início rápido à sua
navegação.
Alternativamente, você pode ocultar ou adicionar o Quickstart à sua navegação na página
Configurações do projeto, alternando o Início rápido do Atlas Security na página
Configurações do projeto para Desativado ou Ativado, respectivamente.

5
Clique em Ir para o banco de dados para visualizar suas implantações de banco de dados.
Configurar entradas da lista de acesso IP
Nesta página

Acesso obrigatório
Ver entradas da lista de acesso IP
Adicionar entradas da lista de acesso IP
Modificar entradas da lista de acesso IP
Excluir entradas da lista de acesso IP
O Atlas só permite conexões de clientes para a implantação do banco de dados a partir de
entradas na lista de acesso IP do projeto. Cada entrada é um único endereço IP ou um
intervalo de endereços com notação CIDR. Para clusters da AWS com uma ou mais
conexões de peering de VPC para a mesma região da AWS, você pode especificar um
grupo de segurança associado a uma VPC com peering.

Para clusters Atlas implantados no Google Cloud Platform (GCP) ou Microsoft Azure,
adicione os endereços IP dos seus serviços Google Cloud ou Azure à lista de acesso IP do
projeto Atlas para conceder acesso a esses serviços ao cluster.

A lista de acesso IP se aplica a todas as implantações de banco de dados no projeto e pode


ter até 200 entradas na lista de acesso IP, com a seguinte exceção: projetos com um cluster
fragmentado existente criado antes de 25 de agosto de 2017 podem ter até 100 entradas na
lista de acesso IP.

O Atlas oferece suporte à criação de entradas temporárias de lista de acesso IP que


expiram dentro de um período de 7 dias configurável pelo usuário.

O Atlas audita a criação, exclusão e atualizações de entradas da lista de acesso de IP


temporárias e permanentes no Feed de atividades do projeto.

Para visualizar o Feed de atividades do projeto, clique em Feed de atividades na seção


Projeto do painel de navegação esquerdo.

DICA
Veja também:
Ver todas as atividades

OBSERVAÇÃO
Considerações sobre feed de atividades
O Atlas não relata atualizações no comentário de uma entrada da lista de acesso IP no
Feed de atividades.

Quando você modifica o endereço de uma entrada da lista de acesso IP, o Feed de
atividades relata duas novas atividades: uma para a exclusão da entrada antiga e outra para
a criação da nova entrada.

Acesso obrigatório
Para gerenciar entradas da Lista de Acesso IP, você deve ter acesso de Proprietário do
Projeto ao projeto.

Os usuários com acesso de Proprietário da Organização devem adicionar-se ao projeto


como Proprietário do Projeto.

Ver entradas da lista de acesso IP

CLI do Atlas

IU do Atlas
Para listar as entradas da lista de acesso IP do seu projeto usando a CLI do Atlas, execute
o seguinte comando:

atlas accessLists list [options]

Para retornar os detalhes da entrada da lista de acesso IP especificada usando a CLI do


Atlas, execute o seguinte comando:

atlas accessLists describe <entry> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
lista de listas de acesso do atlas
e
atlas accessLists descreve.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Adicionar entradas da lista de acesso IP

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para criar uma lista de acesso IP para o seu projeto usando o Atlas CLI, execute o seguinte
comando:
atlas accessLists create [entry] [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas accessLists criam.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Modificar entradas da lista de acesso IP

CLI do Atlas

API de administração do Atlas

IU do Atlas
Você não pode modificar entradas da lista de acesso IP com o Atlas CLI. Selecione uma
interface diferente para saber como modificar as entradas da lista de acesso IP.

Excluir entradas da lista de acesso IP


IMPORTANTE
Quando você remove uma entrada da lista de acesso IP, as conexões existentes dos
endereços removidos podem permanecer abertas por um período de tempo variável.
Quanto tempo passa antes que o Atlas feche a conexão depende de vários fatores,
incluindo:

como a conexão foi estabelecida

como o aplicativo ou
motorista
usando o endereço se comporta

qual protocolo (como TCP ou UDP) a conexão usa

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para excluir uma lista de acesso IP do seu projeto usando a CLI do Atlas, execute o
seguinte comando:

atlas accessLists delete <entry> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas accessLists excluir.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Configurar uma conexão de peering de rede
Nesta página

Acesso obrigatório
Configurar contêineres de rede
Configurar uma conexão de peering de rede Atlas
Ver conexões de peering de rede Atlas
Remover uma conexão de peering de rede Atlas
Arquiteturas de peering de rede
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber
mais, consulte as Limitações do Atlas M0 (cluster gratuito), M2 e M5.

No momento, esse recurso não é compatível com instâncias sem servidor. Para saber mais,
consulte Limitações de instância sem servidor.

O Atlas oferece suporte a conexões de peering de rede para clusters dedicados


hospedados em AWS, Google Cloud e Azure, e em clusters fragmentados em várias
nuvens.

O peering de rede estabelece uma conexão privada entre sua VPC Atlas e a VPC do seu
provedor de nuvem. A conexão isola o tráfego de redes públicas para maior segurança.

AVISO
O Atlas não oferece suporte ao peering de rede entre clusters implantados em uma única
região em diferentes provedores de nuvem. Por exemplo, você não pode configurar o
peering de rede entre um cluster Atlas hospedado em uma única região na AWS e um
aplicativo hospedado em uma única região no GCP.

Acesso obrigatório
Para configurar uma conexão de peering de rede, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao projeto.

Configurar contêineres de rede


Crie um contêiner de rede
Para configurar o Atlas CIDR sem configurar o peering de rede, consulte
Crie um novo contêiner de peering de rede
. Você deve usar a API para criar o contêiner sem peering de rede.

Ver contêineres de rede

CLI do Atlas

API de administração do Atlas


Para listar todos os contêineres de peering de rede do seu projeto usando a CLI do Atlas,
execute o seguinte comando:
atlas networking containers list [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
lista de contêineres de rede do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Excluir contêineres de rede

CLI do Atlas

API de administração do Atlas


Para excluir o contêiner de peering de rede especificado usando a CLI do Atlas, execute o
seguinte comando:

atlas networking containers delete <containerId> [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
exclusão de contêineres de rede atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Configurar uma conexão de peering de rede Atlas


Para configurar o Atlas Network Peering para um cluster, execute o procedimento na aba
correspondente ao provedor de nuvem do seu cluster. Você também configura o CIDR Atlas
VPC durante este procedimento.

AWS

Azul

GCP
Considerações
Configuração DNS
O DNS resolve os nomes de host do cluster para o endereço IP público, em vez do
endereço IP interno, se:

Os nomes de host DNS estão desativados,

A resolução DNS está desativada e

O usuário acessa o cluster Atlas de fora de uma VPC com peering.

Para saber mais sobre como ativar essas opções, consulte


Atualizando o suporte DNS para sua VPC.

Se os aplicativos implantados na AWS usarem serviços DNS personalizados e peering de


VPC com Atlas, consulte as perguntas frequentes para saber como se conectar usando
strings de conexão privadas.

Implantações em múltiplas regiões


As implantações do Atlas em diversas regiões devem ter uma conexão de peering para
cada região do Atlas.

Por exemplo: se você tiver uma VPC em Sydney e implantações do Atlas em Sydney e
Cingapura, crie duas conexões de peering.

Pré-requisitos de emparelhamento de VPC da AWS


Crie a seguinte regra de tráfego de rede no grupo de segurança da AWS anexado aos
recursos que se conectam ao Atlas:

Permissão
Direção
Porta
Alvo
Permitir
saída
27015-27017 inclusive
para o seu Atlas CIDR
Configurar peering de rede para um cluster apoiado pela AWS
Para configurar o peering Atlas VPC para um cluster apoiado pela AWS:

1
Na AWS, habilite nomes de host DNS e resolução DNS.
Faça login em sua conta AWS.

Vou ao
Painel VPC
.

Abra sua lista de recursos VPC.


Selecione a VPC com a qual deseja fazer peering.

Habilite nomes de host DNS e resolução DNS.

Essas configurações garantem que, quando seu aplicativo se conectar ao cluster na VPC,
ele use endereços IP privados.

2
No Atlas, adicione uma nova conexão de peering de rede para o seu projeto.
OBSERVAÇÃO
Você pode pular esta etapa se estiver usando a CLI do Atlas para adicionar uma conexão
de peering de rede.

Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Clique em Acesso à rede na barra lateral.

Na guia Peering, clique em Adicionar conexão de peering.

3
No Atlas, configure sua conexão de peering de rede.

CLI do Atlas

IU do Atlas
Para criar uma conexão de peering de rede com a AWS usando a CLI do Atlas, execute o
seguinte comando:

atlas networking peering create aws [options]

Para observar a disponibilização de uma conexão de peering usando a CLI do Atlas,


execute o seguinte comando:

atlas networking peering watch <peerId> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
seção At documentação CLI para
peering de rede atlas criar aws
e
relógio de peering de redes atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Preencha os campos na seção Seu Atlas VPC.

Campo
Descrição
Região Atlas VPC
Região da AWS onde reside o Atlas VPC. O Atlas criará uma VPC para o projeto Atlas na
região escolhida se essa região não tiver clusters M10 ou superiores ou conexões de
peering de VPC.

Desmarque Igual à região VPC do aplicativo para selecionar uma região diferente de onde
reside o VPC do seu aplicativo.

CIDR de VPC
O Atlas usa esse bloco CIDR do Atlas para todas as outras conexões de peering de rede
criadas no projeto. O bloco CIDR Atlas deve ser pelo menos /24 e no máximo /21 em um
dos seguintes
redes privadas.

Limite Inferior
Limite superior
Prefixo
10.0.0.0
10.255.255.255
8/10
172.16.0.0
172.31.255.255
172.16/12
192.168.0.0
192.168.255.255
192.168/16
O Atlas bloqueia esse valor para uma determinada região se já existir um cluster M10 ou
superior ou uma conexão de peering de rede nessa região.

Para modificar o bloco CIDR, o projeto de destino não pode ter:

Qualquer cluster M10 ou superior com nós na região de destino

Quaisquer instantâneos de backup em nuvem armazenados na região de destino


Quaisquer outras conexões de peering de VPC com a região de destino

Você também pode criar um novo projeto e, em seguida, criar uma conexão de peering de
rede para definir o bloco CIDR Atlas VPC desejado para esse projeto.

IMPORTANTE
O Atlas limita o número de nós MongoDB por conexão de peering de rede com base no
bloco CIDR e na região selecionada para o projeto.

EXEMPLO
Um projeto em uma região da AWS que oferece suporte a três zonas de disponibilidade e
um bloco Atlas CIDR VPC de /24 é limitado ao equivalente a 27 conjuntos de réplicas de
três nós.

Contato
Suporte MongoDB
para qualquer dúvida sobre os limites do Atlas de nós MongoDB por VPC.

Clique em Iniciar peering.

Aguarde a aprovação da solicitação de conexão de peering.

O proprietário da VPC de peering deve aprovar a solicitação de conexão de peering de


VPC. Certifique-se de que o proprietário aprove a solicitação.

Atlas fornece instruções para aprovar a solicitação de conexão.

IMPORTANTE
As solicitações expiram após 7 dias.
4
Na AWS, atualize a tabela de rotas da sua VPC.
No VPC Dashboard, clique em Tabelas de rotas.

Selecione a tabela de rotas para sua VPC ou sub-redes.

Clique na guia Rotas.

Clique em Editar rotas.

Clique em Adicionar rota.

Adicione o bloco CIDR do Atlas VPC à coluna Destino.

Adicione o ID de conexão de peering da AWS à coluna Destino.

Este valor usa um prefixo pcx-.


Clique em Salvar.

OBSERVAÇÃO
Cada projeto Atlas pode ter no máximo 50 conexões de peering no total. Este total inclui um
máximo de 25 conexões de peering pendentes.

Após a configuração, você pode editar ou encerrar a conexão de peering de VPC na tabela
de peering.

Antes que seu novo par de VPC possa se conectar ao cluster Atlas, você deve:

Localize os endereços de bloco CIDR da VPC (ou subconjunto) ou os grupos de segurança


associados à VPC configurada em seu projeto.

Adicione pelo menos um desses blocos CIDR à lista de acesso.

DICA
Veja também:
Seleção de sub-rede CIDR para MongoDB Atlas

Perguntas frequentes sobre alterações no peering de rede da AWS.

Ver conexões de peering de rede Atlas

CLI do Atlas

IU do Atlas
Para retornar os detalhes de todas as conexões de peering de rede no projeto especificado
usando a CLI do Atlas, execute o seguinte comando:

lista de peering de rede atlas [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
lista de peering de rede atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Remover uma conexão de peering de rede Atlas

CLI do Atlas

IU do Atlas
Para excluir a conexão de peering de rede especificada usando a CLI do Atlas, execute o
seguinte comando:

peering de rede atlas excluir <peerId> [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
exclusão de peering de rede atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Arquiteturas de peering de rede


Vários aplicativos hospedados na nuvem podem precisar se conectar com segurança ao
mesmo projeto Atlas.

Peering de rede entre uma VPC Atlas e duas redes virtuais com blocos CIDR idênticos
Considere um caso em que dois aplicativos usam redes virtuais (VPC, VNet) com blocos
CIDR de IP idênticos. Você deseja que ambos os aplicativos se conectem com segurança
ao mesmo cluster Atlas por meio de peering de VPC. Para conseguir isto, crie uma ligação
de peering de rede entre a rede virtual de cada aplicação e o seu cluster Atlas.

As redes virtuais do provedor de nuvem não poderão fazer peering entre si se tiverem
blocos CIDR idênticos. No entanto, você poderá emparelhar cada uma das redes virtuais
dos aplicativos com a rede virtual Atlas se a rede virtual Atlas incluir dois blocos CIDR não
sobrepostos. Configure cada uma das conexões de peering para ter blocos CIDR de retorno
de rota não sobrepostos na rede virtual Atlas.

Siga este processo geral:

Antes de implantar qualquer cluster, criar uma conexão de peering de rede para cada rede
virtual que você deseja emparelhar com o Atlas. Você faz isso criando um bloco CIDR na
rede virtual Atlas.
Na configuração da rede virtual do seu provedor de nuvem, estabeleça o roteamento entre
cada uma das redes virtuais do seu aplicativo e seus respectivos blocos CIDR Atlas.

Implante seu cluster Atlas.


Configurar pontos finais privados
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber mais
sobre quais recursos não estão disponíveis, consulte Limitações do Atlas M0 (cluster
gratuito), M2 e M5.

Os pontos finais privados permitem uma ligação privada entre o seu fornecedor de nuvem e
o Atlas que não envia informações através de uma rede pública. Você pode usar pontos de
extremidade privados para criar uma conexão unidirecional com implantações de banco de
dados Atlas a partir da sua rede virtual.

Use os seguintes recursos para ajudá-lo a aprender e configurar pontos finais privados:

Saiba mais sobre endpoints privados no Atlas

Configurar um endpoint privado para um cluster dedicado

Configurar um endpoint privado para uma instância sem servidor

Gerencie e conecte-se a partir de endpoints privados

Solucionar problemas de conexão de endpoint privado


Saiba mais sobre endpoints privados no Atlas
Nesta página

Acesso obrigatório
Considerações
Limitações
Pré-requisitos
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber mais
sobre quais recursos não estão disponíveis, consulte as Limitações do Atlas M0 (cluster
gratuito), M2 e M5.

MongoDB Atlas oferece suporte a endpoints privados em clusters dedicados e instâncias


sem servidor. Selecione o tipo de implantação do seu banco de dados para saber quais
provedores de nuvem o Atlas suporta:

Clusters Dedicados

Instâncias sem servidor


AWS usando o
AWS PrivateLink
recurso.

Azure usando o
Link Privado do Azure
recurso.

Google Cloud usando o


Conexão de serviço privado
recurso.

Você também pode configurar endpoints privados para seu arquivo online. Para saber mais,
consulte Configurar um endpoint privado para arquivos online.

AWS PrivateLink

Link Privado do Azure

Conexão de serviço privado


Quando você habilita esse recurso, o Atlas cria sua própria VPC e coloca implantações de
banco de dados em uma região atrás de um balanceador de carga de rede na VPC do
Atlas.
Em seguida, você cria recursos que estabelecem uma conexão unidirecional da sua VPC
com o balanceador de carga de rede na VPC Atlas usando um endpoint privado.

AWS PrivateLink

AWS PrivateLink com conexão direta


Imagem mostrando como o AWS PrivateLink se estabelece
conexões da VPC do seu aplicativo para
recursos no |serviço| VPC.
Clique para ampliar
As conexões com implantações de banco de dados Atlas usando terminais privados
oferecem as seguintes vantagens em relação a outras opções de gerenciamento de acesso
à rede:

As conexões que usam pontos finais privados são unidirecionais. As VPCs Atlas não podem
iniciar conexões com suas VPCs. Isso garante que o limite de confiança da rede percebido
não seja estendido.

As conexões com endpoints privados em sua VPC podem ser feitas de forma transitória a
partir de:

Outra VPC fez peering com a VPC conectada ao endpoint privado.

Um data center local conectado com


Conexão direta
ao VPC conectado ao endpoint privado. Isso permite que você se conecte ao Atlas
diretamente do seu data center local sem adicionar endereços IP públicos à lista de acesso
IP do Atlas.

Acesso obrigatório
Para configurar um ponto final privado, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao projeto.

Considerações
Alta disponibilidade
Para garantir que as ligações de ponto final privado ao Atlas possam resistir a uma
interrupção da zona de disponibilidade, deve implementar sub-redes em múltiplas zonas de
disponibilidade numa região.

Intervalos de portas usados para endpoints privados


O AWS PrivateLink oferece suporte a 50 destinos endereçáveis, o Atlas pode usar a porta
1024 até a porta 65535, mas normalmente começa com a porta 1024. As portas podem
mudar em circunstâncias específicas, incluindo (mas não se limitando a) alterações de
cluster.

IMPORTANTE
O MongoDB recomenda fortemente o uso da string de conexão com reconhecimento de
endpoint privado da lista de valores iniciais de DNS, para que o DNS atualize
automaticamente as portas que o AWS PrivateLink usa se elas mudarem. Pela mesma
razão, o MongoDB também recomenda fortemente listar todo o intervalo de portas, em vez
de portas específicas.

Strings de conexão com reconhecimento de endpoint privado


Quando você configura um endpoint privado, o Atlas gera uma lista de valores iniciais de
DNS e cadeias de conexão padrão com reconhecimento de endpoint privado:

Conexão de lista de valores iniciais DNS

mongodb+srv://cluster0-pl-0-k45tj.mongodb.net

Cadeia de conexão padrão

mongodb://pl-0-us-east-1-k45tj.mongodb.net:1024,pl-0-us-east-1-k45tj.mongodb.net:
1025,pl-0-us-east-1-k45tj.mongodb.net:1026/?ssl=true&authSource=admin&replicaS
et=Cluster0-shard-0-shard-0

Quando um cliente em sua VPC se conecta a uma implantação de banco de dados Atlas
usando uma dessas strings de conexão com reconhecimento de endpoint privado, o cliente
tenta estabelecer uma conexão com o balanceador de carga na VPC Atlas por meio de um
dos endpoints de interface. O mecanismo de resolução DNS do seu cliente trata para quais
pontos de extremidade da interface o nome do host é resolvido. Se um endpoint de interface
não estiver disponível, o próximo será usado. Isso é opaco para o driver ou outro
mecanismo de conexão. O driver só reconhece o nome do host no registro SRV ou na
cadeia de conexão.

Registro SRV para cadeias de conexão com reconhecimento de endpoint privado da lista de
valores iniciais de DNS

O exemplo a seguir mostra o registro SRV para um cluster de região única habilitado para
AWS PrivateLink, mostrando três portas exclusivas definidas para
pl-0-us-east-1-k45tj.mongodb.net:

$ nslookup -type=SRV _mongodb._tcp.cluster0-pl-0-k45tj.mongodb.net


Server: 127.0.0.53
Address: 127.0.0.53#53
Non-authoritative answer:
_mongodb._tcp.cluster0-pl-0-k45tj.mongodb.net service = 0 0 1026
pl-0-us-east-1-k45tj.mongodb.net.
_mongodb._tcp.cluster0-pl-0-k45tj.mongodb.net service = 0 0 1024
pl-0-us-east-1-k45tj.mongodb.net.
_mongodb._tcp.cluster0-pl-0-k45tj.mongodb.net service = 0 0 1025
pl-0-us-east-1-k45tj.mongodb.net.

DICA
No exemplo anterior:

_mongodb._tcp.cluster0-pl-0-k45tj.mongodb.net é o registro SRV ao qual a cadeia de


conexão mongodb+srv://cluster0-pl-0-k45tj.mongodb.net faz referência.

pl-0-us-east-1-k45tj.mongodb.net é o nome do host de cada nó em um cluster Atlas em uma


região para a qual você configurou o AWS PrivateLink.

1024, 1025 e 1026 são portas exclusivas que O Atlas atribui no balanceador de carga para
cada nó do conjunto de réplicas do Atlas na região para a qual você habilitou o AWS
PrivateLink. Todos os nós em um conjunto de réplicas do Atlas são acessíveis por meio do
mesmo nome de host, com o balanceador de carga resolvendo nós individuais por sua porta
exclusiva.

Resolução DNS de nome de host em strings de conexão com reconhecimento de endpoint


privado e registros SRV

O nome do host no registro SRV e a string de conexão padrão é um registro DNS Canonical
Name (CNAME) que resolve o nome DNS regional específico do endpoint que a AWS gera
para o endpoint da interface. Existe um registro DNS ALIAS para cada sub-rede na VPC na
qual você implantou o endpoint da interface. Cada registro ALIAS contém o endereço IP
privado do terminal de interface dessa sub-rede.

O exemplo a seguir mostra a pesquisa de DNS para o nome do host no registro SRV e na
cadeia de conexão padrão, incluindo o nome DNS regional específico do endpoint para o
endpoint da interface e seus registros DNS ALIAS:

$ nslookup pl-0-us-east-1-k45tj.mongodb.net
Server: 127.0.0.53
Address: 127.0.0.53#53
Non-authoritative answer:
pl-0-us-east-1-k45tj.mongodb.net
canonical name =
vpce-024f5b57108c8d3ed-ypwbxwll.vpce-svc-02863655456245e5c.us-east-1.vpce.am
azonaws.com.
Name:
vpce-024f5b57108c8d3ed-ypwbxwll.vpce-svc-02863655456245e5c.us-east-1.vpce.am
azonaws.com
Address: 10.0.30.194
Name:
vpce-024f5b57108c8d3ed-ypwbxwll.vpce-svc-02863655456245e5c.us-east-1.vpce.am
azonaws.com
Address: 10.0.20.54

DICA
Veja também:
Conecte-se ao Atlas usando um endpoint privado

Listas de acesso IP e conexões de peering de rede com pontos finais privados


Ao ativar pontos finais privados, ainda pode permitir o acesso às suas implementações de
base de dados Atlas utilizando outros métodos, como adicionar IPs públicos a listas de
acesso IP e peering de rede.

Os clientes que se conectam a implantações de banco de dados Atlas usando outros


métodos usam cadeias de conexão padrão. Seus clientes talvez precisem identificar quando
usar cadeias de conexão com reconhecimento de endpoint privado e cadeias de conexão
padrão.

(Opcional) Endpoints privados regionalizados para clusters fragmentados multirregionais


Para clusters fragmentados globais e multirregionais, você pode implantar vários pontos de
extremidade privados em uma região se precisar se conectar ao Atlas usando um ponto de
extremidade privado de redes que não podem ser emparelhadas entre si.

Você pode implantar qualquer número de terminais privados em regiões nas quais
implantou sua implantação de banco de dados. Cada endpoint privado regional se conecta
ao
mongos
casos naquela região.

AVISO
Suas cadeias de conexão para clusters fragmentados globais e multirregionais existentes
mudam quando você habilita essa configuração.

Você deve atualizar seus aplicativos para usar as novas cadeias de conexão. Isso pode
causar tempo de inatividade.

Você poderá habilitar essa configuração somente se o seu projeto Atlas não contiver
conjuntos de réplicas não fragmentadas.

Você não pode desativar essa configuração se tiver:

Mais de um endpoint privado em mais de uma região ou

Mais de um ponto final privado numa região e um ponto final privado em uma ou mais
regiões.
Você só pode criar clusters fragmentados ao habilitar a configuração de endpoint privado
regionalizado. Você não pode criar conjuntos de réplicas.

Para usar esse recurso, você deve ativar a configuração de terminal privado regionalizado.

Para ativar ou desativar a configuração do endpoint privado regionalizado:

CLI do Atlas

IU do Atlas
Habilitar endpoints privados regionalizados
Para habilitar a configuração de endpoint privado regionalizado para seu projeto usando a
CLI do Atlas, execute o seguinte comando:

atlas privateEndpoints regionalModes enable [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atlas privateEndpoints regionalModes habilitados.

Desabilitar endpoints privados regionalizados


Para desabilitar a configuração de endpoint privado regionalizado para seu projeto usando a
CLI do Atlas, execute o seguinte comando:

atlas privateEndpoints regionalModes disable [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atlas privateEndpoints regionalModes desativados.

Exibir configurações de endpoint privado regionalizado


Para retornar as configurações de endpoint privado regionalizado para seu projeto usando a
CLI do Atlas, execute o seguinte comando:

atlas privateEndpoints regionalModes disable [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atlas privateEndpoints regionalModes descreve.

(Opcional) Melhore o desempenho da conexão para clusters fragmentados atrás de um


endpoint privado
O Atlas pode gerar uma cadeia de conexão SRV otimizada para clusters fragmentados
usando os balanceadores de carga do seu serviço de endpoint privado. Quando você usa
uma cadeia de conexão otimizada, o Atlas limita o número de conexões por mongos entre
seu aplicativo e seu cluster fragmentado. As conexões limitadas por mongos melhoram o
desempenho durante picos na contagem de conexões.

OBSERVAÇÃO
O Atlas não oferece suporte a cadeias de conexão otimizadas para clusters executados no
Google Cloud ou no Azure.

Para saber mais sobre cadeias de conexão otimizadas para clusters fragmentados atrás de
uma extremidade privada ponto, consulte Melhorar o desempenho da conexão para clusters
fragmentados atrás de um ponto final privado.

Cobrança
Para saber mais sobre a faturação de pontos finais privados para clusters dedicados,
consulte Pontos finais privados para clusters dedicados.

Limitações
O AWS PrivateLink deve estar ativo em todas as regiões nas quais você implanta um cluster
multirregional. Você receberá um erro se o AWS PrivateLink estiver ativo em algumas
regiões de destino, mas não em todas. Se você tiver um cluster multinuvem no AWS ou no
Azure, deverá provisionar um endpoint em cada provedor ou região e configurar uma VPN
site a site.

Você pode fazer apenas um dos seguintes:

Crie mais de um ponto final privado numa única região.

Crie no máximo um ponto final privado por região, se os nós forem implantados em mais de
uma região.

IMPORTANTE
Esta limitação se aplica a todos os provedores de nuvem. Por exemplo, se criar mais de um
ponto final privado numa única região no AWS, não poderá criar pontos finais privados em
mais de uma região no Azure.

Ver
(Opcional) Endpoints privados regionalizados para clusters fragmentados multirregionais
para uma exceção para clusters fragmentados globais e multirregionais.

Para se conectar a implantações de banco de dados Atlas usando o AWS PrivateLink de


regiões nas quais você não implantou uma conexão de endpoint privado, você deve
emparelhar VPCs nessas regiões com VPCs em uma região na qual você implantou uma
conexão de endpoint privado.

Para saber mais sobre peering de VPC entre regiões, consulte o


Documentação da AWS.
Você pode usar o AWS PrivateLink em projetos Atlas com até 50 destinos endereçáveis por
região. Se você precisar de mais de 50 alvos endereçáveis em uma região:

Entre em contato com o suporte do MongoDB ou

Use projetos ou regiões adicionais para conectar-se a alvos alcançáveis além deste limite.

Os alvos endereçáveis incluem:

Cada
mondeus
instância em uma implantação de conjunto de réplicas (clusters fragmentados excluídos).

Cada implantação de cluster fragmentado que usa cadeias de conexão otimizadas.

Cada
mongos
instância para implantações de cluster fragmentado que usam cadeias de conexão não
otimizadas.

Cada instância do BI Connector for Atlas em todos os clusters dedicados do projeto.

OBSERVAÇÃO
Para solicitar um aumento único para usar o AWS PrivateLink com até 100 destinos
endereçáveis por projeto Atlas, entre em contato com o suporte do MongoDB.

Antes de poder implementar um ponto final privado numa região, deve primeiro retomar
quaisquer implementações de base de dados pausadas no seu projeto com nós
implementados nessa região.

Pré-requisitos
Para habilitar conexões com o Atlas usando endpoints privados, você deve:

Tenha uma forma de pagamento válida já configurada para sua organização.

Ter a função de Proprietário do Projeto ou Proprietário da Organização no Atlas.

Tenha uma conta de usuário da AWS com uma política de usuário do IAM que conceda
permissões para criar, modificar, descrever e excluir endpoints. Para obter mais informações
sobre como controlar o uso de terminais de interface, consulte o
Documentação da AWS.

(Recomendado):
Instale a AWS CLI.

Caso ainda não tenha feito isso, crie suas instâncias VPC e EC2 na AWS. Veja o
Documentação da AWS para orientação.
Configurar um endpoint privado para um
cluster dedicado
Nesta página

Acesso obrigatório
Pré-requisitos, considerações e limitações
Siga esses passos
Dê os próximos passos
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber mais
sobre quais recursos não estão disponíveis, consulte Limitações do Atlas M0 (cluster
gratuito), M2 e M5.

Siga estas etapas para permitir que um cliente se conecte a um cluster dedicado do Atlas
usando pontos finais privados.

Para saber mais sobre como usar pontos finais privados com o Atlas, consulte Saiba mais
sobre pontos finais privados no Atlas.

Para configurar um endpoint privado para uma instância sem servidor, consulte Configurar
um endpoint privado para uma instância sem servidor.

Acesso obrigatório
Para configurar um endpoint privado para um cluster dedicado, você deve ter acesso de
Proprietário da Organização ou Proprietário do Projeto ao projeto.

Pré-requisitos, considerações e limitações


Para conhecer os pré-requisitos, considerações e limitações para configurar um ponto final
privado, consulte os seguintes recursos:

Pré-requisitos

Considerações

Limitações

Siga esses passos

AWS PrivateLink

Link Privado do Azure

Conexão de serviço privado

CLI do Atlas
IU do Atlas
Para configurar o AWS PrivateLink por meio da CLI do Atlas,
instale a CLI do Atlas
e
conectar-se a partir da CLI do Atlas
. Em seguida, conclua as seguintes etapas:

1
Crie o serviço de endpoint privado no Atlas.
Execute o comando Atlas CLI para criar um endpoint privado e um serviço de endpoint
privado no Atlas. Certifique-se de que o valor de --region corresponda à região onde você
implantou seu cluster:

atlas privateEndpoints aws create [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atlas privateEndpoints aws criar.

Se você tiver um cluster multirregional ou multinuvem e não habilitar pontos finais privados
regionalizados, deverá provisionar um ponto final para cada provedor e região.

Anote o ID do serviço de ponto final privado na resposta. Neste exemplo, o ID é


6344ac8f51b94c6356527881.

Private endpoint '6344ac8f51b94c6356527881' created.

2
Recuperar o nome do serviço de terminal privado.
OBSERVAÇÃO
Pode levar algum tempo para o Atlas provisionar o ponto final privado. Aguarde 1-2 minutos
antes de concluir esta etapa.

Execute o comando Atlas CLI para descrever o endpoint privado usando seu ID de serviço:

atlas privateEndpoints aws describe <privateEndpointId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atlas privateEndpoints aws descreve.
Observe o valor de ENDPOINT SERVICE na resposta, que mostra o nome do serviço do
terminal. Neste exemplo, o nome do serviço de endpoint é
com.amazonaws.vpce.us-east-1.vpce-svc-0705499aae25ac77c:

ERRO DE STATUS DO SERVIÇO ID ENDPOINT


6344ac8f51b94c6356527881
com.amazonaws.vpce.us-east-1.vpce-svc-0705499aae25ac77c DISPONÍVEL
Se o valor STATUS for INITIATING, aguarde mais 1-2 minutos para que o Atlas provisione o
ponto final privado. Em seguida, tente esta etapa novamente.

3
Crie o endpoint da interface na AWS.
Execute o comando na AWS CLI, substituindo os seguintes espaços reservados pelos seus
valores:

Espaço reservado
Descrição
{ID-VPC}
String exclusiva que identifica o peer AWS VPC. Encontre esse valor no painel VPC em sua
conta AWS.
{REGIÃO}
Região da AWS na qual reside a implantação do seu banco de dados.
{IDS DE SUB-REDE}
String exclusiva que identifica as sub-redes que sua AWS VPC usa. Encontre esses valores
no painel Sub-rede da sua conta da AWS.

IMPORTANTE
Você deve especificar pelo menos uma sub-rede. Caso contrário, a AWS não provisionará
um endpoint de interface em sua VPC. Um endpoint de interface é necessário para que os
clientes em sua VPC enviem tráfego para o endpoint privado.

{NOME DO SERVIÇO}
Cadeia de caracteres exclusiva que identifica o serviço de terminal privado recuperado
anteriormente.

aws ec2 create-vpc-endpoint --vpc-id {VPC-ID} \


--region {REGION} --service-name {SERVICE-NAME} \
--vpc-endpoint-type Interface --subnet-ids {SUBNET-IDS}

Para saber mais sobre a AWS CLI, consulte


Criando um terminal de interface.

Observe o valor na resposta do campo VpcEndpointId. Esta é uma string alfanumérica de


22 caracteres que identifica seu endpoint privado. Você também pode encontrar esse valor
no AWS VPC Dashboard em Endpoints > VPC ID.

4
Atualize seu endpoint privado com o VPC Endpoint ID.
Execute o comando Atlas CLI para criar um endpoint de interface no Atlas usando o ID de
serviço do endpoint Atlas e o ID do endpoint VPC. Neste exemplo, você definiria os
seguintes parâmetros:

Parâmetro
Tipo
Valor de exemplo
endpointServiceId
Argumento
6344ac8f51b94c6356527881
privateEndpointId
Opção
vpce-00713b5e644e830a3

atlas privateEndpoints aws interfaces create <endpointServiceId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atlas privateEndpoints aws interfaces criam.

5
Configure os grupos de segurança dos seus recursos para enviar e receber tráfego do
ponto final da interface.
Para cada recurso que precisa se conectar aos clusters do Atlas usando o AWS PrivateLink,
o grupo de segurança do recurso deverá permitir o tráfego de saída para os endereços IP
privados do terminal da interface em todas as portas.

Ver
Adicionando regras a um grupo de segurança
Para maiores informações.

6
Crie um grupo de segurança para seu endpoint de interface para permitir que recursos o
acessem.
Esse grupo de segurança deve permitir o tráfego de entrada em todas as portas de cada
recurso que precisa se conectar aos clusters do Atlas usando o AWS PrivateLink:

No console AWS, navegue até o painel VPC.

Clique em Grupos de segurança e em Criar grupo de segurança.

Use o assistente para criar um grupo de segurança. Certifique-se de selecionar sua VPC na
lista de VPC.

Selecione o grupo de segurança que você acabou de criar e clique na guia Regras de
entrada.
Clique em Editar regras.

Adicione regras para permitir todo o tráfego de entrada de cada recurso da VPC que você
deseja conectar ao cluster Atlas.

Clique em Salvar regras.

Clique em Endpoints e, em seguida, clique no endpoint da sua VPC.

Clique na guia Grupos de segurança e em Editar grupos de segurança.

Adicione o grupo de segurança que você acabou de criar e clique em Salvar.

Para aprender mais sobre


Grupos de segurança VPC
, consulte a documentação da AWS.

7
Verifique a disponibilidade do ponto final privado.
Você pode se conectar à implantação do banco de dados usando o endpoint privado do
AWS PrivateLink depois que o Atlas terminar de configurar todos os recursos e o endpoint
privado ficar disponível.

Para verificar se o endpoint privado da AWS está disponível:

Execute o comando Atlas CLI para descrever o endpoint da interface usando seu ID. Neste
exemplo, você definiria os seguintes parâmetros:

Parâmetro
Tipo
Valor de exemplo
interfaceEndpointId
Argumento
vpce-00713b5e644e830a3
endpointServiceId
Opção
6344ac8f51b94c6356527881

atlas privateEndpoints aws interfaces describe <interfaceEndpointId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas privateEndpoints descreve as interfaces aws.
Verifique se o valor do campo STATUS está DISPONÍVEL conforme mostrado no exemplo a
seguir:

ERRO DE STATUS DE ID
vpce-00713b5e644e830a3 DISPONÍVEL
Dê os próximos passos
Gerencie e conecte-se a partir de endpoints privados

Solucionar problemas de conexão de endpoint privado


Configurar um endpoint privado para uma
instância sem servidor
Nesta página

Acesso obrigatório
Pré-requisitos, considerações e limitações
Siga esses passos
Dê os próximos passos
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber mais
sobre quais recursos não estão disponíveis, consulte as Limitações do Atlas M0 (cluster
gratuito), M2 e M5.

OBSERVAÇÃO
As instâncias sem servidor não oferecem suporte ao Private Service Connect. Se precisar
configurar o Private Service Connect, use um cluster dedicado.

O MongoDB planeja adicionar suporte para mais configurações e recursos em instâncias


sem servidor ao longo do tempo. Para saber quais recursos o MongoDB planeja oferecer
suporte para instâncias sem servidor no futuro, consulte Limitações de instâncias sem
servidor.

Siga estas etapas para permitir que um cliente se conecte a uma instância sem servidor do
Atlas usando um endpoint privado.

Para saber mais sobre como usar pontos finais privados com o Atlas, consulte Saiba mais
sobre pontos finais privados no Atlas.

Para configurar um ponto final privado para um cluster dedicado, consulte Configurar um
ponto final privado para um cluster dedicado.

Acesso obrigatório
Para configurar um endpoint privado para uma instância sem servidor, você deve ter acesso
de proprietário do projeto ao projeto. Os usuários com acesso de Proprietário da
Organização devem adicionar-se ao projeto como Proprietário do Projeto.

Pré-requisitos, considerações e limitações


Para conhecer os pré-requisitos, considerações e limitações para configurar um ponto final
privado, consulte os seguintes recursos:

Pré-requisitos

Considerações

Limitações
Siga esses passos

AWS PrivateLink

Link Privado do Azure


Você pode configurar o AWS PrivateLink para instâncias sem servidor usando a UI do Atlas
ou a API de administração do Atlas. Selecione uma interface para saber mais.

API de administração do Atlas

IU do Atlas
Para configurar o AWS PrivateLink por meio da API de administração do Atlas, configure o
acesso à API. Em seguida, conclua as seguintes etapas:

1
Crie o ponto final privado no Atlas.
Execute o comando para
crie um endpoint privado
, substituindo os espaços reservados pelos seus parâmetros. Para saber mais sobre os
parâmetros, consulte
crie um endpoint privado.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \


--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST
"https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless
/instance/{INSTANCE-NAME}/endpoint?pretty=true" \
--data '
{
"comment" : "example comment"
}'

Observe o valor do campo _id na resposta.

{
2
"_id": "5f7cac1adf5d6c6306f4b283",
3
"cloudProviderEndpointId": null,
4
"comment": "example comment",
5
"endpointServiceName": null,
6
"errorMessage": null,
7
"status": "RESERVATION_REQUESTED"
8
}

2
Recuperar o nome do serviço para o ponto final privado.
OBSERVAÇÃO
Pode levar algum tempo para o Atlas provisionar o ponto final privado. Aguarde 1-2 minutos
antes de concluir esta etapa.

Execute o comando para


obtenha um endpoint privado
, substituindo os espaços reservados pelos parâmetros do endpoint que você criou.
Substitua {ENDPOINT-ID} pelo _id que você recuperou anteriormente. Para saber mais
sobre os parâmetros, consulte
obtenha um endpoint privado.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \


--header "Accept: application/json" \
--request GET
"https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless
/instance/{INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"

Anote o valor do campo endpointServiceName na resposta.

{
2
"_id": "5f7cac1adf5d6c6306f4b283",
3
"cloudProviderEndpointId": "34985fcac938279cd98dc894",
4
"comment": "example comment",
5
"endpointServiceName":
"com.amazonaws.vpce.us-east-1.vpce-svc-0afd34ee97e30d43f",
6
"errorMessage": null,
7
"status": "RESERVED"
8
}

Se endpointServiceName for nulo, aguarde mais 1 a 2 minutos para que o Atlas provisione
o ponto final privado. Em seguida, tente esta etapa novamente.
3
Crie o endpoint da interface na AWS.
Execute o comando na AWS CLI, substituindo os seguintes espaços reservados pelos seus
valores:

Espaço reservado
Descrição
{ID-VPC}
String exclusiva que identifica o peer AWS VPC. Encontre esse valor no painel VPC em sua
conta AWS.
{REGIÃO}
Região da AWS na qual reside a implantação do seu banco de dados.
{IDS DE SUB-REDE}
String exclusiva que identifica as sub-redes que sua AWS VPC usa. Encontre esses valores
no painel Sub-rede da sua conta da AWS.

IMPORTANTE
Você deve especificar pelo menos uma sub-rede. Caso contrário, a AWS não provisionará
um endpoint de interface em sua VPC. Um endpoint de interface é necessário para que os
clientes em sua VPC enviem tráfego para o endpoint privado.

{NOME DO SERVIÇO}
Cadeia de caracteres exclusiva que identifica o serviço de terminal privado recuperado
anteriormente.

aws ec2 create-vpc-endpoint --vpc-id {VPC-ID} \


--region {REGION} --service-name {SERVICE-NAME} \
--vpc-endpoint-type Interface --subnet-ids {SUBNET-IDS}

Para saber mais sobre a AWS CLI, consulte


Criando um terminal de interface.

Observe o valor na resposta do campo VpcEndpointId. Esta é uma string alfanumérica de


22 caracteres que identifica seu endpoint privado. Você também pode encontrar esse valor
no AWS VPC Dashboard em Endpoints > ID da VPC.

4
Atualize seu endpoint privado com o VPC Endpoint ID.
Execute o comando para
atualizar um endpoint privado
, substituindo os espaços reservados pelos parâmetros do endpoint que você criou. Atualize
o campo cloudProviderEndpointId para o ID do VPC Endpoint que você recuperou
anteriormente. Para saber mais sobre os parâmetros, consulte
atualize um endpoint privado.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2
--header "Accept: application/json" \
3
--header "Content-Type: application/json" \
4
--request PATCH
"https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverl
ess/instance/{INSTANCE-NAME}/endpoint/{ENDPOINT-ID}" \
5
--data '
6
{
7
"cloudProviderEndpointId" : "vpce-fcac938279cd98dc894",
8
"providerName" : "AWS"
9
}'

OBSERVAÇÃO
Você deve incluir o ProviderName para executar esse comando com êxito.

5
Configure os grupos de segurança dos seus recursos para enviar e receber tráfego do
ponto final da interface.
Para cada recurso que precisa se conectar aos clusters do Atlas usando o AWS PrivateLink,
o grupo de segurança do recurso deve permitir o tráfego de saída para os endereços IP
privados do endpoint da interface em todas as portas.

Ver
Adicionando regras a um grupo de segurança
Para maiores informações.

6
Crie um grupo de segurança para seu endpoint de interface para permitir que recursos o
acessem.
Esse grupo de segurança deve permitir o tráfego de entrada em todas as portas de cada
recurso que precisa se conectar aos clusters do Atlas usando o AWS PrivateLink:

No console AWS, navegue até o painel VPC.

Clique em Grupos de segurança e em Criar grupo de segurança.

Use o assistente para criar um grupo de segurança. Certifique-se de selecionar sua VPC na
lista de VPC.

Selecione o grupo de segurança que você acabou de criar e clique na guia Regras de
entrada.
Clique em Editar regras.

Adicione regras para permitir todo o tráfego de entrada de cada recurso da VPC que você
deseja conectar ao cluster Atlas.

Clique em Salvar regras.

Clique em Endpoints e, em seguida, clique no endpoint da sua VPC.

Clique na guia Grupos de segurança e em Editar grupos de segurança.

Adicione o grupo de segurança que você acabou de criar e clique em Salvar.

Para aprender mais sobre


Grupos de segurança VPC
, consulte a documentação da AWS.

7
Verifique a disponibilidade do ponto final privado.
Você pode se conectar a uma instância sem servidor do Atlas usando o endpoint privado do
AWS PrivateLink depois que o Atlas terminar de configurar todos os recursos e o endpoint
privado ficar disponível.

Para verificar se o endpoint privado do AWS PrivateLink está disponível:

Execute o comando para


obtenha um endpoint privado para uma instância sem servidor
, substituindo os espaços reservados pelos parâmetros do endpoint que você criou. Para
saber mais sobre os parâmetros, consulte
obtenha um endpoint privado para uma instância sem servidor.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \


--header "Accept: application/json" \
--request GET
"https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/privateEndpoint/serverless
/instance/{INSTANCE-NAME}/endpoint/{ENDPOINT-ID}?pretty=true"

Verifique se o valor do campo de status está DISPONÍVEL conforme mostrado no exemplo


a seguir:

{
2
"_id": "5f7cac1adf5d6c6306f4b283",
3
"cloudProviderEndpointId": "vpce-fcac938279cd98dc894",
4
"comment": "example comment",
5
"endpointServiceName":
"com.amazonaws.vpce.us-east-1.vpce-svc-0afd34ee97e30d43f",
6
"errorMessage": null,
7
"status": "AVAILABLE"
8
}

Se cloudProviderEndpointId estiver iniciando, aguarde mais 1 a 2 minutos para que o Atlas


configure o ponto final privado. Em seguida, tente esta etapa novamente.

Dê os próximos passos
Conecte-se a partir de um endpoint privado

Remover um endpoint privado do Atlas

Solucionar problemas de conexão de endpoint privado


Gerencie e conecte-se a partir de endpoints
privados
Nesta página

Acesso obrigatório
Conecte-se a partir de um endpoint privado
Ver endpoints privados
Remover um endpoint privado do Atlas
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber mais
sobre quais recursos não estão disponíveis, consulte Limitações do Atlas M0 (cluster
gratuito), M2 e M5.

Depois de configurar um endpoint privado para um cluster ou configurar um endpoint


privado para uma instância sem servidor, siga estas etapas para gerenciar e conectar-se a
partir de seus endpoints privados do Atlas.

Para saber mais sobre como usar pontos finais privados com o Atlas, consulte Saiba mais
sobre pontos finais privados no Atlas.

Acesso obrigatório
Para visualizar pontos finais privados, você deve ter acesso somente leitura do projeto ao
projeto.

Para excluir pontos de extremidade privados, você deve ter acesso de Proprietário do
Projeto ou superior ao projeto.

Os usuários com acesso de Proprietário da Organização devem adicionar-se ao projeto


como Proprietário do Projeto.

Conecte-se a partir de um endpoint privado


IMPORTANTE
Para obter considerações sobre cadeias de conexão com reconhecimento de endpoint
privado, consulte Cadeias de conexão com reconhecimento de endpoint privado.

Use uma cadeia de conexão privada com reconhecimento de endpoint para se conectar a
uma implantação de banco de dados Atlas com o seguinte procedimento:

Clusters Dedicados

Instâncias sem servidor


1
Na UI do Atlas, selecione sua implantação de banco de dados.
Clique em Banco de dados no canto superior esquerdo do Atlas.
Na visualização Implementações de Banco de Dados, clique em Conectar para a
implementação de banco de dados à qual deseja se conectar.

2
Selecione o tipo de conexão Ponto Final Privado.
3
Selecione o ponto final privado ao qual pretende ligar-se.
4
Crie um usuário de banco de dados.
IMPORTANTE
Pule esta etapa se o Atlas indicar na etapa Configurar segurança da conexão que você tem
pelo menos um usuário de banco de dados configurado em seu projeto. Para gerenciar
usuários de banco de dados existentes, consulte Configurar usuários de banco de dados.

Para acessar a implantação do banco de dados, você precisa de um usuário MongoDB com
acesso ao banco de dados desejado ou aos bancos de dados na implantação do banco de
dados em seu projeto. Se o seu projeto não tiver usuários MongoDB, o Atlas solicitará que
você crie um novo usuário com a função Atlas Admin.

Insira o nome de usuário do novo usuário.

Insira uma senha para esse novo usuário ou clique em Gerar senha segura
automaticamente.

Clique em Criar usuário do banco de dados para salvar o usuário.

Use esse usuário para se conectar à implantação do seu banco de dados na etapa a seguir.

Depois de adicionar um usuário de banco de dados, clique em Escolher seu método de


conexão.

5
Clique em Escolher um método de conexão.

AWS PrivateLink

Link Privado do Azure

Conexão de serviço privado


As cadeias de conexão com reconhecimento de endpoint privado estão disponíveis em um
dos seguintes formatos:

Conexão de lista de valores iniciais DNS

mongodb+srv://cluster0-pl-0-auylw.mongodb.net
Cadeia de conexão padrão

mongodb://pl-0-us-east-1-auylw.mongodb.net:1024,pl-0-us-east-1-auylw.mongodb.ne
t:1025,pl-0-us-east-1-auylw.mongodb.net:1026/?ssl=true&authSource=admin&replica
Set=Cluster0-shard-0-shard-0

O MongoDB recomenda que seus clientes usem o formato de cadeia de conexão de lista de
valores iniciais DNS.

Ver endpoints privados

CLI do Atlas

IU do Atlas
Pontos finais
Para retornar os detalhes do endpoint privado da AWS especificado usando a CLI do Atlas,
execute o seguinte comando:

atlas privateEndpoints aws describe <privateEndpointId> [options]

Para listar todos os endpoints privados da AWS em um projeto usando a CLI do Atlas,
execute o seguinte comando:

atlas privateEndpoints aws describe <privateEndpointId> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
atlas privateEndpoints aws descrever e atlas privateEndpoints lista aws.

Terminais de interface
Para retornar a interface do endpoint privado da AWS especificada. usando a CLI do Atlas,
execute o seguinte comando:

atlas privateEndpoints aws interfaces describe <interfaceEndpointId> [options]


Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do
Atlas CLI para
atlas privateEndpoints descreve as interfaces aws.

Remover um endpoint privado do Atlas

CLI do Atlas

IU do Atlas
Pontos finais
Para excluir o endpoint privado da AWS especificado usando a CLI do Atlas, execute o
seguinte comando:

atlas privateEndpoints aws delete <privateEndpointId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para excluir atlas privateEndpoints aws.

Terminais de interface
Para excluir a interface do endpoint privado da AWS especificada usando a CLI do Atlas,
execute o seguinte comando:

atlas privateEndpoints aws interfaces delete <interfaceEndpointId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para interfaces atlas privateEndpoints aws excluídas.
Solucionar problemas de conexão de endpoint
privado
Nesta página

Clusters Dedicados
Instâncias sem servidor
Esta página descreve problemas comuns de conexão de endpoint privado e possíveis
soluções.

Clusters Dedicados

AWS PrivateLink

Link Privado do Azure

Conexão de serviço privado


1
Verifique o status das conexões do AWS PrivateLink.
A guia Private Endpoint na página Network Access lista cada endpoint privado que você
criou. Os campos Atlas Endpoint Service Status e Endpoint Status mostram o status de
cada endpoint privado.

Consulte os seguintes status para ajudá-lo a determinar o estado de suas conexões de


ponto final privado:

Status do serviço Atlas Endpoint

Status
Descrição
Criando link privado
A Atlas está criando o balanceador de carga de rede e os recursos VPC.
Fracassado
Ocorreu uma falha no sistema.
Disponível
O balanceador de carga de rede Atlas e o serviço de endpoint VPC são criados e prontos
para receber solicitações de conexão.
Excluindo
Atlas está excluindo o serviço de endpoint privado.
Status do terminal

Status
Descrição
Não configurado
A Atlas criou o balanceador de carga de rede e o serviço de endpoint VPC, mas a AWS
ainda não criou o endpoint de interface. Clique em Editar e conclua o assistente para criar o
terminal da interface.
Aceitação pendente
A AWS recebeu a solicitação de conexão do endpoint da interface para o serviço de
endpoint Atlas VPC.
Pendente
A AWS está estabelecendo a conexão entre o endpoint da interface e o serviço de endpoint
Atlas VPC.
Fracassado
A AWS não conseguiu estabelecer uma conexão entre os recursos do Atlas VPC e o
endpoint da interface em sua VPC. Clique em Editar, verifique se as informações fornecidas
estão corretas e, em seguida, crie novamente o ponto final privado.

IMPORTANTE
Se o seu endpoint de interface falhar, você poderá ver a seguinte mensagem:

EXEMPLO
Nenhuma entrada de DNS encontrada para o endpoint vpce-<guid>, seu endpoint deve ser
provisionado em pelo menos uma sub-rede. Clique em "Editar" para corrigir o problema.

Essa mensagem indicava que você não especificou uma sub-rede ao criar a conexão do
AWS PrivateLink. Para resolver este erro:

Clique em Editar.

Clique em Voltar.

Especifique pelo menos uma sub-rede.

Siga as instruções restantes para criar a conexão AWS PrivateLink.

Disponível
Os recursos do Atlas VPC estão conectados ao endpoint da interface em sua VPC. Você
pode se conectar a clusters Atlas nesta região usando o AWS PrivateLink.
Excluindo
Atlas está removendo o endpoint de interface do serviço de endpoint privado.
2
Certifique-se de que seus grupos de segurança estejam configurados corretamente.
Para cada recurso que precisa se conectar aos clusters do Atlas usando o AWS PrivateLink,
o grupo de segurança do recurso deve permitir o tráfego de saída para os endereços IP
privados do endpoint da interface em todas as portas.

Ver
Adicionando regras a um grupo de segurança
Para maiores informações.

O grupo de segurança de endpoint da interface deve permitir o tráfego de entrada em todas


as portas de cada recurso que precisa se conectar aos clusters do Atlas usando o AWS
PrivateLink.
Colocar endereços IP de instância ou grupos de segurança na lista de permissões
para permitir que o tráfego deles alcance o grupo de segurança do terminal da interface.

Instâncias sem servidor

AWS PrivateLink

Link Privado do Azure


1
Verifique o status das conexões do AWS PrivateLink.
A guia Private Endpoint na página Network Access lista cada endpoint privado que você
criou. Os campos Atlas Endpoint Service Status e Endpoint Status mostram o status de
cada endpoint privado.

Consulte os seguintes status para ajudá-lo a determinar o estado de suas conexões de


ponto final privado:

Status do serviço Atlas Endpoint

Status
Descrição
Criando link privado
A Atlas está criando o balanceador de carga de rede e os recursos VPC.
Fracassado
Ocorreu uma falha no sistema.
Disponível
O balanceador de carga de rede Atlas e o serviço de endpoint VPC são criados e prontos
para receber solicitações de conexão.
Excluindo
Atlas está excluindo o serviço de endpoint privado.
Status do terminal

Status
Descrição
Não configurado
A Atlas criou o balanceador de carga de rede e o serviço de endpoint VPC, mas a AWS
ainda não criou o endpoint de interface. Clique em Editar e conclua o assistente para criar o
terminal da interface.
Aceitação pendente
A AWS recebeu a solicitação de conexão do endpoint da interface para o serviço de
endpoint Atlas VPC.
Pendente
A AWS está estabelecendo a conexão entre o endpoint da interface e o serviço de endpoint
Atlas VPC.
Fracassado
A AWS não conseguiu estabelecer uma conexão entre os recursos do Atlas VPC e o
endpoint da interface em sua VPC. Clique em Editar, verifique se as informações fornecidas
estão corretas e, em seguida, crie novamente o ponto final privado.
IMPORTANTE
Se o seu endpoint de interface falhar, você poderá ver a seguinte mensagem:

EXEMPLO
Nenhuma entrada de DNS encontrada para o endpoint vpce-<guid>, seu endpoint deve ser
provisionado em pelo menos uma sub-rede. Clique em "Editar" para corrigir o problema.

Essa mensagem indicava que você não especificou uma sub-rede ao criar a conexão do
AWS PrivateLink. Para resolver este erro:

Clique em Editar.

Clique em Voltar.

Especifique pelo menos uma sub-rede.

Siga as instruções restantes para criar a conexão AWS PrivateLink.

Disponível
Atlas V
Os recursos do PC estão conectados ao endpoint da interface em sua VPC. Você pode se
conectar a clusters Atlas nesta região usando o AWS PrivateLink.
Excluindo
Atlas está removendo o endpoint de interface do serviço de endpoint privado.
2
Certifique-se de que seus grupos de segurança estejam configurados corretamente.
Para cada recurso que precisa se conectar aos clusters do Atlas usando o AWS PrivateLink,
o grupo de segurança do recurso deve permitir o tráfego de saída para os endereços IP
privados do endpoint da interface em todas as portas.

Ver
Adicionando regras a um grupo de segurança
Para maiores informações.

O grupo de segurança de endpoint da interface deve permitir o tráfego de entrada em todas


as portas de cada recurso que precisa se conectar aos clusters do Atlas usando o AWS
PrivateLink.

Colocar endereços IP de instância ou grupos de segurança na lista de permissões


para permitir que o tráfego deles alcance o grupo de segurança do terminal da interface.
Configurar o acesso unificado da AWS
Nesta página

Visão geral
Acesso obrigatório
Pré-requisitos
Procedimento
Gerenciar funções do AWS IAM
Visão geral
Alguns recursos do Atlas, incluindo Federação de dados e criptografia em repouso, são
autenticados na AWS
Funções do IAM
. Quando o Atlas acessa os serviços da AWS,
assume uma função do IAM.

Você pode configurar uma função IAM assumida para sua conta Atlas usar com a API de
administração do Atlas ou a UI do Atlas se você tiver a função de proprietário do projeto. O
Atlas oferece suporte ao acesso unificado apenas para AWS.

OBSERVAÇÃO
Se você tiver a criptografia em repouso habilitada para seu cluster e quiser configurar uma
nova função do IAM, certifique-se de que a nova função tenha acesso ao KMS existente.

Acesso obrigatório
Para configurar o acesso unificado à AWS, você deve ter acesso de proprietário da
organização ou proprietário do projeto ao projeto.

Pré-requisitos
Uma conta Atlas.

O
Interface de linha de comando da AWS (CLI).

Procedimento

CLI do Atlas

API de administração do Atlas

IU do Atlas
1
Crie uma nova função AWS IAM no Atlas.
Para criar uma função AWS IAM usando a CLI do Atlas, execute o seguinte comando:

atlas cloudProviders accessRoles aws create [options]


Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do
Atlas CLI para
atlas cloudProviders accessRoles aws create.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Salve os valores dos campos AtlasAWSAccountArn e AtlasAssumedRoleExternalId


retornados pelo comando para uso na próxima etapa.

2
Modifique sua política de confiança de função do AWS IAM.
Faça login no Console de gerenciamento da AWS.

Navegue até o serviço Identity and Access Management (IAM).

Selecione Funções na navegação do lado esquerdo.

Clique na função IAM existente que você deseja usar para acesso ao Atlas na lista de
funções.

Selecione a guia Relacionamentos de confiança.

Clique no botão Editar relação de confiança.

Edite o documento de política. Adicione um novo objeto Statement com o conteúdo a seguir.

OBSERVAÇÃO
Substitua as linhas destacadas pelos valores retornados na etapa anterior.

{
"Version":"2012-10-17",
"Statement":[
{
"Effect":"Allow",
"Principal":{
"AWS":"<atlasAWSAccountArn>"
},
"Action":"sts:AssumeRole",
"Condition":{
"StringEquals":{
"sts:ExternalId":"<atlasAssumedRoleExternalId>"
}
}
}
]
}

Clique no botão Atualizar política de confiança.

3
Autorize a nova função do IAM.
Para autorizar uma função AWS IAM usando a CLI do Atlas, execute o seguinte comando:

atlas cloudProviders accessRoles aws authorize <roleId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas cloudProviders accessRoles aws autorizar.

Se o comando for bem-sucedido, você poderá usar o valor RoleID ao configurar serviços
Atlas que usam AWS.

Retomar um procedimento de autorização


Se você cancelar um procedimento para autorizar uma função do AWS IAM para uso com o
Atlas, poderá retomá-lo de onde parou.

Expanda o menu Opções próximo ao nome do seu projeto no canto superior esquerdo da UI
do Atlas. Selecione Integrações.

Clique no botão Configurar no painel AWS IAM Role Access.

Observação: se você já tiver uma ou mais funções configuradas, o botão exibirá Editar.

Quaisquer funções com um procedimento de autorização em andamento são listadas com


um status em andamento. Clique no botão Continuar para retomar o processo de
autorização.

Para cancelar completamente uma autorização de função em andamento, clique no ícone


Excluir próximo à função em andamento.

Desautorizar uma função assumida do IAM


Você pode desautorizar uma função existente do AWS IAM da sua conta do Atlas com a API
de administração do Atlas ou a UI do Atlas.

OBSERVAÇÃO
Certifique-se de remover todos os serviços Atlas associados da função IAM antes de
desautorizá-lo.

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para desautorizar uma função do AWS IAM usando a CLI do Atlas, execute o seguinte
comando:

atlas cloudProviders accessRoles aws deauthorize <roleId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para desautorizar atlas cloudProviders accessRoles aws.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Gerenciar funções do AWS IAM

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para autorizar uma função AWS IAM usando a CLI do Atlas, execute o seguinte comando:

atlas cloudProviders accessRoles aws authorize <roleId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atlas cloudProviders accessRoles aws autorizar.
Configurar autenticação e autorização de
implantação de banco de dados
Nesta página

Autenticação ou autorização de usuário do banco de dados


Funções de banco de dados personalizadas
Autenticação sem senha com AWS IAM
Autenticação ou autorização de usuário com LDAP
Autenticação de usuário com OIDC
Autenticação de usuário com X.509
O Atlas oferece os seguintes recursos de segurança para autenticação e autorização de
implantação de banco de dados.

Autenticação ou autorização de usuário do banco de dados


O Atlas exige que os clientes se autentiquem para acessar implantações de banco de
dados. Você deve criar usuários de banco de dados para acessar o banco de dados. Para
configurar usuários de banco de dados para suas implantações de banco de dados,
consulte Configurar usuários de banco de dados.

Funções de banco de dados personalizadas


Quando os privilégios de usuário do banco de dados Atlas integrados não atendem ao
conjunto desejado de privilégios, você pode criar funções personalizadas.

Autenticação sem senha com AWS IAM


Você pode configurar a autenticação sem senha para usuários do AWS IAM das seguintes
maneiras:

Configure funções do AWS IAM para tornar opcionais os campos de nome de usuário ou
senha. Para saber mais, consulte Configurar a autenticação sem senha com funções do
AWS IAM.

Use credenciais temporárias obtidas com o


Operação da API AssumeRoleWithSAML
. Para saber mais, consulte Configurar autenticação sem senha usando SAML.

Autenticação ou autorização de usuário com LDAP


Atlas oferece suporte à autenticação e autorização de usuário com LDAP. Para usar o
LDAP, consulte Configurar autenticação e autorização do usuário com LDAP.

Autenticação de usuário com OIDC


Atlas oferece suporte à autenticação e autorização de usuário com OIDC. Para usar o
OIDC, consulte Configurar a Federação de Identidade da Força de Trabalho com o OIDC.

Autenticação de usuário com X.509


Os certificados de cliente X.509 fornecem aos usuários do banco de dados acesso às
implantações de banco de dados em seu projeto. As opções para autenticação X.509
incluem autenticação X.509 gerenciada pelo Atlas e autenticação X.509 autogerenciada.
Para saber mais sobre a autenticação X.509 autogerenciada, consulte Configurar a
autenticação X.509 autogerenciada.
Configurar usuários do banco de dados
Nesta página

Autenticação de usuário de banco de dados


Acesso obrigatório
Adicionar usuários do banco de dados
Exibir usuários e certificados do banco de dados
Modificar usuários do banco de dados
Excluir usuários do banco de dados
Funções integradas
Privilégios Específicos
Crie usuários de banco de dados para fornecer aos clientes acesso às implantações de
banco de dados em seu projeto. O acesso de um usuário ao banco de dados é determinado
pelas funções atribuídas ao usuário. Ao criar um usuário de banco de dados, qualquer um
dos funções integradas e adicione o usuário a todas as implantações de banco de dados no
seu projeto Atlas. Você pode remover o padrão função incorporada. E definir privilégios
específicos e funções personalizadas para adicionar o usuário a implantações de banco de
dados específicas.

Os usuários do banco de dados são separados dos usuários do Atlas. Os usuários do


banco de dados têm acesso aos bancos de dados MongoDB, enquanto os usuários do Atlas
têm acesso ao próprio aplicativo Atlas. O Atlas oferece suporte à criação de usuários de
banco de dados temporários que expiram automaticamente em um período de 7 dias
configurável pelo usuário.

O Atlas audita a criação, exclusão e atualizações de usuários do banco de dados no Feed


de atividades do projeto. O Atlas audita ações relativas a usuários de bancos de dados
temporários e não temporários. Para visualizar o Feed de atividades do projeto, clique em
Feed de atividades na seção Projeto da navegação esquerda. Para obter mais informações
sobre o feed de atividades do projeto, consulte Exibir todas as atividades.

O Atlas disponível funções integradas e privilégios específicos suporta um subconjunto de


comandos do MongoDB. Consulte Comandos não suportados em clusters M10+ para obter
mais informações.

O Atlas suporta no máximo 100 usuários de banco de dados por projeto Atlas. Se você
precisar de mais de 100 usuários de banco de dados em um projeto, entre em contato
Suporte Atlas
.

IMPORTANTE
Você deve usar o
CLI do Atlas
,
API de administração do Atlas
, Atlas UI ou uma integração compatível para adicionar, modificar ou excluir usuários de
banco de dados em implantações de banco de dados Atlas. Caso contrário, o Atlas
reverterá quaisquer modificações do usuário.

Autenticação de usuário de banco de dados


Atlas oferece as seguintes formas de autenticação para usuários de banco de dados:

Senha

Certificados X.509

AWS IAM

LDAP

OIDC
SCRAM
é o método de autenticação padrão do MongoDB. SCRAM requer uma senha para cada
usuário.

O
banco de dados de autenticação
para usuários autenticados por SCRAM é o banco de dados administrativo.

OBSERVAÇÃO
Por padrão, o Atlas oferece suporte à autenticação SCRAM-SHA-256. Se você tiver algum
usuário de banco de dados criado antes do lançamento do MongoDB 4.0, atualize suas
senhas para gerar credenciais SCRAM-SHA-256. Você pode reutilizar senhas existentes.

Acesso obrigatório
Para adicionar usuários de banco de dados, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao Atlas.

Adicionar usuários do banco de dados


Um projeto pode ter usuários com diferentes métodos de autenticação.

Você não pode alterar o método de autenticação de um usuário após criá-lo. Para usar um
método de autenticação alternativo, você deve criar um novo usuário.

CLI do Atlas

API de administração do Atlas

IU do Atlas
A CLI do Atlas usa os comandos a seguir para criar novos usuários de banco de dados e
certificados X.509. As opções especificadas determinam o método de autenticação.
Para criar um usuário de banco de dados para seu projeto usando a CLI do Atlas, execute o
seguinte comando:

atlas dbusers create [builtInRole]... [options]

Para criar um novo certificado X.509 gerenciado pelo Atlas para o usuário do banco de
dados especificado usando a CLI do Atlas, execute o seguinte comando:

atlas dbusers certs create [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para criar atlas dbusers e certificados criados atlas dbusers.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Exibir usuários e certificados do banco de dados

CLI do Atlas

API de administração do Atlas

IU do Atlas
Ver usuários do banco de dados
Para listar todos os usuários do banco de dados Atlas do seu projeto usando a CLI do Atlas,
execute o seguinte comando:

atlas dbusers list [options]

Para retornar os detalhes de um único usuário do banco de dados Atlas no projeto


especificado usando a CLI do Atlas, execute o seguinte comando:

atlas dbusers describe <username> [options]


Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para a lista de dbusers do atlas e atlas dbusers descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Visualizar certificados X.509 para um usuário de banco de dados


Para listar todos os certificados não expirados gerenciados pelo Atlas para um usuário de
banco de dados usando a CLI do Atlas, execute o seguinte comando:

lista de certificados atlas dbusers <nome de usuário> [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para lista de certificados atlas dbusers.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Modificar usuários do banco de dados

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para atualizar um usuário de banco de dados do seu projeto usando a CLI do Atlas, execute
o seguinte comando:

atlas dbusers certs list <username> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atualização do atlas dbusers.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas
Conecte-se à CLI do Atlas

Excluir usuários do banco de dados

CLI do Atlas

API de administração do Atlas

IU do Atlas
Deletar um usuário de banco de dados do seu projeto usando a CLI do Atlas, execute o
seguinte comando:

atlas dbusers delete <nome de usuário> [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas dbusers excluir.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Funções integradas
A tabela a seguir descreve as funções integradas do Atlas e o
Funções do MongoDB
ou
ações privilegiadas
eles representam.

OBSERVAÇÃO
Namespaces de banco de dados MongoDB protegidos
Os bancos de dados a seguir são somente leitura para todos os usuários, incluindo aqueles
com o
atlasAdmin
ou
clusterMonitor
papel.

local

configuração

Desencorajamos a gravação no banco de dados administrativo. O Atlas gerencia diversas


coleções no banco de dados administrativo e essas coleções são somente leitura para
todos os usuários.
atlasAdmin
tem o
atualizar
privilégio na coleção config.settings para gerenciar o balanceador.

Função integrada do Atlas


Função do MongoDB
Funções herdadas ou ações de privilégio
Administrador do Atlas
atlasAdmin
readWriteAnyDatabase

leiaAnyDatabase

dbAdminAnyDatabase

clusterMonitor

limpezaOrfã

ativarfragmentação

flushRouterConfig

moverChunk

visualizarUsuário

Ler e gravar em qualquer banco de dados


readWriteAnyDatabase
readWriteAnyDatabase

Leia apenas qualquer banco de dados


leiaAnyDatabase
leiaAnyDatabase

Para saber mais sobre comandos comuns que o Atlas não suporta com os privilégios de
usuário atuais do Atlas, consulte Comandos não suportados em clusters M10+

Privilégios Específicos
A tabela a seguir descreve os privilégios específicos do Atlas, o banco de dados ao qual ele
se aplica e o
ações privilegiadas
eles representam.

Privilégio específico do Atlas


Base de dados
Ações Privilegiadas
cópia de segurança
administrador
listabancos de dados

listaColeções

índices de lista

anexarOplogNote

getParameter

status do servidor

clusterMonitor
administrador
connPoolStats

getCmdLineOpts

getDefaultRWConcern

obterLog

getParameter

getShardMap

hostInfo

em andamento

listabancos de dados

listaSessões

listaShards

netstat

replSetGetConfig

replSetGetStatus

status do servidor

estado de fragmentação
principal

administrador de banco de dados


Usuário configurado
ignorarDocumentValidation

mudançaStream

colMod

colStats

compactar

convertToCapped

criarColeção

criarIndex

criarSearchIndex

dbHash

dbStats

dropCollection

dropDatabase

dropIndex

dropSearchIndex

habilitarProfiler

encontrar

matarCursores

listaColeções

índices de lista

listSearchIndexes

planCacheIndexFilter
planCacheRead

planCacheWrite

reIndexar

renomearCollectionSameDB

Detalhes de armazenamento

atualizarSearchIndex

validar

dbAdminAnyDatabase
Usuário configurado, exceto local e configuração
dbAdminAnyDatabase

ativarfragmentação
ativarfragmentação

ler
Usuário configurado
mudançaStream

colStats

dbHash

dbStats

encontrar

matarCursores

índices de lista

listaColeções

listSearchIndexes

ler escrever
Usuário configurado
mudançaStream

colStats

convertToCapped
criarColeção

criarSearchIndex

dbHash

dbStats

dropCollection

criarIndex

dropIndex

dropSearchIndex

encontrar

inserir

matarCursores

índices de lista

listaColeções

listSearchIndexes

remover

renomearCollectionSameDB

atualizar

killOpSession
Usuário configurado
em andamento

matar

matarAnySession

listaSessões

readWriteAnyDatabase
Usuário configurado, exceto local e configuração
readWriteAnyDatabase
mudançaStream

colStats

convertToCapped

criarColeção

criarSearchIndex

dbHash

dbStats

dropCollection

dropSearchIndex

criarIndex

dropIndex

encontrar

inserir

matarCursores

índices de lista

listaColeções

listabancos de dados

listSearchIndexes

remover

renomearCollectionSameDB

atualizar

leiaAnyDatabase
Usuário configurado, exceto local e configuração
leiaAnyDatabase

mudançaStream
colStats

dbHash

dbStats

encontrar

matarCursores

índices de lista

listaColeções

listabancos de dados

listSearchIndexes
Configurar funções de banco de dados
personalizadas
Nesta página

Considerações
Acesso obrigatório
Adicionar funções personalizadas
Ver funções personalizadas
Modificar funções personalizadas
Excluir funções personalizadas
Atribuir funções personalizadas
Você pode criar funções personalizadas no Atlas quando as funções integradas não incluem
o conjunto desejado de privilégios. O Atlas aplica as funções personalizadas de cada
usuário do banco de dados junto com:

Quaisquer funções internas atribuídas ao adicionar um usuário de banco de dados ou


modificar um usuário de banco de dados.

Qualquer privilégios específicos você atribui ao adicionar um usuário de banco de dados ou


modificar um usuário de banco de dados.

Você pode atribuir diversas funções personalizadas a cada usuário do banco de dados.

OBSERVAÇÃO
Limitação de cluster gratuito, cluster compartilhado e instância sem servidor
As alterações nas funções personalizadas podem levar até 30 segundos para serem
implementadas em clusters gratuitos M0, clusters compartilhados M2/M5 e instâncias sem
servidor.

As ações privilegiadas disponível para funções personalizadas e a API de funções


personalizadas representam um subconjunto das ações de privilégio disponíveis para
funções integradas.

Para revisar a lista de privilégios de função personalizada, consulte a referência da API.

Considerações
IMPORTANTE
Você deve usar o
CLI do Atlas

API de administração do Atlas, Atlas UI ou uma integração compatível para adicionar,


modificar ou excluir funções de banco de dados em implantações de banco de dados Atlas.
Caso contrário, o Atlas reverterá quaisquer modificações de função.
Você pode atribuir até 20 funções personalizadas a um único usuário de banco de dados e
criar até 100 funções personalizadas por projeto. Se você precisar de mais funções
personalizadas por usuário do banco de dados ou por projeto, entre em contato
Suporte Atlas

O Atlas audita a criação, exclusão e atualizações de funções personalizadas do MongoDB


no Feed de atividades do projeto.

Se você atribuir diversas funções a um usuário e essas funções concederem permissões


conflitantes para um objeto, o Atlas honrará as permissões mais altas em qualquer função.

EXEMPLO
Você cria duas funções personalizadas e atribui ambas ao usuário A:

A primeira função personalizada concede apenas privilégios de leitura no seu banco de


dados. Também concede ignorarDocumentValidation em seu banco de dados.

A segunda função concede privilégios dbAdmin no seu banco de dados. Não concede
ignorarDocumentValidation, que é uma negação implícita de permissões de bypass.

O usuário A teria todos os privilégios dbAdmin para seu banco de dados, já que dbAdmin é
a permissão de acesso mais alta ao banco de dados. O usuário A também teria
ignorarDocumentValidation, desde que DocumentValidation é a permissão de desvio mais
alta.

Acesso obrigatório
Para configurar funções de banco de dados personalizadas, você deve ter acesso de
Proprietário da Organização ou Proprietário do Projeto ao Atlas.

Adicionar funções personalizadas

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para criar uma função de banco de dados personalizada para seu projeto usando a CLI do
Atlas, execute o seguinte comando:

atlas customDbRoles criar <roleName> [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
criar atlas customDbRoles.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Ver funções personalizadas

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para listar todas as funções de banco de dados personalizadas do seu projeto usando a CLI
do Atlas, execute o seguinte comando:

atlas customDbRoles list [options]

Para retornar os detalhes de uma única função de banco de dados personalizada no projeto
especificado usando a CLI do Atlas, execute o seguinte comando:

atlas customDbRoles describe <roleName> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
lista atlas customDbRoles e atlas customDbRoles descreve.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Modificar funções personalizadas

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para atualizar uma função de banco de dados personalizada para seu projeto usando a CLI
do Atlas, execute o seguinte comando:
atlas customDbRoles update <roleName> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atualização do atlas customDbRoles.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Excluir funções personalizadas

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para excluir uma função de banco de dados personalizada do seu projeto usando a CLI do
Atlas, execute o seguinte comando:

atlas customDbRoles update <roleName> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para excluir atlas customDbRoles.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Você não pode excluir uma função personalizada nos seguintes cenários:

Ao excluir a função deixaria uma ou mais funções filhas sem funções ou ações pai.

Ao excluir a função, um ou mais usuários do banco de dados ficariam sem funções.

Atribuir funções personalizadas


Você pode atribuir funções personalizadas na UI do Atlas ao adicionar um usuário de banco
de dados ou modificar um usuário de banco de dados. Para atribuir funções personalizadas
por meio da API Atlas Administration, consulte Crie um usuário de banco de dados ou
Atualizar um usuário do banco de dados.
Configure a aConfigure a autenticação sem senha com AWS IAM
Nesta página

Configurar a autenticação sem senha com funções AWS IAM


AWS Lambda
AWSECS
AWS ECS Fargate
AWS EKS
Configure a autenticação sem senha usando SAML
Você pode configurar a autenticação sem senha para usuários do AWS IAM das seguintes
maneiras:

Configure funções do AWS IAM para tornar opcionais os campos de nome de usuário ou
senha. Neste cenário, cada usuário apresenta a chave secreta para autenticação. O usuário
não envia a chave secreta pela rede para o Atlas e o driver não a persiste. Para saber mais,
consulte
Configure a autenticação sem senha com funções AWS IAM.

Use credenciais temporárias obtidas com o


Operação da API AssumeRoleWithSAML
. Nesse cenário, você deve integrar-se a um provedor de SSO e ter uma função do IAM que
especifique seu provedor IdP SAML em sua política de confiança. Para saber mais, consulte
Configure a autenticação sem senha usando SAML.

Configurar a autenticação sem senha com funções AWS IAM


Você pode configurar um usuário de banco de dados para usar um ARN de usuário do AWS
IAM para autenticação. Você pode se conectar ao seu banco de dados usando
mangusto
e drivers e autenticar usando o ARN do usuário AWS IAM. Usar a função AWS IAM reduz
o número de mecanismos de autenticação e o número de segredos a serem gerenciados.
Você pode configurar o AWS IAM para não exigir um nome de usuário ou senha para
autenticação, tornando-o um mecanismo sem senha. A chave secreta que você usa para
autenticação não é enviada pela rede para o Atlas e não é persistida pelo driver, tornando o
AWS IAM adequado até mesmo para as situações mais sensíveis.

Para AWS Lambda e HTTP (ECS e EC2), os drivers são lidos automaticamente do
variáveis ​ambientais
. Para AWS EKS, você deve atribuir manualmente a função do IAM. Esta página descreve
como AWS Lambda, AWS ECS e AWS EKS podem se conectar usando uma função AWS
IAM.

OBSERVAÇÃO
Você deve atribuir uma função do IAM ao Lambda, EC2, ECS ou EKS no console da AWS.

AWS Lambda
O AWS Lambda passa informações para funções por meio das seguintes variáveis de
ambiente se você
atribuir uma função de execução
para a função lambda.

AWS_ACCESS_KEY_ID

AWS_SECRET_ACCESS_KEY

AWS_SESSION_TOKEN

OBSERVAÇÃO
Você não precisa criar manualmente essas variáveis de ambiente ao usar um
função de execução
em sua função.

Para saber mais sobre essas variáveis de ambiente, consulte


Usando variáveis de ambiente AWS Lambda.

AWSECS
AWS ECS obtém as credenciais do seguinte URI:

http://169.254.170.2 + AWS_CONTAINER_CREDENTIALS_RELATIVE_URI
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI é uma variável de ambiente. Para
saber mais, consulte
Funções do IAM para tarefas.

AWS EC2 obtém as credenciais do Instance Metadata Service V2 no seguinte URL:

http://169.254.169.254/latest/meta-data/iam/security-credentials/
Para saber mais, consulte
Execute uma instância com uma função do IAM.

AWS ECS Fargate


Para saber como configurar uma função AWS IAM para autenticação sem senha com AWS
ECS Fargate, consulte o
Documentação da AWS.

AWS EKS
Para o AWS EKS, você deve primeiro atribuir a função do IAM ao seu pod para configurar
as seguintes variáveis de ambiente nesse pod:

AWS_WEB_IDENTITY_TOKEN_FILE – contém o caminho para o arquivo do token de


identidade da web.

AWS_ROLE_ARN – contém a função do IAM que você deseja usar para se conectar à
implantação do seu banco de dados.

Para obter informações sobre como atribuir uma função do IAM ao seu pod, consulte o
Documentação da AWS.
Depois de atribuir a função do IAM ao pod, você deverá assumir manualmente a função do
IAM para se conectar à implantação do banco de dados.

Para assumir a função manualmente:

Use a AWS
SDK
chamar
AssumeRoleWithWebIdentity.

DICA
Omita o parâmetro ProviderID.

Encontre o valor do parâmetro WebIdentityToken no arquivo descrito na variável de


ambiente AWS_WEB_IDENTITY_TOKEN_FILE do seu pod.

Passe as credenciais que você recebeu na etapa anterior para o driver MongoDB. Ver o seu
documentação do motorista
para detalhes.

DICA
Veja também:
Papéis do IAM para contas de serviço

Configure a autenticação sem senha usando SAML


Se você integrar seus usuários do AWS IAM a um IdP que depende da autenticação SAML,
poderá usar o provedor de SSO corporativo da sua empresa para:

Acesse Atlas.

Estabeleça autenticação sem senha para o usuário do banco de dados MongoDB se


conectar ao Atlas.
mangusto
e os drivers MongoDB podem então usar esse usuário de banco de dados para se
conectar ao Atlas.

Para este usuário do banco de dados MongoDB, você pode usar credenciais de segurança
temporárias obtidas com o
Operação da API AssumeRoleWithSAML.

Neste cenário, você já deve ter:

Um provedor SAML SSO configurado.

Uma função de IdP existente que especifica seu provedor de IdP SAML em sua política de
confiança.
As etapas a seguir mostram como configurar a autenticação sem senha para um usuário do
banco de dados MongoDB. Para saber mais, use os links para cada etapa do fluxo de
trabalho.

Para configurar a autenticação sem senha para o usuário do banco de dados MongoDB
quando sua empresa usa um provedor de SSO com SAML e se integra ao AWS IAM:

Crie uma função para delegar permissões a um usuário do IAM.

Solicite credenciais de segurança temporárias da função delegada. O AWS Security Token


Service cria segurança temporária autenticação sem senha com AWS IAM
Nesta página

Configurar a autenticação sem senha com funções AWS IAM


AWS Lambda
AWSECS
AWS ECS Fargate
AWS EKS
Configure a autenticação sem senha usando SAML
Você pode configurar a autenticação sem senha para usuários do AWS IAM das seguintes
maneiras:

Configure funções do AWS IAM para tornar opcionais os campos de nome de usuário ou
senha. Neste cenário, cada usuário apresenta a chave secreta para autenticação. O usuário
não envia a chave secreta pela rede para o Atlas e o driver não a persiste. Para saber mais,
consulte Configure a autenticação sem senha com funções AWS IAM.

Use credenciais temporárias obtidas com a Operação da API AssumeRoleWithSAML.


Nesse cenário, você deve integrar-se a um provedor de SSO e ter uma função do IAM que
especifique seu provedor IdP SAML em sua política de confiança. Para saber mais, consulte
Configure a autenticação sem senha usando SAML.

Configurar a autenticação sem senha com funções AWS IAM


Você pode configurar um usuário de banco de dados para usar um ARN de usuário do AWS
IAM para autenticação. Você pode se conectar ao seu banco de dados usando
mangusto
e drivers e autenticar usando o ARN do usuário AWS IAM. Usar a função AWS IAM reduz
o número de mecanismos de autenticação e o número de segredos a serem gerenciados.
Você pode configurar o AWS IAM para não exigir um nome de usuário ou senha para
autenticação, tornando-o um mecanismo sem senha. A chave secreta que você usa para
autenticação não é enviada pela rede para o Atlas e não é persistida pelo driver, tornando o
AWS IAM adequado até mesmo para as situações mais sensíveis.

Para AWS Lambda e HTTP (ECS e EC2), os drivers são lidos automaticamente do
variáveis ​ambientais
. Para AWS EKS, você deve atribuir manualmente a função do IAM. Esta página descreve
como AWS Lambda, AWS ECS e AWS EKS podem se conectar usando uma função AWS
IAM.
OBSERVAÇÃO
Você deve atribuir uma função do IAM ao Lambda, EC2, ECS ou EKS no console da AWS.

AWS Lambda
O AWS Lambda passa informações para funções por meio das seguintes variáveis de
ambiente se você
atribuir uma função de execução
para a função lambda.

AWS_ACCESS_KEY_ID

AWS_SECRET_ACCESS_KEY

AWS_SESSION_TOKEN

OBSERVAÇÃO
Você não precisa criar manualmente essas variáveis de ambiente ao usar um
função de execução
em sua função.

Para saber mais sobre essas variáveis de ambiente, consulte


Usando variáveis de ambiente AWS Lambda.

AWSECS
AWS ECS obtém as credenciais do seguinte URI:

http://169.254.170.2 + AWS_CONTAINER_CREDENTIALS_RELATIVE_URI
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI é uma variável de ambiente. Para
saber mais, consulte
Funções do IAM para tarefas.

AWS EC2 obtém as credenciais do Instance Metadata Service V2 no seguinte URL:

http://169.254.169.254/latest/meta-data/iam/security-credentials/
Para saber mais, consulte
Execute uma instância com uma função do IAM.

AWS ECS Fargate


Para saber como configurar uma função AWS IAM para autenticação sem senha com AWS
ECS Fargate, consulte o
Documentação da AWS.

AWS EKS
Para o AWS EKS, você deve primeiro atribuir a função do IAM ao seu pod para configurar
as seguintes variáveis de ambiente nesse pod:
AWS_WEB_IDENTITY_TOKEN_FILE – contém o caminho para o arquivo do token de
identidade da web.

AWS_ROLE_ARN – contém a função do IAM que você deseja usar para se conectar à
implantação do seu banco de dados.

Para obter informações sobre como atribuir uma função do IAM ao seu pod, consulte o
Documentação da AWS.

Depois de atribuir a função do IAM ao pod, você deverá assumir manualmente a função do
IAM para se conectar à implantação do banco de dados.

Para assumir a função manualmente:

Use a AWS
SDK
chamar
AssumeRoleWithWebIdentity.

DICA
Omita o parâmetro ProviderID.

Encontre o valor do parâmetro WebIdentityToken no arquivo descrito na variável de


ambiente AWS_WEB_IDENTITY_TOKEN_FILE do seu pod.

Passe as credenciais que você recebeu na etapa anterior para o driver MongoDB. Ver o seu
documentação do motorista
para detalhes.

DICA
Veja também:
Papéis do IAM para contas de serviço

Configure a autenticação sem senha usando SAML


Se você integrar seus usuários do AWS IAM a um IdP que depende da autenticação SAML,
poderá usar o provedor de SSO corporativo da sua empresa para:

Acesse Atlas.

Estabeleça autenticação sem senha para o usuário do banco de dados MongoDB se


conectar ao Atlas.
mangusto e os drivers MongoDB podem então usar esse usuário de banco de dados para
se conectar ao Atlas.

Para este usuário do banco de dados MongoDB, você pode usar credenciais de segurança
temporárias obtidas com o
Operação da API AssumeRoleWithSAML.
Neste cenário, você já deve ter:

Um provedor SAML SSO configurado.

Uma função de IdP existente que especifica seu provedor de IdP SAML em sua política de
confiança.

As etapas a seguir mostram como configurar a autenticação sem senha para um usuário do
banco de dados MongoDB. Para saber mais, use os links para cada etapa do fluxo de
trabalho.

Para configurar a autenticação sem senha para o usuário do banco de dados MongoDB
quando sua empresa usa um provedor de SSO com SAML e se integra ao AWS IAM:

Crie uma função para delegar permissões a um usuário do IAM.

Solicite credenciais de segurança temporárias da função delegada. O AWS Security Token


Service cria segurança temporária credenciais quando você ligar para a Operação da API
AssumeRoleWithSAML.

Use sua chave de API temporária, chave de acesso e token para autenticar com
implantações de banco de dados Atlas.
Configurar autenticação e autorização de
usuário com LDAP
Nesta página

Acesso obrigatório
Pré-requisitos
Recomendação
Considerações
Conflitos entre autorização LDAP e usuários X.509
Nomes de usuário
Cadeia de conexão
Reinicialização contínua na alteração da configuração
Usando endereços IP públicos
Limitações
Procedimentos
Configurar autenticação com LDAP
Configurar autorização
Adicionar um usuário ou grupo de banco de dados LDAP
Ver configuração LDAP
Desabilitar configuração LDAP
Tutoriais para provedores LDAP terceirizados
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber
mais, consulte Limitações do Atlas M0 (cluster gratuito), M2 e M5.

No momento, esse recurso não é compatível com instâncias sem servidor. Para saber mais,
consulte Limitações de instância sem servidor.

O Atlas fornece a capacidade de gerenciar a autenticação e autorização do usuário de


todos os clientes MongoDB usando seu próprio servidor Lightweight Directory Access
Protocol (LDAP) sobre TLS. Uma única configuração LDAPS (LDAP sobre TLS) se aplica a
todos os clusters de um projeto.

Se você habilitar a autorização de usuário com LDAP, poderá criar grupos LDAP no banco
de dados admin mapeando grupos LDAP para funções MongoDB em seus bancos de
dados Atlas. Para usar grupos LDAP de maneira eficaz, crie projetos adicionais no Atlas
para controlar o acesso a implantações específicas em sua organização, como a criação de
projetos Atlas separados para ambientes de desenvolvimento e produção. Você pode então
mapear um grupo LDAP para uma função no projeto Atlas para fornecer acesso à
implantação desejada.

OBSERVAÇÃO
Quando você habilita a autorização do usuário e um usuário LDAP não pertence a nenhum
grupo LDAP, o Atlas não atribui nenhuma função de banco de dados ao usuário. Quando
você habilita a autenticação do usuário e desabilita a autorização do usuário, o Atlas atribui
funções de banco de dados MongoDB ao usuário LDAP.
Se você tiver vários departamentos com necessidades de cobrança, configurações de alerta
e membros de projeto próprios, considere criar um novo conjunto de projetos ou uma nova
organização para cada departamento ou unidade de negócios.

OBSERVAÇÃO
Uma explicação do LDAP está fora do escopo da documentação do MongoDB. Por favor
revise
RFC 4515
e
RFC 4516
ou consulte a documentação LDAP de sua preferência.

Acesso obrigatório
Para gerenciar usuários ou grupos LDAP, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao Atlas.

Pré-requisitos
Você deve atender aos seguintes pré-requisitos para gerenciar a autenticação e autorização
do usuário usando LDAP no Atlas:

Cluster Atlas usando MongoDB 4.0 ou posterior.

Servidor LDAP usando TLS que seus clusters Atlas podem acessar pela rede usando
conexão de peering VPC ou VNet ou os endereços IP públicos dos nós do cluster.

Participações em grupos LDAP incorporadas como um atributo para cada usuário na


entrada LDAP somente para autorização do usuário.

Recomendação
Para que o seu serviço LDAPS acesse clusters Atlas, o MongoDB recomenda uma das
duas configurações:

Usando uma VPC ou VNet:

Execute seu servidor LDAP em uma VPC ou VNet.

Estabeleça uma conexão de peering com seu projeto Atlas.

Use um FQDN público que resolva o endereço IP privado do seu servidor LDAP.

Usando seu data center:

Execute seu servidor LDAP com um FQDN público que resolva para um endereço IP
público.

Configure o servidor LDAP para permitir acesso de entrada dos endereços IP públicos dos
nós do cluster Atlas.
Considerações
Conflitos entre autorização LDAP e usuários X.509
Se você habilitar a autorização LDAP, não poderá se conectar às implantações de banco de
dados com usuários autenticados com um certificado X.509 gerenciado pelo Atlas.

Depois de ativar a autorização LDAP, você poderá conectar-se às implantações de banco


de dados com usuários autenticados com um certificado X.509 autogerenciado. Entretanto,
o Nome Comum do usuário no certificado X.509 deve corresponder ao Nome Distinto de um
usuário autorizado a acessar seu banco de dados com LDAP.

Nomes de usuário
O Atlas usa o Nome Distinto (DN) completo dos usuários em seu servidor LDAP como nome
de usuário do Atlas. Por exemplo, um usuário LDAP chamado ralph tem o seguinte nome de
usuário no Atlas:

cn=ralph,cn=Usuários,dc=aws-atlas-ldap-01,dc=minhaequipe,dc=com

Cadeia de conexão
Se o administrador ativar a autenticação do usuário ou a autenticação e autorização do
usuário com LDAP, os usuários do banco de dados deverão substituir os parâmetros a
seguir na cadeia de conexão para seus clientes.

authSource deve ser $externo

O mecanismo de autenticação deve ser PLAIN

EXEMPLO
A seguinte string de conexão para
mangusto
autentica um usuário LDAP chamado rob:

mongosh "mongodb+srv://cluster0-tijis.mongodb.net/test?authSource=%24external"\
--authenticationMechanism PLAIN \
--username cn=rob,cn=Usuários,dc=ldaps-01,dc=minhaequipe,dc=com

Para copiar a string de conexão:

Clique em Banco de dados no canto superior esquerdo do Atlas.

Clique em Conectar na página Implantação de banco de dados.

Edite a string com seu DN de usuário e senha.

OBSERVAÇÃO
Se suas senhas, nomes de bancos de dados ou cadeias de conexão contiverem caracteres
de URI reservados, você deverá escapar dos caracteres. Por exemplo, se sua senha for
@bc123, você deverá escapar do caractere @ ao especificar a senha na cadeia de
conexão, como %40bc123. Para saber mais, consulte Caracteres especiais na senha da
string de conexão.

Reinicialização contínua na alteração da configuração


Se você alterar a configuração do LDAP, o Atlas executará uma reinicialização contínua do
cluster. Essa inicialização permite que o Atlas use as configurações corretas para autenticar
usuários.

Usando endereços IP públicos


Você pode usar endereços IP públicos que se referem a outros endereços IP internos ou
privados usando a Tradução de Endereço de Rede para permitir o tráfego do Atlas para o
seu servidor LDAP. Se você fizer isso, esteja ciente de que determinadas atividades
desencadeiam uma alteração nos endereços IP públicos do cluster Atlas.

Se você permitiu o acesso ao servidor LDAP com base em endereços IP públicos, as


alterações no endereço IP público do cluster Atlas impedirão o acesso LDAP. Para restaurar
o acesso LDAP, adicione os novos endereços IP públicos do cluster Atlas à lista de acesso
LDAP.

Limitações
Você não pode usar autenticação LDAP e SCRAM para o mesmo usuário do banco de
dados.

Procedimentos
Configurar autenticação com LDAP

CLI do Atlas

IU do Atlas
OBSERVAÇÃO
Você pode usar o mesmo comando Atlas CLI para configurar a autenticação LDAP e a
autorização LDAP.

Para salvar uma configuração LDAP para o projeto especificado usando a CLI do Atlas,
execute o seguinte comando:

atlas security ldap save [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atlas segurança ldap salvar.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas
Conecte-se à CLI do Atlas

Configurar autorização

CLI do Atlas

IU do Atlas
OBSERVAÇÃO
Você pode usar o mesmo comando Atlas CLI para configurar a autenticação LDAP e a
autorização LDAP.

Para salvar uma configuração LDAP para o projeto especificado usando a CLI do Atlas,
execute o seguinte comando:

atlas dbusers create [builtInRole]... [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas segurança ldap salvar.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Adicionar um usuário ou grupo de banco de dados LDAP

CLI do Atlas

IU do Atlas
Para criar um usuário de banco de dados para seu projeto usando a CLI do Atlas, execute o
seguinte comando:

atlas dbusers create [builtInRole]... [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas dbusers criam.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Ver configuração LDAP

CLI do Atlas

IU do Atlas
Para retornar os detalhes de uma configuração LDAP usando a CLI do Atlas, execute o
seguinte comando:

atlas security ldap get [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas segurança ldap obter.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Desabilitar configuração LDAP

CLI do Atlas

IU do Atlas
OBSERVAÇÃO
Você pode usar o mesmo comando Atlas CLI para desabilitar as configurações de
autenticação LDAP e as configurações de autorização LDAP.

Para excluir uma configuração LDAP usando a CLI do Atlas, execute o seguinte comando:

atlas security ldap delete [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
exclusão de ldap de segurança do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas
Conecte-se à CLI do Atlas

Tutoriais para provedores LDAP terceirizados


Use os seguintes tutoriais para configurar o Atlas para autenticar e autorizar usuários de
provedores LDAP terceirizados:

Configurar a autenticação e autorização do usuário com os serviços de domínio do Azure


AD

Configurar autenticação e autorização de usuário com interface Okta LDAP

Configure a autenticação e autorização do usuário com OneLogin VLDAP


Configurar a autenticação e autorização do usuário com os serviços de domínio do Azure
AD
Nesta página

Limitações
Acesso obrigatório
Pré-requisitos
Procedimentos
Configure os serviços de domínio do Azure AD para o seu domínio
Configurar o Atlas para autenticação LDAP
Adicione os grupos LDAP de acesso ao banco de dados ao Atlas
Configurar o Atlas para autorização LDAP
Conecte-se ao seu cluster usando mongosh
Usar
para se conectar ao seu cluster com credenciais de usuário que você adicionou ao Atlas.
Depois de se conectar ao cluster, execute comandos para verificar se o usuário tem os
privilégios de leitura ou gravação que você atribuiu a ele.
Solucionar problemas de conexão LDAP
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber
mais, consulte Limitações do Atlas M0 (cluster gratuito), M2 e M5.

No momento, esse recurso não é compatível com instâncias sem servidor. Para saber mais,
consulte Limitações de instância sem servidor.

Este guia mostra como permitir que o Atlas autentique e autorize usuários de banco de
dados (não usuários do Atlas) de
Serviços de Domínio Azure AD
, um provedor LDAP terceirizado.

Você pode ativar apenas a autenticação LDAP ou ativar a autenticação e a autorização


LDAP:

Se você ativar apenas a autenticação LDAP, você adicionará usuários individuais ao Atlas e
atribuirá privilégios de acesso ao banco de dados a cada usuário adicionado.

Se você ativar a autenticação e autorização LDAP, adicione grupos de usuários ao Atlas e


atribua privilégios de acesso ao banco de dados a cada grupo. Os usuários herdam os
privilégios de acesso ao banco de dados do grupo LDAP ao qual pertencem.

O Atlas dá suporte à autenticação e autorização de usuários de banco de dados dos


Serviços de Domínio do Azure AD.

Limitações
Você deve implementar clusters Atlas M10 ou maiores para ativar a integração LDAP. A
integração LDAP é um recurso do Atlas Enterprise.
O Atlas não oferece suporte à integração de logon único para usuários de banco de dados.
Para saber mais sobre a integração de logon único para a interface web administrativa do
Atlas, consulte Configurar autenticação federada.

Acesso obrigatório
Para gerenciar usuários ou grupos LDAP, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao Atlas.

Pré-requisitos
Para integrar o LDAP do Azure AD Domain Services ao Atlas, você deve ter:

Uma assinatura do Azure. Para obter uma assinatura, visite o


Portal do Microsoft Azure.

Privilégios de contribuidor ou superiores para a sua subscrição do Azure para criar os


recursos exigidos pela integração LDAP.

Um locatário do Azure AD associado à sua assinatura. Para obter informações sobre como
configurar um locatário do Azure AD, consulte o
Documentação do Azure AD.

Privilégios de Administrador Global no seu inquilino Azure AD para ativar os Serviços de


Domínio Azure AD.

Um nome de domínio personalizado e roteável.

Procedimentos
Configure os serviços de domínio do Azure AD para o seu domínio
1
Configure os Serviços de Domínio Azure AD para o seu domínio.
Para configurar os Serviços de Domínio Azure AD, siga o
Crie um domínio gerenciado avançado
tutorial na Documentação do Azure usando a opção Nome DNS de nomes de domínio
personalizados.

Ao configurar seu domínio gerenciado, certifique-se de anotar o valor inserido no campo


Nome de domínio DNS. Este valor é o seu <domínio gerenciado>. Você deve fornecê-lo em
vários lugares deste tutorial.

EXEMPLO
aadds.exemplo.com

2
Obtenha um certificado SSL para LDAP seguro.
Os Serviços de Domínio Azure AD utilizam certificados SSL para proteger o LDAP. Seu
certificado deve atender aos requisitos descritos no
Documentação do Azure.
Para obter um certificado:

Obtenha um da autoridade de certificação (CA) pública ou empresarial que sua organização


usa.

Você deve obter um certificado curinga para garantir que o LDAP seguro funcione
corretamente com os Serviços de Domínio do Azure AD.

O nome da entidade do certificado deve corresponder ao <domínio gerenciado> que você


usou quando configurou os Serviços de Domínio do Azure AD.

EXEMPLO
*.aadds.example.com

Gere um certificado autoassinado. Certificados autoassinados não são recomendados para


produção.

Para gerar um certificado autoassinado em sistemas MacOS ou Linux para fins de teste:

OBSERVAÇÃO
Se você estiver no macOS Catalina, instale a versão mais recente do openssl. Execute o
seguinte comando para instalar usando Homebrew:

preparar instalar o openssl

Gere uma chave privada com openssl. O comando a seguir gera um arquivo de chave
privada denominado <nome-da-sua-chave>.key:

openssl genrsa -out <seu-nome-chave>.key 2048

Edite o seguinte modelo de arquivo de configuração. Atualize os atributos na seção


[dn-param] com valores relacionados à sua organização. Certifique-se de que o nome do
assunto (CN) corresponda ao seguinte modelo: *.<domínio gerenciado>

EXEMPLO
*.aadds.example.com

# parâmetros de extfile openssl x509


extensões = estender
[req] # parâmetros de solicitação do openssl
alerta = não
nome_distinto = dn-param
[dn-param] # campos DN
C = EUA
ST = NY
L = Nova York
O = MongoDB
OU = Atlas
CN = *.aadds.example.com
[estender] # extensões openssl
subjectKeyIdentifier = hash
autoridadeKeyIdentifier = keyid: sempre
keyUsage = digitalSignature,keyEncipherment,keyCertSign
ExtendedKeyUsage=serverAuth,clientAuth

Salve o arquivo como <seu-nome-configuração>.cfg.

Gere uma solicitação de assinatura de certificado usando a chave e os arquivos de


configuração que você criou. O seguinte comando geral Há uma solicitação de assinatura
de certificado chamada <seu-nome-csr>.csr:

openssl req -new -key <nome-da-sua-chave>.key \


-out <nome-seu-csr>.csr -config <nome-seu-config>.cfg \
-extensões estendem

Gere um certificado autoassinado usando arquivos de chave, configuração e solicitação de


assinatura de certificado que você criou. O comando a seguir gera um arquivo de certificado
autoassinado denominado <seu-nome-certificado>.crt:

openssl x509 -req -sha256 -days 365 -in <seu-nome-csr>.csr \


-signkey <seu-nome-chave>.key -out <seu-nome-certificado>.crt \
-extfile <seu-nome-config>.cfg

Para gerar um certificado autoassinado em um sistema Windows para fins de teste,


consulte o
Documentação do Azure.

3
Obtenha um certificado SSL que inclua sua chave privada.
Os Serviços de Domínio Azure AD utilizam chaves privadas para desencriptar o tráfego
LDAP seguro. Os certificados que incluem chaves privadas usam o formato PKCS#12 e o
formato de arquivo .pfx. Você deve carregar um certificado desse formato nos Serviços de
Domínio do Azure AD para descriptografar o tráfego LDAP seguro enviado pela Internet
pública.

Para gerar um certificado .pfx em sistemas MacOS ou Linux:

Salve sua chave pública e certificado SSL em sua máquina local.

OBSERVAÇÃO
Seu certificado deve usar o formato PEM.

Se o seu certificado não contiver sua chave privada, você poderá salvá-la em um arquivo no
formato .key.
Gere um certificado .pfx usando sua chave privada e seu certificado com openssl. O
comando a seguir gera um arquivo de certificado .pfx denominado
<seu-nome-certificado>.pfx:

openssl pkcs12 -export -out <seu-nome-certificado>.pfx \


-inkey <seu-nome-chave>.key -in <seu-nome-certificado>.crt

Quando solicitado, digite e verifique uma senha para criptografar o arquivo. Você inserirá
essa senha para descriptografar sua chave privada ao carregar o certificado .pfx nos
Serviços de Domínio do Azure AD.

Para gerar um certificado .pfx em um sistema Windows, consulte o


Documentação do Azure.

4
Habilite o LDAP seguro nos Serviços de Domínio do Azure AD.
Para habilitar o LDAP seguro nos Serviços de Domínio do Azure AD, consulte o
Documentação do Azure.

5
Configure seu provedor DNS.
Você deve configurar seu provedor DNS para que o Atlas e os nós do banco de dados
possam se conectar ao servidor LDAP no domínio personalizado gerenciado pelos Serviços
de Domínio do Azure AD.

Crie um registro de host para o tráfego LDAP que resolva um subdomínio do seu <domínio
gerenciado> para o endereço IP externo que o serviço LDAP dos Serviços de Domínio do
Azure AD usa:

Endereço IP LDAP
Subdomínio para tráfego LDAP
203.0.113.77
ldap.aadds.example.com
Para encontrar o endereço IP externo que o serviço LDAP do Azure AD Domain Services
usa, consulte o
Documentação do Azure.

6
Adicione seu domínio personalizado ao Azure AD.
Adicione o seu nome de domínio personalizado ao Azure AD para criar utilizadores que
pertençam ao seu domínio. Depois de adicionar o seu domínio, também deve adicionar as
informações de DNS do Azure AD num registo TXT com o seu fornecedor de DNS e
verificar a configuração.

Para adicionar seu domínio personalizado ao Azure AD, consulte o


Documentação do Azure.

7
Configure os Serviços de Domínio Azure AD para tráfego LDAP de entrada.
Você deve permitir todo o tráfego em todas as portas da Internet pública até a porta 636
para usar os Serviços de Domínio do Azure AD como um provedor LDAP com o Atlas.

Para adicionar uma regra de segurança de entrada para permitir o tráfego LDAP de entrada
na porta 636, consulte o
Documentação do Azure.

8
Crie um usuário vinculado.
Crie um usuário vinculado. O usuário de ligação é um usuário do Azure AD que você usa
para consultar a conta e autenticar as credenciais dos usuários do banco de dados quando
eles se conectam a um banco de dados Atlas. O utilizador de ligação deve pertencer ao
domínio personalizado que adicionou ao Azure AD.

Para criar usuários do Azure AD, consulte o


Documentação do Azure.

9
Habilite a conta de usuário vinculada para serviços de domínio do Azure AD.
Você deve gerar um hash de senha para o usuário de ligação para autenticação Kerberos e
NTLM antes que o usuário de ligação possa usar os Serviços de Domínio do Azure AD. As
etapas diferem com base no tipo de conta de usuário do Azure AD.

Para saber como gerar hashes de senha para seus usuários, consulte o
Documentação do Azure.

10
Atribua a função Leitores de Diretório à conta de usuário vinculada.
Para consultar o Azure AD, o usuário vinculado deve ter as permissões concedidas pelo
Leitores de diretório papel.

Para atribuir a função de Leitores de Diretório ao usuário de ligação, consulte o


Documentação do Azure.

11
Crie usuários do Azure AD.
Se ainda não existirem, crie utilizadores nos Serviços de Domínio Azure AD aos quais
pretende conceder acesso à base de dados. Os usuários devem pertencer ao domínio
personalizado adicionado ao Azure AD.

Para criar usuários do Azure AD, consulte o


Documentação do Azure.

Configurar o Atlas para autenticação LDAP


O procedimento a seguir permite que o Atlas autentique usuários de banco de dados do
LDAP dos Serviços de Domínio do Azure AD:
1
Faça login no Atlas.
2
Navegue até a página Avançado do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Clique em Avançado na barra lateral.

3
Alterne o botão próximo a Autenticação LDAP para Ativado.
OBSERVAÇÃO
Você poderá incorrer em custos adicionais ao ativar esse recurso. Veja Avançado
Segurança.

4
Insira os detalhes do servidor e vincule as credenciais de todos os seus servidores LDAP no
painel Configurar seu servidor LDAP.
Nome do host do servidor:

ldap.<domínio gerenciado>.com

Porta do servidor: 636

Nome de usuário vinculado:

CN=<bind-username>,OU=AADDC Users,DC=<managed-domain>,DC=com

OBSERVAÇÃO
Para os Serviços de Domínio Azure AD, os atributos em nomes distintos devem estar em
maiúsculas.

Se o seu <domínio gerenciado> consistir em um ou mais subdomínios, você deverá


adicionar um atributo DC (domainComponent) ao nome distinto de cada um.

EXEMPLO
Se o seu <domínio gerenciado> for aadds.example.com, os componentes do domínio serão:

DC=aadds,DC=exemplo,DC=com

5
Opcional: Adicione um usuário ao mapeamento DN.
Adicione um mapeamento de usuário para DN semelhante ao exemplo a seguir para
permitir que os clientes forneçam seus nomes de usuário em vez de DNs completos quando
se conectarem aos bancos de dados Atlas:

[
{
"match":"(.+)",
"substitution":"CN={0},OU=AADDC Users,DC=<managed-domain>,DC=com"
}
]

OBSERVAÇÃO
Para os Serviços de Domínio Azure AD, os atributos em nomes distintos devem estar em
maiúsculas.

Se o seu <domínio gerenciado> consistir em um ou mais subdomínios, você deverá


adicionar um atributo DC (domainComponent) ao nome distinto de cada um.

EXEMPLO
Se o seu <domínio gerenciado> for aadds.example.com, os componentes do domínio serão:

DC=aadds,DC=exemplo,DC=com

6
Opcional: Insira certificados emitidos por uma Autoridade de Certificação (CA) para seus
servidores LDAP, separados por vírgulas, no campo Certificado Raiz da CA.
Se você gerou um certificado autoassinado, deverá fornecê-lo.

7
Clique em Verificar e Salvar.
Aguarde até que o Atlas implante suas alterações. O Atlas verifica se seus clusters podem
se conectar, autenticar e consultar seus servidores LDAP usando os detalhes de
configuração que você forneceu.

8
Adicione usuários LDAP ao Atlas.
OBSERVAÇÃO
Pular esta etapa se você deseja ativar a autorização LDAP.

Adicione usuários gerenciados no Azure AD ao Atlas.

Na seção Segurança da navegação esquerda, clique em Acesso ao banco de dados.

Clique em Adicionar novo usuário do banco de dados.

Clique em Usuário LDAP.


Execute um dos seguintes procedimentos:

Se você não inseriu um mapeamento de usuário para DN, insira o DN completo do usuário
LDAP. Siga este modelo:

CN=Jane Doe,ou=AADDC Users,DC=aadds,DC=example,DC=com

Por exemplo, se seu <nome de usuário> for Jane Doe e seu <domínio gerenciado> for
aadds.example.com, o DN do seu usuário será:

CN=Jane Doe,ou=Usuários AADDC,DC=aadds,DC=exemplo,DC=com


Se você inseriu um mapeamento de usuário para DN, insira o nome de usuário exigido pelo
seu mapeamento.

Selecione o nível de acesso ao banco de dados a ser concedido ao usuário.

Clique em Adicionar usuário.

Adicione os grupos LDAP de acesso ao banco de dados ao Atlas


OBSERVAÇÃO
Pule esta seção se não quiser ativar a autorização LDAP.

IMPORTANTE
Você deve ativar a autenticação com LDAP antes de ativar a autorização.

Ao ativar e configurar a autorização LDAP, os usuários do banco de dados configurados


apenas para autenticação LDAP não poderão mais acessar os bancos de dados.

A autorização LDAP do Atlas usa grupos LDAP para determinar se os usuários estão
autorizados a executar ações de banco de dados.

Crie grupos separados do Azure AD para cada nível de acesso que você deseja conceder
aos usuários. Por exemplo, você cria um grupo para acesso de leitura a um banco de
dados, outro para acesso de leitura e gravação e assim por diante. Atribua usuários a
grupos com base no nível de acesso exigido por cada usuário.

Para criar grupos de acesso ao banco de dados do Azure AD e atribuir usuários, consulte o
Documentação do Azure.

Configurar o Atlas para autorização LDAP


OBSERVAÇÃO
Pule esta seção se não quiser ativar a autorização LDAP.
O procedimento a seguir adiciona os grupos de acesso ao banco de dados do Azure AD
Domain Services ao Atlas e permite a autorização do usuário do banco de dados no Atlas:

1
Adicione os grupos LDAP de acesso ao banco de dados ao Atlas.
Adicione cada um dos grupos de banco de dados do Azure que você criou ao Atlas. Os
membros dos grupos adicionados estão autorizados a executar ações de banco de dados
concedidas ao grupo.

Na seção Segurança da navegação esquerda, clique em Acesso ao Banco de Dados.

Clique em Adicionar novo usuário do banco de dados.

Clique em Grupo LDAP e insira o DN completo do grupo que contém os usuários do banco
de dados, mesmo se você tiver ativado o mapeamento de usuário para DN. Siga este
modelo:

CN=<group-name>,OU=AADDC Users,DC=<managed-domain>,DC=com

OBSERVAÇÃO
Para os Serviços de Domínio Azure AD, os atributos em nomes distintos devem estar em
maiúsculas.

Se o seu <domínio gerenciado> consistir em um ou mais subdomínios, você deverá


adicionar um atributo DC (domainComponent) ao nome distinto de cada um.

EXEMPLO
Se o seu <domínio gerenciado> for aadds.example.com, os componentes do domínio serão:

DC=aadds,DC=exemplo,DC=com

Por exemplo, se seu <nome-do-grupo> for somente leitura do Atlas e seu <domínio
gerenciado> for aadds.example.com, o DN do seu usuário será:

CN=Atlas read only,OU=AADDC Users,DC=aadds,DC=example,DC=com

Selecione o nível de acesso ao banco de dados a ser concedido aos usuários deste grupo.

Clique em Adicionar usuário.


2
Navegue até a página Avançado do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na navegação
bar.

Clique em Avançado na barra lateral.

3
Alterne o botão próximo a Autorização LDAP para Ativado.
4
Verifique se os detalhes do servidor e as credenciais de ligação do seu servidor LDAP estão
corretas no painel Configurar seu servidor LDAP.
5
Insira um modelo de consulta em Modelo de Consulta.
Quando um usuário tenta realizar uma ação, o Atlas executa o Modelo de consulta LDAP
para obter os grupos LDAP aos quais o usuário autenticado pertence. O Atlas permite a
ação se a consulta retornar pelo menos um grupo autorizado a executar a ação. O Atlas não
permitirá a ação se a consulta não retornar a nenhum grupo autorizado a executar a ação.

O Atlas substitui o nome de usuário autenticado no espaço reservado {USER} ao executar a


consulta. A consulta é relativa ao host especificado em Nome do host do servidor.

A formatação da consulta deve estar de acordo com


RFC4515

Se quiser identificar de qual grupo um usuário é membro, você pode usar o modelo de
consulta padrão:

{USER}?memberOf?base

OBSERVAÇÃO
Outros modelos de consulta também podem funcionar.

6
Clique em Verificar e Salvar.
Aguarde até que o Atlas implante suas alterações. O Atlas verifica se seus clusters podem
se conectar, autenticar e consultar seu servidor LDAP usando os detalhes de configuração
que você fornece.

Conecte-se ao seu cluster usando mongosh


O procedimento a seguir verifica se a autenticação LDAP (e a autorização LDAP, se
ativada) está configurada corretamente:
OBSERVAÇÃO
Quando a autenticação LDAP está habilitada, os usuários do banco de dados devem
substituir os seguintes parâmetros na cadeia de conexão de seus clientes:

authSource deve ser $externo

O mecanismo de autenticação deve ser PLAIN

1
Usar mangusto para se conectar ao seu cluster com credenciais de usuário que você
adicionou ao Atlas. Para copiar a string de conexão:

Clique em Banco de dados no canto superior esquerdo do Atlas.

Clique em Conectar na página Implantações de banco de dados.

Clique em LDAP e em Copiar.

Cole e edite a string com seu DN de usuário e senha.

OBSERVAÇÃO
Conecte-se ao seu cluster com o DN completo de um usuário se o mapeamento de usuário
para DN não estiver habilitado.

OBSERVAÇÃO
Para os Serviços de Domínio Azure AD, os atributos em nomes distintos devem estar em
maiúsculas.

Se o seu <domínio gerenciado> consistir em um ou mais subdomínios, você deverá


adicionar um atributo DC (domainComponent) ao nome distinto de cada um.

EXEMPLO
Se o seu <domínio gerenciado> for aadds.example.com, os componentes do domínio serão:

DC=aadds,DC=exemplo,DC=com

Espaços de escape em nomes de usuários ou grupos no DN completo do usuário:

--username CN=Jane\ Doe,OU=AADDC\ Users,DC=aadds,DC=example,DC=com

OBSERVAÇÃO
Se você estiver usando o DN completo de um usuário, inclua apenas a UO de usuários do
AADDC (unidade organizacional). Não inclua outros grupos do Azure AD dos quais o
usuário seja membro.

2
Depois de se conectar ao cluster, execute comandos para verificar se o usuário tem os
privilégios de leitura ou gravação que você atribuiu a ele.
Solucionar problemas de conexão LDAP
OBSERVAÇÃO
Nos Serviços de Domínio do Azure AD, o usuário vinculado ao grupo de Administradores do
AAD DC para realizar pesquisas LDAP.
Certifique-se de que seu usuário de ligação tenha esses privilégios
antes de executar o ldapsearch.

Use ldapsearch para determinar se o modelo de consulta que você configurou para o Atlas
retornar DNs de usuário da maneira esperada. O modelo de consulta pode não retornar os
DNs de usuário corretos se a autenticação LDAP funcionar, mas a autorização LDAP não.

Use o seguinte modelo ldapsearch:

ldapsearch -H 'ldaps://ldap.<managed-domain>.com' -b
'DC=<managed>,DC=<domain>,DC=com' -s sub -D
'CN=<bind-user-dn>,OU=AADDC Users,DC=<managed>,DC=<domain>,DC=com'
-w '<REDACTED>'
'(&(objectCategory=user)(memberOf=CN=<group-name>,OU=AADDC
Users,DC=<managed-domain>,DC=com))'

OBSERVAÇÃO
Para os Serviços de Domínio Azure AD, os atributos em nomes distintos devem estar em
maiúsculas.

Se o seu <domínio gerenciado> consistir em um ou mais subdomínios, você deverá


adicionar um atributo DC (domainComponent) ao nome distinto de cada um.

EXEMPLO
Se o seu <domínio gerenciado> for aadds.example.com, os componentes do domínio serão:

DC=aadds,DC=exemplo,DC=com

Por exemplo, se seu bind-user-dn for CN=LDAP Bind User,OU=AADDC


Users,DC=aadds,DC=example,DC=com, seu <domínio gerenciado> será
aadds.example.com e seu grupo -name é somente leitura do Atlas, use o seguinte
comando:
ldapsearch -H 'ldaps://ldap.aadds.example.com' -b
'DC=aadds,DC=example,DC=com' -s sub -D 'CN=LDAP Bind User,OU=AADDC
Users,DC=aadds,DC=example,DC=com' -w '<REDACTED>'
'(&(objectCategory=user)(memberOf=CN=Atlas read only,OU=AADDC
Users,DC=aadds,DC=example,DC=com))'

OBSERVAÇÃO
Outros modelos de consulta também podem funcionar.
Configurar autenticação e autorização de
usuário com interface Okta LDAP
Nesta página

Limitações
Acesso obrigatório
Procedimentos
Configurar Okta para autenticação LDAP
Configurar o Atlas para autenticação LDAP
Configurar Okta para autorização LDAP
Configurar o Atlas para autorização LDAP
Conecte-se ao seu cluster usando mongosh
Conecte-se ao seu cluster com as credenciais de usuário que você adicionou ao Atlas.
Depois de se conectar ao cluster, execute comandos para verificar se o usuário tem os
privilégios de leitura ou gravação que você atribuiu a ele.
Solucionar problemas de conexão LDAP
OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber
mais, consulte Limitações do Atlas M0 (cluster gratuito), M2 e M5.

No momento, esse recurso não é compatível com instâncias sem servidor. Para saber mais,
consulte Limitações de instância sem servidor.

Este guia mostra como permitir que o Atlas autentique e autorize usuários de banco de
dados (não usuários do Atlas) de
Okta
, um provedor LDAP terceirizado.

Você pode ativar apenas a autenticação LDAP ou ativar a autenticação e a autorização


LDAP:

Se você ativar apenas a autenticação LDAP, você adicionará usuários individuais ao Atlas e
atribuirá privilégios de acesso ao banco de dados a cada usuário adicionado.

Se você ativar a autenticação e autorização LDAP, adicione grupos de usuários ao Atlas e


atribua privilégios de acesso ao banco de dados a cada grupo. Os usuários herdam os
privilégios de acesso ao banco de dados do grupo LDAP ao qual pertencem.

Atlas suporta:

Autenticação de usuários de banco de dados da sincronização do Okta Active Directory.

Autenticando usuários do banco de dados do Okta.

Autorizando usuários de banco de dados em grupos Okta.


Limitações
Você deve implementar clusters Atlas M10 ou maiores para ativar a integração LDAP. A
integração LDAP é um recurso do Atlas Enterprise.

O Atlas não oferece suporte à autorização de usuários de banco de dados em grupos de


sincronização do Okta Active Directory.

O Atlas não oferece suporte à integração de logon único para usuários de banco de dados.
Para saber mais sobre a integração de logon único para a interface web administrativa do
Atlas, consulte Configurar autenticação federada.

Acesso obrigatório
Para gerenciar usuários ou grupos LDAP, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao Atlas.

Procedimentos
Configurar Okta para autenticação LDAP
O procedimento a seguir configura o Okta para autenticação com Atlas:

1
Configure a interface LDAP do Okta.
Para saber mais sobre como configurar a interface LDAP do Okta, consulte o
Documentação Okta.

Anote seu <okta-instance-id>. Você deve fornecê-lo em vários locais durante o processo de
configuração.

O nome da instância está localizado no URL que você usa para fazer login na sua conta
Okta:

https://<okta-instance-id>.admin.okta.com

2
Crie um usuário vinculado.
Crie um novo usuário Okta
para usar como usuário de vinculação do Atlas. O usuário bind é um usuário Okta que
você usa para consultar a conta e autenticar as credenciais dos usuários do banco de
dados quando eles se conectam a um banco de dados Atlas.

IMPORTANTE
Não use sua própria conta de usuário para o usuário vinculado.

Use o modelo a seguir para determinar o Nome Distinto (DN) completo do seu usuário de
ligação:
uid=<bind-user-email>,dc=<okta-instance-id>,dc=okta,dc=com

Por exemplo, se seu <bind-user-email> for bind@example.com e seu <okta-instance-id> for


mdb-example, o DN do seu usuário de ligação será:

uid=bind@example.com,ou=users,dc=mdb-example,dc=okta,dc=com

3
Crie usuários de banco de dados no Okta.
Se eles ainda não existirem, crie usuários no Okta aos quais você deseja conceder acesso
ao banco de dados:

Navegue até a página Okta People.

Clique em Adicionar pessoa.

Insira os dados do usuário. Use endereços de e-mail para nomes de usuário.

OBSERVAÇÃO
Evite inserir endereços de e-mail com símbolos de mais (+). A integração do Atlas LDAP
pode encontrar problemas com endereços de e-mail contendo símbolos de adição.

Clique em Salvar.

Configurar o Atlas para autenticação LDAP


O procedimento a seguir permite que o Atlas autentique usuários do banco de dados do
Okta LDAP:

1
Faça login no Atlas.
2
Navegue até a página Avançado do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Clique em Avançado na barra lateral.

3
Alterne o botão próximo a Autenticação LDAP para Ativado.
OBSERVAÇÃO
Você poderá incorrer em custos adicionais ao ativar esse recurso. Consulte Segurança
Avançada.

4
Insira os detalhes do servidor e vincule as credenciais de todos os seus servidores LDAP no
painel Configurar seu servidor LDAP.
Nome do host do servidor:

<okta_instance_id>.ldap.okta.com

Porta do servidor: 636

Nome de usuário vinculado:

uid=<bind-user-email>,ou=users,dc=<okta-instance-id>,dc=okta,dc=com

5
Opcional: Adicione um usuário ao mapeamento DN.
Adicione um mapeamento de usuário para DN semelhante ao exemplo a seguir para
permitir que os clientes forneçam seus endereços de e-mail em vez de DNs completos
quando se conectarem aos bancos de dados Atlas:

[
{
"match": "(.+)",
"substitution": "uid={0},ou=users,dc=<okta_instance_id>,dc=okta,dc=com"
}
]

6
Opcional: Insira certificados emitidos por uma Autoridade de Certificação (CA) para seus
servidores LDAP, separados por vírgulas, no campo Campo Certificado raiz da CA.
Você pode fornecer certificados autoassinados.

7
Clique em Verificar e Salvar.
Aguarde até que o Atlas implante suas alterações. O Atlas verifica se seus clusters podem
se conectar, autenticar e consultar seus servidores LDAP usando os detalhes de
configuração que você forneceu.

8
Adicione usuários LDAP ao Atlas.
OBSERVAÇÃO
Pular esta etapa se você deseja ativar a autorização LDAP.

Adicione usuários gerenciados no Okta LDAP ao Atlas.

Na seção Segurança da navegação esquerda, clique em Acesso ao Banco de Dados.

Clique em Adicionar novo usuário do banco de dados.

Clique em Usuário LDAP.

Execute um dos seguintes procedimentos:

Se você não inseriu um mapeamento de usuário para DN, insira o DN completo do usuário
LDAP. Siga este modelo:

uid=<user-name>,ou=users,dc=<okta-instance-id>,dc=okta,dc=com

Por exemplo, se seu <nome-de-usuário> for jane@example.com e seu <okta-instance-id>


for mdb-example, o DN do seu usuário será:

uid=jane@example.com,ou=users,dc=mdb-example,dc=okta,dc=com

Se você inseriu um mapeamento de usuário para DN, insira o nome de usuário ou endereço
de e-mail exigido pelo seu mapeamento.

Selecione o nível de acesso ao banco de dados a ser concedido ao usuário.

Clique em Adicionar usuário.

Configurar Okta para autorização LDAP


OBSERVAÇÃO
Ignorar esta seção
se você não quiser ativar a autorização LDAP.
O procedimento a seguir configura o Atlas para autorizar usuários que pertencem a grupos
de acesso ao banco de dados LDAP Okta.

IMPORTANTE
Você deve ativar a autenticação com LDAP antes de ativar a autorização.

Ao ativar e configurar a autorização LDAP, os usuários do banco de dados configurados


apenas para autenticação LDAP não poderão mais acessar os bancos de dados.

1
Crie grupos de acesso ao banco de dados Okta.
A autorização LDAP do Atlas usa grupos LDAP para determinar se os usuários estão
autorizados a executar ações de banco de dados.

Crie grupos Okta separados para cada nível de acesso que você deseja conceder aos
usuários. Por exemplo, você cria um grupo para acesso de leitura a um banco de dados,
outro para acesso de leitura e gravação e assim por diante.

Navegue até a página de grupos do Okta clicando em Diretório e depois em Grupos.

Clique em Adicionar grupo.

Insira um nome de grupo, por exemplo db-read.

Clique em Adicionar grupo.

2
Adicione usuários do Okta a grupos de acesso ao banco de dados.
Atribua usuários a grupos com base no nível de acesso exigido por cada usuário.

Clique no grupo ao qual deseja adicionar usuários.

Clique em Gerenciar pessoas.

Adicione usuários ao grupo e clique em Salvar.

3
Atribua privilégios ao usuário vinculado.
O usuário de ligação deve ter privilégios de administrador somente leitura para autorizar
usuários em grupos específicos do Okta e para executar pesquisas LDAP. Para atribuir
privilégios de administrador somente leitura ao usuário vinculado:

Navegue até a página Administradores do Okta clicando em Segurança e depois em


Administradores.

Clique em Adicionar administrador.

Procure seu usuário de ligação e selecione a função Administrador somente leitura.


Clique em Adicionar administrador.

Configurar o Atlas para autorização LDAP


OBSERVAÇÃO
Ignorar esta seção
se você não quiser ativar a autorização LDAP.

O procedimento a seguir adiciona os grupos de acesso ao banco de dados Okta ao Atlas e


permite a autorização do usuário do banco de dados no Atlas:

1
Adicione os grupos LDAP de acesso ao banco de dados ao Atlas.
Adicione cada um dos grupos de banco de dados Okta que você criou ao Atlas. Os
membros dos grupos adicionados estão autorizados a executar ações de banco de dados
concedidas ao grupo.

Na seção Segurança da navegação esquerda, clique em Acesso ao Banco de Dados.

Clique em Adicionar novo usuário do banco de dados.

Clique em Grupo LDAP e insira o DN completo do grupo que contém os usuários do banco
de dados, mesmo se você tiver ativado o mapeamento de usuário para DN. Siga este
modelo:

cn=<nome do grupo>,ou=grupos,dc=<okta-instance-id>,dc=okta,dc=com

Por exemplo, se seu <group-name> for db-read e seu <okta-instance-id> for mdb-example,
o DN do seu usuário de ligação será:

cn=<group-name>,ou=groups,dc=<okta-instance-id>,dc=okta,dc=com

Selecione o nível de acesso ao banco de dados a ser concedido aos usuários deste grupo.

Clique em Adicionar usuário.

2
Navegue até a página Avançado do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Clique em Avançado na barra lateral.

3
Alterne o botão próximo a Autorização LDAP para Ativado.
4
Verifique se os detalhes do servidor e as credenciais de ligação do seu servidor LDAP estão
corretas no painel Configurar seu servidor LDAP.
5
Insira um modelo de consulta em Modelo de Consulta.
Quando um usuário tenta realizar uma ação, o Atlas executa o
Modelo de consulta LDAP
para obter os grupos LDAP aos quais o usuário autenticado pertence. O Atlas permite a
ação se a consulta retornar pelo menos um grupo autorizado a executar a ação. O Atlas não
permitirá a ação se a consulta não retornar nenhum grupo autorizado a executar a ação.

O Atlas substitui o nome de usuário autenticado no espaço reservado {USER} ao executar a


consulta. A consulta é relativa ao host especificado em Nome do host do servidor.

A formatação da consulta deve estar de acordo com


RFC4515

Se quiser identificar de qual grupo um usuário é membro, você pode usar o seguinte modelo
de consulta:

ou=grupos,dc=<okta-instance-id>,dc=okta,dc=com?dn?sub?(&(objectClass=groupofUnique
Names)(uniqueMember={USER}))

OBSERVAÇÃO
Outros modelos de consulta também podem funcionar. Usar o modelo padrão
{USER}?memberOf?base pode resultar em tempos de pesquisa mais longos.

6
Clique em Verificar e Salvar.
Aguarde até que o Atlas implante suas alterações. O Atlas verifica se seus clusters podem
se conectar, autenticar e consultar seu servidor LDAP usando os detalhes de configuração
que você fornece.

Conecte-se ao seu cluster usando mongosh


O procedimento a seguir verifica se a autenticação LDAP (e a autorização LDAP, se
ativada) está configurada corretamente:

OBSERVAÇÃO
Quando a autenticação LDAP está habilitada, os usuários do banco de dados devem
substituir os seguintes parâmetros na cadeia de conexão de seus clientes:

authSource deve ser $externo

O mecanismo de autenticação deve ser PLAIN

1
Conecte-se ao seu cluster com as credenciais de usuário que você adicionou ao Atlas.
Usar mangusto para se conectar ao seu cluster. Para copiar a string de conexão:

Clique em Banco de dados no canto superior esquerdo do Atlas.

Clique em Conectar na página Implantações de banco de dados.

Clique em LDAP e em Copiar.

Cole e edite a string com seu DN de usuário e senha.

OBSERVAÇÃO
Conecte-se ao seu cluster com o DN completo de um usuário se o mapeamento de usuário
para DN não estiver habilitado.

2
Depois de se conectar ao cluster, execute comandos para verificar se o usuário tem os
privilégios de leitura ou gravação que você atribuiu a ele.
Solucionar problemas de conexão LDAP
OBSERVAÇÃO
No Okta, o usuário bind deve ter privilégios de administrador somente leitura para realizar
pesquisas LDAP.
Certifique-se de que seu usuário de ligação tenha esses privilégios
antes de executar o ldapsearch.

Use ldapsearch para determinar se o modelo de consulta que você configurou para o Atlas
retornar DNs de usuário da maneira esperada. O modelo de consulta pode não retornar os
DNs de usuário corretos se a autenticação LDAP funcionar, mas a autorização LDAP não.

Use o seguinte modelo ldapsearch:

ldapsearch -H 'ldaps://<okta-instance-id>.ldap.okta.com' -D "<bind-user-dn>" -w


"<bind-user-pwd>" -b 'ou=groups,dc=<okta-instance-id>,dc=okta,dc=com'
'(&(objectClass=groupofUniqueNames)(uniqueMember=<bind-user-dn or group-dn>))

Por exemplo, se seu bind-user-dn for


uid=jane@example.com,ou=users,dc=mdb-example,dc=okta,dc=com e seu
<okta-instance-id> for mdb-example, use o seguinte comando:

ldapsearch -H 'ldaps://mdb-example.ldap.okta.com' -D
"uid=jane@example.com,dc=mdb-example,dc=okta,dc=com" -w "REDACTED" -b
'ou=groups,dc=mdb-example,dc=okta,dc=com'
'(&(objectClass=groupofUniqueNames)(uniqueMember=uid=jane@example.com,ou=
users,dc=mdb-example,dc=okta,dc=com))'
OBSERVAÇÃO
Outros modelos de consulta também podem funcionar. Usar o modelo padrão
{USER}?memberOf?base pode resultar em tempos de pesquisa mais longos.
Configurar a autenticação federada do
PingOne
Nesta página

Acesso obrigatório
Pré-requisitos
Procedimentos
Configure o PingOne como um provedor de identidade
(Opcional) Mapear uma organização
(Opcional) Configurar opções avançadas de autenticação federada
Faça login no Atlas usando seu URL de login
Este guia mostra como configurar a autenticação federada usando PingOne como seu IdP.

Após integrar o PingOne e o Atlas, você poderá usar as credenciais da sua empresa para
fazer login no Atlas e em outros serviços em nuvem do MongoDB.

Acesso obrigatório
Para gerenciar a autenticação federada, você deve ter acesso de Proprietário da
Organização a uma ou mais organizações que estão delegando configurações de federação
à instância.

Pré-requisitos
Para usar o PingOne como IdP para Atlas, você deve ter:

Uma assinatura PingOne. Para obter uma assinatura, visite


PingOne.

Um usuário PingOne com privilégios administrativos. Para conceder privilégios


administrativos a um usuário, consulte
Gerenciando administradores
. Alternativamente, você pode usar o usuário administrativo padrão criado na ativação de
sua conta PingOne.

Procedimentos
Configure o PingOne como um provedor de identidade
Use o console administrativo do PingOne para configurar o PingOne como um IdP SAML.

1
Baixe seu certificado de origem PingOne.
1
Na sua conta PingOne, faça login no ambiente Administrador.

2
Na barra de navegação superior, clique em Configuração.

3
Na barra de navegação secundária, clique em Certificados. Um Certificado de Originação
de Conta PingOne com uma data de expiração é exibido.

4
Clique na seta de expansão à direita da data de validade e clique em Download.

2
Configure o aplicativo SAML.
1
Na barra de navegação superior, clique em Aplicativos.

2
Na guia Meus Aplicativos, clique no menu suspenso Adicionar Aplicativo e selecione Novo
Aplicativo SAML.

3
Insira um nome para identificar o aplicativo, como "MongoDB Atlas", no campo Nome do
Aplicativo.

4
Insira uma descrição do aplicativo no campo Descrição do Aplicativo.

5
Selecione uma categoria para o aplicativo no menu suspenso Categoria.

6
Clique em Continuar para a próxima etapa.

3
Abra o Console de gerenciamento de federação.
1
Faça login no Atlas.

2
Use o menu suspenso na parte superior esquerda do Atlas para selecionar a organização
para a qual você deseja gerenciar as configurações de federação.

3
Clique em Configurações no painel de navegação esquerdo.

4
Em Configurações de autenticação federada, clique em Abrir aplicativo de gerenciamento
de federação.

4
Forneça credenciais PingOne ao Atlas.
1
Clique em Provedores de identidade no painel esquerdo. Se você já configurou um IdP,
clique em Adicionar provedor de identidade no canto superior direito da página e clique em
Configurar provedor de identidade. Se você ainda não configurou um IdP, clique em
Configurar provedor de identidade.

2
Na tela Configurar provedor de identidade, insira as seguintes informações:

Campo
Valor
Nome da configuração
Etiqueta descritiva que identifica a configuração
URI do emissor
Preencha com valores de espaço reservado
URL de login único
Preencha com valores de espaço reservado
Certificado de Assinatura do Provedor de Identidade
Certificado que você recebeu da PingOne em uma etapa anterior
Solicitar vinculação
POSTAGEM HTTP
Algoritmo de Assinatura de Resposta
SHA-256
3
Clique no botão Avançar para ver os valores da configuração do PingOne.

5
Na página de configuração do PingOne, clique em Tenho a configuração SAML na parte
superior e insira os valores do Atlas FMC.

Campo
Valor
Certificado de Assinatura
Certificado que você recebeu da PingOne em uma etapa anterior
Versão do protocolo
SAML v2.0
Afirmação de Atendimento ao Consumidor
O URL do Assertion Consumer Service do Atlas FMC
ID da entidade
O URI de público do Atlas FMC
URL do aplicativo
Deixe em branco
Ponto final de logout único
Deixe em branco
Ponto final de resposta de logout único
Deixe em branco
Tipo de associação de logout único
Deixe em branco
Certificado de Verificação Primária
Não selecione um certificado.
Criptografar afirmação
Desmarcado
Assinatura
Afirmação de Assinatura
Algoritmo de assinatura
RSA_SHA256
Forçar reautenticação
Desmarcado
6
Na configuração do PingOne, clique em Continuar para a próxima etapa.

7
Adicione atributos do aplicativo.
1
Para cada atributo, clique em Adicionar novo atributo.

2
Forneça os seguintes valores para os atributos do aplicativo:

Atributo do aplicativo
Atributo do Identity Bridge ou valor literal
Como literal
SAML_SUBJECT
E-mail
Desmarcado
primeiro nome
Primeiro nome
Desmarcado
sobrenome
Sobrenome
Desmarcado
3
Para cada atributo, clique em Avançado.
4
Adicione o seguinte formato de ID de nome:
urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.

5
Clique em Continuar para a próxima etapa.
8
Adicione os grupos de usuários para os quais deseja ativar a autenticação federada e clique
em Continuar para a próxima etapa.

9
Na página Revisar Configuração, observe os valores de Emissor e idpid para uso em uma
etapa posterior.
10
No Atlas FMC, clique em Concluir. Na tela Provedores de identidade, clique em Modificar
para o provedor PingOne criado anteriormente.

11
Substitua os valores de espaço reservado atribuídos anteriormente pelos seguintes valores:

Campo
Valor
URI do emissor
Valor do emissor que você anotou anteriormente.
URL de login único
URL que se conecta ao Single Sign-On:
https://sso.connect.pingidentity.com/sso/idp/SSO.saml2?idpid=<IDP_ID> onde <IDP_ID> é o
valor idpid que você anotou anteriormente.
12
Clique em Avançar e depois clique em Concluir.
13
Na página de configuração do PingOne, clique em Concluir.

Mapeie seu domínio


Mapear seu domínio para o IdP permite que o Atlas saiba que os usuários do seu domínio
devem ser direcionados para o URL de login da configuração do seu provedor de
identidade.

Quando os usuários visitam a página de login do Atlas, eles inserem seu endereço de
e-mail. Se o domínio de e-mail estiver associado a um IdP, eles serão enviados para o URL
de login desse IdP.

IMPORTANTE
Você pode mapear um único domínio para vários provedores de identidade. Se você fizer
isso, os usuários que fizerem login usando o console do MongoDB Cloud serão
automaticamente redirecionados para o primeiro IdP correspondente mapeado para o
domínio.

Para fazer login usando um provedor de identidade alternativo, os usuários devem:

Inicie o login do MongoDB Cloud por meio do IdP desejado ou

Faça login usando o URL de login associado ao IdP desejado.

Use o Federation Management Console para mapear seu domínio para o IdP:

1
Abra o FMC.

1
Faça login no Atlas e use o menu suspenso no canto superior esquerdo para selecionar a
organização para a qual deseja gerenciar as configurações de federação.

2
Clique em Configurações no painel de navegação esquerdo.

3
Em Gerenciar configurações de federação, clique em Visitar aplicativo de gerenciamento de
federação.

2
Insira informações de mapeamento de domínio.

1
Clique em Adicionar um domínio.

2
Na tela Domínios, clique em Adicionar Domínio.

3
Insira as seguintes informações para o mapeamento do seu domínio:

Campo
Descrição
Nome de exibição
Etiqueta para identificar facilmente o domínio.
Nome do domínio
Nome do domínio
mapear.
4
Clique em Avançar.

3
Escolha o seu método de verificação de domínio.

OBSERVAÇÃO
Você pode escolher o método de verificação uma vez. Não pode ser modificado. Para
selecionar um método de verificação diferente, exclua e recrie o mapeamento de domínio.

Selecione a guia apropriada dependendo se você está verificando seu domínio enviando um
arquivo HTML ou criando um registro DNS TXT:

Carregar arquivo HTML

Criar registro DNS


Faça upload de um arquivo HTML contendo uma chave de verificação para verificar se você
é o proprietário do seu domínio.
1
Clique em Carregar arquivo HTML.

2
Clique em Avançar.

3
Baixe o arquivo mongodb-site-verification.html fornecido pelo Atlas.

4
Carregue o arquivo HTML em um site do seu domínio. Você deve conseguir acessar o
arquivo em <https://host.domain>/mongodb-site-verification.html.

5
Clique em Concluir.

4
Verifique seu domínio.

A tela Domínios exibe domínios não verificados e verificados que você mapeou para seu
IdP. Para verificar seu domínio, clique no botão Verificar do domínio de destino. Atlas mostra
se a verificação foi bem-sucedida em um banner na parte superior da tela.

Associe seu domínio ao seu provedor de identidade


Depois de verificar seu domínio com sucesso, use o Federation Management Console para
associar o domínio ao PingOne:

1
Clique em Provedores de identidade na navegação esquerda.

2
Para o IdP que você deseja associar ao seu domínio, clique em Editar ao lado de Domínios
Associados.

3
Selecione o domínio que deseja associar ao IdP.

4
Clique em Confirmar.

Teste seu mapeamento de domínio


IMPORTANTE
Antes de começar a testar, copie e salve o URL do modo Ignorar SAML para seu IdP. Use
esta URL para ignorar a autenticação federada caso você não tenha acesso à sua
organização Atlas.
Durante o teste, mantenha sua sessão conectada ao Console de gerenciamento de
federação para garantir ainda mais proteção contra bloqueios.

Para saber mais sobre o modo Ignorar SAML, consulte Ignorar modo SAML.

Use o Federation Management Console para testar a integração entre seu domínio e o
PingOne:

1
Em uma janela privada do navegador, navegue até a página de login do Atlas.

2
Insira um nome de usuário (geralmente um endereço de e-mail) com seu domínio verificado.

EXEMPLO
Se o seu domínio verificado for mongodb.com, use um endereço de e-mail no formato
username@mongodb.com.

3
Clique em Avançar. Se você mapeou seu domínio corretamente, você será redirecionado ao
seu IdP para autenticação. Após a autenticação bem-sucedida, você será redirecionado de
volta ao Atlas.

OBSERVAÇÃO
Você pode ignorar a página de login do Atlas navegando diretamente para o URL de login
do seu IdP.

(Opcional) Mapear uma organização


Use o Federation Management Console para atribuir aos usuários do seu domínio acesso a
organizações específicas do Atlas:

1
Abra o Console de gerenciamento de federação.
Faça login no Atlas.

Use o menu suspenso na parte superior esquerda do Atlas para selecionar a organização
para a qual você deseja gerenciar as configurações de federação.

Clique em Configurações no painel de navegação esquerdo.

Em Gerenciar configurações de federação, clique em Visitar aplicativo de gerenciamento de


federação.

2
Conecte uma organização ao Aplicativo da Federação.
Clique em Exibir organizações.

O Atlas exibe todas as organizações das quais você é proprietário da organização.


As organizações que ainda não estão conectadas ao Aplicativo da Federação possuem o
botão Conectar na coluna Ações.

Clique no botão Conectar da organização desejada.

3
Aplique um provedor de identidade à organização.
Na tela Organizações no console de gerenciamento:

Clique no nome da organização que você deseja mapear para um IdP.

Na tela Provedor de Identidade, clique em Aplicar Provedor de Identidade.

O Atlas direciona você para a tela Provedores de Identidade, que mostra todos os IdPs
vinculados ao Atlas.

Para o IdP que você deseja aplicar à organização, clique em Adicionar organizações.No
modal Aplicar provedor de identidade a organizações, selecione as organizações às quais
este IdP se aplica.

Clique em Confirmar.

4
Conecte uma organização ao Aplicativo da Federação.
Clique em Organizações na navegação esquerda.

Na lista de Organizações, certifique-se de que as organizações desejadas agora tenham o


Provedor de Identidade esperado.

(Opcional) Configurar opções avançadas de autenticação federada


Você pode configurar as seguintes opções avançadas para autenticação federada para
obter maior controle sobre seus usuários federados e fluxo de autenticação:

Ignorar modo SAML

OBSERVAÇÃO
As seguintes opções avançadas para autenticação federada exigem que você
mapear uma organização.

Atribuir uma função de usuário padrão para uma organização

Restringir o acesso a uma organização por domínio

Restringir a adesão de usuários à Federação

Faça login no Atlas usando seu URL de login


Todos os usuários atribuídos ao aplicativo PingOne podem fazer login no Atlas usando suas
credenciais PingOne na URL de login. Os usuários têm acesso às organizações mapeadas
para seu IdP.

IMPORTANTE
Você pode mapear um único domínio para vários provedores de identidade. Se você fizer
isso, os usuários que fizerem login usando o console do MongoDB Cloud serão
automaticamente redirecionados para o primeiro IdP correspondente mapeado para o
domínio.

Para fazer login usando um provedor de identidade alternativo, os usuários devem:

Inicie o login do MongoDB Cloud por meio do IdP desejado ou

Faça login usando o URL de login associado ao IdP desejado.

Se você selecionar uma função de organização padrão, os novos usuários que fizerem login
no Atlas usando o URL de login terão a função que você especificar.
Opções avançadas para autenticação federada
Nesta página

Acesso obrigatório
Console de gerenciamento de federação
Atribuir uma função de usuário padrão para uma organização
Restringir o acesso a uma organização por domínio
Ignorar modo SAML
Faça login após ativar o modo Ignorar SAML
Restringir a adesão de usuários à Federação
Você pode configurar opções avançadas em sua instância de Autenticação Federada para
obter maior controle sobre seus usuários federados e fluxo de autenticação.

Acesso obrigatório
Para gerenciar a autenticação federada, você deve ter acesso de Proprietário da
Organização a uma ou mais organizações que estão delegando configurações de federação
à instância.

Console de gerenciamento de federação


Você pode gerenciar a autenticação federada no Federation Management Console.

Para abrir o Console de gerenciamento de federação:

Faça login no Atlas.

Use o menu suspenso na parte superior esquerda do Atlas para selecionar a organização
para a qual você deseja gerenciar as configurações de federação.

Clique em Configurações no painel de navegação esquerdo.

Em Gerenciar configurações de federação, clique em Visitar aplicativo de gerenciamento de


federação.

Atribuir uma função de usuário padrão para uma organização


Você pode configurar o Atlas para provisionar automaticamente cada usuário autenticado
por meio do IdP com uma função padrão em uma organização mapeada. Você pode
selecionar funções diferentes para organizações diferentes.

OBSERVAÇÃO
A função selecionada só se aplica a usuários autenticados por meio do IdP se eles ainda
não tiverem uma função na organização.

1
Clique em Organizações no painel de navegação esquerdo.
2
Clique no nome da organização para a qual você deseja atribuir permissões padrão.
3
No menu suspenso Função de usuário padrão, selecione a função desejada.
Para remover uma função de usuário padrão, clique em ao lado do menu suspenso.

Restringir o acesso a uma organização por domínio


Você pode especificar uma lista de domínios aprovados para impedir que usuários fora
desses domínios acessem sua organização. Use esta lista para definir uma lista de
domínios aprovados para sua organização sem precisar mapear diretamente esses
domínios para seu IdP.

IMPORTANTE
Considerações
Depois de ativar a opção Restringir acesso por domínio:

Você só pode convidar novos usuários para ingressar na sua organização cujos endereços
de e-mail estejam na lista de domínios aprovados.

Os usuários que já estão na sua organização e cujos nomes de usuário não contêm um
domínio na lista aprovada não têm acesso restrito à sua organização.

Quaisquer domínios mapeados para o seu IdP são automaticamente adicionados à lista
aprovada.

No Console de gerenciamento de federação:

1
Clique em Organizações no painel de navegação esquerdo.
2
Clique no nome da organização para a qual você deseja restringir o acesso.
3
Nas configurações avançadas, alterne Restringir acesso por domínio para Ativado.
Quando você habilita essa configuração, o Atlas adiciona automaticamente todos os
domínios mapeados para um IdP à lista de Domínios Aprovados.

4
Adicione domínios à lista aprovada.
Para adicionar domínios à lista aprovada, você pode:

Clique em Adicionar domínios de membros existentes. O Atlas abre um modal contendo


domínios de endereços de e-mail de usuários existentes em sua organização. Use esta lista
para permitir facilmente o acesso de usuários que já fazem parte da sua organização.

Use as caixas de seleção para selecionar os domínios desejados e clique em Adicionar


para adicioná-los à lista de aprovados.

Clique em Adicionar domínios. Atlas abre um modal onde você pode adicionar
manualmente domínios à lista aprovada.
Insira o domínio que deseja aprovar na caixa de entrada e clique em Adicionar. Repita esse
processo para cada domínio que deseja aprovar.

OBSERVAÇÃO
Se você tem
associação de usuário restrita à sua federação
, o Atlas avisa se você adicionar um domínio que está sendo usado para acessar
organizações fora da sua federação.

Depois de adicionar todos os domínios desejados, clique em Enviar.

Ignorar modo SAML


Ignorar o modo SAML fornece um URL de login que ignora sua autenticação federada e, em
vez disso, permite que você se autentique com suas credenciais do Atlas.

Se as configurações de autenticação federada não estiverem configuradas corretamente,


talvez você não consiga fazer login no Atlas por meio do seu IdP. O URL do modo Ignorar
SAML ajuda a evitar que você fique bloqueado na sua organização Atlas. Ao configurar e
testar seu IdP, recomendamos que você anote o URL do modo Ignorar SAML para garantir
que você possa fazer login no Atlas e definir corretamente suas configurações de
autenticação federada.

Cada URL do modo Bypass SAML está associado a um IdP individual e corresponde ao
URL de login do IdP.

O modo Ignorar SAML está ativado por padrão, mas você pode querer desativá-lo como
medida de segurança quando tiver certeza de que configurou corretamente sua
autenticação federada.

Para definir o modo Ignorar SAML, no Console de gerenciamento de federação:

1
Clique em Provedores de Identidade no painel de navegação esquerdo.
2
Localize o IdP para o qual você deseja visualizar/modificar a configuração Ignorar modo
SAML.
3
Alterne o modo Ignorar SAML conforme desejado.
4
Se você estiver desabilitando Ignorar modo SAML, clique em Desabilitar na caixa de diálogo
de confirmação.
Faça login após ativar o modo Ignorar SAML
Depois de ativar o modo Ignorar SAML, você deverá fazer login no Atlas usando:

O URL do modo Ignorar SAML para o seu IdP.

Um nome de usuário que:


Contém o domínio que você mapeou para seu IdP.

Você costumava entrar no Atlas ou Cloud Manager antes de configurar a Autenticação


Federada.

Restringir a adesão de usuários à Federação


Você pode impedir que usuários em sua instância de Autenticação Federada criem novas
organizações ou usem suas credenciais para acessar organizações fora da federação.
Defina essa configuração para ter controle total dos usuários federados e ajudar a garantir
que os usuários federados tenham acesso apenas às organizações desejadas do Atlas.

IMPORTANTE
Essa configuração se aplica a toda a federação, incluindo todos os provedores de
identidade e organizações da federação.

Considerações
Depois de ativar esta configuração:

Nenhum usuário na sua instância de Autenticação Federada pode obter acesso a


organizações fora da sua federação.

Da mesma forma, nenhum usuário federado pode aceitar ou receber convites para
ingressar em organizações fora da sua federação.

Os usuários da sua federação com a função de Proprietário da Organização ainda poderão


criar novas organizações. Estas novas organizações são automaticamente conectadas à
sua federação.

Os usuários na sua federação sem a função de Proprietário da Organização não podem


criar novas organizações.

Os usuários da sua federação mantêm acesso a todas as organizações às quais tinham


acesso antes da restrição de associação.

Procedimento
No Console de gerenciamento de federação:

1
Clique em Configurações avançadas no painel de navegação esquerdo.
2
Ative Restringir associação.
3
Ver conflitos de usuário
Se a sua federação contiver usuários que pertencem a organizações fora da sua federação,
o Atlas exibirá um banner de aviso. Para revisar os usuários conflitantes, clique em Exibir
conflitos de usuários.
O Atlas exibe um modal com uma lista de usuários que entram em conflito com a restrição
da federação. Considere entrar em contato com esses usuários para informá-los sobre a
restrição.
Gerencie suas opções de autenticação
multifator
Nesta página

Considerações
Acesso obrigatório
Pré-requisitos
Habilitar autenticação multifator
Remover um método de autenticação
A autenticação verifica a identidade de um usuário. O processo usa algo que você tem ou
algo que você conhece. Você sabe sua senha. Você tem um aplicativo que fornece um
token único. A autenticação multifator (MFA) usa ambos.

Considerações
Ao habilitar a MFA, o Atlas solicita duas formas de identificação: sua senha e um dos
seguintes fatores:

Okta verificar aplicativo móvel

WebAuthn

Autenticador Google

E-mail

SMS

Configurar métodos de autenticação multifator de backup


AVISO
Ative no mínimo dois métodos para que você ainda possa acessar sua conta caso perca o
acesso a um método.

Embora você possa configurar um, alguns ou todos os métodos disponíveis, recomendamos
fortemente que você configure pelo menos dois métodos. Quando o Atlas exige MFA, ele
oferece a escolha de qual método usar. Se você tiver menos de dois métodos configurados,
o Atlas solicitará que você configure o MFA e um método de backup no login.

Acesso obrigatório
Para usar a MFA, o proprietário da organização deve habilitá-la para sua organização.
Todos os membros dessa organização devem habilitar a MFA para suas contas. Os
membros que não habilitaram a MFA não podem acessar a organização.

Pré-requisitos
Instale e configure vários fatores de autenticação.
Okta verificar aplicativo móvel

Chave de segurança/biométrica

Aplicativo autenticador

E-mail

SMS
Baixe o aplicativo Okta Verify para o seu
iOS
ou
Android
dispositivo.

Habilitar autenticação multifator


1
Navegue até a página Segurança da conta.
Clique no seu nome no canto superior direito do console do Atlas. Um menu suspenso é
exibido.

Clique em Gerenciar sua conta MongoDB.

Clique em Segurança na navegação do lado esquerdo.

2
Configure um método de autenticação.
Escolha seu método de autenticação preferido.

Clique em Configurar à direita do método escolhido.

Siga o procedimento para o método escolhido:

Okta verificar aplicativo móvel

Chave de segurança/biométrica

Aplicativo autenticador

E-mail

SMS
Conclua estas etapas usando o aplicativo móvel Okta Verify.

Abra o aplicativo Okta Verify em seu dispositivo móvel.


Toque no ícone + para adicionar uma conta. O aplicativo coloca este ícone na barra de
menu do aplicativo, na parte superior da tela.

Digitalize o código de barras exibido no Atlas.

Clique em Concluído.

3
Escolha outro método de autenticação.
Depois de configurar seu primeiro método de autenticação, repita as etapas para configurar
outro método.

Remover um método de autenticação


Para remover um método da sua conta:

Escolha um método para remover.

Clique em Excluir à direita desse método.

Para remover um método, o Atlas solicita que você se autentique novamente usando MFA.
Autenticação legada de dois fatores
Nesta página

Redefinir a autenticação herdada de dois fatores


IMPORTANTE
O 2FA legado está obsoleto. Se você atualmente tem o 2FA herdado habilitado, você pode
continuar a usá-lo, mas é recomendado que você mude para a autenticação multifator.

Se um proprietário da organização ativar a MFA, todos os membros da organização também


deverão ativar a MFA antes de acessar essa organização.

O Legacy 2FA fornece uma segunda camada de segurança para sua conta Atlas. Se você
tiver 2FA habilitado para sua conta, depois de inserir seu nome de usuário e senha, será
solicitado um código de verificação urgente de seis dígitos. Esse código é enviado para um
dispositivo separado, como um telefone celular ou token de segurança, que você pode ler e
inserir no Atlas e concluir seu login.

OBSERVAÇÃO
Um proprietário da organização Atlas pode exigir que todos os usuários do Atlas em sua
organização habilitem a MFA para suas contas Atlas. Para saber mais, consulte Exigir
autenticação multifator.

Se você fizer login usando sua conta do Google:

O Google gerencia seu 2FA. Você não pode usar a autenticação multifator do Atlas e não
será solicitada uma verificação Atlas 2FA ao fazer login no Atlas. O Google deve verificar
sua identidade usando
Verificação em duas etapas do Google.

Para saber mais sobre as configurações da organização, consulte Alterar configurações da


organização.

Atlas inclui as seguintes fontes para códigos de verificação 2FA:

Texto ou voz

Aplicativo 2FA

Dispositivo 2FA
Mensagens de texto (SMS)

Quando o Atlas solicita um código de verificação, o Atlas envia o código de verificação de 6


dígitos por texto (SMS) para o número de telefone fornecido.

Aplicam-se as tarifas de SMS da operadora de celular.


Chamadas de voz automatizadas

Quando o Atlas solicita um código de verificação, o Atlas liga para o número de telefone
fornecido. Um sistema automatizado repete o código de verificação de 6 dígitos três vezes
no total antes de desligar.

Aplicam-se as tarifas de chamadas de voz da operadora de celular.

IMPORTANTE
O Voice funciona apenas nos EUA/Canadá.
OBSERVAÇÃO
Os usuários do Atlas que operam em uma região geográfica com cobertura ou
confiabilidade limitada do serviço celular podem encontrar atrasos no recebimento do
código 2FA via SMS ou voz. Considere usar um aplicativo ou dispositivo 2FA.

Redefinir a autenticação herdada de dois fatores


Como o 2FA legado está obsoleto, se você tiver o 2FA legado ativado e perder o acesso ao
seu dispositivo 2FA, deverá configurar a autenticação multifator para substituir o 2FA.
Autorização da IU do Atlas
Nesta página

Funções de usuário do Atlas


Organizações
Projetos
Convites
Acesso Programático
Você pode gerenciar o acesso às implantações de banco de dados Atlas com funções de
usuário Atlas. Você pode aplicar essas permissões somente no nível da organização ou do
projeto. Portanto, planeje cuidadosamente a hierarquia de suas organizações e projetos.

Funções de usuário do Atlas


As funções de usuário do Atlas definem as ações que os usuários do Atlas podem realizar
em organizações, projetos ou ambos. Os proprietários de organizações e projetos podem
gerenciar usuários do Atlas e suas funções em suas respectivas organizações e projetos.
Para saber mais, consulte Funções de usuário do Atlas.

Organizações
Uma organização pode conter vários projetos (anteriormente chamados de grupos). Sob
esta estrutura hierárquica:

O faturamento acontece no nível da organização, preservando a visibilidade do uso em


cada projeto.

Você pode visualizar todos os projetos de uma organização.

Você pode usar equipes para atribuir usuários da organização em massa a projetos dentro
da organização.

Para saber mais, consulte Gerenciar o acesso à organização.

Projetos
Você pode criar vários projetos em uma organização.

Ao ter vários projetos em uma organização, você pode:

Isole ambientes diferentes (por exemplo, ambientes de desenvolvimento/qa/produção) uns


dos outros.

Associe diferentes usuários ou equipes a diferentes ambientes ou conceda diferentes


permissões a usuários em diferentes ambientes.

Mantenha configurações de segurança de cluster separadas. Por exemplo:


Crie/gerencie diferentes conjuntos de credenciais de usuário de banco de dados para cada
projeto.

Isole redes em diferentes VPCs.

Crie diferentes configurações de alerta. Por exemplo, configure alertas para ambientes de
produção de forma diferente dos ambientes de desenvolvimento.

Para saber mais, consulte Gerenciar o acesso ao projeto.

Convites
A guia Convites permite visualizar e aceitar convites pendentes para organizações e
projetos do Atlas. Para saber mais, consulte Convites para organizações e projetos.

IMPORTANTE
Suspensão de uso do convite do projeto
O lançamento do Atlas em 13 de setembro de 2023 descontinua convites de projetos.

Quando você convida um membro da organização para projetos dentro da organização, o


usuário recebe automaticamente acesso a esses projetos e não recebe nenhum convite.
Quando você convida um usuário para projetos em uma organização à qual o usuário não
pertence, o usuário recebe um único convite para a organização, que inclui acesso a todos
os projetos aos quais você concede acesso. Os convites expiram após 30 dias.

Acesso Programático
Para conceder acesso programático a uma organização ou projeto usando apenas a API,
você pode criar uma chave de API para a API Atlas Administration. Para saber mais,
consulte Conceder acesso programático ao Atlas.
Funções de usuário do Atlas
Nesta página

Funções da organização
Funções do projeto
As funções de usuário do Atlas definem as ações que os usuários do Atlas podem realizar
em organizações, projetos ou ambos. Os proprietários de organizações e projetos podem
gerenciar usuários do Atlas e suas funções em suas respectivas organizações e projetos.

Você pode aplicar essas permissões somente no nível da organização ou no nível do


projeto. Portanto, você deve planejar cuidadosamente a hierarquia de suas organizações e
projetos. Para saber mais, consulte Gerenciamento de implantação de banco de dados.

Funções da organização
Função da organização (IU)
Função da organização (API)
Descrição
Proprietário da organização
ORG_OWNER
Concede acesso root à organização, incluindo:

Dono do projeto
acesso a todos os projetos da organização, o que concede acesso ao banco de dados,
mesmo se adicionado a um projeto com função de não Proprietário.

Privilégios para administrar configurações da organização.

Privilégios para adicionar, modificar ou excluir usuários do Atlas e usuários de banco de


dados na organização.

Privilégios para excluir a organização.

Privilégios para adicionar, modificar ou excluir tags de recursos.

Todos os privilégios concedidos pelas outras funções da organização combinadas.

Criador de projetos de organização


ORG_GROUP_CREATOR
Concede o seguinte acesso:

Privilégios para criar projetos na organização.

Privilégios concedidos pelo


Membro da Organização
papel.

Administrador de faturamento da organização


ORG_BILLING_ADMIN
Concede o seguinte acesso:

Privilégios para administrar informações de cobrança da organização.

Privilégios concedidos pelo


Membro da Organização
papel.

Privilégios para criar, editar, excluir, confirmar e cancelar alertas de cobrança.

Visualizador de faturamento da organização


ORG_BILLING_READ_ONLY
Concede o seguinte acesso:

Privilégios para visualizar informações de cobrança da organização.

Privilégios concedidos pelo


Membro da Organização
papel.

Organização somente leitura


ORG_READ_ONLY
Fornece acesso somente leitura às configurações, usuários e projetos na organização.
Membro da Organização
ORG_MEMBER
Fornece acesso somente leitura às configurações e aos usuários da organização e aos
projetos aos quais eles pertencem.

Diferente
Organização somente leitura
, um
Membro da Organização
só pode acessar projetos aos quais foram explicitamente adicionados.

Para um
Membro da Organização
, dentro de um projeto, o usuário tem os privilégios determinados pelo usuário
função do projeto
. Se a função do projeto de um usuário for
Dono do projeto
, o usuário poderá adicionar um novo usuário ao projeto, o que resultará na adição também
do usuário recém-adicionado à organização (se o usuário recém-adicionado ainda não
estiver na organização).

Funções do projeto
As funções a seguir concedem privilégios em um projeto.

Função do projeto (IU)


Função do projeto (API)
Descrição
Dono do projeto
GROUP_OWNER
Concede privilégios para executar as seguintes ações:

Crie uma implantação de banco de dados.

Gerencie o acesso e as configurações do projeto.

Gerenciar entradas da lista de acesso IP.

Gerencie o acesso programático a um projeto.

Você pode conceder acesso de chaves de API a um projeto com uma organização ou uma
função de projeto. Se a sua chave tiver ambos os
Proprietário da organização
e
Dono do projeto
funções, ele poderá acessar todos os projetos da organização.

Gerencie o acesso ao banco de dados para implantações de banco de dados no projeto.

Recuperar logs de processo e auditoria para todos os clusters do projeto.

Gerencie backups e restaure dados em todos os clusters do projeto.

Inicie os gráficos do MongoDB.

Conecte ou desconecte fontes de dados de gráficos.

Crie aplicativos de serviços de aplicativos.

Adicione, modifique ou exclua tags de recursos.

Gerente de Cluster de Projetos


GROUP_CLUSTER_MANAGER
Um usuário com o
Gerente de Cluster de Projetos
A função pode executar as seguintes tarefas:

Concede acesso para editar, pausar e retomar clusters do Atlas.

Failover de teste.

O
Gerente de Cluster de Projetos
A função não permite que os usuários:
Crie implantações de banco de dados Atlas.

Acesse o Explorador de Dados.

Recuperar logs de processo e auditoria.

Administrador de acesso a dados do projeto


GROUP_DATA_ACCESS_ADMIN
Concede acesso ao Data Explorer. Esta função também concede privilégios de
Projeto somente leitura.

Permite que o usuário execute as seguintes ações do Data Explorer:

Visualize, crie e elimine bancos de dados, coleções e índices.

Apenas UI: visualize, modifique e exclua documentos. Você não pode ler ou gravar dados
usando a API de administração do Atlas.

Recuperar logs de processo e auditoria para todos os clusters do projeto.

Visualize os valores de campo de consulta de amostra no Performance Advisor.

Veja o desempenho da consulta no Query Profiler.

Veja o desempenho em tempo real no Painel de desempenho em tempo real.

Inicie os gráficos do MongoDB.

O
Administrador de acesso a dados do projeto
A função não concede privilégios para iniciar tarefas de backup ou restauração.

Leitura/gravação de acesso aos dados do projeto


GROUP_DATA_ACCESS_READ_WRITE
Concede acesso ao Data Explorer; especificamente, os privilégios para realizar o seguinte
por meio da UI do Atlas:

Visualize e crie bancos de dados e coleções.

Apenas UI: visualize, modifique e exclua documentos. Você não pode ler ou gravar dados
usando a API de administração do Atlas.

Veja índices.

Recuperar logs de processo e auditoria para todos os clusters do projeto.

Visualize os valores de campo de consulta de amostra no Performance Advisor.


Ver desempenho da consulta ce no Query Profiler.

Veja o desempenho em tempo real no Painel de desempenho em tempo real.

Inicie os gráficos do MongoDB.

Acesso aos dados do projeto somente leitura


GROUP_DATA_ACCESS_READ_ONLY
Concede acesso ao Data Explorer; especificamente, para executar as seguintes ações por
meio da UI do Atlas:

Visualize bancos de dados e coleções.

Somente UI: visualize documentos. Você não pode ler ou gravar dados usando a API de
administração do Atlas.

Veja índices.

Recuperar logs de processo e auditoria para todos os clusters do projeto.

Visualize os valores de campo de consulta de amostra no Performance Advisor.

Veja o desempenho da consulta no Query Profiler.

Veja o desempenho em tempo real no Painel de desempenho em tempo real.

Inicie os gráficos do MongoDB.

Projeto somente leitura


GROUP_READ_ONLY
Concede acesso somente visualização de metadados ao painel de controle do projeto para
todos os projetos da organização, incluindo: todas as atividades, dados operacionais,
usuários e funções de usuário. O usuário, entretanto, não pode acessar o Data Explorer ou
recuperar logs de processo e auditoria. O usuário pode visualizar gráficos de métricas de
implantação de banco de dados.

Concede acesso aos gráficos do MongoDB somente se for convidado para o projeto por um
Dono do projeto
. O usuário, porém, não pode acessar dados de Gráficos, a menos que o
Dono do projeto
também lhes concede
acesso à fonte de dados.

Editor de índice de pesquisa de projetos


GROUP_SEARCH_INDEX_EDITOR
Concede privilégios para executar as seguintes ações:
Crie um índice de pesquisa do Atlas.

Veja um índice de pesquisa do Atlas.

Edite um índice de pesquisa do Atlas.

Exclua um índice de pesquisa do Atlas.


Gerenciar o acesso da organização
Nesta página

Acesso obrigatório
Exigir autenticação multifator
Exigir lista de acesso IP para a API de administração do Atlas
Exigir lista de acesso IP para a UI do Atlas
Como proprietário da organização, você pode controlar o acesso à sua organização das
seguintes maneiras:

Exigir autenticação multifator

Exigir lista de acesso IP para a API de administração do Atlas

Exigir lista de acesso IP para a UI do Atlas

Acesso obrigatório
Para executar qualquer uma das ações a seguir, você deve ter acesso de proprietário da
organização ao Atlas.

Exigir autenticação multifator


Se você habilitar a autenticação multifator em sua própria conta Atlas, poderá exigir que
todos os usuários Atlas em sua organização habilitem a MFA para suas contas Atlas.

Procedimento
1
Navegue até a página Configurações da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique no ícone Configurações da organização próximo ao menu Organizações.

2
Alterne Exigir autenticação multifator (MFA) para Ativado.
Exigir lista de acesso IP para a API de administração do Atlas
Você pode configurar o Atlas para exigir listas de acesso de API no nível da organização.
Quando você habilita a lista de acesso IP para a API Atlas Administration, todas as
chamadas de API nessa organização devem ser originadas de uma entrada válida na lista
de acesso de chaves da API Atlas Administration associada. Consulte também endpoint de
listas de acesso de API.

Procedimento
1
Navegue até a página Configurações da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.
Clique no ícone Configurações da organização próximo ao menu Organizações.

2
Ative a opção Exigir lista de acesso IP para a API de administração do Atlas.
Exigir lista de acesso IP para a UI do Atlas
IMPORTANTE
Para ativar a configuração da lista de acesso IP para a UI do Atlas para suas organizações,
entre em contato
Suporte Atlas
.

Você pode configurar o Atlas para exigir listas de acesso da UI do Atlas no nível da
organização. Ao ativar a lista de acesso IP para a UI do Atlas, todo o acesso à UI do Atlas
nessa organização deve ser originado de uma entrada nessa lista.

Você pode:

Configurar e ativar a lista de acesso IP para a UI do Atlas

Editar lista de acesso IP para a UI do Atlas

Desativar lista de acesso IP para a interface do Atlas

Configurar e ativar a lista de acesso IP para a UI do Atlas


Para ativar a lista de acesso de endereços IP para uma organização, você deve adicionar
um intervalo CIDR que inclua seu próprio endereço IP ou seu próprio endereço IP à lista.
Depois de adicionar seu endereço IP ou adicionar um bloco CIDR que contenha esse
endereço, o Atlas ativa o botão Habilitar. Você pode então adicionar outros endereços IP e
intervalos CIDR, e intervalos CIDR, conforme necessário.

1
Navegue até a página Configurações da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique no ícone Configurações da organização próximo ao menu Organizações.

2
Configure a lista de acesso IP para a UI do Atlas.
Navegue para Definir lista de acesso IP para a interface do usuário do Atlas.

Clique em Configurar. A página Lista de acesso IP para a UI do Atlas é aberta, onde você
pode configurar, ativar e fazer alterações na lista de acesso IP da UI do Atlas para sua
organização.

3
Adicione endereços IP ou blocos CIDR à lista de IP da UI do Atlas.
Insira um endereço IP ou um bloco de intervalo CIDR na tabela.

Você pode:

Adicione endereços IPv4 ou IPv6, como 1.1.1.2, para IPv4, e


3ffe:1900:fe21:4545:0000:0000:0000:0000, para IPv6, ou intervalos de blocos CIDR, como
2.1.1.1/16, e seus descrições para a lista.

Clique para excluir um endereço ou intervalo inserido e inserir um novo.

O Atlas valida endereços IP e blocos CIDR inseridos e sinaliza as entradas inválidas.

Você não pode:

Exclua todos os endereços ou seu próprio endereço IP da lista. Se você tentar excluir esses
endereços, o Atlas impedirá que você salve as alterações.

Adicione endereços IP inválidos, como endereços malformados ou fora do intervalo para os


intervalos CIDR inseridos.

Adicione endereços duplicados. Você pode, no entanto, adicionar um intervalo CIDR que
tenha um endereço IP específico e também inserir o próprio endereço IP.

Edite endereços ou blocos CIDR na tabela. Para editar uma entrada, exclua-a e adicione
uma nova entrada.

Adicione uma descrição opcional.

Clique em Adicionar entrada para adicionar um endereço IP ou intervalo CIDR para


usuários em sua organização ou clique em Adicionar meu endereço IP atual.

A tabela da lista de acesso IP identifica seu endereço IP atual ou um intervalo CIDR que o
contém como seu e adiciona suas descrições, mesmo que você não tenha fornecido
descrições para essas entradas.

4
Habilite a lista de acesso IP para a UI do Atlas.
Para ativar o botão Ativar que ativa as restrições da lista de acesso IP, você, como
proprietário da organização, deve adicionar seu endereço IP atual ou um intervalo CIDR
com seu endereço IP atual à lista.

Se a lista estiver vazia ou se o Atlas detectar que a lista não contém seu endereço IP, o
Atlas desativará o botão Habilitar para evitar que você fique fora da organização.

Clique em Habilitar.

Atlas pede uma confirmação.


Clique em Ativar para confirmar ou em Cancelar para cancelar.

Depois de ativar a lista de acesso IP para a UI do Atlas, apenas os endereços IP e


intervalos definidos poderão acessar a UI do Atlas desta organização. Se o endereço IP de
um usuário não estiver na lista, o Atlas desabilitará (esmaecerá) todas as organizações com
acesso restrito para esse usuário em sua lista de organizações. Se esse usuário tentar
acessar uma página da UI do Atlas para qualquer organização restrita, o Atlas exibirá o
seguinte aviso:

Você não tem permissão para visualizar o <url-with-organizationID> no


IU do Atlas. Para obter acesso, peça ao proprietário da organização para adicionar seu
Endereço IP para a lista de acesso IP.

As chaves de API que herdam desta lista de acesso IP usam a lista para restrições de
acesso IP.

Editar lista de acesso IP para a UI do Atlas


Se você ativar a lista de acesso IP para a UI do Atlas, a lista de acesso de IP para o menu
da UI do Atlas na página Organização > Configurações muda de Configurar para as
seguintes opções: Editar e Desabilitar.

1
Configure a lista de acesso IP para a UI do Atlas.
Em Configurações da organização, navegue até Definir lista de acesso IP para a interface
do usuário do Atlas.

Clique em Configurar. A página Lista de acesso de IP para a UI do Atlas é aberta, onde


você pode fazer alterações na lista de acesso de IP da UI do Atlas para sua organização.

2
Edite endereços IP ou blocos CIDR na lista de acesso IP da UI do Atlas.
Clique em Editar. A tabela da lista de IPs é aberta, permitindo adicionar endereços IP ou
intervalos de blocos CIDR adicionais.

Você pode:

Adicione endereços IPv4 ou IPv6, como 1.1.1.2, para IPv4, e


3ffe:1900:fe21:4545:0000:0000:0000:0000, para IPv6, ou intervalos de blocos CIDR, como
2.1.1.1/16, e seus descrições para a lista.

Clique para excluir um endereço ou intervalo inserido e inserir um novo.

O Atlas valida endereços IP e blocos CIDR inseridos e sinaliza entradas inválidas.

Você não pode:

Exclua todos os endereços ou seu próprio endereço IP da lista. Se você tentar excluir esses
endereços, o Atlas impedirá que você salve as alterações.
Adicione endereços IP inválidos, como endereços malformados ou fora do intervalo para os
intervalos CIDR inseridos.

Adicione endereços duplicados. No entanto, você pode adicionar um intervalo CIDR que
contenha um endereço IP específico e também inserir o próprio endereço IP.

Edite endereços ou blocos CIDR na tabela. Para editar uma entrada, exclua-a e adicione
uma nova entrada.

Adicione uma descrição opcional.

Clique em Adicionar entrada para adicionar um endereço IP ou intervalo CIDR ou clique em


Adicionar meu endereço IP atual.

3
Salve a lista de acesso IP editada.
O Atlas desabilita o botão Salvar no canto superior direito se você excluir seu próprio
endereço IP ou um bloco CIDR com seu endereço IP da lista.

Para ativar o botão Salvar, adicione um bloco CIDR com seu endereço IP atual (ou seu
endereço IP) à lista, além de quaisquer outros endereços ou intervalos CIDR que você ou
outros proprietários da organização já tenham adicionado.

Clique em Salvar.

Atlas mostra uma mensagem de confirmação de que salvou as alterações com sucesso.

As chaves de API que herdam desta lista de acesso IP usam a lista para restrições de
acesso IP.

Desativar lista de acesso IP para a interface do Atlas


1
Clique em Definir lista de acesso IP para a interface do usuário do Atlas.
Em Configurações da organização, navegue até Definir lista de acesso IP para a interface
do usuário do Atlas.

2
Clique em Configurar.
A lista de acesso IP para a página Atlas UI é aberta. Se a lista foi habilitada anteriormente, a
UI do Atlas mostrará Habilitado próximo ao título da página.

3
Clique em Desabilitar.
Atlas pede que você confirme. Se você desabilitar a lista de acesso IP, o Atlas:

Desativa todas as restrições de IP para a UI do Atlas` para a organização.


Mantém a lista de acesso IP que você configurou anteriormente. As chaves de API que
herdam desta lista de acesso IP não usam mais a lista de restrições de acesso IP.

4
Confirme que deseja desabilitar a lista de acesso IP.
Clique em Desativar para confirmar.

A IU do Atlas mostra Desativado próximo ao título da página.


Gerenciar organizações
Nesta página

Crie uma organização


Ver organizações
Sair de uma organização
Renomear uma organização
Excluir uma organização
Na hierarquia de organizações e projetos, uma organização pode conter vários projetos
(anteriormente chamados de grupos). Sob esta estrutura:

O faturamento acontece no nível da organização, preservando a visibilidade do uso em


cada projeto.

Você pode visualizar todos os projetos de uma organização.

Você pode usar equipes para atribuir usuários da organização em massa a projetos dentro
da organização.

Se precisar expandir além dos limites do projeto existente, você poderá criar diversas
organizações.

Crie uma organização


Ao criar uma organização, você é adicionado como proprietário da organização.

1
Veja todas as suas organizações.
Expanda o menu Organizações na barra de navegação.

Clique em Exibir todas as organizações.

2
Clique em Nova organização.
3
Insira o nome da sua organização.
IMPORTANTE
Não inclua informações confidenciais no nome da sua organização.

4
Selecione Atlas e clique em Avançar.
Você tem a opção de adicionar uma nova organização do Cloud Manager ou uma nova
organização do Atlas. Para obter mais informações sobre o Cloud Manager, consulte o
documentação
.

5
Adicione membros.
Para usuários existentes do Atlas, insira seu nome de usuário. Normalmente, este é o
e-mail que a pessoa usou para se registrar.

Para novos usuários do Atlas, insira o endereço de e-mail para enviar um convite.

6
Especifique o acesso para os membros.
7
(Opcional) Desative o requisito de lista de acesso IP para a API de administração do Atlas.
Quando você cria uma nova organização com a UI do Atlas, o Atlas exige listas de acesso
IP para a API de administração do Atlas por padrão. Se você precisar de uma lista de
acesso IP, suas chaves de API de administração do Atlas poderão fazer solicitações de API
somente a partir dos endereços IP ou CIDR baseados em localização especificados na lista
de acesso IP.

Para desabilitar o requisito da lista de acesso IP e permitir que suas chaves da API de
administração do Atlas façam solicitações de qualquer endereço na Internet, alterne Exigir
lista de acesso de IP para a API de administração do Atlas para DESLIGADO.

Para saber mais, consulte Opcional: Exigir uma lista de acesso IP para a API de
administração do Atlas.

8
Clique em Criar organização.
Ver organizações

CLI do Atlas

IU do Atlas
Para listar todas as organizações que usam a CLI do Atlas, execute o seguinte comando:

atlas organizations list [options]

Para retornar os detalhes da organização especificada usando a CLI do Atlas, execute o


seguinte comando:

atlas organizations describe <ID> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
lista de organizações do atlas
e
organizações do atlas descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Sair de uma organização


IMPORTANTE
Para sair de uma organização, pelo menos outro usuário deve existir como Proprietário da
organização.

1
Veja todas as suas organizações.
Expanda o menu Organizações na barra de navegação.

Clique em Exibir todas as organizações.

2
Deixe a organização.
Para a organização da qual você deseja sair, clique no botão Sair para abrir a caixa de
diálogo Sair da Organização.

3
Clique em Sair da organização na caixa de diálogo Sair da organização.
Renomear uma organização
Você deve ter a função de Proprietário da Organização para que uma organização possa
renomeá-la.

1
Navegue até a página Configurações da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique no ícone Configurações da organização próximo ao menu Organizações.

2
Clique ao lado do nome da organização.
3
Insira o novo nome da organização.
4
Clique em Salvar.
Excluir uma organização
IMPORTANTE
Para excluir uma organização, você deve ter a função de Proprietário da organização para a
organização.
Não é possível excluir uma organização que tenha projetos ativos. Você deve excluir os
projetos da organização antes de excluí-la.

Não é possível excluir uma organização com pagamentos pendentes. Para saber mais,
consulte Solução de problemas de faturas e pagamentos.

Se você tiver uma política de conformidade de backup habilitada, não poderá excluir um
projeto se existir algum snapshot. Se não for possível remover todos os projetos, você não
poderá
exclua a organização.

CLI do Atlas

IU do Atlas
Para excluir uma organização usando a CLI do Atlas, execute o seguinte comando:

atlas organizations delete <ID> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
organizações do atlas são excluídas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Gerenciar usuários da organização
Nesta página

Acesso obrigatório
Adicionar usuários a uma organização
Visualizar usuários ativos e convites enviados em uma organização
Editar a função do usuário em uma organização
Remover usuários de uma organização
Você pode conceder aos usuários do Atlas acesso às organizações do Atlas. Atribua
funções de usuário para impor níveis de permissão aos usuários do Atlas.

É recomendável criar no mínimo dois usuários com a função Proprietário da Organização


para garantir que o acesso a uma organização não dependa de um único usuário.

IMPORTANTE
Suspensão de uso do convite do projeto
O lançamento do Atlas em 13 de setembro de 2023 descontinua convites de projetos.

Quando você convida um membro da organização para projetos dentro da organização, o


usuário recebe automaticamente acesso a esses projetos e não recebe nenhum convite.
Quando você convida um usuário para projetos em uma organização à qual o usuário não
pertence, o usuário recebe um único convite para a organização, que inclui acesso a todos
os projetos aos quais você concede acesso. Os convites expiram após 30 dias.

Acesso obrigatório
Para executar qualquer uma das ações a seguir, você deve ter acesso de proprietário da
organização ao Atlas.

Adicionar usuários a uma organização


IMPORTANTE
O Atlas limita a associação de usuários do Atlas a um máximo de 500 usuários do Atlas por
organização.

CLI do Atlas

IU do Atlas
Para convidar um usuário para sua organização usando a CLI do Atlas, execute o seguinte
comando:

atlas users invite [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
usuários do atlas convidam.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Visualizar usuários ativos e convites enviados em uma organização

CLI do Atlas

IU do Atlas
Ver usuários ativos
Para listar todos os usuários da sua organização usando a CLI do Atlas, execute o seguinte
comando:

atlas organizations users list [options]

Para retornar os detalhes de um usuário especificado usando a CLI do Atlas, execute o


seguinte comando:

atlas users describe [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para lista de usuários de organizações do atlas e os usuários
do atlas descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Ver convites de usuários pendentes


Para listar todos os convites pendentes para a organização especificada usando a CLI do
Atlas, execute o seguinte comando:

atlas organizations invitations list [options]


Para retornar os detalhes de um convite pendente para a organização especificada usando
a CLI do Atlas, execute o seguinte comando:

atlas organizations invitations describe <invitationId> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para lista de convites de organizações atlas e os convites das
organizações do atlas descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Modificar ou cancelar um convite de usuário pendente


Para atualizar um convite pendente para a organização especificada usando a CLI do Atlas,
execute o seguinte comando:

atlas organizations invitations update [invitationId] [options]

Para excluir um convite pendente para a organização especificada usando a CLI do Atlas,
execute o seguinte comando:

atlas organizations invitations delete <invitationId> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para atualização de convites de organizações do atlas e
exclusão de convites de organizações do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Editar a função do usuário em uma organização


OBSERVAÇÃO
Você não poderá editar funções para usuários específicos na página do Access Manager se
configurar mapeamentos de funções para grupos IdP.
Para editar a função de um usuário em uma organização:

1
Navegue até a página do Access Manager da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Access Manager na barra lateral ou clique em Access Manager na barra de


navegação e clique em sua organização.

2
Se ainda não estiver exibido, clique na guia Usuários.
3
Para o usuário da organização modificar, clique em Editar permissões.
4
Selecione a nova função ou funções para o usuário no menu.
5
Clique na marca de seleção para salvar suas alterações.
Remover usuários de uma organização
OBSERVAÇÃO
Você não pode remover o último proprietário da organização de uma organização.

Para remover um usuário de uma organização:

1
Navegue até a página do Access Manager da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Access Manager na barra lateral ou clique em Access Manager na barra de


navegação e clique em sua organização.

2
Se ainda não estiver exibido, clique na guia Usuários.
3
Clique à direita do usuário para remover.
4
Para confirmar a remoção de um usuário, clique em Remover usuário da organização.
Gerenciar equipes da organização
Nesta página

Acesso obrigatório
Crie uma equipe
Ver equipes
Adicionar membros da equipe
Remover membros da equipe
Renomear uma equipe
Excluir uma equipe
Próximos passos
Você pode criar equipes no nível da organização e adicionar equipes a projetos para
conceder funções de acesso ao projeto a vários usuários. Adicione qualquer número de
usuários da organização a uma equipe.

Conceda funções a uma equipe para projetos específicos. Todos os membros de uma
equipe compartilham o mesmo acesso ao projeto. Os usuários da organização podem
pertencer a diversas equipes. Para adicionar equipes a um projeto ou editar funções de
equipe, consulte Gerenciar acesso a um projeto.

Acesso obrigatório
Para executar qualquer uma das ações a seguir, você deve ter acesso de proprietário da
organização ao Atlas.

Crie uma equipe


IMPORTANTE
O Atlas limita o número de usuários a um máximo de 100 equipes por projeto e a um
máximo de 250 equipes por organização.

CLI do Atlas

IU do Atlas
Para criar uma equipe em sua organização usando a CLI do Atlas, execute o seguinte
comando:

equipes do atlas criam <nome> [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
as equipes do atlas criam.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas
Conecte-se à CLI do Atlas

Para adicionar usuários à sua equipe, consulte


Adicione membros da equipe.

Ver equipes

CLI do Atlas

IU do Atlas
Para listar todas as equipes da sua organização usando a CLI do Atlas, execute o seguinte
comando:

atlas teams list [options]

Para retornar os detalhes da equipe especificada usando a CLI do Atlas, execute o seguinte
comando:

atlas teams describe [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
lista de equipes do atlas
e
as equipes do atlas descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Adicionar membros da equipe


IMPORTANTE
O Atlas limita a associação de usuários do Atlas a um máximo de 250 usuários do Atlas por
equipe.

CLI do Atlas

IU do Atlas
Para adicionar um usuário à equipe especificada usando a CLI do Atlas, execute o seguinte
comando:

atlas teams users delete <userId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
os usuários das equipes do atlas adicionam.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Remover membros da equipe

CLI do Atlas

IU do Atlas
Para excluir um usuário da equipe especificada usando a CLI do Atlas, execute o seguinte
comando:

usuários das equipes do atlas excluem <userId> [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
os usuários das equipes do atlas excluem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Renomear uma equipe


OBSERVAÇÃO
Limitação CLI do Atlas
Você não pode renomear uma equipe usando a CLI do Atlas.

1
Navegue até a página do Access Manager da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.
Clique em Access Manager na barra lateral ou clique em Access Manager na barra de
navegação e clique em sua organização.

2
Clique na guia Equipes.
3
Renomeie a equipe.
Para a equipe que você deseja renomear:

Clique no botão de reticências (...) na coluna Ações.

Clique em Renomear equipe.

Insira um novo nome para a equipe.

O nome da equipe deve ser exclusivo dentro da organização.

Clique em Renomear equipe.

Excluir uma equipe

CLI do Atlas

IU do Atlas
Para excluir uma equipe da sua organização usando a CLI do Atlas, execute o seguinte
comando:

atlas teams delete <teamId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
equipes do atlas excluem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Próximos passos
Para que os usuários da organização em uma equipe tenham acesso a um projeto, você
deverá adicionar a equipe ao projeto. Para adicionar equipes a um projeto ou editar funções
de equipe, consulte Gerenciar acesso a um projeto.
Gerenciar configurações da organização
Nesta página

Acesso obrigatório
Migração ao vivo: conecte-se ao Atlas
Integrações
Acesso obrigatório
Para executar qualquer uma das ações a seguir, você deve ter acesso de proprietário da
organização ao Atlas.

Migração ao vivo: conecte-se ao Atlas


Você se conecta a uma organização no Atlas ao migrar sua implantação do Cloud Manager
ou do Ops Manager para o Atlas.

Integrações
Você pode configurar o Atlas para as seguintes integrações:

Folga

Vercel

Configurar espaços de trabalho do Slack


1
Navegue até a página Integrações da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Integrações na barra lateral.

2
Clique em Adicionar ao Slack.
3
Faça login no seu espaço de trabalho.
Digite o nome do seu espaço de trabalho no campo.

Clique em Continuar.

Selecione seu método de autenticação.

Clique em Autorizar.

4
Clique em Salvar.
IMPORTANTE
Você pode autorizar apenas um Slack Workspace para cada organização.
Selecione a organização para remover a autorização do Slack
1
Navegue até a página Integrações da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Integrações na barra lateral.

2
Clique em Remover integração.
IMPORTANTE
Isso não impede que o Atlas envie alertas. Para impedir que o Atlas envie alertas para o
Slack, você deve excluir a configuração de alerta do Slack.

Configurar integrações Vercel


Você pode conectar seus clusters Atlas a aplicativos implantados usando
Vercel. Para saber mais, consulte Integrar com Vercel.
Gerenciar acesso ao projeto
Nesta página

Crie um projeto
Ver projetos
Mover um projeto
Excluir um projeto
Os grupos agora são projetos na hierarquia de organizações e projetos.

Você pode criar vários projetos em uma organização.

Ao ter vários projetos em uma organização, você pode:

Isole ambientes diferentes (por exemplo, ambientes de desenvolvimento/qa/produção) uns


dos outros.

Associe diferentes usuários ou equipes a diferentes ambientes ou conceda diferentes


permissões a usuários em diferentes ambientes.

Mantenha configurações de segurança de cluster separadas. Por exemplo:

Crie/gerencie diferentes conjuntos de credenciais de usuário de banco de dados para cada


projeto.

Isole redes em diferentes VPCs.

Crie diferentes configurações de alerta. Por exemplo, configure alertas para ambientes de
produção de forma diferente dos ambientes de desenvolvimento.

Crie um projeto
Pré-requisitos
Para criar um projeto para uma organização, você deve ser proprietário da organização ou
criador do projeto da organização.

Ao criar um projeto, você é adicionado como proprietário do projeto.

Procedimento

CLI do Atlas

IU do Atlas
Para criar um novo projeto usando o Atlas CLI, execute o seguinte comando:

atlas projects create <projectName> [options]


Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do
Atlas CLI para
projetos atlas criam.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Ver projetos
Pré-requisitos
Para visualizar um projeto, você deve:

Seja proprietário de uma organização ou proprietário de projeto

Receba um convite que concede acesso ao projeto. Um proprietário da organização ou


proprietário do projeto pode convidar usuários para projetos.

IMPORTANTE
Suspensão de uso do convite do projeto
O lançamento do Atlas em 13 de setembro de 2023 descontinua convites de projetos.

Quando você convida um membro da organização para projetos dentro da organização, o


usuário recebe automaticamente acesso a esses projetos e não recebe nenhum convite.
Quando você convida um usuário para projetos em uma organização à qual o usuário não
pertence, o usuário recebe um único convite para a organização, que inclui acesso a todos
os projetos aos quais você concede acesso. Os convites expiram após 30 dias.

Procedimento

CLI do Atlas

IU do Atlas
Para listar todos os projetos usando a CLI do Atlas, execute o seguinte comando:

atlas projects list [options]

Para retornar os detalhes do projeto especificado usando a CLI do Atlas, execute o seguinte
comando:

atlas projects describe <ID> [options]


Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
lista de projetos do atlas
e
os projetos do atlas descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Mover um projeto
Quando você move um projeto para outra organização do Atlas, o Atlas copia os usuários
do projeto e suas respectivas funções para o mesmo projeto na organização de destino. No
entanto, o Atlas não transfere equipes atribuídas ao projeto porque você define equipes no
nível da organização.

Quando você move projetos entre organizações, suas alterações entram em vigor
imediatamente. A mudança não:

Impacto no tempo de atividade do cluster ou na configuração atual do cluster.

Causa tempo de inatividade para a implantação do banco de dados ou alterações na cadeia


de conexão.

IMPORTANTE
Atlas remove chaves de API existentes após mover o projeto. Você deve criar uma nova
chave de API após mover o projeto.

Pré-requisitos
Para mover um projeto para outra organização Atlas, você deve ser proprietário da
organização tanto da organização atual quanto da organização de destino.

Procedimento
Para mover um projeto para uma organização:

1
Veja todos os seus projetos.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Clique no ícone Folha no canto superior esquerdo da página. Você também pode expandir o
menu Projetos na barra de navegação e clicar em Exibir todos os projetos.

2
Selecione o projeto que você deseja mover.
Para o projeto que você deseja mover:

Clique em .

Clique em Mover projeto.

A caixa de diálogo Mover Projeto é exibida.

3
Selecione a organização de destino. Clique em Próximo: Confirmar para ir para a tela de
confirmação.
4
Clique em Confirmar e mover.
OBSERVAÇÃO
Faturamento de um projeto movido
Um proprietário de duas organizações diferentes pode mover projetos entre essas
organizações a qualquer momento. O uso em qualquer projeto específico durante qualquer
hora específica é acumulado para a Organização sob a qual o projeto estava naquele
momento.

EXEMPLO
O proprietário de uma organização é dono das organizações de telecomunicações e
armazenamento no Atlas. Eles decidem mover seu projeto de backup de Telecom para
armazenamento às 11h40.

O projeto Telecomm é cobrado integralmente das 11h00 às 11h59. O armazenamento


começa a ser cobrado às 12h.

Excluir um projeto
OBSERVAÇÃO
Se você tiver uma Política de Conformidade de Backup habilitada, não será possível excluir
o projeto se existir algum instantâneo.

Pré-requisitos
Para excluir um projeto de uma organização, você deve ter a função de Proprietário do
Projeto para o projeto ou a função de Proprietário da Organização para a organização do
projeto.

O projeto não tem saída e emitir faturas.

O projeto não possui implantações de banco de dados ativas. Encerre clusters ativos ou
instâncias sem servidor no projeto antes de excluí-lo.

O projeto não possui conexões de endpoint privado configuradas.

O projeto não possui instâncias de banco de dados federadas ativas.


Procedimento

CLI do Atlas

IU do Atlas
Para excluir um projeto usando a CLI do Atlas, execute o seguinte comando:

atlas projects delete <ID> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
projetos do atlas excluídos.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Gerenciar o acesso a um projeto
Nesta página

Acesso obrigatório
Adicionar usuários ou equipes a um projeto
Ver quem pode acessar um projeto
Ver convites de usuários
Cancelar ou atualizar convites de usuários
Remover usuários ou equipes de um projeto
Editar a função de um usuário ou equipe em um projeto
IMPORTANTE
Suspensão de uso do convite do projeto
O lançamento do Atlas em 13 de setembro de 2023 descontinua convites de projetos.

Quando você convida um membro da organização para projetos dentro da organização, o


usuário recebe automaticamente acesso a esses projetos e não recebe nenhum convite.
Quando você convida um usuário para projetos em uma organização à qual o usuário não
pertence, o usuário recebe um único convite para a organização, que inclui acesso a todos
os projetos aos quais você concede acesso. Os convites expiram após 30 dias.

Você pode conceder aos usuários e equipes do Atlas acesso aos projetos do Atlas. Atribua
funções de usuário para impor níveis de permissão para usuários e equipes do Atlas.

Acesso obrigatório
Para executar qualquer uma das ações a seguir, você deve ter acesso de Proprietário do
Projeto ao Atlas.

Adicionar usuários ou equipes a um projeto


IMPORTANTE
Adicionar um usuário a um projeto também adiciona esse usuário à organização.

Atlas limita o número de equipes a um máximo de:

100 equipes por projeto e

250 equipes por organização.

O Atlas também limita a associação de usuários do Atlas a um máximo de:

500 por projeto e

500 por organização, o que inclui a adesão combinada de todos os projetos da organização.

O Atlas gera um erro se uma operação exceder esses limites.

EXEMPLO
Você tem uma organização com cinco projetos. Cada projeto tem 100 usuários do Atlas.
Cada usuário do Atlas pertence a apenas um projeto. Você não pode adicionar usuários do
Atlas a esta organização ou a qualquer projeto dessa organização sem primeiro remover os
usuários do Atlas existentes da organização ou da associação ao projeto.

CLI do Atlas

IU do Atlas
Para usar o Atlas CLI, execute o seguinte comando:

atlas accessLists create [entry] [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para criar atlas accessLists.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Ver quem pode acessar um projeto

CLI do Atlas

IU do Atlas
Para listar todos os usuários no projeto especificado usando a CLI do Atlas, execute o
seguinte comando:

atlas projects users list [options]

Para listar todas as equipes de um projeto usando a CLI do Atlas, execute o seguinte
comando:

atlas projects teams list [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para lista de usuários de projetos atlas e lista de equipes de
projetos do atlas.
DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Ver convites de usuários


IMPORTANTE
Suspensão de uso do convite do projeto
O lançamento do Atlas em 13 de setembro de 2023 descontinua convites de projetos.

Quando você convida um membro da organização para projetos dentro da organização, o


usuário recebe automaticamente acesso a esses projetos e não recebe nenhum convite.
Quando você convida um usuário para projetos em uma organização à qual o usuário não
pertence, o usuário recebe um único convite para a organização, que inclui acesso a todos
os projetos aos quais você concede acesso. Os convites expiram após 30 dias.

CLI do Atlas

IU do Atlas
Para listar todos os convites pendentes para o projeto especificado usando a CLI do Atlas,
execute o seguinte comando:

atlas projects invitations list [options]

Para retornar os detalhes de um convite pendente para o projeto especificado usando a CLI
do Atlas, execute o seguinte comando:

atlas projects invitations describe <invitationId> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
lista de convites de projetos atlas
e
Os convites para projetos do Atlas descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Cancelar ou atualizar convites de usuários
IMPORTANTE
Suspensão de uso do convite do projeto
O lançamento do Atlas em 13 de setembro de 2023 descontinua convites de projetos.

Quando você convida um membro da organização para projetos dentro da organização, o


usuário recebe automaticamente acesso a esses projetos e não recebe nenhum convite.
Quando você convida um usuário para projetos em uma organização à qual o usuário não
pertence, o usuário recebe um único convite para a organização, que inclui acesso a todos
os projetos aos quais você concede acesso. Os convites expiram após 30 dias.

CLI do Atlas

IU do Atlas
Para usar o Atlas CLI, execute o seguinte comando:

atlas accessLists create [entry] [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas accessLists criam.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Remover usuários ou equipes de um projeto


IMPORTANTE
Os projetos devem ter pelo menos um usuário ou equipe. Você não pode excluir o último
membro (usuário ou equipe) do projeto. Em vez disso, você deve fechar o projeto.

CLI do Atlas

IU do Atlas
Para excluir um usuário de um projeto usando o Atlas CLI, execute o fseguinte comando:

atlas projects users delete <ID> [options]


Para remover uma equipe do projeto especificado usando a CLI do Atlas, execute o
seguinte comando:

atlas projects teams delete <teamId> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
usuários de projetos atlas excluem
e
As equipes de projetos do Atlas excluem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Editar a função de um usuário ou equipe em um projeto


OBSERVAÇÃO
Você não poderá editar funções para usuários específicos na página do Access Manager se
configurar mapeamentos de funções para grupos IdP.

CLI do Atlas

IU do Atlas
Para atualizar funções de uma equipe no projeto especificado usando a CLI do Atlas,
execute o seguinte comando:

atlas projects teams update <teamId> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atualização das equipes de projetos do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


OBSERVAÇÃO
Limitação CLI do Atlas
Você não pode atualizar a função de um usuário em um projeto usando a CLI do Atlas.
Gerenciar configurações do projeto
Nesta página

Acesso obrigatório
Gerenciar configurações do projeto
Acesso obrigatório
Para visualizar as configurações do projeto, você deve ter acesso de proprietário do projeto
ao projeto.

Gerenciar configurações do projeto


As configurações do projeto se aplicam a todos os usuários do projeto [1]. O ID do projeto
exibido na parte superior da página é usado pela API de administração do Atlas e pela CLI
do Atlas.

CLI do Atlas

IU do Atlas
Atualizar configurações do projeto
Para atualizar as configurações do projeto especificado usando a CLI do Atlas, execute o
seguinte comando:

atualização de configurações de projetos atlas [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para atualização das configurações dos projetos atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Ver configurações do projeto


Para retornar os detalhes das configurações do projeto especificado usando a CLI do Atlas,
execute o seguinte comando:

atlas projects settings describe [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para as configurações dos projetos atlas descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Configurar DNS personalizado na AWS


Use os comandos a seguir para definir configurações de DNS personalizadas na AWS.

Habilite DNS personalizado na AWS


Para habilitar a configuração DNS personalizada para um cluster Atlas implantado na AWS
usando a CLI do Atlas, execute o seguinte comando:

atlas customDns aws enable [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para habilitar atlas customDns aws.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Desabilitar DNS personalizado na AWS


Para desabilitar a configuração DNS personalizada para um cluster Atlas implantado na
AWS usando a CLI do Atlas, execute o seguinte comando:

atlas customDns aws disable [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas customDns aws desativar.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Retorne os detalhes do seu DNS personalizado na AWS


Para retornar a configuração DNS personalizada de um cluster Atlas implantado na AWS
usando a CLI do Atlas, execute o seguinte comando:
atlas customDns aws describe [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para descrever atlas customDns aws.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Gerenciar a página inicial do projeto
Nesta página

Acesso obrigatório
Habilite a visão geral do projeto
Desative a visão geral do projeto
A visão geral do projeto é uma página inicial do seu projeto Atlas que exibe módulos que
contêm ações comuns do Atlas. A visão geral facilita a localização de recursos e o
gerenciamento de implantações de banco de dados na página inicial do Atlas.

Para navegar até a visão geral do projeto, clique em Visão geral na barra lateral do Atlas.
Se o Atlas não exibir uma opção Visão geral, você deverá primeiro
ativar a visão geral
para o seu projeto. Se você não habilitar a visão geral do projeto, o Atlas exibirá
Implantações de banco de dados como a página inicial do projeto.

Acesso obrigatório
Para ativar ou desativar a visão geral do projeto, você deve ter acesso de Proprietário do
Projeto ou Proprietário da Organização ao Atlas.

Habilite a visão geral do projeto


Siga estas etapas para ativar a visão geral do projeto. O Atlas habilita a visão geral por
padrão para todos os projetos criados a partir de 12 de julho de 2023. Depois de habilitar a
visão geral, a opção Visão geral é exibida na barra lateral para todos os usuários do projeto.

1
Navegue até a página Configurações do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Ao lado do menu Projetos, expanda o menu Opções e clique em Configurações do Projeto.

2
Alterne Visão geral do projeto para LIGADO.
Desative a visão geral do projeto
Siga estas etapas para desativar a visão geral do projeto. Depois de desativar a visão geral,
as seguintes alterações serão aplicadas a todos os usuários do projeto:

A opção Visão geral não é exibida na barra lateral deste projeto.

Implantações de banco de dados se torna a página inicial do projeto.

1
Navegue até a página Configurações do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Ao lado do menu Projetos, expanda o menu Opções e clique em Configurações do Projeto.

2
Alterne Visão geral do projeto para DESLIGADO.
Convites para organizações e projetos
Nesta página

Aceite convites para ingressar em organizações


Ver convites de saída
IMPORTANTE
Suspensão de uso do convite do projeto
O lançamento do Atlas em 13 de setembro de 2023 descontinua convites de projetos.

Quando você convida um membro da organização para projetos dentro da organização, o


usuário recebe automaticamente acesso a esses projetos e não recebe nenhum convite.
Quando você convida um usuário para projetos em uma organização à qual o usuário não
pertence, o usuário recebe um único convite para a organização, que inclui acesso a todos
os projetos aos quais você concede acesso. Os convites expiram após 30 dias.

Aceite convites para ingressar em organizações


A guia Convites permite visualizar e aceitar convites pendentes para organizações Atlas.

Para visualizar convites pendentes para ingressar em organizações:

1
Navegue até a página Convites.
No canto superior direito da interface do Atlas, clique no seu nome de usuário para acessar
o menu Conta.

Em Atlas, clique em Convites.

Para aceitar um convite, clique em Aceitar convite para o convite correspondente.

Você também pode aceitar um convite do e-mail que o Atlas envia quando você é convidado
pela primeira vez para ingressar em uma organização ou projeto.

Detalhes do convite
O Atlas exibe as seguintes informações para cada convite:

Organização
Nome da organização para a qual você foi convidado.
Funções
Funções de usuário que este convite concede na organização e nos projetos especificados.
Enviado
Hora em que o convite foi enviado.
Data de validade
Data em que o convite expira.
Ações
Botão para aceitar o convite.
Ver convites de saída
Para visualizar convites enviados para uma organização:

1
Navegue até a página do Access Manager da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Access Manager na barra lateral ou clique em Access Manager na barra de


navegação e clique em sua organização.

Para visualizar convites enviados para um projeto:

1
Navegue até a página do Access Manager do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Selecione o projeto desejado na lista de projetos na página Projetos.

Clique nas reticências verticais () ao lado do nome do projeto no canto superior esquerdo e
selecione Configurações do projeto.

Clique em Access Manager na barra de navegação e clique em seu projeto.

Atlas exibe convites enviados como usuário pendente.


Ver feed de atividades
Nesta página

Acesso obrigatório
Veja o feed de atividades
O feed de atividades da organização Atlas exibe eventos selecionados que ocorreram para
uma determinada organização Atlas, como eventos de faturamento ou acesso. Da mesma
forma, o feed de atividades do projeto Atlas exibe eventos selecionados que ocorreram para
determinados projetos Atlas. Os eventos do Atlas Project Activity Feed normalmente
fornecem detalhes mais granulares sobre o estado do seu cluster e banco de dados.

Acesso obrigatório
Para visualizar o feed de atividades da organização, você deve ter acesso de membro da
organização ou superior à organização.

Para visualizar o feed de atividades do projeto, você deve ter acesso somente leitura do
projeto ou superior ao projeto.

Veja o feed de atividades


Você pode acessar eventos no nível da organização ou do projeto. Você pode usar a UI do
Atlas, a CLI do Atlas ou a API de administração do Atlas. Selecione as guias a seguir com
base em como você gostaria de acessar os eventos.

Feed de atividades da organização

Feed de atividades do projeto


OBSERVAÇÃO
O Feed de atividades da organização fornece registros de todas as atividades no nível da
organização, desde a criação da organização até sua exclusão.

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para retornar todos os eventos de uma organização usando a CLI do Atlas, execute o
seguinte comando:

atlas events organizations list [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
lista de organizações de eventos do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Gerencie sua conta MongoDB Atlas
Nesta página

Encontre sua conta MongoDB Atlas


Altere seu endereço de e-mail do Atlas
Desvincule sua conta MongoDB Atlas de sua conta GitHub
Desvincule sua conta MongoDB Atlas da sua conta do Google
Excluir uma conta Atlas
Encontre sua conta MongoDB Atlas
Você pode gerenciar as configurações da sua conta Atlas, desvincular sua conta da sua
conta Google ou GitHub e configurar a autenticação multifator para sua conta Atlas.

Para encontrar sua conta MongoDB Atlas:

1
Clique no nome da sua conta no menu superior do Atlas.
2
Clique em Gerenciar sua conta MongoDB.
A página Visão geral é aberta. A partir daqui, você pode:

Acesse a Página de login do MongoDB Atlas.

Acesse o Suporte para visualizar casos de suporte ativos e falar com a equipe de suporte.

Visite a Universidade MongoDB para fazer cursos gratuitos para se tornar um especialista
certificado em MongoDB.

Visite os Fóruns da comunidade MongoDB para conhecer outros desenvolvedores do


MongoDB.

Na barra de navegação esquerda, você também pode:

Forneça suas informações pessoais em Informações do perfil.

Se você gerencia sua conta por meio de sua Conta do Google, visite sua conta do Google
para gerenciar suas informações pessoais.

Se você gerencia sua conta por meio de sua conta GitHub, visite sua conta GitHub para
gerenciar suas informações pessoais.

Desvincule sua conta Mongodb Atlas de Google ou GitHub em Informações do perfil.

Gerencie suas opções de autenticação multifator em segurança.

Altere seu endereço de e-mail do Atlas


Você pode alterar o endereço de e-mail usado para fazer login em sua conta do MongoDB
Atlas.

OBSERVAÇÃO
Se suas informações de login forem gerenciadas por um provedor de identidade com
Autenticação Federada, entre em contato com o administrador da sua empresa.

Se você fizer login com o Google SSO, deverá


desvincular sua conta
antes de alterar seu endereço de e-mail.

Para alterar seu endereço de e-mail:

1
Clique no nome da sua conta no menu superior do Atlas.
2
Clique em Gerenciar sua conta MongoDB.
3
Clique em Informações do perfil na barra de navegação.
4
Mude seu endereço de email.
Clique em Alterar endereço de e-mail no seu endereço de e-mail atual.

Coloque sua senha. Se você tiver o MFA habilitado, autentique-se com seu método MFA.

Insira um novo endereço de e-mail.

OBSERVAÇÃO
Você não pode usar um endereço de e-mail associado a outra conta ou a uma conta
excluída.

Clique em Salvar alterações.

OBSERVAÇÃO
Depois de salvar as alterações, um banner na parte superior da página solicita que você
verifique seu e-mail. Se quiser cancelar sua alteração e continuar usando seu endereço de
e-mail original, clique em Cancelar solicitação no banner.

5
Confirme sua nova conta de e-mail.
Um e-mail de verificação será enviado para seu novo endereço de e-mail assim que você
salvar as alterações. Nesse e-mail, clique em Verificar e-mail para atualizar seu endereço
de e-mail. O feed de atividades do projeto registra sua atualização.

6
Faça login no Atlas.
Use seu endereço de e-mail atualizado para fazer login no Atlas.
Desvincule sua conta MongoDB Atlas de sua conta GitHub
Se você vinculou sua conta MongoDB Atlas à sua conta Github, poderá desvinculá-la
usando o procedimento a seguir.

Para desvincular sua conta MongoDB Atlas de sua conta Github:

1
Desvincule sua conta da conta GitHub.
Clique em Gerenciar sua conta MongoDB.

Clique em Informações do perfil. O console indica que:

Sua conta Atlas está vinculada à sua conta GitHub.

Se você pretende desvincular sua conta, deverá alterar a senha da sua conta Atlas.

Clique em Desvincular do GitHub.

Clique em Confirmar. Atlas envia um e-mail para sua conta de e-mail. Esta mensagem
contém instruções para redefinir a senha da sua conta Atlas.

2
Redefina sua senha.
Faça login no e-mail e localize o e-mail de redefinição de senha.

OBSERVAÇÃO
Se você não redefinir sua senha dentro de duas horas, envie uma nova solicitação.

Clique no link de redefinição de senha no e-mail para concluir o processo de redefinição de


senha.

Digite seu e-mail.

Digite sua nova senha do Atlas.

OBSERVAÇÃO
Política de senha da Atlas
A senha da sua conta de usuário Atlas deve:

Contém pelo menos oito caracteres.

Contém caracteres, números ou símbolos exclusivos.

Exclua seu endereço de e-mail e nome de usuário do Atlas.

Diferente das quatro senhas anteriores.

Diferem das senhas mais comumente usadas.


Digite novamente sua nova senha para confirmá-la.

Clique em Salvar. Quando sua senha atender aos requisitos e corresponder em ambos os
campos, você terá redefinido sua senha. Atlas exibe uma mensagem de sucesso com um
link para fazer login.

3
Faça login no Atlas.
Clique em Login para continuar.

Digite seu e-mail.

Digite sua nova senha.

Desvincule sua conta MongoDB Atlas da sua conta do Google


Se você vinculou sua conta do MongoDB Atlas à sua conta do Google, poderá desvinculá-la
usando o procedimento a seguir.

Para desvincular sua conta do MongoDB Atlas da sua conta do Google:

1
Desvincule sua conta da conta do Google.
Clique em Gerenciar sua conta MongoDB.

Clique em Informações do perfil. O console indica que:

Sua conta Atlas está vinculada à sua conta Google.

Se você pretende desvincular sua conta, deverá alterar a senha da sua conta Atlas.

Clique em Desvincular do Google.

Clique em Confirmar. Atlas envia um e-mail para sua conta do Gmail. Esta mensagem
contém instruções para redefinir a senha da sua conta Atlas.

2
Redefina seu senha.
Faça login no Gmail e localize o e-mail de redefinição de senha.

OBSERVAÇÃO
Se você não redefinir sua senha dentro de duas horas, envie uma nova solicitação.

Clique no link de redefinição de senha no e-mail para concluir o processo de redefinição de


senha.

Digite seu e-mail.


Digite sua nova senha do Atlas.

OBSERVAÇÃO
Política de senha da Atlas
A senha da sua conta de usuário Atlas deve:

Contém pelo menos oito caracteres.

Contém caracteres, números ou símbolos exclusivos.

Exclua seu endereço de e-mail e nome de usuário do Atlas.

Diferente das quatro senhas anteriores.

Diferem das senhas mais comumente usadas.

Digite novamente sua nova senha para confirmá-la.

Clique em Salvar. Quando sua senha atender aos requisitos e corresponder em ambos os
campos, você terá redefinido sua senha. Atlas exibe uma mensagem de sucesso com um
link para fazer login.

3
Faça login no Atlas.
Clique em Login para continuar.

Digite seu e-mail.

Digite sua nova senha.

Excluir uma conta Atlas


Esta seção orienta você na exclusão de sua conta Atlas.

Pré-requisitos
Para excluir sua conta Atlas, você deve garantir que não possui:

Faturas pendentes

Implantações de banco de dados ativas

Projetos

Organizações

IMPORTANTE
Se você fizer login no Atlas por meio de um provedor de identidade, não poderá excluir sua
conta sozinho. Entre em contato com seu provedor de identidade para excluir sua conta
Atlas.
Excluir todos os projetos
Excluir um projeto
Para excluir um projeto de uma organização:

Você deve ter a função de Proprietário para o projeto ou a função de Proprietário da


Organização para a organização do projeto.

O projeto não deve ter faturas pendentes.

O projeto não deve ter implantações de banco de dados ativas. Para saber como visualizar
as faturas do seu projeto, consulte Gerenciar faturas.

Encerrar todos os clusters


AVISO
O encerramento de um cluster também exclui quaisquer snapshots de backup desse cluster.
Consulte Programação de instantâneos.

Para encerrar um cluster Atlas:

1
Navegue até a página Implantações de banco de dados do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Se a página Implantações de banco de dados ainda não estiver exibida, clique em Banco de
dados na barra lateral.

2
Se você ativou a proteção contra encerramento, desative-a.
Clique em Editar configuração e selecione o cluster que deseja encerrar no menu suspenso.

Clique em Configurações adicionais e desative a proteção contra rescisão.

Clique em Revisar alterações.

Clique em Aplicar alterações.

3
Clique ao lado do cluster que você deseja encerrar.
4
(Opcional) Mantenha os snapshots existentes após o encerramento.
Se você tiver uma política de conformidade de backup habilitada e encerrar um cluster, o
Atlas manterá automaticamente todos os snapshots existentes após o encerramento, de
acordo com a política de backup. Atlas mantém o
registrar
para restaurar um ponto no tempo com backup contínuo na nuvem em um estado estático
até que o Atlas não possa mais usá-los para backup contínuo na nuvem.

Caso contrário, se o Backup na nuvem estiver ativado, você poderá alternar Manter
instantâneos existentes após o encerramento para Ativado.

Se você tiver o Backup na nuvem desabilitado, esta opção não estará disponível.

5
Clique em Encerrar.
Para encerrar uma instância sem servidor do Atlas:

1
Navegue até a página Implantações de banco de dados do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Se a página Implantações de banco de dados ainda não estiver exibida, clique em Banco de
dados na barra lateral.

2
Se você ativou a proteção contra encerramento, desative-a.
Clique em Editar configuração.

Selecione a instância sem servidor que você deseja encerrar no menu suspenso.

Clique em Configurações adicionais e desative a proteção contra rescisão.

Clique em Revisar alterações.

Clique em Aplicar alterações.

3
Clique ao lado da instância sem servidor que você deseja encerrar.
4
Clique em Encerrar.
O Atlas executa a operação de encerramento após concluir quaisquer alterações de
implantação em andamento.

Excluir o projeto
Você pode excluir um projeto de uma organização na visualização Projetos da organização
ou na visualização Configuração do projeto do projeto:
Excluir da visualização Projetos

Excluir da visualização Configuração do projeto


1
Veja todos os seus projetos.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Clique no ícone Folha no canto superior esquerdo da página. Você também pode expandir o
menu Projetos na barra de navegação e clicar em Exibir todos os projetos.

2
Para o projeto que você deseja excluir, clique em .
3
Clique em Excluir projeto.
4
Se a autenticação herdada de dois fatores estiver habilitada, insira o código de verificação.
Após a verificação, clique em Excluir projeto novamente.

Sair ou excluir todas as organizações


Sair de uma organização
OBSERVAÇÃO
Se você for o único proprietário da organização em uma organização, deverá promover
outro membro a proprietário da organização antes de poder sair da organização.

1
Veja todas as suas organizações.
Expandir no menu Organizações na barra de navegação.

Clique em Exibir todas as organizações.

2
Deixe a organização.
Para a organização da qual você deseja sair, clique no botão Sair para abrir a caixa de
diálogo Sair da Organização.

3
Clique em Sair da organização na caixa de diálogo Sair da organização.
Excluir uma organização
OBSERVAÇÃO
Para excluir uma organização, você deve ter a função de Proprietário da organização para a
organização.

Você não pode excluir uma organização que tenha projetos ativos. Você deve excluir os
projetos da organização antes de excluí-la.

1
Navegue até a página Configurações da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique no ícone Configurações da organização próximo ao menu Organizações.

2
Na guia Configurações gerais, clique em Excluir.
Isso exibe a caixa de diálogo Excluir organização.

3
Clique em Excluir organização para confirmar.
Depois de excluir todas as implantações, projetos e organizações de banco de dados ativos,
você não será mais cobrado por nenhuma atividade do Atlas e não receberá mais alertas do
Atlas.

Exclua sua conta Atlas


OBSERVAÇÃO
Depois de excluir sua conta, não há como recuperá-la.

O Atlas leva até duas semanas para processar totalmente a exclusão de uma conta. Até
então, você não poderá criar uma nova conta Atlas com o endereço de e-mail associado à
sua conta excluída.

1
Navegue até as informações do seu perfil.
Clique no seu nome no canto superior direito da interface do Atlas.

Clique em Gerenciar sua conta MongoDB.

Clique em Informações do perfil no painel de navegação esquerdo.

2
Clique em Excluir conta.
3
Confirme que deseja excluir sua conta.
Reconheça as implicações de excluir sua conta Atlas.

Clique em Confirmar exclusão da conta.

OBSERVAÇÃO
Se houver algum requisito que você ainda não atendeu, você será solicitado a concluí-lo
antes de excluir sua conta.

4
Verifique sua identidade.
Você será solicitado a verificar sua identidade:
Se você usar MFA, será solicitado que você verifique sua identidade com o método de
autenticação MFA escolhido.

Se você usa o Google SSO, o MongoDB envia um código para o seu endereço de e-mail.
Use esse código para verificar sua identidade. As contas que usam o Google SSO são
desvinculadas automaticamente como parte do processo de exclusão da conta.

Se você não tiver o MFA configurado e não usar o SSO do Google, será solicitado que você
verifique novamente sua senha. Em seguida, o MongoDB envia um código para o seu
endereço de e-mail. Use esse código para concluir a verificação de sua identidade.

Sua conta foi excluída.


Personalize os recursos da interface do Atlas
A aparência está disponível como um recurso de visualização. O recurso e a documentação
correspondente podem mudar a qualquer momento durante o período de visualização.
Você pode personalizar alguns aspectos visuais da UI do Atlas, como formatos de data e
hora.

1
Clique no seu nome no canto superior direito da interface do Atlas.
O menu da sua conta é exibido.

2
Clique em Preferências do usuário.
A página Personalização é exibida.

3
(Opcional) Atualize os seguintes recursos:
Recurso
Descrição
Meu fuso horário
Fuso horário no qual o Atlas exibe datas.

Padrão: Sem preferência

Meu formato de data


Formato no qual o Atlas exibe datas. Os valores possíveis são:

MM/dd/aa

DD/MM/aaaa

aaaa-MM-dd

dd-MM-aa

dd-MM-aaaa

Padrão: MM/dd/aa

Meu formato de hora


Formato no qual o Atlas exibe os horários. Os valores possíveis são:

24 horas

MANHÃ TARDE

Padrão: AM/PM
Aparência
Modo em que o Atlas Data Services e o Atlas App Services aparecem. Os valores possíveis
são:

Modo claro

Modo escuro

Automático (sincronizar com sistema operacional)

Padrão: Modo Claro


Configurar o acesso de suporte do MongoDB à
infraestrutura de back-end do Atlas
Nesta página

Bloquear acesso no nível da organização


Conceda acesso de infraestrutura ao suporte MongoDB por 24 horas
Conceda acesso de sincronização de dados ao suporte do MongoDB por 24 horas
Revogar o acesso temporário à infraestrutura para suporte do MongoDB
Como proprietário de uma organização, você pode configurar sua organização Atlas para
que os funcionários de suporte à produção do MongoDB, incluindo engenheiros de serviço
técnico, só possam acessar seus servidores de produção com sua permissão explícita. Se
surgir um problema que exija suporte do MongoDB e você desejar conceder acesso
temporário à infraestrutura de 24 horas ao suporte do MongoDB, você poderá conceder
acesso no nível de implantações de banco de dados. A concessão de acesso temporário
não dá ao suporte do MongoDB acesso para ler seu banco de dados, apenas a
infraestrutura subjacente, o que deve excluir informações confidenciais. Você também pode
revogar o acesso temporário à infraestrutura a qualquer momento antes da expiração
automática de 24 horas.

IMPORTANTE
Bloquear o acesso à infraestrutura do suporte MongoDB pode aumentar o tempo de
resposta e resolução de problemas de suporte e impactar negativamente a disponibilidade
da implantação do seu banco de dados.

Bloquear acesso no nível da organização


Você deve ser proprietário de uma organização para ajustar essa configuração.

1
Navegue até as configurações da sua organização.
No console do Atlas, clique no seu nome de usuário no canto superior direito e selecione
Organizações.

2
Selecione a organização à qual deseja restringir o acesso ao suporte.
3
Selecione Configurações na navegação do lado esquerdo.
4
Alterne a configuração.
Alterne a chave marcada Bloquear acesso do funcionário do suporte à produção do
MongoDB à infraestrutura Atlas para a posição Ativado.

Conceda acesso de infraestrutura ao suporte MongoDB por 24 horas


Se surgir um problema que exija suporte do MongoDB e você quiser permitir que a equipe
de suporte do MongoDB tenha acesso por tempo limitado a uma implantação de banco de
dados em sua organização, você poderá fazer isso com o procedimento a seguir.
1
Navegue até a Visão Geral do Cluster.
Clique em Banco de dados próximo à parte superior do console do Atlas.

2
Localize a implantação de banco de dados à qual deseja conceder acesso na lista de
implantações de banco de dados.
3
Selecione o ícone de reticências (...) à direita da implantação do banco de dados.
4
Selecione Conceder acesso temporário à infraestrutura ao suporte do MongoDB.
5
Clique em Conceder acesso.
Conceda acesso de sincronização de dados ao suporte do MongoDB por 24 horas
O procedimento que você segue para conceder acesso de dados de sincronização ao
suporte do MongoDB por 24 horas depende se o proprietário da sua organização ativou o
bloqueio de acesso ao suporte do MongoDB para a infraestrutura do Atlas.

Selecione a guia aplicável à sua organização.

Acesso ao suporte bloqueado

Acesso ao suporte ativado


Se a sincronização dos Serviços de Aplicativos estiver habilitada e surgir um problema que
exija suporte do MongoDB, você poderá permitir que a equipe de suporte do MongoDB
tenha acesso por tempo limitado aos dados de sincronização dos Serviços de Aplicativos
em uma implantação de banco de dados em sua organização com o procedimento a seguir.

1
Navegue até a Visão Geral do Cluster.
Clique em Banco de dados próximo à parte superior do console do Atlas.

2
Localize a implantação de banco de dados à qual deseja conceder acesso na lista de
implantações de banco de dados.
3
Selecione o ícone de reticências (...) à direita da implantação do banco de dados.
4
Selecione Conceder acesso temporário à infraestrutura ao suporte do MongoDB.
Um modal Grant Infrastructure Access to MongoDB Support por 24 horas é exibido.

5
Selecione Conceder Dados de Sincronização de Infraestrutura e Serviços de Aplicativo para
conceder acesso temporário à infraestrutura e aos dados de sincronização ao Suporte do
MongoDB.
Quando você concede acesso temporário ao suporte do MongoDB com sucesso, um novo
item aparece no menu suspenso informando quando seu acesso expira.
Revogar o acesso temporário à infraestrutura para suporte do MongoDB
Se quiser revogar o acesso a uma implantação de banco de dados em sua organização que
recebeu acesso temporário à infraestrutura 24 horas por dia, você poderá fazer isso com o
procedimento a seguir.

IMPORTANTE
O acesso temporário à infraestrutura que não for revogado expirará automaticamente ao
final de 24 horas. O Atlas exibe um cronômetro que indica quanto tempo resta antes que o
acesso temporário à infraestrutura de 24 horas expire.

1
Navegue até a Visão Geral do Cluster.
Clique em Banco de dados próximo à parte superior do console do Atlas.

2
Localize a implantação de banco de dados à qual deseja conceder acesso na lista de
implantações de banco de dados.
3
Selecione o ícone de reticências (...) à direita da implantação do banco de dados.
4
Selecione Revogar acesso temporário à infraestrutura para suporte do MongoDB.
IMPORTANTE
Certifique-se de que todos os problemas que exigem suporte do MongoDB foram resolvidos
antes de revogar o acesso.

5
Clique em Revogar acesso.
Clique em Revogar acesso para revogar o acesso temporário à infraestrutura.
Migrar ou importar dados
Nesta página

MongoDB 6.0.8 e posterior: migração ao vivo para Atlas


Versões anteriores do MongoDB: Live Migrate to Atlas
Referência Adicional
Você pode trazer dados de implantações existentes do MongoDB, arquivos JSON ou CSV
para implantações no Atlas usando:

migração ao vivo onde o Atlas ajuda você, ou

ferramentas para uma migração autoguiada de dados de suas implantações existentes para
o Atlas.

MongoDB 6.0.8 e posterior: migração ao vivo para Atlas


Se os clusters de origem e de destino estiverem executando o MongoDB 6.0.8 ou posterior,
você poderá migrar seus dados de um cluster de origem para um cluster Atlas MongoDB
usando um dos seguintes tipos de migração em tempo real guiada na UI do Atlas:

Migração ao vivo (pull). Para obter instruções, consulte Live Migrate (Pull) de um cluster
MongoDB 6.0.8 ou posterior para o Atlas.

Migração ao vivo (push). Para obter instruções, consulte Live Migrate (Push) de um cluster
MongoDB 6.0.8 ou posterior monitorado pelo Cloud Manager para o Atlas.

Versões anteriores do MongoDB: Live Migrate to Atlas


Se você estiver migrando versões do MongoDB anteriores à 6.0.8, use um dos métodos de
migração a seguir, dependendo dos requisitos e da configuração da sua implantação.

Configuração do cluster de origem


Estratégia de Importação
Uma implantação do MongoDB executando o MongoDB anterior à versão 6.0.8 que não é
monitorada pelo Cloud Manager ou pelo Ops Manager.
Use a migração ao vivo (pull), onde o Atlas extrai dados da implantação de origem e requer
acesso à implantação de origem por meio do firewall da implantação.
Uma implantação do MongoDB executando o MongoDB anterior à versão 6.0.8 que é
monitorada pelo Cloud Manager ou pelo Ops Manager.
Use a migração ao vivo (push), onde o Cloud Manager ou o Ops Manager envia dados para
o Atlas usando um token de link seguro sem exigir acesso ao cluster de origem por meio do
firewall do cluster.

Para clusters de origem e destino que executam o MongoDB 6.0.8, a migração push ao vivo
está atualmente desabilitada. Ver
MongoDB 6.0.8 e posterior: migração ao vivo para Atlas.
Se seus clusters de origem e destino estiverem executando o MongoDB 6.0.8 ou posterior,
você poderá migrar em tempo real para o Atlas usando este procedimento.

Um cluster multilocatário compartilhado, ou um cluster onde você não tem acesso ao oplog,
ou um cluster que executa uma versão do MongoDB que não é mais suportada.
Use mongostore.
Um padrão "único
fragmento
"Implantação do cluster fragmentado do MongoDB no Compose.
Migre do Compose para o MongoDB Atlas.
Uma réplica definida na AWS.
Migre um conjunto de réplicas do MongoDB da AWS para o MongoDB Atlas.
Referência Adicional
Para mover dados para uma instância sem servidor,
use o Compass para exportar e importar dados
ou migre dados com ferramentas autogerenciadas. Para saber mais, consulte Limitações de
instância sem servidor.

Para carregar dados em um novo cluster no Atlas, consulte Carregar dados de exemplo.

Para fazer uma cópia do seu cluster para fins de teste, consulte
Métodos de backup do MongoDB.

Se o aplicativo que você deseja migrar exigir um tempo de atividade quase contínuo, entre
em contato com o suporte do MongoDB e compartilhe seus requisitos de tempo de atividade
e configuração do cluster.
Migração ao vivo (extração) de um cluster
MongoDB 6.0.8 ou posterior para o Atlas
Nesta página

Restrições
Caminho de migração
Pré-requisitos
Considerações
Migre seu cluster
Apoio à migração
IMPORTANTE
Recurso indisponível em instâncias sem servidor
As instâncias sem servidor não oferecem suporte a esse recurso no momento. Para saber
mais, consulte Limitações de instância sem servidor.

Se os clusters de origem e de destino estiverem executando o MongoDB 6.0.8 ou posterior,


o Atlas poderá efetuar pull de um cluster de origem para um cluster do Atlas usando o
procedimento descrito nesta seção.

Este processo usa


mongosync
como ferramenta de migração de dados subjacente, permitindo migrações em tempo real
mais rápidas e com menos tempo de inatividade:

O Atlas sincroniza dados do cluster de origem para o cluster de destino até que você
transfira seus aplicativos para o cluster Atlas de destino.

Depois de atingir a etapa de transição, siga o procedimento a seguir:

Pare as gravações no cluster de origem.

Pare as instâncias do seu aplicativo, aponte-as para o cluster Atlas e reinicie-as.

Restrições
Esta migração ao vivo tem as seguintes limitações:

O FCV para clusters de origem e destino é de pelo menos 6,0 e é o mesmo nos clusters de
origem e destino.

Você não pode executar este procedimento de migração ao vivo para clusters de origem ou
destino com versões do MongoDB anteriores ao MongoDB 6.0.8. Para saber mais, consulte
Notas de versão do servidor.

Este procedimento de migração ao vivo não oferece suporte a versões rápidas do


MongoDB, como 6.1 ou 6.2. Somente as principais versões do MongoDB, como 6.0.x (a
partir de 6.0.8 e posteriores) são suportadas. Para saber mais, consulte
Controle de versão do MongoDB.

Não é possível usar instâncias sem servidor como clusters de destino.

Não é possível selecionar um cluster compartilhado M0 (nível gratuito) ou M2/M5 como


origem ou destino para migração ao vivo. Para migrar dados de um cluster compartilhado
M0 (nível gratuito) ou M2/M5 para um cluster pago, altere o nível e o tipo do cluster.

Você não pode migrar em tempo real usando este procedimento de migração para um
cluster de destino Atlas que tenha o BI Connector for Atlas ativado.

Durante a migração ao vivo, o Atlas desativa alertas de host.

Coleções de séries temporais não são suportados. O processo de migração ignora qualquer
coleção de série temporal no cluster de origem.

Coleções agrupadas comexpireAfterSeconds set não são suportados.

Os comandos convertToCapped e cloneCollectionAsCapped não são suportados.

Se em seu cluster de origem você usou


aplicarOps operações, elas não serão suportadas no cluster de destino.

Documentos que possuem nomes de campos com prefixo de dólar ($) não são suportados.
Ver
Nomes de campos com pontos e cifrões.

Criptografia Consultável não é suportado.

Não é possível sincronizar uma coleção que tenha um índice exclusivo e um índice não
exclusivo definidos nos mesmos campos.

Dentro de uma coleção, o campo _id deve ser exclusivo em todos os fragmentos do cluster.
Para saber mais, consulte
Clusters fragmentados e índices exclusivos.

Você não pode usar o comando moverPrimário para reatribuir o fragmento primário durante
a execução deste processo de migração ao vivo.

Não é possível adicionar ou remover fragmentos durante a execução deste processo de


migração em tempo real.

Este processo de migração ao vivo migra apenas índices que existem em todos os
fragmentos e que possuem especificações consistentes em todos os fragmentos.

Você não pode refinar uma chave de fragmento durante a execução deste processo de
migração ao vivo.
Você não pode modificar a chave de fragmento usando rehardCollection durante este
processo de migração ao vivo.

O número máximo de índices de chave de fragmento é um abaixo do normal, 63 em vez de


64.

Não é possível usar esse processo de migração ao vivo para sincronizar um cluster de
origem com vários clusters de destino.

A compactação de rede não é compatível.

Este processo de migração ao vivo replica dados, não replica a configuração da zona.

Coleções do sistema não são replicados com este processo de migração em tempo real.

Se você emitir um
dropDatabase
comando no cluster de origem, essa alteração não será aplicada diretamente no cluster de
destino. Em vez disso, esse processo de migração ao vivo descarta coleções e
visualizações de usuários no banco de dados do cluster de destino, mas não descarta
coleções do sistema nesse banco de dados. Por exemplo, no cluster de destino, a operação
de descarte não afeta um arquivo criado pelo usuário
sistema.js
coleção. Se você ativar o perfil, o
sistema.perfil
resta a coleção. Se você criar visualizações no cluster de origem e, em seguida, descartar
o banco de dados, replicar a eliminação com esse processo de migração ao vivo removerá
as visualizações, mas deixará um campo vazio
visualizações do sistema
coleção. Nesses casos, a migração ao vivo dos resultados do dropDatabase remove do
banco de dados todas as coleções criadas pelo usuário, mas deixa as coleções do sistema
no cluster de destino.

A migração ao vivo (pull) não oferece suporte ao peering de VPC ou endpoints privados
para o cluster de origem ou de destino.

Caminho de migração
A migração ao vivo do Atlas descrita nesta seção oferece suporte aos seguintes caminhos
de migração:

Cluster de origem
Versão do MongoDB
Cluster Atlas de destino
Versão do MongoDB
6.0.8
6.0.8
7,0+
7,0+
Pré-requisitos
Se o cluster for executado com autenticação:

Para conjuntos de réplicas, conceda o


cópia de segurança
e
leiaAnyDatabase
funções no banco de dados admin para o usuário que executará o plano de migração
processo.

Para clusters fragmentados, conceda o


cópia de segurança
,
leiaAnyDatabase
,e
clusterMonitor
funções no banco de dados administrativo para o usuário que executará o processo de
migração.

Certifique-se de que este usuário esteja autenticado usando


ambos SCRAM-SHA-1 e SCRAM-SHA-256
. Para saber mais, consulte
Segurança do cluster de origem.

IMPORTANTE
Preparação do cluster de origem
Para ajudar a garantir uma migração de dados tranquila, o cluster de origem deve atender a
todas as recomendações do cluster de produção. Verifica a
Lista de verificação de operações
e
Notas de produção
antes de iniciar o processo de migração ao vivo.

Acesso à rede
Configure permissões de rede para os seguintes componentes:

O firewall do cluster de origem permite o tráfego do servidor de migração em tempo real


Quaisquer firewalls para o cluster de origem devem conceder ao servidor de migração ao
vivo do MongoDB acesso ao cluster de origem.

O processo de migração ao vivo do Atlas transmite dados por meio de um servidor de


migração ao vivo controlado pelo MongoDB. Atlas fornece os intervalos de IP dos
servidores de migração ao vivo do MongoDB durante o processo de migração ao vivo.
Conceda a esses intervalos de IP acesso ao cluster de origem. Isso permite que o servidor
de migração ao vivo do MongoDB se conecte aos clusters de origem.

OBSERVAÇÃO
Se sua organização tiver requisitos de rede rígidos e você não puder habilitar o acesso de
rede necessário aos servidores de migração ao vivo do MongoDB, consulte
Migração ao vivo de uma implantação comunitária para o Atlas.

Atlas Cluster permite tráfego de seus servidores de aplicativos


O Atlas permite conexões a um cluster a partir de hosts adicionados à lista de acesso IP do
projeto. Adicione os endereços IP ou blocos CIDR dos hosts do seu aplicativo à lista de
acesso IP do projeto. Faça isso antes de iniciar o procedimento de migração.

O Atlas adiciona temporariamente os endereços IP dos servidores de migração MongoDB à


lista de acesso IP do projeto. Durante o procedimento de migração, não é possível editar ou
excluir esta entrada. O Atlas remove esta entrada assim que o procedimento for concluído.

Para saber como adicionar entradas à lista de acesso IP do Atlas, consulte Configurar
entradas da lista de acesso IP.

Validação pré-migração
Antes de iniciar o seguinte procedimento de migração ao vivo, o Atlas executa verificações
de validação nos clusters de origem e destino e verifica se:

A versão do MongoDB do cluster de origem e de destino é pelo menos FCV 6.0 e


corresponde conforme descrito em
Restrições.

O usuário do banco de dados do cluster de origem tem as permissões corretas, conforme


descrito em
Segurança do cluster de origem.

Os clusters de origem e de destino são conjuntos de réplicas ou são clusters fragmentados


com o mesmo número de fragmentos.

Se o cluster de origem for independente, antes de usar esse processo de migração,


converter o autônomo em um conjunto de réplicas.

Se estiver migrando um cluster fragmentado para outro cluster fragmentado, o


O cluster fragmentado de origem deve usar CSRS (conjuntos de réplicas do Config Server).
Ver
Servidores de configuração do conjunto de réplicas.
Segurança do cluster de origem
Várias funções integradas fornecem privilégios suficientes. Por exemplo:

Para conjuntos de réplicas de origem executando o MongoDB 6.0.8 ou posterior, um usuário


do MongoDB deve ter o
leiaAnyDatabase
e
cópia de segurança
papéis.
Para clusters fragmentados de origem executando o MongoDB 6.0.8 ou posterior, um
usuário do MongoDB deve ter o
leiaAnyDatabase
,
cópia de segurança
,e
clusterMonitor
papéis.

Para verificar se o usuário do banco de dados que executará o processo de migração em


tempo real possui essas funções, execute o comando
db.getUser()
comando no banco de dados admin. Por exemplo, para um conjunto de réplicas, execute:

use admin
db.getUser("admin")
{
"_id" : "admin.admin",
"user" : "admin",
"db" : "admin",
"roles" : [
{
"role" : "backup",
"db" : "admin"
},
{
"role" : "readAnyDatabase",
"db" : "admin"
}
]
} ...

Especifique o nome de usuário e a senha do Atlas quando solicitado na tela passo a passo
do procedimento de migração ao vivo.

Atlas suporta apenas


SCRAM
para conexão com clusters de origem que impõem autenticação.

Como o MongoDB protege seus servidores de migração ativos


Em qualquer migração ao vivo do tipo pull para o Atlas, o Atlas gerencia o servidor que
executa a migração ao vivo e envia dados do cluster de origem para o cluster de destino.

O MongoDB toma as seguintes medidas para proteger a integridade e a confidencialidade


dos seus dados em trânsito para o Atlas:
O MongoDB criptografa dados em trânsito entre o servidor de migração ao vivo gerenciado
pelo Atlas e o cluster de destino. Se você precisar de criptografia para dados em trânsito
entre o cluster de origem e o servidor de migração gerenciado pelo Atlas, configure o TLS
no cluster de origem.

O MongoDB protege o acesso às instâncias do servidor de migração gerenciado pelo Atlas,


assim como protege o acesso a quaisquer outras partes do Atlas.

Em raros casos em que é necessária intervenção para investigar e restaurar serviços


críticos, o MongoDB adere ao princípio do menor privilégio e autoriza apenas um pequeno
grupo de usuários privilegiados a acessar seus clusters Atlas por um tempo mínimo limitado
necessário para reparar o problema crítico. O MongoDB requer MFA para que esses
usuários façam login nos clusters Atlas e estabeleçam uma conexão SSH por meio do host
bastião. A concessão deste tipo de acesso de usuário privilegiado requer aprovação da alta
administração do MongoDB. MongoDB não permite acesso por nenhum outro seu pessoal
do MongoDB para seus clusters do MongoDB Atlas.

O MongoDB permite o uso de contas de usuários privilegiados apenas para atividades


privilegiadas. Para realizar atividades não privilegiadas, os usuários privilegiados devem
usar uma conta separada. Contas de usuários privilegiados não podem usar credenciais
compartilhadas. As contas de usuários privilegiados devem seguir os requisitos de senha
descritos na Seção 4.3.3 do
Segurança Atlas
papel branco.

Você pode restringir o acesso aos seus clusters por todo o pessoal do MongoDB, incluindo
usuários privilegiados, no Atlas. Se você optar por restringir esse acesso e o MongoDB
determinar que o acesso é necessário para resolver um problema de suporte, o MongoDB
deverá primeiro solicitar sua permissão e você poderá então decidir se deseja restaurar
temporariamente o acesso de usuário privilegiado por até 24 horas. Você pode revogar a
concessão de acesso temporário de 24 horas a qualquer momento. Ativar esta restrição
pode resultar num aumento do tempo de resposta e resolução de problemas de suporte e,
como resultado, pode impactar negativamente a disponibilidade dos seus clusters Atlas.

O MongoDB analisa trimestralmente a autorização de acesso de usuários privilegiados.


Além disso, o MongoDB revoga o acesso de um usuário privilegiado quando ele não for
mais necessário, inclusive dentro de 24 horas após esse usuário privilegiado mudar de
função ou sair da empresa. Também registramos qualquer acesso do pessoal do MongoDB
aos clusters do Atlas, retemos logs de auditoria por pelo menos seis anos e incluímos
carimbo de data/hora, ator, ação e saída. O MongoDB usa uma combinação de revisões
automatizadas e manuais para verificar esses logs de auditoria.

Para saber mais sobre a segurança do Atlas, consulte o


Segurança Atlas
papel branco. Em particular, revise a seção "Acesso de pessoal do MongoDB aos clusters
do MongoDB Atlas".

Considerações
Criptografia de rede
Durante as migrações pull ao vivo, se o cluster de origem não usar criptografia TLS para
seus dados, o tráfego do cluster de origem para o Atlas não será criptografado. Determine
se isso é aceitável antes de iniciar um procedimento de migração pull em tempo real.

Usuários e funções do banco de dados


O Atlas não migra nenhum dado de usuário ou função para o cluster de destino.

Se o cluster de origem não usar autenticação, você deverá criar um usuário no Atlas porque
o Atlas não dá suporte à execução sem autenticação.

Se o cluster de origem impor autenticação, você deverá recriar as credenciais que seus
aplicativos usam no cluster Atlas de destino. Atlas usa
SCRAM
para autenticação do usuário. Para saber mais, consulte Configurar usuários do banco de
dados.

Configuração do Cluster de Destino


Ao configurar o cluster de destino, considere o seguinte:

O processo de migração ao vivo transmite dados por meio de um servidor de migração ao


vivo gerenciado pelo MongoDB. Cada servidor é executado em infraestrutura hospedada na
região mais próxima do cluster de origem. As seguintes regiões estão disponíveis:

Europa
Francoforte

Irlanda

Londres

Américas
Leste dos EUA

Oeste dos EUA

APAC
Bombaim

Cingapura

Sidney

Tóquio

Use a região de nuvem para o cluster de destino no Atlas que tem a latência de rede mais
baixa em relação aos servidores de aplicativos ou à sua implantação hospedada no cluster
de origem. Idealmente, os servidores da sua aplicação devem estar em execução na
nuvem, na mesma região que a região primária do cluster Atlas de destino. Para saber
mais, consulte Provedores de nuvem.

Devido à latência da rede, o processo de migração em tempo real pode não conseguir
acompanhar um cluster de origem que tenha uma carga de gravação extremamente
pesada. Nessa situação, você ainda pode migrar diretamente do cluster de origem
apontando a ferramenta mongomirror para o cluster Atlas de destino.

O cluster de destino no Atlas deve corresponder ou exceder a implantação de origem em


termos de RAM, CPU e armazenamento. Provisione um cluster de destino de tamanho
adequado para que ele possa acomodar o processo de migração e a carga de trabalho
esperada ou aumente a escala do cluster de destino para uma camada com mais poder de
processamento, largura de banda ou E/S de disco.

Para maximizar o desempenho da migração, utilize pelo menos um cluster M40 para o
cluster de destino. Ao migrar grandes conjuntos de dados, use um cluster M80 com discos
de 6.000 IOPS ou superiores.

Você também pode optar por aumentar temporariamente o tamanho do cluster Atlas de
destino durante o processo de migração. Depois de migrar a carga de trabalho do seu
aplicativo para um cluster no Atlas, entre em contato com o suporte para obter assistência
com ajuste adicional de desempenho e dimensionamento do cluster de destino para
minimizar custos.

Para evitar alterações inesperadas de dimensionamento, desative o escalonamento


automático no cluster de destino. Para saber mais, consulte Gerenciar clusters.

Para evitar o crescimento ilimitado da coleção de oplogs, defina um tamanho fixo de oplog
durante o processo de migração em tempo real. Para saber mais, consulte Acesso
necessário e opções de configuração do Atlas. Se você observar problemas de
desempenho mesmo depois de seguir essas recomendações, entre em contato com o
suporte.

Os clusters de origem e de destino são conjuntos de réplicas ou são clusters fragmentados


com o mesmo número de fragmentos.

Não é possível selecionar um cluster de nível compartilhado M0 (nível gratuito) ou M2/M5


como cluster de destino para migração ao vivo.

Não mude o recurso sinalizador reCompatibilityVersion enquanto a migração ao vivo do


Atlas está em execução.

Evite cargas de trabalho no cluster de destino


Evite executar quaisquer cargas de trabalho, incluindo aquelas que possam estar em
execução em namespaces que não se sobrepõem ao processo de migração ao vivo, no
cluster de destino. Esta ação evita potenciais conflitos de bloqueio e degradação do
desempenho durante o processo de migração em direto.
Não execute várias migrações para o mesmo cluster de destino ao mesmo tempo.

Não inicie o processo de transferência dos seus aplicativos para o cluster de destino
enquanto o processo de migração ao vivo estiver sincronizando.

Evite backups na nuvem


O Atlas para de tirar snapshots de backup em nuvem sob demanda do cluster de destino
durante a migração ao vivo. Depois de concluir a etapa de transição no procedimento de
migração ao vivo nesta página, o Atlas retoma a obtenção de snapshots de backup na
nuvem com base em sua política de backup.

Evite eleições
O processo de migração em tempo real faz o melhor possível para continuar uma migração
durante interrupções temporárias da rede e eleições nos clusters de origem ou de destino.
No entanto, esses eventos podem causar falha no processo de migração em tempo real. Se
o processo de migração ao vivo não puder ser recuperado automaticamente, reinicie-o
desde o início.

Migre seu cluster


OBSERVAÇÃO
Migrações de preparação e produção
Considere executar este procedimento duas vezes. Execute uma migração parcial que pare
primeiro na etapa Executar a substituição. Isso cria um cluster de teste atualizado apoiado
pelo Atlas para testar o comportamento e o desempenho do aplicativo usando o mais
recente
versão do driver
que suporta a versão MongoDB do cluster Atlas.

Depois de testar seu aplicativo, execute o procedimento completo de migração usando um


cluster Atlas separado para criar seu ambiente de produção apoiado pelo Atlas.

Lista de verificação pré-migração


Antes de iniciar o processo de importação:

Se ainda não tiver um cluster de destino, crie uma nova implantação do Atlas e configure-a
conforme necessário. Para obter documentação completa sobre a criação de um cluster
Atlas, consulte Criar um cluster.

Após a implantação do cluster Atlas, certifique-se de que você possa se conectar a ele a
partir de todo o hardware cliente onde seus aplicativos são executados. Testar sua cadeia
de conexão ajuda a garantir que seu processo de migração de dados possa ser concluído
com tempo de inatividade mínimo.

Baixar e instalar
mangusto
em uma máquina cliente representativa, caso ainda não a tenha.
Conecte-se ao cluster de destino usando a cadeia de conexão da UI do Atlas. Para obter
mais informações, consulte Conectar via mongosh.

Depois de verificar sua conectividade com o cluster de destino, inicie o procedimento de


migração em tempo real.

Procedimento
1
Inicie o processo de migração.
Inicie o processo de migração de uma das seguintes maneiras:

No painel esquerdo da página da sua organização, clique em Live Migration e escolha


Select Cluster for General Live Migration, ou

Navegue até o cluster Atlas de destino e clique no botão de reticências.... Na lista de


clusters, o botão de reticências ... aparece abaixo do nome do cluster. Ao visualizar os
detalhes do cluster, as reticências ... aparecem no lado direito da tela, próximo aos botões
Conectar e Configuração.

Clique em Migrar dados para este cluster.

O Atlas exibe uma tela passo a passo com instruções sobre como proceder com a migração
ao vivo. O processo sincroniza os dados do cluster de origem com o novo cluster de
destino. Depois de concluir o passo a passo, você poderá apontar seu aplicativo para o
novo cluster.

Você precisará dos seguintes detalhes do cluster de origem para facilitar a migração:

Para conjuntos de réplicas, o nome do host e a porta do cluster de origem


primário
. Por exemplo, mongoPrimary.example.net:27017.

Para clusters fragmentados, o nome do host e a porta de cada


mongos
em cada fragmento. Por exemplo, mongos.example.net:27017.

O nome de usuário e a senha de autenticação do banco de dados usados para conectar-se


ao cluster de origem. Para conjuntos de réplicas, o usuário do banco de dados deve ter o
leiaAnyDatabase
e
cópia de segurança
papéis. Para clusters fragmentados, o usuário do banco de dados deve ter o
leiaAnyDatabase
,
cópia de segurança
,e
clusterMonitor
papéis.
Se o cluster de origem usar TLS/SSL e não estiver usando uma autoridade de certificação
(CA) pública, você precisará do arquivo CA do cluster de origem.

Prepare as informações conforme indicado na tela passo a passo e clique em Estou pronto
para migrar.

O Atlas exibe uma tela passo a passo que coleta as informações necessárias para se
conectar ao cluster de origem.

O Atlas exibe o endereço IP do servidor de migração ao vivo do MongoDB responsável pela


sua migração ao vivo na parte superior da tela passo a passo. Configure o firewall do cluster
de origem para conceder acesso ao endereço IP exibido.

Para conjuntos de réplicas, insira o nome do host e a porta do membro primário do cluster
de origem na caixa de texto fornecida. Para clusters fragmentados, insira o nome do host e
a porta de cada
mongos.

Se o cluster de origem impor autenticação, insira um nome de usuário e uma senha nas
caixas de texto fornecidas.

Ver
Segurança do cluster de origem
para obter orientação sobre as permissões de usuário exigidas pela migração ao vivo do
Atlas.

Se o cluster de origem usar TLS/SSL e não estiver usando um Autoridade de certificação


(CA) pública, alterne a opção A criptografia em trânsito está habilitada? e copie o conteúdo
do arquivo CA do cluster de origem na caixa de texto fornecida.

Se você deseja descartar todas as coleções no cluster de destino antes de iniciar o


processo de migração, alterne a opção Excluir dados existentes no cluster de destino?

Clique em Validar para confirmar se o Atlas pode se conectar ao cluster de origem.

Se a validação falhar, verifique se:

Você tem
adicionado
Atlas para a lista de acesso IP em seu cluster de origem.

As credenciais de usuário fornecidas, se houver, existem no cluster de origem e possuem


as permissões necessárias.

A mensagem A criptografia em trânsito está habilitada? a alternância será habilitada


somente se o cluster de origem exigir isso.
O arquivo CA fornecido, se houver, é válido e correto.

Clique em Iniciar migração para iniciar o processo de migração.

Assim que o processo de migração começar, a UI do Atlas exibirá a tela passo a passo
Migrando dados para o cluster Atlas de destino. A tela passo a passo é atualizada à medida
que o cluster de destino prossegue no processo de migração. O processo de migração
inclui:

Aplicar novas gravações nos dados do cluster de origem aos dados do cluster de destino.

Copiando dados do cluster de origem para o cluster de destino.

Finalizando a migração no cluster de destino.

Um valor de tempo de atraso é exibido durante a fase final do processo de migração que
representa o atraso atual entre os clusters de origem e de destino.

Você receberá uma notificação por e-mail quando a janela de expiração estiver quase
acabando.

Quando o temporizador e o botão Preparar para transição ficarem verdes, prossiga para a
próxima etapa.

2
Execute a transição.
Quando o Atlas detecta que os clusters de origem e destino estão quase sincronizados, ele
inicia um cronômetro extensível de 120 horas (5 dias) para iniciar o estágio de transição do
procedimento de migração ao vivo. Após o período de 120 horas, o Atlas para de
sincronizar com o cluster de origem. Você pode estender o tempo restante em 24 horas
clicando em Prolongar tempo abaixo do <tempo> restante para interromper o cronômetro.

Clique em Preparar para transição. O Atlas exibe uma tela passo a passo que informa: Sua
migração está quase concluída! A tela passo a passo exibe as seguintes instruções sobre
como proceder com o processo de transição:

Pare seu aplicativo. Isso garante que não ocorram mais gravações no cluster de origem.

Aguarde até que a lacuna ideal chegue a zero. Quando o contador chega a zero, os clusters
de origem e de destino estão sincronizados.

Marque a caixa que diz: Confirmo que estou pronto para transferir o aplicativo para o cluster
de destino. Ao prosseguir, a Atlas finalizará a migração. Este processo levará alguns
segundos. Quando estiver concluído, você poderá apontar seu aplicativo para o cluster de
destino e começar a gravar nele.

Clique em Corte. Atlas conclui a migração e exibe a página Connect.


Decida quando retomar as gravações no cluster de destino. Você pode fazer o seguinte:

Aguarde até que o banner no cartão do cluster indique: A migração do cluster foi concluída
e, em seguida, retome as gravações no cluster de destino. Se você optar por aguardar a
conclusão da migração, seu aplicativo sofrerá uma pausa temporária nas gravações durante
o período necessário para finalizar a migração.

ou

Comece as gravações do aplicativo no cluster de destino sem esperar a conclusão da


migração, enquanto o banner do cartão do cluster indica: Seu cluster de destino no Atlas
está pronto para aceitar gravações, mas ainda estamos finalizando a migração. Se você
optar por mover gravações para o cluster de destino sem esperar até o final do processo de
migração, e a migração em tempo real falhar nos estágios finais e emitir um erro, você
deverá redirecionar as gravações de volta para o cluster de origem e reiniciar o processo de
migração em tempo real.

Quando você estiver pronto para redirecionar gravações para o cluster de destino no Atlas:

Use a cadeia de conexão do cluster de destino para se conectar ao seu aplicativo.

Confirme se seu aplicativo está funcionando com o cluster Atlas de destino.

Atlas executa estas ações para concluir o processo:

Remove as sub-redes do servidor de migração ao vivo MongoDB da lista de acesso IP no


cluster de destino.

Remove o usuário do banco de dados que a migração ao vivo usou para importar dados
para o cluster de destino.

Marca o processo de migração como concluído.

Apoio à migração
Se você tiver alguma dúvida sobre o suporte à migração além do que é abordado nesta
documentação ou se encontrar um erro durante a migração, solicite suporte por meio da UI
do Atlas.

Para registrar um ticket de suporte:

Clique em Suporte na navegação à esquerda.

Clique em Solicitar suporte.

Para Categoria do Problema, selecione Ajuda com migração em tempo real.

Para Prioridade, selecione a prioridade apropriada. Para perguntas, selecione Prioridade


Média. Se houve uma falha na migração, selecione Alta Prioridade.
Para Resumo da solicitação, inclua Migração ao vivo em seu resumo.

Para obter mais detalhes, inclua quaisquer outros detalhes relevantes à sua pergunta ou
erro de migração.

Clique no botão Solicitar suporte para enviar o formulário.


Migração ao vivo (envio) de um cluster
MongoDB 6.0.8 ou posterior monitorado pelo
Cloud Manager para o Atlas
Nesta página

Restrições
Caminho de migração e plataformas suportadas
Pré-requisitos
Considerações
Migre seu cluster
APIs de migração push ao vivo
Enviar comandos CLI de migração ao vivo
Apoio à migração
Se os clusters de origem e de destino estiverem executando o MongoDB 6.0.8 ou posterior,
e o Cloud Manager monitorar o cluster de origem, o Atlas poderá enviar um cluster de
origem para um cluster do Atlas usando o procedimento descrito nesta seção.

Este processo usa


mongosync
como ferramenta de migração de dados subjacente, permitindo migrações em tempo real
mais rápidas e com menos tempo de inatividade:

O Atlas sincroniza dados do cluster de origem para o cluster de destino até que você
transfira seus aplicativos para o conjunto de réplicas do Atlas de destino.

Depois de atingir a etapa de transição, siga o procedimento a seguir:

Pare as gravações no cluster de origem.

Pare as instâncias do seu aplicativo, aponte-as para o cluster Atlas e reinicie-as.

Restrições
Esta migração ao vivo tem as seguintes limitações:

O FCV para clusters de origem e destino é de pelo menos 6,0 e é o mesmo nos clusters de
origem e destino.

Você não pode executar este procedimento de migração ao vivo para clusters de origem ou
destino com versões do MongoDB anteriores ao MongoDB 6.0.8. Para saber mais, consulte
Notas de versão do servidor.

Este procedimento de migração ao vivo não oferece suporte a versões rápidas do


MongoDB, como 6.1 ou 6.2. Somente as principais versões do MongoDB, como 6.0.x (a
partir de 6.0.8 e posteriores) são suportadas. Para saber mais, consulte
Controle de versão do MongoDB.
Não é possível usar instâncias sem servidor como clusters de destino.

Não é possível selecionar um cluster compartilhado M0 (nível gratuito) ou M2/M5 como


origem ou destino para migração ao vivo. Para migrar dados de um cluster compartilhado
M0 (nível gratuito) ou M2/M5 para um cluster pago, altere o nível e o tipo do cluster.

Você não pode migrar em tempo real usando este procedimento de migração para um
cluster de destino Atlas que tenha o BI Connector for Atlas ativado.

Durante a migração ao vivo, o Atlas desativa alertas de host.

Coleções de séries temporais


não são suportados. O processo de migração ignora qualquer coleção de série temporal
no cluster de origem.

Coleções agrupadas com expireAfterSeconds set não são suportados.

E os comandos convertToCapped e cloneCollectionAsCapped não são suportados.

Se em seu cluster de origem você usou operações aplicarOps, elas não serão suportadas
no cluster de destino.

Documentos que possuem nomes de campos com prefixo de dólar ($) não são suportados.
Ver
Nomes de campos com pontos e cifrões.

Criptografia Consultável não é suportado.

Não é possível sincronizar uma coleção que tenha um índice exclusivo e um índice não
exclusivo definidos nos mesmos campos.

Dentro de uma coleção, o campo _id deve ser exclusivo em todos os fragmentos do cluster.
Para saber mais, consulte Clusters fragmentados e índices exclusivos.

Você não pode usar o comando moverPrimário para reatribuir o fragmento primário durante
a execução deste processo de migração ao vivo.

Não é possível adicionar ou remover fragmentos durante a execução deste processo de


migração em tempo real.

Este processo de migração ao vivo migra apenas índices que existem em todos os
fragmentos e que possuem especificações consistentes em todos os fragmentos.

Você não pode


refinar
uma chave de fragmento durante a execução deste processo de migração ao vivo.
Você não pode modificar a chave de fragmento usando
rehardCollection
durante este processo de migração ao vivo.

O número máximo de
índices de chave de fragmento
é um abaixo do normal, 63 em vez de 64.

Não é possível usar esse processo de migração ao vivo para sincronizar um cluster de
origem com vários clusters de destino.

A compactação de rede não é compatível.

Este processo de migração ao vivo replica dados, não replica a configuração da zona.

Coleções do sistema
não são replicados com este processo de migração em tempo real.

Se você emitir um comando dropDatabase no cluster de origem, essa alteração não será
aplicada diretamente no cluster de destino. Em vez disso, esse processo de migração ao
vivo descarta coleções e visualizações de usuários no banco de dados do cluster de
destino, mas não descarta coleções do sistema nesse banco de dados. Por exemplo, no
cluster de destino, a operação de descarte não afeta um arquivo criado pelo usuário
sistema.js coleção. Se você ativar o perfil, o sistema.perfil resta a coleção. Se você criar
visualizações no cluster de origem e, em seguida, descartar o banco de dados, replicar a
eliminação com esse processo de migração ao vivo removerá as visualizações, mas deixará
um campo vazio visualizações do sistema coleção. Nesses casos, a migração ao vivo dos
resultados do dropDatabase remove do banco de dados todas as coleções criadas pelo
usuário, mas deixa as coleções do sistema no cluster de destino.

Suporte para peering de VPC e endpoints privados


A tabela a seguir lista o status de suporte atual para peering de VPC e endpoints privados
para clusters de origem e destino que você migra em tempo real para o Atlas. Selecione a
guia para conjuntos de réplicas ou clusters fragmentados.

Conjuntos de réplicas

Clusters fragmentados
Provedor de nuvem
Pareamento de VPC
Pontos finais privados
Azul

AWS

Google Nuvem
Caminho de migração e plataformas suportadas
A migração ao vivo do Cloud Manager para o Atlas é compatível com todas as plataformas
nas quais você pode provisionar um host para
mongosync
. Para obter uma lista completa de plataformas suportadas nas quais você pode provisionar
um host para
mongosync
, ver
plataformas mongosync
.

A migração ao vivo do Atlas (push) oferece suporte aos seguintes caminhos de migração:

Cluster de origem
Versão do MongoDB
Cluster Atlas de destino
Versão do MongoDB
6.0.8
6.0.8
7,0+
7,0+
Pré-requisitos
Antes de iniciar a migração push ao vivo de um cluster executando o MongoDB 6.0.8 ou
posterior monitorado no Cloud Manager para Atlas:

Atualize o cluster de origem para MongoDB 6.0.8 ou posterior.

Crie uma conta Atlas.

Crie uma organização Atlas e, em seguida, crie um projeto nesta organização.

Certifique-se de ter a função de proprietário da organização Atlas.

Implante seu cluster neste projeto.

Conecte-se ao seu cluster a partir de todos os servidores clientes onde seus aplicativos são
executados.

Considere configurar uma conexão de peering de VPC ou um endpoint privado entre cada
host de migração e o cluster Atlas de destino no mesmo provedor de nuvem e na mesma
região que o cluster de destino.

OBSERVAÇÃO
Se você optar por não usar peering de VPC ou endpoints privados ao migrar conjuntos de
réplicas, o processo de migração em tempo real será executado em endereços IP públicos
adicionados à lista de acesso IP do projeto Atlas como parte do procedimento de migração
em tempo real nesta seção.
No cluster de origem no Cloud Manager,
provisionar um host de migração
no Gerenciador de nuvem.

O nome de usuário e a senha usados para conectar-se ao cluster de origem.

Se você não estiver usando um ponto final privado entre o host de migração e o cluster
Atlas de destino, obtenha os endereços IP externos ou blocos CIDR dos hosts de migração
provisionados no Cloud Manager com seu administrador do Cloud Manager.

Se o cluster de origem usar TLS/SSL com uma autoridade de certificação raiz


personalizada, para garantir que os hosts possam ler o certificado, adicione o arquivo CA do
cluster de origem aos hosts de migração.

Durante o processo de migração ao vivo, o Atlas valida que pode coletar estatísticas do
banco de dados MongoDB usando
dbStats
. Antes de migrar para um cluster Atlas,
revise as configurações do projeto
para o cluster de origem no Cloud Manager e certifique-se de que a opção Coletar
estatísticas específicas do banco de dados esteja ativada. Esta opção está habilitada por
padrão no Cloud Manager e deve permanecer habilitada para que o processo de migração
passe na validação.

Fluxo de trabalho de migração ao vivo


Esta seção descreve o fluxo de trabalho. Para etapas detalhadas, consulte o
procedimento para migrar um cluster do Cloud Manager para o Atlas.

"Para migrar sua implantação para o Atlas, gere um token de link,


provisionar um host de migração e iniciar a migração em tempo real."
As etapas do fluxo de trabalho de migração ao vivo são:

Etapa 1: Link com Atlas. Execute esta etapa no Atlas, depois de criar sua conta,
organização e projeto do Atlas; implantou seu cluster dedicado neste projeto; e pode se
conectar a ele.

Na organização Atlas, acesse Live Migration.

Selecione Migrar do Cloud Manager e inicie o assistente de migração em tempo real.

Estágio 2: Provisionar Host de Migração.

provisionar um host de migração


no Gerenciador de nuvem. Um host de migração executa um agente MongoDB dedicado
que orquestra o processo de migração ao vivo do Cloud Manager para o Atlas.

OBSERVAÇÃO
Se você estiver migrando uma implantação de origem do MongoDB que nunca usou o
Cloud Manager antes,
adicione processos existentes do MongoDB ao Cloud Manager.

Na seção Live Migration: Connect to Atlas da página Configurações da sua organização do


Cloud Manager, selecione Connect to Atlas e cole o token de link que você criou no Atlas.
Para saber mais, consulte
Conecte-se ao Atlas para migração ao vivo
no Gerenciador de nuvem.

Etapa 3: iniciar a migração. No Atlas, siga as etapas do assistente para iniciar o processo
de migração em tempo real.

Endereço IP externo do host de migração no Cloud Manager


Antes de iniciar o procedimento de migração em tempo real, adicione os endereços IP ou
blocos CIDR dos seus hosts de migração à lista de acesso IP do projeto. O Atlas permite
conexões com o cluster de destino apenas a partir de hosts com entradas na lista de acesso
do projeto.

Validação pré-migração
Antes de iniciar o procedimento de migração ao vivo, o Atlas executa verificações de
validação nos clusters de origem e destino.

A versão do MongoDB do cluster de origem e de destino é pelo menos FCV 6.0 e


corresponde conforme descrito em Restrições.

O usuário do banco de dados do cluster de origem tem as permissões corretas, conforme


descrito em Segurança do cluster de origem.

Os clusters de origem e de destino são conjuntos de réplicas ou são clusters fragmentados


com o mesmo número de fragmentos.

Se o cluster de origem for independente, antes de usar esse processo de migração,


converter o autônomo em um conjunto de réplicas.

Se estiver migrando um cluster fragmentado para outro cluster fragmentado, o cluster


fragmentado de origem deverá usar CSRS (Config Server Replica Sets). Ver
Servidores de configuração do conjunto de réplicas.

O cluster de origem permite coletar estatísticas de banco de dados para seu projeto no
Cloud Manager. Isso permite que o Atlas colete estatísticas do banco de dados MongoDB
durante o processo de migração ao vivo. Para confirmar se a opção Coletar estatísticas
específicas do banco de dados está habilitada, revise as configurações do projeto para a
fonte cluster no Cloud Manager.

O cluster Atlas de destino não tem o BI Connector for Atlas habilitado.

Segurança do cluster de origem


Várias funções integradas fornecem privilégios suficientes. Por exemplo:

Para conjuntos de réplicas de origem executando o MongoDB 6.0.8 ou posterior, um usuário


do MongoDB deve ter o
leiaAnyDatabase
e
cópia de segurança
papéis.

Para clusters fragmentados de origem executando o MongoDB 6.0.8 ou posterior, um


usuário do MongoDB deve ter o
leiaAnyDatabase
,
cópia de segurança
,e
clusterMonitor
papéis.

Para verificar se o usuário do banco de dados que executará o processo de migração em


tempo real possui essas funções, execute o comando
db.getUser()
comando no banco de dados admin. Por exemplo, para um conjunto de réplicas, execute:

usar administrador
db.getUser("admin")
{
"_id": "admin.admin",
"usuário": "administrador",
"db": "administrador",
"papéis": [
{
"papel": "backup",
"db": "administrador"
},
{
"role": "readAnyDatabase",
"db": "administrador"
}
]
} ...

Especifique o nome de usuário e a senha do Atlas quando solicitado na tela passo a passo
do procedimento de migração ao vivo.

Atlas suporta apenas


SCRAM
para conexão com clusters de origem que impõem autenticação.
Requisitos de segurança para o host de migração
Para migrações ao vivo do tipo push, você é responsável por provisionar, proteger e
executar o host de migração. O host de migração criptografa apenas a comunicação de
saída com clusters Atlas.

Para saber mais sobre a segurança do Atlas, consulte o


Segurança Atlas
papel branco.

Considerações
Criptografia de rede
Durante migrações push ao vivo, se o cluster de origem não usar criptografia TLS para seus
dados, o tráfego do cluster de origem para o host de migração não será criptografado, mas
o tráfego do host de migração para o Atlas será criptografado. Determine se isso é aceitável
antes de iniciar um procedimento de migração push ao vivo.

Usuários e funções do banco de dados


Se o cluster de origem não usar autenticação, você deverá criar um usuário no Atlas porque
o Atlas não dá suporte à execução sem autenticação.

O Atlas não migra nenhum dado de usuário ou função para o cluster de destino.

Se o cluster de origem impôs autenticação, antes de migrar você deverá recriar o


mecanismo de autenticação apropriado usado por seus aplicativos no cluster Atlas de
destino. A tabela a seguir lista os mecanismos de autenticação e como configurá-los no
Atlas.

Mecanismo de Autenticação
Método de configuração
SCRAM
Crie usuários de banco de dados com SCRAM para autenticação por senha.
LDAP

Configure o LDAP.
AWS KMS, Azure Key Vault, Google Cloud KMS
Configure a criptografia KMS.
Configuração do Cluster de Destino
Para o cluster de destino, aplicam-se as seguintes considerações:

Os clusters de origem e de destino são conjuntos de réplicas ou são clusters fragmentados


com o mesmo número de fragmentos.

Não é possível selecionar um cluster de nível compartilhado M0 (nível gratuito) ou M2/M5


como destino para migração ao vivo.

O cluster de destino no Atlas deve corresponder ou exceder a implantação de origem em


termos de RAM, CPU e armazenamento. Provisione um cluster de destino de tamanho
adequado para que ele possa acomodar o processo de migração e a carga de trabalho
esperada ou aumente a escala do cluster de destino para uma camada com mais poder de
processamento, largura de banda ou E/S de disco.

Para maximizar o desempenho da migração, utilize pelo menos um cluster M40 para o
cluster de destino. Ao migrar grandes conjuntos de dados, use um cluster M80 com discos
de 6.000 IOPS ou superiores.

Você também pode optar por aumentar temporariamente o tamanho do cluster Atlas de
destino durante o processo de migração. Depois de migrar a carga de trabalho do seu
aplicativo para um cluster no Atlas, entre em contato com o suporte para obter assistência
com ajuste adicional de desempenho e dimensionamento do cluster de destino para
minimizar custos.

Para evitar alterações inesperadas de dimensionamento, desative o escalonamento


automático no cluster de destino. Para saber mais, consulte Gerenciar clusters.

Para evitar o crescimento ilimitado da coleção de oplogs, defina um tamanho fixo de oplog
durante o processo de migração em tempo real. Para saber mais, consulte Acesso
necessário e opções de configuração do Atlas. Se você observar problemas de
desempenho mesmo depois de seguir essas recomendações, entre em contato com o
suporte.

Não altere o sinalizador featureCompatibilityVersion enquanto a migração ao vivo do Atlas


estiver em execução.

Evite cargas de trabalho no cluster de destino


Evite executar quaisquer cargas de trabalho, incluindo aquelas que possam estar em
execução em namespaces que não se sobrepõem ao processo de migração ao vivo, no
cluster de destino. Esta ação evita potenciais conflitos de bloqueio e degradação do
desempenho durante o processo de migração em direto.

Não execute várias migrações para o mesmo cluster de destino ao mesmo tempo.

Não inicie o processo de transferência dos seus aplicativos para o cluster de destino
enquanto o processo de migração ao vivo estiver sincronizando.

Evite backups na nuvem


O Atlas para de tirar snapshots de backup em nuvem sob demanda do cluster de destino
durante a migração ao vivo. Depois de concluir a etapa de transição no procedimento de
migração ao vivo nesta página, o Atlas retoma a obtenção de snapshots de backup na
nuvem com base em sua política de backup.

Evite alterações de namespace


Não faça alterações no namespace durante o processo de migração, como usar o
renomearCollection
comando ou executando um pipeline de agregação que inclui o
$ fora
fase de agregação.
Evite eleições
O processo de migração em tempo real faz o melhor possível para continuar uma migração
durante interrupções temporárias da rede e eleições nos clusters de origem ou de destino.
No entanto, esses eventos podem causar falha no processo de migração em tempo real. Se
o processo de migração ao vivo não puder ser recuperado automaticamente, reinicie-o
desde o início.

Reinicializações contínuas
Após a conclusão do processo de migração, o cluster reinicia cada um dos membros, um de
cada vez. Isso é chamado de reinicialização contínua e, como consequência, ocorrerá um
failover no primário. Para garantir uma migração tranquila, considere executar um
procedimento Testar Failover Primário antes de migrar seus dados para o cluster de destino.

Ambientes de preparação e produção


Considere executar o procedimento a seguir duas vezes. Execute uma migração parcial que
pare primeiro na etapa Executar a substituição. Isso cria um cluster de teste atualizado
apoiado pelo Atlas para testar o comportamento e o desempenho do aplicativo usando o
mais recente
versão do driver
que suporta a versão MongoDB do cluster Atlas.

Depois de testar seu aplicativo, execute o procedimento completo de migração usando um


cluster Atlas separado para criar seu ambiente de produção apoiado pelo Atlas.

Migre seu cluster


IMPORTANTE
Evite fazer alterações na configuração do cluster de origem enquanto o procedimento de
migração em tempo real é executado, como remover membros do conjunto de réplicas ou
modificar
mondeus
configurações de tempo de execução, como featureCompatibilityVersion.

Procedimento
1
Inicie o processo de migração.
No painel esquerdo da página da sua organização, clique em Live Migration.

Clique em Migrar do Ops Manager ou Cloud Manager.

OBSERVAÇÃO
O rótulo da UI menciona o Ops Manager, no entanto, para este procedimento, você só pode
migrar para implantações do Atlas MongoDB 6.0.8 ou posterior que o Cloud Manager
monitora.

Clique em Estou pronto para começar.


O Atlas exibe um assistente de migração ao vivo com instruções sobre como prosseguir
com o processo. O processo envia os dados do cluster de origem para o novo cluster de
destino. Depois de concluir as etapas do assistente, você poderá apontar seu aplicativo
para o novo cluster.

2
Link com Atlas.
Clique em Gerar token de link. Atlas exibe a página para gerar um token de link.

Clique em Avançar para ver uma página que contém o token de link gerado.

Copie o token do link e armazene-o em um local seguro. O Atlas nunca exibe o conteúdo do
token do link. O Atlas também não exibe o token do link após gerá-lo. Não compartilhe
publicamente.

OBSERVAÇÃO
Use um token de link exclusivo para migrar ao vivo todos os projetos em uma organização
do Cloud Manager para o Atlas.

Clique em Concluído.

3
Cole o token do link no Cloud Manager.
Acesse a organização no Cloud Manager:

Abra o Cloud Manager e navegue até a organização cujo cluster do projeto você está
migrando ao vivo para o Atlas.

Clique em Configurações no painel de navegação esquerdo.

Na seção Live Migration: Connect to Atlas, clique em Connect to Atlas. A caixa de diálogo
Conectar ao Atlas é aberta.

Cole o token de link gerado na etapa anterior do assistente de migração ao vivo e clique em
Conectar ao Atlas. O Cloud Manager estabelece a conexão com o Atlas. Use o botão
Atualizar para enviar uma atualização ao Atlas, se necessário.

4
Crie o cluster Atlas de destino.
Se ainda não o fez, crie um cluster de destino no Atlas. Ver
Pré-requisitos.

5
Inicie a migração do cluster de destino.
Clique em Selecionar cluster de destino em projetos.

Vá para o projeto do cluster Atlas de destino e encontre o cluster de destino.


Clique e selecione Migrar dados para este cluster na lista suspensa para iniciar a migração.
A página Migrar dados para este cluster é aberta.

Clique em Migrar do Ops Manager ou Cloud Manager.

OBSERVAÇÃO
O rótulo da UI menciona o Ops Manager, no entanto, para este procedimento, você só pode
migrar para implantações do Atlas MongoDB 6.0.8 ou posterior que o Cloud Manager
monitora.

Preencha os campos da seguinte forma:

Selecione o projeto de origem no Cloud Manager, se ainda não estiver selecionado.

Selecione um host de migração para lidar com a migração.

Se não estiver a utilizar um ponto final privado, reveja a lista de acesso de endereços IP e
verifique se o endereço IP externo do anfitrião de migração está incluído nesta lista. Se não
estiver adicionado, adicione-o agora:

Clique em Definir acesso à rede para host

Clique em + Adicionar endereço IP

Retorne ao assistente de migração ao vivo. Selecione o cluster de origem no menu


suspenso e escolha Migrar dados para este cluster em .

Selecione o cluster de origem no menu suspenso.

Se o cluster de origem impor autenticação, insira um nome de usuário e uma senha nas
caixas de texto fornecidas.

Consulte Segurança do Cluster de Origem para obter orientação sobre as permissões de


usuário exigidas pela migração ao vivo do Atlas.

Se você suspender o cluster de origem da automação no Cloud Manager, mas continuar


monitorando o cluster de origem com o Agente de Monitoramento, o Nome de Usuário e a
Senha serão exibidos. Se sua implantação exigir autenticação de usuário, forneça o nome
de usuário e a senha nestes arquivos LDS. O usuário do banco de dados cujas credenciais
você fornece deve ter pelo menos o
função de backup
no banco de dados admin e deve ser autenticado usando
tanto SCRAM-SHA-1 quanto SCRAM-SHA-256.

Se o cluster de origem usar TLS/SSL, alterne a opção A criptografia em trânsito está


habilitada? botão.
Se o cluster de origem usar TLS/SSL com uma autoridade de certificação raiz (CA)
personalizada, copie o caminho para o arquivo CA do seu host de migração e cole esse
caminho na caixa de texto fornecida. O arquivo deve estar presente no host de migração
para garantir que o host de migração possa ler o certificado. O Atlas verifica se o certificado
está presente e legível.

Se o seu cluster de destino tiver dados e você quiser preservá-los, mantenha a opção
Limpar quaisquer dados existentes no cluster de destino desmarcada. O serviço de
migração ao vivo avisa se encontrar namespaces duplicados. Se você deseja excluir os
dados existentes, marque esta opção.

Escolha uma conexão para se conectar ao cluster. A conexão Padrão sempre aparece
como disponível na IU. No entanto, outras opções de conexão serão habilitadas somente se
você tiver configurado anteriormente uma conexão de peering de VPC ou um endpoint
privado para seus clusters. Se o Atlas detectar que você não tem conexões VPC ou
endpoints privados configurados, essas opções ficarão esmaecidas.

Se você não estiver usando peering de VPC ou um endpoint privado, clique em Conexão
padrão e prossiga para o estágio de validação desta etapa.

Se você configurou uma conexão de peering de VPC entre o host de migração e o conjunto
de réplicas do Atlas, a opção de peering de VPC estará ativa. Clique em peering de VPC
para conectar-se usando peering de VPC para migração em tempo real. Se a opção VPC
Peering estiver esmaecida, configure uma conexão de peering de VPC antes de iniciar este
procedimento. Para saber mais, consulte
Suporte para peering de VPC e endpoints privados.

Se você configurou um ponto final privado entre o host de migração e o cluster Atlas, a
opção Ponto Final Privado estará ativa. Clique em Ponto Final Privado para conectar-se a
um ponto final privado e, em seguida, selecione um ponto final privado previamente
configurado no menu suspenso. Apenas os pontos finais privados que estão no estado
AVAILABLE são válidos. Se a opção Private Endpoint estiver esmaecida, configure um
endpoint privado antes de iniciar este procedimento. Para saber mais, consulte
Suporte para peering de VPC e endpoints privados.

OBSERVAÇÃO
Para migrações push ao vivo em que os clusters de origem e destino executam o MongoDB
6.0.8 ou posterior, os endpoints privados são suportados apenas para clusters implantados
em um único provedor de nuvem e em uma única região.

Clique em Validar. O processo de validação verifica se o seu host de migração está


acessível e executa as verificações de validação a seguir para garantir que você possa
iniciar a migração em tempo real para o Atlas.

Para aproveitar as seguintes verificações de validação,


atualizar o agente MongoDB no Cloud Manager
para a versão mais recente. As seguintes verificações de validação são executadas
durante a migração em tempo real:
O host de migração pode se conectar ao cluster de destino.

Se o cluster de origem usar TLS/SSL com uma autoridade de certificação raiz (CA)
personalizada, o host de migração poderá acessar o cluster de origem usando TLS/SSL.

As credenciais do usuário do banco de dados são válidas. Essa verificação de validação


será executada somente se você suspender o cluster de origem da automação no Cloud
Manager, mas continuar monitorando o cluster de origem com o Agente de Monitoramento.

O processo de migração valida se o cluster de destino tem espaço em disco suficiente com
base no tamanho de armazenamento dos dados compactados. Para saber mais sobre
dados e tamanhos de armazenamento, consulte
dbStats.

Se a validação falhar, verifique o host de migração, a validade dos seus endereços IP


externos ou bloco CIDR e o token do link. Verifique também as credenciais do usuário do
banco de dados, seus certificados TLS/SSL e a quantidade de tamanho de armazenamento
em disco no cluster de destino.

Se a validação for bem-sucedida, clique em Avançar.

6
Inicie a migração.
Revise o relatório que lista sua organização, projeto e cluster de origem e o host de
migração que o processo de migração em tempo real usará.

Clique em Iniciar a migração.

7
Prepare-se para cortar.
Quando o temporizador e o botão Preparar para transição ficarem verdes, clique nele para
prosseguir para a próxima etapa.

8
Execute a transição.
Quando o Atlas detecta que os clusters de origem e destino estão quase sincronizados, ele
inicia um cronômetro extensível de 120 horas (5 dias) para iniciar o estágio de transição do
procedimento de migração ao vivo. Após o período de 120 horas, o Atlas para de
sincronizar com o cluster de origem. Você pode estender o tempo restante em 24 horas
clicando em Prolongar tempo abaixo do <tempo> restante para interromper o cronômetro.

Clique em Preparar para transição. O Atlas exibe uma tela passo a passo que informa: Sua
migração está quase concluída! A tela passo a passo exibe as seguintes instruções sobre
como proceder com o processo de transição:

Pare seu aplicativo. Isso garante que não ocorram mais gravações no cluster de origem.
Aguarde até que a lacuna ideal chegue a zero. Quando o contador chega a zero, os clusters
de origem e de destino estão sincronizados.

Marque a caixa que diz: Confirmo que estou pronto para cortar o aplicativo para o cluster de
destino. Ao prosseguir, a Atlas finalizará a migração. Este processo levará alguns segundos.
Quando estiver concluído, você poderá apontar seu aplicativo para o cluster de destino e
começar a gravar nele.

Clique em Corte. Atlas conclui a migração e exibe a página Connect.

Decida quando retomar as gravações no cluster de destino. Você pode fazer o seguinte:

Aguarde até que o banner no cartão do cluster indique: A migração do cluster foi concluída
e, em seguida, retome as gravações no cluster de destino. Se você optar por aguardar a
conclusão da migração, seu aplicativo sofrerá uma pausa temporária nas gravações durante
o período necessário para finalizar a migração.

ou

Comece as gravações do aplicativo no cluster de destino sem esperar a conclusão da


migração, enquanto o banner do cartão do cluster indica: Seu cluster de destino no Atlas
está pronto para aceitar gravações, mas ainda estamos finalizando a migração. Se você
optar por mover gravações para o cluster de destino sem esperar até o final do processo de
migração, e a migração em tempo real falhar nos estágios finais e emitir um erro, você
deverá redirecionar as gravações de volta para o cluster de origem e reiniciar o processo de
migração em tempo real.

Quando você estiver pronto para redirecionar gravações para o cluster de destino no Atlas:

Use a cadeia de conexão do cluster de destino para se conectar ao seu aplicativo.

Confirme se seu aplicativo está funcionando com o cluster Atlas de destino.

Atlas executa estas ações para concluir o processo:

Remove as sub-redes do servidor de migração ao vivo MongoDB da lista de acesso IP no


cluster de destino.

Remove o usuário do banco de dados que a migração ao vivo usou para importar dados
para o cluster de destino.

Marca o processo de migração como concluído.

APIs de migração push ao vivo


Para executar tarefas associadas ao procedimento de migração em tempo real, consulte
API de migração push ao vivo.

OBSERVAÇÃO
As APIs de migração ao vivo mencionam Cloud Manager ou Ops Manager, no entanto, o
tipo de migração ao vivo descrito nesta seção suporta apenas a migração de clusters de
origem monitorados no Cloud Manager para clusters de destino no Atlas.

Enviar comandos CLI de migração ao vivo


Para migrar um cluster usando a CLI do Atlas, você pode executar as seguintes etapas:

Crie ou exclua um token de link

Criar ou visualizar um trabalho de validação

Criar ou visualizar um job de migração

Execute a transição

Para outras etapas no procedimento de migração ao vivo, deve-se usar a UI do Cloud


Manager ou a UI do Atlas. Para saber mais, consulte o fluxo de trabalho de migração em
tempo real.

Antes de migrar um cluster usando a CLI do Atlas, conclua a validação de pré-migração.

OBSERVAÇÃO
Antes de executar qualquer comando Atlas CLI, você deve:

Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Criar ou excluir um token de link


Para criar um novo token de link usando a CLI do Atlas, execute o seguinte comando:

atlas liveMigrations link criar [opções]

Para excluir o token de link especificado usando a CLI do Atlas, execute o seguinte
comando:

atlas liveMigrations link excluir [opções]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
atlas liveMigrações link criar
e
exclusão do link atlas liveMigrations.

Se você estiver migrando do Ops Manager, solicite um endereço IP externo e especifique-o


no token de link. Para saber mais, consulte
Solicite um endereço IP externo
na documentação do Ops Manager.
Criar e visualizar um trabalho de validação
Para criar uma nova solicitação de validação usando a CLI do Atlas, execute o seguinte
comando:

atlas liveMigrations validação criar [opções]

Para retornar os detalhes da solicitação de validação especificada usando a CLI do Atlas,


execute o seguinte comando:

validação do atlas liveMigrations descreve [opções]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
atlas liveMigrations validação criar
e
descrição da validação do atlas liveMigrations.

Para saber o que o Atlas valida, consulte o marcador Validar na seção Migrar seu cluster
nesta página.

Criar e visualizar um trabalho de migração


Para criar um novo trabalho de migração usando a CLI do Atlas, execute o seguinte
comando:

atlas liveMigrations create [opções]

Para retornar os detalhes do trabalho de migração especificado usando a CLI do Atlas,


execute o seguinte comando:

atlas liveMigrations descrevem [opções]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
atlas liveMigrações criar
e
atlas liveMigrations descreve.

Execute a transição
Para iniciar a transferência para migração ao vivo usando a CLI do Atlas, execute o
seguinte comando:

atlas liveMigrations cutover [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas liveMigrations cutover.
Quando a transição for concluída, o Atlas concluirá o processo de migração em tempo real
e interromperá a sincronização com o cluster de origem. Para saber mais, consulte a seção
Migrar seu cluster nesta página.

OBSERVAÇÃO
Os comandos da CLI do Live Migration podem mencionar Cloud Manager ou Ops Manager,
no entanto, o tipo de migração ao vivo descrito nesta seção oferece suporte apenas à
migração de clusters de origem monitorados no Cloud Manager para clusters de destino no
Atlas.

Apoio à migração
Se você tiver alguma dúvida sobre o suporte à migração além do que é abordado nesta
documentação ou se encontrar um erro durante a migração, solicite suporte por meio da UI
do Atlas.

Para registrar um ticket de suporte:

Clique em Suporte na navegação à esquerda.

Clique em Solicitar suporte.

Para Categoria do Problema, selecione Ajuda com migração em tempo real.

Para Prioridade, selecione a prioridade apropriada. Para perguntas, selecione Prioridade


Média. Se houve uma falha na migração, selecione Alta Prioridade.

Para Resumo da solicitação, inclua Migração ao vivo em seu resumo.

Para obter mais detalhes, inclua quaisquer outros detalhes relevantes à sua pergunta ou
erro de migração.

Clique no botão Solicitar suporte para enviar o formulário.


Migração ao vivo: coloque seus dados no Atlas
Você pode extrair dados de implantações existentes do MongoDB, JSON ou arquivos CSV
para o Atlas usando uma das seguintes ferramentas gerenciadas pelo Atlas na interface do
usuário do Atlas.

Para localizar a migração ao vivo (pull) na UI do Atlas, no painel esquerdo da página da sua
organização, acesse Live Migration to Atlas e selecione General Live Migration.

Se seus clusters de origem e destino estiverem executando o MongoDB 6.0.8 ou posterior,


você poderá migrar em tempo real para o Atlas usando este procedimento.

Método
Descrição
Migrar ao vivo (extrair) um conjunto de réplicas
Use a interface do usuário do Atlas para extrair um conjunto de réplicas do MongoDB para
um cluster de conjunto de réplicas do Atlas.
Migrar ao vivo (puxar) um cluster fragmentado
Use a interface do usuário do Atlas para extrair um cluster fragmentado do MongoDB para
um cluster fragmentado do Atlas.
Migração ao vivo de um nó MongoDB independente
Converter o nó MongoDB autônomo para um conjunto de réplicas de nó único e, em
seguida, migrá-lo ao vivo (puxá-lo) para o Atlas. Se você não conseguir converter o conjunto
autônomo em um conjunto de réplicas, use o mongorestore para migrar para o Atlas.
Migração ao vivo (extração) de um conjunto de
réplicas para o Atlas
Nesta página

Restrições
Pré-requisitos
Considerações
Migre seu cluster
Apoio à migração
IMPORTANTE
Recurso indisponível em instâncias sem servidor
As instâncias sem servidor não oferecem suporte a esse recurso no momento. Para saber
mais, consulte Limitações de instância sem servidor.

Se seus clusters de origem e destino estiverem executando o MongoDB 6.0.8 ou posterior,


você poderá migrar em tempo real para o Atlas usando este procedimento.

O Atlas pode extrair um conjunto de réplicas de origem para um cluster Atlas usando o
processo de migração ao vivo. O Atlas sincroniza do cluster de origem para o cluster de
destino até que você transfira seus aplicativos para o cluster Atlas de destino.

Depois de atingir a etapa de transição no procedimento a seguir, interrompa as gravações


no cluster de origem. Pare as instâncias do seu aplicativo, aponte-as para o cluster Atlas e
reinicie-as.

Restrições
Não é possível selecionar um cluster compartilhado M0 (nível gratuito) ou M2/M5 como
origem ou destino para migração ao vivo. Para migrar dados de um cluster compartilhado
M0 (nível gratuito) ou M2/M5 para um cluster pago, altere o nível e o tipo do cluster.

A migração ao vivo (pull) não oferece suporte ao peering de VPC ou endpoints privados
para o cluster de origem ou de destino.

Para migrar em tempo real um cluster fragmentado, consulte Migrar em tempo real (extrair)
um cluster fragmentado para o Atlas.

Não use o procedimento nesta página para migrar seu cluster em tempo real para o
MongoDB v6.0 ou posterior. O procedimento para migração em tempo real de clusters que
executam o MongoDB v6.0 ou posterior é diferente do procedimento nesta página.

Se seus clusters de origem e destino estiverem executando o MongoDB 6.0.8 ou posterior,


você poderá migrar em tempo real para o Atlas usando este procedimento.

Durante a migração ao vivo, o Atlas desativa alertas de host.

Pré-requisitos
Forneça o nome do host do nó primário ao serviço de migração em tempo real.

Ao migrar do MongoDB 4.4 ou anterior para um cluster Atlas que executa o MongoDB 5.0
ou posterior, elimine qualquer
índices geoHaystack
de suas coleções.

Se o cluster for executado com autenticação, conceda ao usuário que executará o processo
de migração as seguintes permissões:

Leia todos os bancos de dados e coleções no host.

Acesso de leitura ao nó primário


oplog.

Aprender mais
Segurança do cluster de origem.

IMPORTANTE
Preparação do cluster de origem
Para ajudar a garantir uma migração de dados tranquila, o cluster de origem deve atender a
todas as recomendações do cluster de produção. Verifica a
Lista de verificação de operações
e
Notas de produção
antes de iniciar o processo de migração ao vivo.

Caminho de migração
A migração ao vivo do Atlas (pull) oferece suporte aos seguintes caminhos de migração:

Conjunto de réplicas de origem


Versão do MongoDB
Conjunto de réplicas do Atlas de destino
Versão do MongoDB
4,0
4.4
4.2
4,4, 5,0
4.4
4,4, 5,0
5,0
5,0
IMPORTANTE
Você não pode migrar seu cluster para o MongoDB v6.0 ou posterior usando o
procedimento nesta página.

Se seus clusters de origem e destino estiverem executando o MongoDB 6.0.8 ou posterior,


você poderá migrar em tempo real para o Atlas usando este procedimento.
Se você estiver migrando de um cluster MongoDB 4.0, atualize e teste seus aplicativos no
contexto do cluster Atlas de destino.

Acesso à rede
Configure permissões de rede para os seguintes componentes:

O firewall do cluster de origem permite o tráfego do servidor de migração em tempo real


Quaisquer firewalls para o cluster de origem devem conceder ao servidor de migração ao
vivo do MongoDB acesso ao cluster de origem.

O processo de migração ao vivo do Atlas transmite dados por meio de um servidor de


migração ao vivo controlado pelo MongoDB. Atlas fornece os intervalos de IP dos
servidores de migração ao vivo do MongoDB durante o processo de migração ao vivo.
Conceda a esses intervalos de IP acesso ao cluster de origem. Isso permite que o servidor
de migração ao vivo do MongoDB se conecte aos clusters de origem.

OBSERVAÇÃO
Se sua organização tiver requisitos de rede rígidos e você não puder habilitar o acesso de
rede necessário aos servidores de migração ao vivo do MongoDB, consulte
Migração ao vivo de uma implantação comunitária para o Atlas.

Atlas Cluster permite tráfego de seus servidores de aplicativos


O Atlas permite conexões a um cluster a partir de hosts adicionados à lista de acesso IP do
projeto. Adicione os endereços IP ou blocos CIDR dos hosts do seu aplicativo à lista de
acesso IP do projeto. Faça isso antes de iniciar o procedimento de migração.

O Atlas adiciona temporariamente os endereços IP dos servidores de migração MongoDB à


lista de acesso IP do projeto. Durante o procedimento de migração, não é possível editar ou
excluir esta entrada. O Atlas remove esta entrada assim que o procedimento for concluído.

Para saber como adicionar entradas à lista de acesso IP do Atlas, consulte Configurar
entradas da lista de acesso IP.

Validação pré-migração
Antes de iniciar o procedimento de migração pull live, o Atlas executa verificações de
validação nos clusters de origem e destino.

O cluster de origem é um conjunto de réplicas.

Se o cluster de origem for independente,


converta primeiro o autônomo em um conjunto de réplicas
antes de usar a migração ao vivo do tipo pull.

O cluster Atlas de destino é um conjunto de réplicas.

OBSERVAÇÃO
Ao contrário dos clusters fragmentados, a migração ao vivo do seu conjunto de réplicas
para o Atlas não exige que o Atlas tenha conectividade com o nome do anfitrião e a porta de
cada nó no cluster de origem. Para executar o processo de migração, o Atlas descobre
automaticamente os nomes de host do conjunto de réplicas com base no nome do host
fornecido. Se isso falhar, o Atlas migrará o conjunto de réplicas usando o nome de host
acessível fornecido. Para saber mais, consulte
Acesso à rede.

Segurança do cluster de origem


Várias funções integradas fornecem privilégios suficientes. Por exemplo:

Para clusters de origem, um usuário deve ter o


leiaAnyDatabase
,
clusterMonitor
,e
cópia de segurança
papéis.

Para verificar se o usuário do banco de dados que executará o processo de migração em


tempo real possui essas funções, execute o comando
db.getUser()
comando no banco de dados admin.

usar administrador
db.getUser("admin")
{
"_id": "admin.admin",
"usuário": "administrador",
"db": "administrador",
"papéis": [
{
"papel": "backup",
"db": "administrador"
},
{
"role": "clusterMonitor",
"db": "administrador"
}
{
"role": "readAnyDatabase",
"db": "administrador"
}
]
} ...

Além disso, o usuário do banco de dados do seu cluster de origem deve ter a função de ler
o oplog no seu banco de dados administrativo. Para saber mais, consulte Acesso Oplog.
Para clusters de origem executando o MongoDB 3.4, um usuário deve ter, no mínimo,
ambos
clusterMonitor
e
leiaAnyDatabase
papéis. Por exemplo:

usar administrador
db.createUser(
{
usuário: "mySourceUser",
pwd: "minhaFonteP@$$palavra",
funções: ["clusterMonitor", "readAnyDatabase"]
}
)

Para clusters de origem executando o MongoDB 3.2, um usuário deve ter, no mínimo,
ambos
gerenciador de clusters
e
leiaAnyDatabase
funções, bem como acesso de leitura no banco de dados local. Isto requer um
função personalizada
, que você pode criar com os seguintes comandos:

usar administrador
db.createRole(
{
função: "migrar",
privilégios: [
{ recurso: { banco de dados: "local", coleção: "" }, ações: [ "encontrar" ] }
],
funções: ["readAnyDatabase", "clusterManager"]
}
)
db.createUser(
{
usuário: "mySourceUser",
pwd: "minhaFonteP@$$palavra",
funções: [ "migrar"]
}
)

Para clusters de origem executando o MongoDB 2.6 ou 3.0, um usuário deve ter, no
mínimo, o
leiaAnyDatabase
papel. Por exemplo:
usar administrador
db.createUser(
{
usuário: "mySourceUser",
pwd: "minhaFonteP@$$palavra",
funções: ["readAnyDatabase"]
}
)

Especifique o nome de usuário e a senha do Atlas quando solicitado pelo procedimento de


migração ao vivo.

Atlas suporta apenas


SCRAM
para conexão com clusters de origem que impõem autenticação.

O suporte para autenticação SCRAM começou no MongoDB 3.0. Se o cluster de origem


estiver executando o MongoDB 2.6, você poderá migrá-lo usando a migração pull ao vivo
sem ativar a autenticação SCRAM.

DICA
Para ocultar credenciais durante a migração, considere adicionar um usuário temporário
com as permissões mínimas necessárias para migração no cluster de origem e, em
seguida, excluir o usuário depois de concluir o processo de migração.

Se o cluster de origem usar um mecanismo de autenticação diferente para se conectar,


você poderá usar o mongomirror para migrar dados do cluster de origem para o cluster
Atlas de destino.

Como o MongoDB protege seus servidores de migração ativos


Em qualquer migração ao vivo do tipo pull para o Atlas, o Atlas gerencia o servidor que
executa a migração ao vivo e envia dados do cluster de origem para o cluster de destino.

O MongoDB toma as seguintes medidas para proteger a integridade e a confidencialidade


dos seus dados em trânsito para o Atlas:

O MongoDB criptografa dados em trânsito entre o servidor de migração ao vivo gerenciado


pelo Atlas e o cluster de destino. Se você precisar de criptografia para dados em trânsito
entre o cluster de origem e o servidor de migração gerenciado pelo Atlas, configure o TLS
no cluster de origem.

O MongoDB protege o acesso às instâncias do servidor de migração gerenciado pelo Atlas,


assim como protege o acesso a quaisquer outras partes do Atlas.

Em raros casos em que é necessária intervenção para investigar e restaurar serviços


críticos, o MongoDB adere ao princípio do menor privilégio e autoriza apenas um pequeno
grupo de usuários privilegiados a acessar seus clusters Atlas por um tempo mínimo limitado
necessário para reparar o problema crítico. O MongoDB requer MFA para que esses
usuários façam login nos clusters Atlas e estabeleçam uma conexão SSH por meio do host
bastião. A concessão deste tipo de acesso de usuário privilegiado requer aprovação da alta
administração do MongoDB. O MongoDB não permite o acesso de nenhum outro pessoal
do MongoDB aos seus clusters do MongoDB Atlas.

O MongoDB permite o uso de contas de usuários privilegiados apenas para atividades


privilegiadas. Para realizar atividades não privilegiadas, os usuários privilegiados devem
usar uma conta separada. Contas de usuários privilegiados não podem usar credenciais
compartilhadas. As contas de usuários privilegiados devem seguir os requisitos de senha
descritos na Seção 4.3.3 do
Segurança Atlas
papel branco.

Você pode restringir o acesso aos seus clusters por todo o pessoal do MongoDB, incluindo
usuários privilegiados, no Atlas. Se você optar por restringir esse acesso e o MongoDB
determinar que o acesso é necessário para resolver um problema de suporte, o MongoDB
deverá primeiro solicitar sua permissão e você poderá então decidir se deseja restaurar
temporariamente o acesso de usuário privilegiado por até 24 horas. Você pode revogar o
acesso temporário de 24 horas não a qualquer momento. Ativar esta restrição pode resultar
num aumento do tempo de resposta e resolução de problemas de suporte e, como
resultado, pode impactar negativamente a disponibilidade dos seus clusters Atlas.

O MongoDB analisa trimestralmente a autorização de acesso de usuários privilegiados.


Além disso, o MongoDB revoga o acesso de um usuário privilegiado quando ele não for
mais necessário, inclusive dentro de 24 horas após esse usuário privilegiado mudar de
função ou sair da empresa. Também registramos qualquer acesso do pessoal do MongoDB
aos clusters do Atlas, retemos logs de auditoria por pelo menos seis anos e incluímos
carimbo de data/hora, ator, ação e saída. O MongoDB usa uma combinação de revisões
automatizadas e manuais para verificar esses logs de auditoria.

Para saber mais sobre a segurança do Atlas, consulte o


Segurança Atlas
papel branco. Em particular, revise a seção "Acesso de pessoal do MongoDB aos clusters
do MongoDB Atlas".

Limites de chave de índice


Se a sua implantação do MongoDB contém índices com chaves que excedem o
Limite de chave de índice
, antes de iniciar o procedimento de migração ao vivo, modifique os índices para que não
contenham chaves superdimensionadas. Para saber mais sobre estratégias para lidar com
chaves superdimensionadas, consulte
failIndexKeyTooLong
na documentação do servidor MongoDB.

IMPORTANTE
Limite de chave de índice
failIndexKeyTooLong
foi descontinuado no MongoDB versão 4.2 e foi removido no MongoDB 4.4 e posterior.
Para MongoDB anterior a 4.2, defina esse parâmetro como false.

Considerações
Criptografia de rede
Durante as migrações pull ao vivo, se o cluster de origem não usar criptografia TLS para
seus dados, o tráfego do cluster de origem para o Atlas não será criptografado. Determine
se isso é aceitável antes de iniciar um procedimento de migração pull em tempo real.

Usuários e funções do banco de dados


O Atlas não migra nenhum dado de usuário ou função para o cluster de destino.

Se o cluster de origem não usar autenticação, você deverá criar um usuário no Atlas porque
o Atlas não dá suporte à execução sem autenticação.

Se o cluster de origem impor autenticação, você deverá recriar as credenciais que seus
aplicativos usam no cluster Atlas de destino. Atlas usa
SCRAM
para autenticação do usuário. Para saber mais, consulte Configurar usuários do banco de
dados.

O suporte para autenticação SCRAM começou no MongoDB 3.0. Se o cluster de origem


estiver executando o MongoDB 2.6, você poderá migrá-lo usando a migração pull ao vivo
sem ativar a autenticação SCRAM.

Configuração do Cluster de Destino


Ao configurar o cluster de destino, considere o seguinte:

O processo de migração ao vivo transmite dados por meio de um servidor de migração ao


vivo gerenciado pelo MongoDB. Cada servidor é executado em infraestrutura hospedada na
região mais próxima do cluster de origem. As seguintes regiões estão disponíveis:

Europa
Francoforte

Irlanda

Londres

Américas
Leste dos EUA

Oeste dos EUA

APAC
Bombaim

Cingapura
Sidney

Tóquio

Use a região de nuvem para o cluster de destino no Atlas que tem a latência de rede mais
baixa em relação aos servidores de aplicativos ou à sua implantação hospedada no cluster
de origem. Idealmente, os servidores da sua aplicação devem estar em execução na
nuvem, na mesma região que a região primária do cluster Atlas de destino. Para saber
mais, consulte Provedores de nuvem.

Devido à latência da rede, o processo de migração em tempo real pode não conseguir
acompanhar um cluster de origem que tenha uma carga de gravação extremamente
pesada. Nessa situação, você ainda pode migrar diretamente do cluster de origem
apontando a ferramenta mongomirror para o cluster Atlas de destino.

O cluster de destino no Atlas deve corresponder ou exceder a implantação de origem em


termos de RAM, CPU e armazenamento. Provisione um cluster de destino de tamanho
adequado para que ele possa acomodar o processo de migração e a carga de trabalho
esperada ou aumente a escala do cluster de destino para uma camada com mais poder de
processamento, largura de banda ou E/S de disco.

Para maximizar o desempenho da migração, utilize pelo menos um cluster M40 para o
cluster de destino. Ao migrar grandes conjuntos de dados, use um cluster M80 com discos
de 6.000 IOPS ou superiores.

Você também pode optar por aumentar temporariamente o tamanho do cluster Atlas de
destino durante o processo de migração. Depois de migrar a carga de trabalho do seu
aplicativo para um cluster no Atlas, entre em contato com o suporte para obter assistência
com ajuste adicional de desempenho e dimensionamento do cluster de destino para
minimizar custos.

Para evitar alterações inesperadas de dimensionamento, desative o escalonamento


automático no cluster de destino. Para saber mais, consulte Gerenciar clusters.

Para evitar o crescimento ilimitado da coleção de oplogs, defina um tamanho fixo de oplog
durante o processo de migração em tempo real. Para saber mais, consulte Acesso
necessário e opções de configuração do Atlas. Se você observar problemas de
desempenho mesmo depois de seguir essas recomendações, entre em contato com o
suporte.

O cluster Atlas de destino deve ser um conjunto de réplicas.

Não é possível selecionar um cluster de nível compartilhado M0 (nível gratuito) ou M2/M5


como cluster de destino para migração ao vivo.

Você não pode migrar seu cluster para o MongoDB v6.0 ou posterior usando o
procedimento nesta página.
Se seus clusters de origem e destino estiverem executando o MongoDB 6.0.8 ou posterior,
você poderá migrar em tempo real para At usando este procedimento.

Não altere o sinalizador featureCompatibilityVersion enquanto a migração ao vivo do Atlas


estiver em execução.

Evite cargas de trabalho no cluster de destino


Evite executar quaisquer cargas de trabalho, incluindo aquelas que possam estar em
execução em namespaces que não se sobrepõem ao processo de migração ao vivo, no
cluster de destino. Esta ação evita potenciais conflitos de bloqueio e degradação do
desempenho durante o processo de migração em direto.

Não execute várias migrações para o mesmo cluster de destino ao mesmo tempo.

Não inicie o processo de transferência dos seus aplicativos para o cluster de destino
enquanto o processo de migração ao vivo estiver sincronizando.

Evite backups na nuvem


O Atlas para de tirar snapshots de backup em nuvem sob demanda do cluster de destino
durante a migração ao vivo. Depois de concluir a etapa de transição no procedimento de
migração ao vivo nesta página, o Atlas retoma a obtenção de snapshots de backup na
nuvem com base em sua política de backup.

Evite alterações de namespace


Não faça alterações no namespace durante o processo de migração, como usar o
renomearCollection
comando ou executando um pipeline de agregação que inclui o
$ fora
fase de agregação.

Evite eleições
O processo de migração em tempo real faz o melhor possível para continuar uma migração
durante interrupções temporárias da rede e eleições nos clusters de origem ou de destino.
No entanto, esses eventos podem causar falha no processo de migração em tempo real. Se
o processo de migração ao vivo não puder ser recuperado automaticamente, reinicie-o
desde o início.

Reinicializações contínuas
Após a conclusão do processo de migração, o cluster reinicia cada um dos membros, um de
cada vez. Isso é chamado de reinicialização contínua e, como consequência, ocorrerá um
failover no primário. Para garantir uma migração tranquila, considere executar um
procedimento Testar Failover Primário antes de migrar seus dados para o cluster de destino.

Migre seu cluster


OBSERVAÇÃO
Migrações de preparação e produção
Considere executar este procedimento duas vezes. Execute uma migração parcial que pare
primeiro na etapa Executar a substituição. Isso cria um cluster de teste atualizado apoiado
pelo Atlas para testar o comportamento e o desempenho do aplicativo usando o mais
recente
versão do driver
que suporta a versão MongoDB do cluster Atlas.

Depois de testar seu aplicativo, execute o procedimento completo de migração usando um


cluster Atlas separado para criar seu ambiente de produção apoiado pelo Atlas.

IMPORTANTE
Evite fazer alterações na configuração do cluster de origem enquanto o processo de
migração em tempo real é executado, como remover membros do conjunto de réplicas ou
modificar
mondeus
configurações de tempo de execução, como featureCompatibilityVersion.

Lista de verificação pré-migração


Antes de iniciar o processo de importação:

Se ainda não tiver um cluster de destino, crie uma nova implantação do Atlas e configure-a
conforme necessário. Para obter documentação completa sobre a criação de um cluster
Atlas, consulte Criar um cluster.

Após a implantação do cluster Atlas, certifique-se de que você possa se conectar a ele a
partir de todo o hardware cliente onde seus aplicativos são executados. Testar sua cadeia
de conexão ajuda a garantir que seu processo de migração de dados possa ser concluído
com tempo de inatividade mínimo.

Baixar e instalar
mangusto
em uma máquina cliente representativa, caso ainda não a tenha.

Conecte-se ao cluster de destino usando a cadeia de conexão da UI do Atlas. Para obter


mais informações, consulte Conectar via mongosh.

Depois de verificar sua conectividade com o cluster de destino, inicie o procedimento de


migração em tempo real.

Procedimento
1
Inicie o processo de migração.
Inicie o processo de migração de uma das seguintes maneiras:

No painel esquerdo da página da sua organização, clique em Live Migration e escolha


Select Cluster for General Live Migration, ou
Navegue até o cluster Atlas de destino e clique no botão de reticências.... Na lista de
clusters, o botão de reticências ... aparece abaixo do nome do cluster. Ao visualizar os
detalhes do cluster, as reticências ... aparecem no lado direito da tela, próximo aos botões
Conectar e Configuração.

Clique em Migrar dados para este cluster.

O Atlas exibe uma tela passo a passo com instruções sobre como proceder com a migração
ao vivo. O processo sincroniza os dados do cluster de origem com o novo cluster de
destino. Depois de concluir o passo a passo, você poderá apontar seu aplicativo para o
novo cluster.

Colete os seguintes detalhes do cluster de origem para facilitar a migração:

O nome do host e a porta do cluster de origem


membro principal

O nome de usuário e a senha usados para se conectar ao cluster de origem

Se o cluster de origem usar TLS/SSL e não estiver usando uma autoridade de certificação
(CA) pública, você precisará do arquivo CA do cluster de origem.

Prepare as informações conforme indicado na tela passo a passo e clique em Estou pronto
para migrar.

O Atlas exibe uma tela passo a passo que coleta as informações necessárias para se
conectar ao cluster de origem.

O Atlas exibe o endereço IP do servidor de migração ao vivo do MongoDB responsável pela


sua migração ao vivo na parte superior da tela passo a passo. Configure o firewall do cluster
de origem para conceder acesso ao endereço IP exibido.

Digite o nome do host e port do membro primário do cluster de origem na caixa de texto
fornecida. Por exemplo, insira mongoPrimary.example.net:27017.

Se o cluster de origem impor autenticação, insira um nome de usuário e uma senha nas
caixas de texto fornecidas.

Ver
Segurança do cluster de origem
para obter orientação sobre as permissões de usuário exigidas pela migração ao vivo do
Atlas.

Se o conjunto de réplicas de origem usar TLS/SSL e não estiver usando uma autoridade de
certificação (CA) pública, alterne a opção A criptografia em trânsito está habilitada? e copie
o conteúdo do arquivo CA do cluster de origem na caixa de texto fornecida.
Se você deseja descartar todas as coleções no conjunto de réplicas de destino antes de
iniciar o processo de migração, alterne a opção marcada Limpar quaisquer dados existentes
em seu cluster de destino? para Sim.

Clique em Validar para confirmar se o Atlas pode se conectar ao conjunto de réplicas de


origem.

Se a validação falhar, verifique se:

Você tem
adicionado
Atlas para a lista de acesso IP em seu conjunto de réplicas de origem.

As credenciais de usuário fornecidas, se houver, existem no cluster de origem e possuem


as permissões necessárias.

A mensagem A criptografia em trânsito está habilitada? a alternância será habilitada


somente se o cluster de origem exigir isso.

O arquivo CA fornecido, se houver, é válido e correto.

Clique em Iniciar migração para iniciar o processo de migração.

Assim que o processo de migração começar, a UI do Atlas exibirá a tela passo a passo
Migrando dados para o cluster Atlas de destino.

A tela passo a passo é atualizada à medida que o cluster de destino prossegue no processo
de migração. O processo de migração inclui:

Copiando coleções do cluster de origem para o cluster de destino.

Criando índices no cluster de destino.

Seguimento de entradas de oplog do cluster de origem.

Um valor de tempo de atraso é exibido durante a fase final do oplog que representa o atraso
atual entre os clusters de origem e de destino. Esse tempo de atraso pode variar
dependendo da taxa de geração de oplog no cluster de origem, mas deve diminuir com o
tempo, à medida que o processo de migração ao vivo copia as entradas de oplog para o
cluster de destino.

Quando o temporizador e o botão Preparar para transição ficarem verdes, prossiga para a
próxima etapa.

2
Execute a transição.
Quando o Atlas detecta que os clusters de origem e destino estão quase sincronizados, ele
inicia um cronômetro extensível de 120 horas (5 dias) para iniciar o estágio de transição do
procedimento de migração ao vivo. Se o período de 120 horas passar, o Atlas interromperá
a sincronização com o cluster de origem. Você pode estender o tempo restante em 24 horas
clicando em Prolongar tempo abaixo do <tempo> restante para interromper o cronômetro.

Quando estiver preparado para transferir seus aplicativos para o cluster Atlas de destino,
clique em Preparar para transferência.

O Atlas exibe uma tela passo a passo com instruções sobre como proceder com a
transição. Essas etapas também são descritas abaixo:

Pare seu aplicativo. Isso garante que não ocorram mais gravações no cluster de origem.

Aguarde até que a lacuna ideal chegue a zero. Quando o contador chega a zero, os clusters
de origem e de destino estão sincronizados.

Reinicie seu aplicativo usando a nova cadeia de conexão fornecida na etapa 3 da UI de


substituição da migração ao vivo.

Depois de concluir o estágio de transição do procedimento e confirmar que seu aplicativo


está funcionando com o cluster Atlas, clique em Corte para concluir o procedimento de
migração. Isso permite que a Atlas:

Remova as sub-redes do MongoDB Application Server da lista de acesso IP do cluster de


destino.

Remova o usuário do banco de dados que a migração em tempo real usou para importar
dados para o cluster de destino.

Marque o processo de migração como concluído.

Apoio à migração
Se você tiver alguma dúvida sobre o suporte à migração além do que é abordado nesta
documentação ou se encontrar um erro durante a migração, solicite suporte por meio da UI
do Atlas.

Para registrar um ticket de suporte:

Clique em Suporte na navegação à esquerda.

Clique em Solicitar suporte.

Para Categoria do Problema, selecione Ajuda com migração em tempo real.

Para Prioridade, selecione a prioridade apropriada. Para perguntas, selecione Prioridade


Média. Se houve uma falha na migração, selecione Alta Prioridade.

Para Resumo da solicitação, inclua Migração ao vivo em seu resumo.


Para obter mais detalhes, inclua quaisquer outros detalhes relevantes à sua pergunta ou
erro de migração.

Clique no botão Solicitar suporte para enviar o formulário.


Migração ao vivo (puxar) um cluster
fragmentado para o Atlas
Nesta página

Restrições
Pré-requisitos
Considerações
Migre seu cluster fragmentado
Apoio à migração
O Atlas pode extrair um cluster fragmentado de origem para um cluster Atlas usando o
processo de migração ao vivo. O Atlas sincroniza do cluster de origem para o cluster de
destino até que você transfira seus aplicativos para o cluster Atlas de destino.

Depois de atingir a etapa de transferência no procedimento a seguir, interrompa as


gravações no cluster de origem parando as instâncias do aplicativo, apontando-as para o
cluster Atlas e reiniciando-as.

Restrições
Não use o procedimento nesta página para migrar em tempo real seu cluster fragmentado
para o MongoDB v6.0 ou posterior. O procedimento para migração em tempo real de
clusters fragmentados executando o MongoDB v6.0 ou posterior difere do procedimento
nesta página.

Se seus clusters de origem e destino estiverem executando o MongoDB 6.0.8 ou posterior,


você poderá migrar em tempo real para o Atlas usando este procedimento.

Para migrar em tempo real um conjunto de réplicas, consulte Migrar em tempo real (extrair)
um conjunto de réplicas para o Atlas.

Não é possível usar um cluster global como destino para migração em tempo real.

A migração ao vivo não oferece suporte ao emparelhamento de VPC ou endpoints privados


para o cluster de origem ou de destino.

Durante a migração ao vivo, o Atlas desativa alertas de host.

Pré-requisitos
Ao migrar do MongoDB 4.4 ou anterior para um cluster Atlas que executa o MongoDB 5.0
ou posterior, elimine qualquer
índices geoHaystack
de suas coleções.

Se o cluster de origem for executado com autenticação, especifique um usuário para o Atlas
que exista em cada fragmento e no conjunto de réplicas do servidor de configuração. O
usuário deve ter permissões para:
Pare ou inicie o balanceador de cluster fragmentado.

Leia todos os bancos de dados e coleções no host.

Leia o oplog no host.

Para saber mais, consulte


Segurança do cluster de origem.

IMPORTANTE
Preparação do cluster de origem
Para ajudar a garantir uma migração de dados tranquila, o cluster de origem deve atender a
todas as recomendações do cluster de produção. Verifica a
Lista de verificação de operações
e
Notas de produção
antes de iniciar o processo de migração ao vivo.

Caminho de migração
A migração ao vivo do Atlas (pull) oferece suporte aos seguintes caminhos de migração:

Cluster fragmentado de origem


Versão do MongoDB
Cluster fragmentado do Atlas de destino
Versão do MongoDB
4.4
4.4
5,0
5,0
OBSERVAÇÃO
Se seus clusters de origem e destino estiverem executando o MongoDB 6.0.8 ou posterior,
você poderá migrar em tempo real para o Atlas usando este procedimento.

Para clusters fragmentados, as versões principais do MongoDB nos clusters de origem e de


destino devem ser exatamente as mesmas. A versão principal do MongoDB na versão 4.4.x
completa é 4.4.

Acesso à rede
Configure permissões de rede para os seguintes componentes:

O firewall do cluster de origem permite o tráfego do servidor de migração em tempo real


Quaisquer firewalls para o cluster de origem devem conceder ao servidor de migração ao
vivo do MongoDB acesso ao cluster de origem.

O processo de migração ao vivo do Atlas transmite dados por meio de um servidor de


migração ao vivo controlado pelo MongoDB. Atlas fornece os intervalos de IP dos
servidores de migração ao vivo do MongoDB durante o processo de migração ao vivo.
Conceda a esses intervalos de IP acesso ao cluster de origem. Isso permite que o servidor
de migração ao vivo do MongoDB se conecte aos clusters de origem.

OBSERVAÇÃO
Se sua organização tiver requisitos de rede rígidos e você não puder habilitar o acesso de
rede necessário aos servidores de migração ao vivo do MongoDB, consulte
Migração ao vivo de uma implantação comunitária para o Atlas.

Atlas Cluster permite tráfego de seus servidores de aplicativos


O Atlas permite conexões a um cluster a partir de hosts adicionados à lista de acesso IP do
projeto. Adicione os endereços IP ou blocos CIDR dos hosts do seu aplicativo à lista de
acesso IP do projeto. Faça isso antes de iniciar o procedimento de migração.

O Atlas adiciona temporariamente os endereços IP dos servidores de migração MongoDB à


lista de acesso IP do projeto. Durante o procedimento de migração, não é possível editar ou
excluir esta entrada. O Atlas remove esta entrada assim que o procedimento for concluído.

Para saber como adicionar entradas à lista de acesso IP do Atlas, consulte Configurar
entradas da lista de acesso IP.

Validação pré-migração
O Atlas realiza diversas verificações de validação nos clusters de origem e destino antes de
iniciar o procedimento de migração ao vivo.

O cluster de origem deve ser um cluster fragmentado.

Se a origem for um cluster de conjunto de réplicas, use primeiro a migração ao vivo do tipo
pull para migrar o cluster para um conjunto de réplicas do Atlas e, em seguida, dimensione
seu cluster para um cluster fragmentado.

Se a fonte for independente,


converta primeiro o autônomo em um conjunto de réplicas
antes de usar a migração ao vivo do tipo pull. Em seguida, dimensione seu cluster para um
cluster fragmentado.

O cluster de origem deve usar CSRS (conjuntos de réplicas do Config Server). Ver
Servidores de configuração do conjunto de réplicas.

O Atlas deve ter conectividade com o nome do host e a porta de cada nó no cluster de
origem.

O Atlas deve ser capaz de parar e iniciar o


Balanceador de cluster fragmentado
no cluster de origem.

O cluster de origem tem a mesma versão de compatibilidade de recursos e versão principal


do MongoDB que o cluster de destino. A versão principal do MongoDB na versão 4.4.x
completa é 4.4.
Para verificar a versão de compatibilidade de recursos de um host no cluster de origem,
execute o seguinte comando em monão:

db.runCommand({ getParameter: 1, "featureCompatibilityVersion": 1 })

Use o
setFeatureCompatibilityVersion
comando de banco de dados para definir o sinalizador featureCompatibilityVersion
conforme necessário.

O cluster fragmentado Atlas de destino deve ter o mesmo número de


fragmentos
como o cluster fragmentado de origem.

Segurança do cluster de origem


Várias funções integradas fornecem privilégios suficientes. Por exemplo:

Para clusters de origem, um usuário deve ter o


leiaAnyDatabase
,
clusterMonitor
,e
cópia de segurança
papéis.

Para verificar se o usuário do banco de dados que executará o processo de migração em


tempo real possui essas funções, execute o comando
db.getUser()
comando no banco de dados admin.

usar administrador
db.getUser("admin")
{
"_id": "admin.admin",
"usuário": "administrador",
"db": "administrador",
"papéis": [
{
"papel": "backup",
"db": "administrador"
},
{
"role": "clusterMonitor",
"db": "administrador"
}
{
"role": "readAnyDatabase",
"db": "administrador"
}
]
} ...

Além disso, o usuário do banco de dados do seu cluster de origem deve ter a função de ler
o oplog no seu banco de dados administrativo. Para saber mais, consulte Acesso Oplog.

Para clusters de origem executando o MongoDB 3.4, um usuário deve ter, no mínimo,
ambos
clusterMonitor
e
leiaAnyDatabase
papéis. Por exemplo:

usar administrador
db.createUser(
{
usuário: "mySourceUser",
pwd: "minhaFonteP@$$palavra",
funções: ["clusterMonitor", "readAnyDatabase"]
}
)

Para clusters de origem executando o MongoDB 3.2, um usuário deve ter, no mínimo,
ambos
gerenciador de clusters
e
leiaAnyDatabase
funções, bem como acesso de leitura no banco de dados local. Isto requer um
função personalizada
, que você pode criar com os seguintes comandos:

usar administrador
db.createRole(
{
função: "migrar",
privilégios: [
{ recurso: { banco de dados: "local", coleção: "" }, ações: [ "encontrar" ] }
],
funções: ["readAnyDatabase", "clusterManager"]
}
)
db.createUser(
{
usuário: "mySourceUser",
pwd: "minhaFonteP@$$palavra",
funções: [ "migrar"]
}
)

Para clusters de origem executando o MongoDB 2.6 ou 3.0, um usuário deve ter, no
mínimo, o
leiaAnyDatabase
papel. Por exemplo:

usar administrador
db.createUser(
{
usuário: "mySourceUser",
pwd: "minhaFonteP@$$palavra",
funções: ["readAnyDatabase"]
}
)

Especifique o nome de usuário e a senha do Atlas quando solicitado pelo procedimento de


migração ao vivo.

Atlas suporta apenas


SCRAM
para conexão com clusters de origem que impõem autenticação.

O suporte para autenticação SCRAM começou no MongoDB 3.0. Se o cluster de origem


estiver executando o MongoDB 2.6, você poderá migrá-lo usando a migração pull ao vivo
sem ativar a autenticação SCRAM.

DICA
Para ocultar credenciais durante a migração, considere adicionar um usuário temporário
com as permissões mínimas necessárias para migração no cluster de origem e, em
seguida, excluir o usuário depois de concluir o processo de migração.

Como o MongoDB protege seus servidores de migração ativos


Em qualquer migração ao vivo do tipo pull para o Atlas, o Atlas gerencia o servidor que
executa a migração ao vivo e envia dados do cluster de origem para o cluster de destino.

O MongoDB toma as seguintes medidas para proteger a integridade e a confidencialidade


dos seus dados em trânsito para o Atlas:

O MongoDB criptografa dados em trânsito entre o servidor de migração ao vivo gerenciado


pelo Atlas e o cluster de destino. Se você precisar de criptografia para dados em trânsito
entre o cluster de origem e o servidor de migração gerenciado pelo Atlas, configure o TLS
no cluster de origem.

O MongoDB protege o acesso às instâncias do servidor de migração gerenciado pelo Atlas,


assim como protege o acesso a quaisquer outras partes do Atlas.
Em raros casos em que é necessária intervenção para investigar e restaurar serviços
críticos, o MongoDB adere ao princípio do menor privilégio e autoriza apenas um pequeno
grupo de usuários privilegiados a acessar seus clusters Atlas por um tempo mínimo limitado
necessário para reparar o problema crítico. O MongoDB requer MFA para que esses
usuários façam login nos clusters Atlas e estabeleçam uma conexão SSH por meio do host
bastião. A concessão deste tipo de acesso de usuário privilegiado requer aprovação da alta
administração do MongoDB. O MongoDB não permite o acesso de nenhum outro pessoal
do MongoDB aos seus clusters do MongoDB Atlas.

O MongoDB permite o uso de contas de usuários privilegiados apenas para atividades


privilegiadas. Para realizar atividades não privilegiadas, os usuários privilegiados devem
usar uma conta separada. Contas de usuários privilegiados não podem usar credenciais
compartilhadas. As contas de usuários privilegiados devem seguir os requisitos de senha
descritos na Seção 4.3.3 do
Segurança Atlas
papel branco.

Você pode restringir o acesso aos seus clusters por todo o pessoal do MongoDB, incluindo
usuários privilegiados, no Atlas. Se você optar por restringir esse acesso e o MongoDB
determinar que o acesso é necessário para resolver um problema de suporte, o MongoDB
deverá primeiro solicitar sua permissão e você poderá então decidir se deseja restaurar
temporariamente o acesso de usuário privilegiado por até 24 horas. Você pode revogar a
concessão de acesso temporário de 24 horas a qualquer momento. Habilitando esta
restrição pode resultar em maior tempo para resposta e resolução de problemas de suporte
e, como resultado, pode impactar negativamente a disponibilidade dos seus clusters Atlas.

O MongoDB analisa trimestralmente a autorização de acesso de usuários privilegiados.


Além disso, o MongoDB revoga o acesso de um usuário privilegiado quando ele não for
mais necessário, inclusive dentro de 24 horas após esse usuário privilegiado mudar de
função ou sair da empresa. Também registramos qualquer acesso do pessoal do MongoDB
aos clusters do Atlas, retemos logs de auditoria por pelo menos seis anos e incluímos
carimbo de data/hora, ator, ação e saída. O MongoDB usa uma combinação de revisões
automatizadas e manuais para verificar esses logs de auditoria.

Para saber mais sobre a segurança do Atlas, consulte o


Segurança Atlas
papel branco. Em particular, revise a seção "Acesso de pessoal do MongoDB aos clusters
do MongoDB Atlas".

Limites de chave de índice


Se a sua implantação do MongoDB contém índices com chaves que excedem o
Limite de chave de índice
, antes de iniciar o procedimento de migração ao vivo, modifique os índices para que não
contenham chaves superdimensionadas. Para saber mais sobre estratégias para lidar com
chaves superdimensionadas, consulte
failIndexKeyTooLong
na documentação do servidor MongoDB.
IMPORTANTE
Limite de chave de índice
failIndexKeyTooLong
foi descontinuado no MongoDB versão 4.2 e foi removido no MongoDB 4.4 e posterior.
Para MongoDB anterior a 4.2, defina esse parâmetro como false.

Considerações
Criptografia de rede
Durante as migrações pull ao vivo, se o cluster de origem não usar criptografia TLS para
seus dados, o tráfego do cluster de origem para o Atlas não será criptografado. Determine
se isso é aceitável antes de iniciar um procedimento de migração pull em tempo real.

Usuários e funções do banco de dados


O Atlas não migra nenhum dado de usuário ou função para o cluster de destino.

Se o cluster de origem não usar autenticação, você deverá criar um usuário no Atlas porque
o Atlas não dá suporte à execução sem autenticação.

Se o cluster de origem impor autenticação, você deverá recriar as credenciais que seus
aplicativos usam no cluster Atlas de destino. Atlas usa
SCRAM
para autenticação do usuário. Para saber como criar usuários de banco de dados no Atlas,
consulte Configurar usuários de banco de dados.

O suporte para autenticação SCRAM começou no MongoDB 3.0. Se o cluster de origem


estiver executando o MongoDB 2.6, você poderá migrá-lo usando a migração pull ao vivo
sem ativar a autenticação SCRAM.

Balanceador de cluster de origem


A migração ao vivo do Atlas interrompe o
balanceador de cluster fragmentado
no cluster de origem no início do procedimento e inicia o balanceador no final do
procedimento.

Se você cancelar a migração ao vivo, o Atlas reiniciará o balanceador no cluster de origem.

OBSERVAÇÃO
Em algumas circunstâncias, o Atlas não consegue reiniciar o balanceador no cluster de
origem no final de um processo de migração ao vivo. Se o balanceador não reiniciar, a
migração ao vivo ainda será bem-sucedida, mas um banner de aviso indicará que você
deve
reiniciar manualmente
o balanceador do cluster de origem.

Configuração do Cluster de Destino


Ao configurar o cluster Atlas de destino, considere o seguinte:
O processo de migração ao vivo transmite dados por meio de um servidor de migração ao
vivo gerenciado pelo MongoDB. Cada servidor é executado em infraestrutura hospedada na
região mais próxima do cluster de origem. As seguintes regiões estão disponíveis:

Europa
Francoforte

Irlanda

Londres

Américas
Leste dos EUA

Oeste dos EUA

APAC
Bombaim

Cingapura

Sidney

Tóquio

Use a região de nuvem para o cluster de destino no Atlas que tem a latência de rede mais
baixa em relação aos servidores de aplicativos ou à sua implantação hospedada no cluster
de origem. Idealmente, os servidores da sua aplicação devem estar em execução na
nuvem, na mesma região que a região primária do cluster Atlas de destino. Para saber
mais, consulte Provedores de nuvem.

Devido à latência da rede, o processo de migração em tempo real pode não conseguir
acompanhar um cluster de origem que tenha uma carga de gravação extremamente
pesada. Nessa situação, você ainda pode migrar diretamente do cluster de origem
apontando a ferramenta mongomirror para o cluster Atlas de destino.

Para evitar o crescimento ilimitado da coleção de oplogs, defina um tamanho fixo de oplog
durante o processo de migração em tempo real. Para saber mais, consulte Acesso
necessário e opções de configuração do Atlas.

Não é possível direcionar um cluster global como destino para migração em tempo real.

IMPORTANTE
Depois de iniciar o processo de migração ao vivo, não será possível modificar o cluster
Atlas de destino. Para ampliar o cluster de destino,
cancelar
o processo de migração em tempo real, ampliar o cluster e reiniciar o processo de
migração em tempo real.
Acesso à rede do cluster de destino
Durante a migração viva, os processos no cluster de destino são encerrados e a
conectividade do cluster por meio dos servidores mongos é suspensa. Os processos
mongos são reiniciados automaticamente assim que a migração é concluída.

Evite cargas de trabalho no cluster de destino


Evite executar quaisquer cargas de trabalho, incluindo aquelas que possam estar em
execução em namespaces que não se sobrepõem ao processo de migração ao vivo, no
cluster de destino. Esta ação evita potenciais conflitos de bloqueio e degradação do
desempenho durante o l processo de migração dinâmico.

Não execute várias migrações para o mesmo cluster de destino ao mesmo tempo.

Não inicie o processo de transferência dos seus aplicativos para o cluster de destino
enquanto o processo de migração ao vivo estiver sincronizando.

Evite backups na nuvem


O Atlas para de tirar snapshots de backup em nuvem sob demanda do cluster de destino
durante a migração ao vivo. Depois de concluir a etapa de transição no procedimento de
migração ao vivo nesta página, o Atlas retoma a obtenção de snapshots de backup na
nuvem com base em sua política de backup.

Evite alterações de namespace


Não faça alterações no namespace durante o processo de migração, como usar o
renomearCollection
comando ou executando um pipeline de agregação que inclui o
$ fora
fase de agregação.

Evite eleições
O processo de migração em tempo real faz o melhor possível para continuar uma migração
durante interrupções temporárias da rede e eleições nos clusters de origem ou de destino.
No entanto, esses eventos podem causar falha no processo de migração em tempo real. Se
o processo de migração ao vivo não puder ser recuperado automaticamente, reinicie-o
desde o início.

Reinicializações contínuas
Após a conclusão do processo de migração, o cluster reinicia cada um dos membros, um de
cada vez. Isso é chamado de reinicialização contínua e, como consequência, ocorrerá um
failover no primário. Para garantir uma migração tranquila, considere executar um
procedimento Testar Failover Primário antes de migrar seus dados para o cluster de destino.

Cancelando a migração ao vivo


Você pode cancelar o processo a qualquer momento clicando em Cancelar. O Atlas exibe a
mensagem Sharded Cluster Live Import in Progress para o cluster de destino até que o
cluster esteja pronto para acesso normal.
Se você cancelar o processo de migração ao vivo antes de sua conclusão, o Atlas não
removerá nenhum dado migrado até esse ponto. Se você reiniciar o processo de migração
ao vivo usando o mesmo cluster Atlas que o cluster de destino, o Atlas limpará todos os
dados do cluster.

Testando o Cluster de Destino


Considere migrar dados para o cluster de destino e, em seguida, interromper o processo de
migração e testar o cluster de destino enquanto deixa o cluster de origem em execução e
fornecendo dados para seus aplicativos.

Para testar seu cluster de destino com dados de produção, siga o


procedimento de migração
todo o caminho até a etapa de teste. Quando estiver pronto para realizar o processo de
migração completo, ignore a etapa de teste e prossiga para a etapa de transferência.

Migre seu cluster fragmentado


OBSERVAÇÃO
Migrações de preparação e produção
Considere executar primeiro um procedimento de migração ao vivo parcial para criar um
ambiente de preparo antes de repetir o procedimento para criar seu ambiente de produção.
O procedimento a seguir inclui uma chamada para o momento apropriado para cancelar o
procedimento e criar um ambiente de preparo.

Use o ambiente de teste para testar o comportamento e o desempenho do aplicativo


usando o mais recente
versão do driver
que suporta a versão MongoDB do cluster Atlas de destino. Em seguida, repita o
procedimento de migração ao vivo por completo para fazer a transição dos aplicativos do
cluster de origem para o cluster de destino do Atlas.

IMPORTANTE
Evite fazer alterações na configuração do cluster de origem enquanto o procedimento de
migração em tempo real é executado, como remover membros do conjunto de réplicas ou
modificar
mondeus
configurações de tempo de execução, como featureCompatibilityVersion.

Lista de verificação pré-migração


Antes de iniciar o processo de importação:

Se ainda não tiver um cluster de destino, crie uma nova implantação do Atlas e configure-a
conforme necessário. Para obter documentação completa sobre a criação de um cluster
Atlas, consulte Criar um cluster.

Após a implantação do cluster Atlas, certifique-se de que você possa se conectar a ele a
partir de todo o hardware cliente onde seus aplicativos são executados. Testar sua cadeia
de conexão ajuda a garantir que seu processo de migração de dados possa ser concluído
com tempo de inatividade mínimo.
Baixar e instalar
mangusto
em uma máquina cliente representativa, caso ainda não a tenha.

Conecte-se ao cluster de destino usando a cadeia de conexão da UI do Atlas. Para obter


mais informações, consulte Conectar via mongosh.

Depois de verificar sua conectividade com o cluster de destino, inicie o procedimento de


migração em tempo real.

Procedimento
1
Inicie o processo de migração.
Inicie o processo de migração de uma das seguintes maneiras:

No painel esquerdo da página da sua organização, clique em Live Migration e escolha


Select Cluster for General Live Migration, ou

Navegue até o cluster Atlas de destino e clique no botão de reticências.... Na lista de


clusters, o botão de reticências ... aparece abaixo do nome do cluster. Ao visualizar os
detalhes do cluster, as reticências ... aparecem no lado direito da tela, próximo aos botões
Conectar e Configuração.

Clique em Migrar dados para este cluster.

O Atlas exibe uma tela passo a passo com instruções sobre como proceder com a migração
ao vivo. Prepare as informações conforme indicado na tela passo a passo e clique em Estou
pronto para migrar.

O Atlas exibe uma tela passo a passo que coleta as informações necessárias para se
conectar ao cluster de origem.

Atlas exibe o endereço IP do mig ao vivo do MongoDB servidor de racionamento


responsável pela sua migração ao vivo na parte superior da tela passo a passo. Configure o
firewall do cluster de origem para conceder acesso ao endereço IP exibido.

Digite o nome do host e a porta de qualquer


mongos
do cluster fragmentado de origem na caixa de texto fornecida. Por exemplo,
mongos.example.net:27017.

Se o cluster de origem impor autenticação, insira um nome de usuário e uma senha nas
caixas de texto fornecidas.

Ver
Segurança do cluster de origem
para obter orientação sobre as permissões de usuário exigidas pela migração ao vivo do
Atlas.

Se o cluster de origem usar TLS/SSL e não estiver usando uma autoridade de certificação
(CA) pública, alterne a opção A criptografia em trânsito está habilitada? e copie o conteúdo
do arquivo CA do cluster de origem na caixa de texto fornecida.

Clique em Validar para confirmar se o Atlas pode se conectar ao cluster de origem.

Se a validação falhar, verifique se:

Você concedeu aos servidores do Live Migration acesso à rede no firewall do cluster de
origem.

As credenciais de usuário fornecidas, se houver, existem no cluster de origem e possuem


as permissões necessárias.

A mensagem A criptografia em trânsito está habilitada? a alternância será habilitada


somente se o cluster de origem exigir isso.

O arquivo CA fornecido, se houver, é válido e correto.

Os nomes de host fornecidos são válidos e acessíveis pela Internet pública.

Clique em Iniciar migração para iniciar o processo de migração.

Atlas exibe o progresso da migração ao vivo na IU. Durante a migração ao vivo, não é
possível visualizar métricas nem acessar dados do cluster de destino.

Um valor de tempo de atraso é exibido durante a fase final do oplog que representa o atraso
atual entre os clusters de origem e de destino. Esse tempo de atraso pode variar
dependendo da taxa de geração de oplog na origem, mas deve diminuir com o tempo à
medida que as entradas de oplog são copiadas para o cluster de destino.

Clique em Visualizar progresso por fragmento para visualizar o progresso da sincronização


e o tempo de migração restante por fragmento. Se o processo de sincronização inicial de
um determinado fragmento falhar, você poderá tentar reiniciar a sincronização clicando em
Reiniciar.

Quando o temporizador e o botão Preparar para transição ficarem verdes, prossiga para a
próxima etapa.

2
(Opcional) Teste o cluster de destino.
Opcional. Se desejar pular o teste e concluir a migração, prossiga para a etapa 3.

Se desejar fazer uma simulação do processo de migração e testar o desempenho e a


integridade dos dados do cluster de destino, você pode, opcionalmente, clicar no botão
Cancelar neste momento. O cluster de origem para de sincronizar dados com o cluster de
destino, mas todos os dados transferidos permanecem, para que você possa testar seus
aplicativos com o novo cluster.

Quando o teste estiver concluído e você estiver pronto para realizar o processo de migração
completo, comece novamente a partir da etapa 1. Todos os bancos de dados e coleções
que foram criados durante a execução do teste serão excluídos e reconstruídos.

3
Execute a transição.
Quando o Atlas detecta que os clusters de origem e destino estão quase sincronizados, ele
inicia um cronômetro extensível de 120 horas (5 dias) para iniciar o estágio de transição do
procedimento de migração ao vivo. Se o período de 120 horas passar, o Atlas interromperá
a sincronização com o cluster de origem. Você pode estender o tempo restante em 24 horas
clicando em Prolongar tempo abaixo do <tempo> restante para interromper o cronômetro.

IMPORTANTE
O procedimento de transferência requer a interrupção do aplicativo e de todas as gravações
no cluster de origem. Considere agendar e anunciar um período de manutenção para
minimizar a interrupção do serviço nos aplicativos dependentes.

Quando estiver preparado para transferir seus aplicativos para o cluster Atlas de destino,
clique em Preparar para transferência.

O Atlas exibe uma tela passo a passo com instruções sobre como proceder com a
transição. A lacuna ideal mostra o quão atrás o cluster de destino está em comparação com
o cluster de origem. Você deve parar seu aplicativo e todas as gravações no cluster de
origem para permitir que o cluster de destino feche a lacuna ideal.

Execute as etapas descritas na tela passo a passo para transferir seus aplicativos para o
cluster Atlas. Essas etapas também são descritas abaixo:

Pare seu aplicativo. Isso garante que não ocorram mais gravações no cluster de origem.

Aguarde até que a lacuna ideal chegue a zero. Quando o contador chega a zero, os clusters
de origem e de destino estão sincronizados.

Reinicie seu aplicativo usando a nova cadeia de conexão fornecida na etapa 3 da UI de


substituição da migração ao vivo.

OBSERVAÇÃO
Preparando a migração
Se você estiver criando um ambiente de teste para testar seus aplicativos, observe a lacuna
ideal para identificar até que ponto seu ambiente de teste estará em comparação com seu
cluster de origem.

Pressione Cancelar para cancelar a migração ao vivo. O Atlas encerra a migração nesse
momento, deixando todos os dados migrados no local. O Atlas exibe a mensagem Sharded
Cluster Live Import in Progress para o cluster de destino até que o cluster esteja pronto para
acesso normal. Para saber mais, consulte
Cancelando a migração ao vivo
. Assim que o cancelamento for concluído, você poderá testar seu aplicativo de teste em
relação aos dados parcialmente migrados.

Clique em Cut Over quando tiver concluído a sequência de transição e atualizou seus
aplicativos para apontar para o cluster de serviço. O intervalo ideal deve ser 0:00 antes que
você possa concluir o procedimento.

O Atlas prepara automaticamente o cluster Atlas assim que você conclui a sequência de
transição. Durante esse período, você não poderá acessar o cluster Atlas. Atlas exibe o
status da configuração do cluster na UI.

Depois que o Atlas exibir o cluster como ativo e pronto, você poderá apontar seus
aplicativos para o cluster do Atlas e começar a executar operações de gravação.

IMPORTANTE
As operações de gravação emitidas para o cluster de origem após a sequência de transição
não são espelhadas no cluster Atlas de destino. Verifique se seus aplicativos usam a cadeia
de conexão do novo cluster Atlas antes de reiniciá-los.

Apoio à migração
Se você tiver alguma dúvida sobre o suporte à migração além do que é abordado nesta
documentação ou se encontrar um erro durante a migração, solicite suporte por meio da UI
do Atlas.

Para registrar um ticket de suporte:

Clique em Suporte na navegação à esquerda.

Clique em Solicitar suporte.

Para Categoria do Problema, selecione Ajuda com migração em tempo real.

Para Prioridade, selecione a prioridade apropriada. Para perguntas, selecione Prioridade


Média. Se houve uma falha na migração, selecione Alta Prioridade.

Para Resumo da solicitação, inclua Migração ao vivo em seu resumo.

Para obter mais detalhes, inclua quaisquer outros detalhes relevantes à sua pergunta ou
erro de migração.

Clique no botão Solicitar suporte para enviar o formulário.


Solucionar problemas de migração ao vivo
(Pull)
Nesta página

Erros comuns de validação de migração ao vivo (pull)


Erros comuns de pós-validação
Antes do início do processo de migração ao vivo (pull), o Atlas realiza uma verificação de
validação para garantir que todos os campos e parâmetros necessários do formulário
estejam funcionais e corretos. Se algum parâmetro for inválido, o Atlas retornará um erro e
a migração ao vivo não prosseguirá.

Esta seção descreve erros comuns de validação de migração ao vivo (pull) e fornece
sugestões sobre o que verificar caso você os encontre.

Erros comuns de validação de migração ao vivo (pull)


Erro
Correção
Não foi possível acessar a origem especificada
Certifique-se de ter adicionado os intervalos de sub-rede corretos à lista de acesso IP no
cluster de origem. Você pode encontrar os quatro intervalos de sub-rede necessários na
janela modal de migração ao vivo.

Confirme se o nome do host especificado resolve um endereço IP público. Em um prompt


de comando, use um dos seguintes comandos:

nslookup <nome do host>


ping <nome do host>

Certifique-se de não estar usando uma conexão de peering de VPC, que não é compatível
com a migração pull em tempo real. Se uma conexão de peering VPC for sua única opção,
use mongomirror.

Não foi possível resolver o nome do host


Nenhum endereço IP foi encontrado para o nome de host fornecido. Confirme se o nome de
host fornecido está correto e acessível publicamente.
Opções SSL inválidas fornecidas
Se você estiver usando SSL:

Confirme se o seu certificado SSL está completo e copiado corretamente para a janela
modal de migração ao vivo (pull).

Confirme se a criptografia em trânsito está habilitada? a chave seletora está na posição


Sim.

Se você não estiver usando SSL:


Verifique sua cadeia de conexão e confirme se o parâmetro de consulta SSL não está
presente. Se --ssl fizer parte da cadeia de conexão, o cluster exigirá uma conexão SSL.

Confirme se a criptografia em trânsito está habilitada? a chave seletora está na posição


Não.

O nome de usuário ou senha não está correto


Confirme suas credenciais em mangusto com os seguintes comandos:

usar administrador
db.getUser("<nome de usuário>");

Se o problema persistir,
atualizar a senha do usuário MongoDB.

Usuário não autorizado a executar comando


Para executar o processo de migração ao vivo (pull), o usuário do MongoDB deve ter
privilégios de sistema suficientes. Para saber mais, consulte Segurança do cluster de
origem.
Informações de armazenamento em disco indisponíveis
Para executar o processo de migração ao vivo (pull), o usuário do MongoDB deve ter
permissões na instância do MongoDB do cluster de origem. Para saber mais, consulte
Segurança do cluster de origem.
O uso do disco de origem é muito grande para o destino
Diferentes níveis de serviço do Atlas têm diferentes quantidades de espaço em disco
disponível. Certifique-se de que o cluster Atlas tenha espaço em disco suficiente para todos
os dados do cluster de origem. Para saber mais sobre dimensionamentos de cluster,
consulte Criar um novo cluster.
A fonte parece ser independente
Sua implantação de origem deve ser um MongoDB conjunto de réplicas. Se a sua
implantação de origem for atualmente um nó independente, converta-o para um conjunto de
réplicas de nó único antes de executar a migração ao vivo (pull).
Não foi possível processar o arquivo CA fornecido
Confirme se seu arquivo CA está completo e colado corretamente na janela modal de
migração ao vivo (pull).
Erros comuns de pós-validação
Erro
Correção
Não foi possível recuperar a entrada mais recente do oplog da origem: não encontrado
Se a origem for um conjunto de réplicas, certifique-se de ter acesso de leitura no
banco de dados local.

Se a origem for uma instância independente,


convertê-lo em um conjunto de réplicas
antes de prosseguir com a migração.

Confirme se o cluster de origem tem um oplog legível. Em alguns serviços hospedados,


como o Compose.io, o oplog é um recurso que deve ser habilitado.
Se você ainda não conseguir acessar o oplog, use o mongorestore para importar seus
dados para o Atlas.

Não foi possível determinar se --host é um conjunto de réplicas: erro ao conectar ao


servidor db: nenhum servidor acessível
Certifique-se de ter adicionado todos os endereços IP exigidos pelo serviço de migração em
tempo real (pull) à lista de acesso IP do cluster de origem.

Confirme se o endereço IP ou nome de host DNS fornecido é um endereço IP acessível


publicamente.

Erro ao aplicar entradas de oplog durante a sincronização inicial: comando


renameCollection encontrado durante a sincronização inicial. Por favor reinicie o
mongomirror.
Renomear uma coleção no cluster de origem durante a migração ao vivo (pull) pode
desencadear esse erro.

Certifique-se de que nenhum usuário ou aplicativo renomeie nenhuma coleção enquanto a


migração ao vivo (pull) estiver ocorrendo.

Operações de agregação que usam


$ fora
pode desencadear esse erro. Certifique-se de que nenhuma operação $out ocorra durante
o procedimento de migração ao vivo (pull).

Erro de índice não suportado


Certos tipos e configurações de índices permitidos em versões anteriores do MongoDB não
são mais suportados em versões mais recentes. Verifique as notas de lançamento da
versão do MongoDB em seu cluster de destino para possíveis conflitos. Se necessário,
elimine quaisquer índices que causem erros e reconstrua-os após a conclusão do processo
de migração ao vivo.
Erro ao seguir o oplog na origem: Ponto de verificação não disponível no oplog
A migração ao vivo (pull) usa a origem
registrar
para sincronizar operações que ocorrem ur no cluster de origem durante o procedimento
de migração pull ao vivo. Se o tamanho do oplog do cluster de origem for muito pequeno,
talvez não seja possível registrar todas as operações que ocorrem no cluster de origem
durante a sincronização, e a migração ao vivo (pull) ficará muito atrasada para ser
atualizada.

Se você vir este erro:

Verifique o tamanho do cluster de origem


registrar
usando o
rs.printReplicationInfo()
comando. O servidor que hospeda o mongomirror deve ter espaço em disco disponível
suficiente para conter os dados de oplog gerados durante o processo de migração.

Se necessário,
aumentar o tamanho do oplog de origem
para suportar uma janela de replicação longa o suficiente para concluir o procedimento de
migração em tempo real.

Se o erro ocorrer ao executar o mongomirror diretamente, reinicie o mongomirror usando


--oplogPath para armazenar em buffer
registrar
dados para o disco durante a migração.
Migração ao vivo: envie seus dados do Cloud
Manager ou do Ops Manager para o Atlas
Você pode migrar dados em tempo real de implantações existentes do MongoDB
monitoradas pelo Cloud Manager ou pelo Ops Manager para o Atlas usando o serviço de
migração em tempo real por meio da UI do Atlas.

Para localizar a migração ao vivo (push) na UI do Atlas, no painel esquerdo da página da


sua organização, acesse Live Migration to Atlas e selecione Migrar do Ops Manager ou
Cloud Manager.

Método
Descrição
Migrar ao vivo (enviar) um conjunto de réplicas monitorado no Ops Manager ou Cloud
Manager para o Atlas
O Cloud Manager ou o Ops Manager envia dados do conjunto de réplicas de origem para
um conjunto de réplicas de destino no Atlas.
Migrar ao vivo (enviar) um cluster fragmentado monitorado no Ops Manager ou Cloud
Manager para Atlas
Cloud Manager ou Ops Manager envia dados do cluster fragmentado de origem para um
cluster fragmentado de destino no Atlas.
Migração ao vivo de um nó MongoDB independente
Converter o nó MongoDB autônomo no Ops Manager ou converter o nó MongoDB
autônomo no Cloud Manager para um conjunto de réplicas de nó único e, em seguida,
migrá-lo ao vivo (enviar) para o Atlas.
Migração em tempo real (envio por push) de
um conjunto de réplicas monitorado pelo Ops
Manager ou Cloud Manager
Nesta página

Restrições
Pré-requisitos
Considerações
Migre seu cluster
APIs de migração push ao vivo
Apoio à migração
Enviar comandos CLI de migração ao vivo
O Atlas pode facilitar uma migração ao vivo em que, se o Cloud Manager ou o Ops Manager
monitorar um cluster de conjunto de réplicas de origem, ele envia esse cluster para um
cluster do Atlas. O Atlas mantém o cluster de destino sincronizado com o cluster de origem
até que você transfira seus aplicativos para o cluster de destino no Atlas.

Depois de atingir a etapa de transição no procedimento a seguir, interrompa as gravações


no cluster de origem. Pare as instâncias do seu aplicativo, aponte-as para o cluster Atlas e
reinicie-as.

Restrições
Não é possível selecionar um cluster compartilhado M0 (nível gratuito) ou M2/M5 como
destino para migração ao vivo. Para migrar dados de um cluster compartilhado M0 (nível
gratuito) ou M2/M5 para um cluster pago, consulte Modificar um cluster.

Você não pode migrar em tempo real usando este procedimento de migração para um
cluster de destino Atlas que tenha o BI Connector for Atlas ativado.

Você não poderá migrar em tempo real para um cluster de destino Atlas se usar o Ops
Manager em
modo local.

Durante a migração ao vivo, o Atlas desativa alertas de host.

Se seus clusters de origem e destino estiverem executando o MongoDB 6.0.8 ou posterior,


você poderá migrar em tempo real para o Atlas usando este procedimento.

Para migrar em tempo real um cluster fragmentado, consulte Migrar em tempo real (enviar)
um cluster fragmentado monitorado pelo Ops Manager ou Cloud Manager.

Suporte para peering de VPC e endpoints privados


A tabela a seguir lista o status de suporte atual para peering de VPC e endpoints privados
para clusters de conjuntos de réplicas de origem e destino que você migra em tempo real
para o Atlas.
Provedor de nuvem
Pareamento de VPC
Pontos finais privados
Azul

AWS

Google Nuvem

Para ativar o peering de VPC com migração em tempo real no Azure, AWS ou Google
Cloud:

Configure uma conexão de emparelhamento de VPC entre o host de migração e o cluster


Atlas de destino.

Para habilitar endpoints privados com migração em tempo real no Azure, AWS ou Google
Cloud:

Configure um ponto final privado entre o anfitrião de migração e o cluster Atlas de destino.

OBSERVAÇÃO
Os pontos finais privados são suportados SOMENTE para migração em tempo real de
conjuntos de réplicas implantados num único fornecedor de nuvem e numa única região.
Clusters fragmentados, clusters multirregionais e clusters multinuvem não suportam a
migração ao vivo através de pontos finais privados.

Pré-requisitos
Antes de iniciar a migração ao vivo do Cloud Manager ou do Ops Manager para o Atlas:

Enquanto o
caminhos de migração suportados
permitem migrar de um cluster de origem no MongoDB 4.0 ou 4.2 para um cluster no Atlas,
é altamente recomendável que, antes de usar este procedimento, você atualize o cluster de
origem para o MongoDB 4.4 ou posterior.

Crie uma conta Atlas.

Crie uma organização Atlas e, em seguida, crie um projeto nesta organização.

Certifique-se de ter a função de proprietário da organização Atlas.

Implante seu cluster neste projeto.

Conecte-se ao seu cluster a partir de todos os servidores clientes onde seus aplicativos são
executados.

Se estiver migrando do Ops Manager, atualize o Ops Manager para a versão 5.0.
Ao migrar do MongoDB 4.4 ou anterior para um cluster Atlas que executa o MongoDB 5.0
ou posterior, elimine qualquer
índices geoHaystack
de suas coleções.

Durante o processo de migração ao vivo, o Atlas valida que pode coletar estatísticas do
banco de dados MongoDB usando
dbStats
. Antes de migrar para um cluster Atlas,
revise as configurações do projeto
para o cluster de origem no Cloud Manager ou
revise as configurações do projeto
para o cluster de origem no Ops Manager e certifique-se de que a opção Coletar
estatísticas específicas do banco de dados esteja habilitada. Esta opção está habilitada por
padrão no Cloud Manager ou no Ops Manager e deve permanecer habilitada para que o
processo de migração passe na validação.

No cluster de origem no Cloud Manager ou no Ops Manager, prepare os seguintes itens:

Provisionar um host de migração


no Gerenciador de operações ou
provisionar um host de migração
no Gerenciador de nuvem.

Obtenha os seguintes endereços IP externos do administrador do Cloud Manager ou do


Ops Manager:

Se estiver migrando do Ops Manager, os endereços IP externos ou blocos CIDR das


instâncias do Ops Manager. Ao migrar do Cloud Manager, o Atlas obtém automaticamente
esses endereços.

Os endereços IP externos ou blocos CIDR dos hosts de migração provisionados no Cloud


Manager ou no Ops Manager.

O nome de usuário e a senha usados para conectar-se ao cluster de origem.

Se o cluster de origem usar TLS/SSL com uma autoridade de certificação raiz


personalizada, para garantir que os hosts possam ler o certificado, adicione o arquivo CA do
cluster de origem aos hosts de migração.

Considere configurar uma conexão de peering de VPC ou um endpoint privado entre cada
host de migração e o cluster Atlas de destino no mesmo provedor de nuvem e na mesma
região que o cluster de destino.

OBSERVAÇÃO
Se você optar por não usar peering de VPC ou endpoints privados, o processo de migração
em tempo real será executado em endereços IP públicos adicionados à lista de acesso IP
do projeto Atlas como parte do procedimento de migração em tempo real.

Fluxo de trabalho de migração ao vivo


Esta seção descreve o trabalho baixo. Para etapas detalhadas, consulte o
procedimento para migrar um conjunto de réplicas do Ops Manager ou Cloud Manager para
o Atlas.

"Para migrar sua implantação para o Atlas, gere um token de link,


provisionar um host de migração e iniciar a migração em tempo real."
As etapas do fluxo de trabalho de migração ao vivo são:

Etapa 1: Link com Atlas. Execute esta etapa no Atlas, depois de criar sua conta,
organização e projeto do Atlas; implantou seu cluster dedicado neste projeto; e pode se
conectar a ele.

Na organização Atlas, acesse Live Migration.

Selecione Migrar do Ops Manager ou Cloud Manager e inicie o assistente de migração em


tempo real.

Se você estiver
migrando
da comunidade MongoDB usando o Ops Manager, aceite o
Contrato de migração do gerente de operações.

Se você estiver migrando do Ops Manager, insira os endereços IP externos de suas


instâncias do Ops Manager na lista de acesso do Atlas. Se você estiver migrando do Cloud
Manager, ignore esta etapa.

Estágio 2: Provisionar Host de Migração.

Provisionar um host de migração


no Gerenciador de operações ou
provisionar um host de migração
no Gerenciador de nuvem. Um host de migração executa um agente MongoDB dedicado
que orquestra o processo de migração ao vivo do Cloud Manager ou Ops Manager para o
Atlas.

OBSERVAÇÃO
Se você estiver migrando uma implantação de origem do MongoDB que nunca usou o Ops
Manager ou o Cloud Manager antes,
adicionar processos existentes do MongoDB ao Ops Manager
ou
adicione processos existentes do MongoDB ao Cloud Manager.
Na seção Live Migration: Connect to Atlas da página Configurações da sua organização
Cloud Manager ou Ops Manager, selecione Connect to Atlas e cole o token de link que você
criou no Atlas. Para saber mais, consulte
Conecte-se ao Atlas para migração ao vivo
no Gerenciador de operações ou
Conecte-se ao Atlas para migração ao vivo
no Gerenciador de nuvem.

Etapa 3: iniciar a migração. No Atlas, siga as etapas do assistente para iniciar o processo
de migração em tempo real.

Caminho de migração e plataformas suportadas


A migração ao vivo do Cloud Manager ou do Ops Manager para o Atlas é compatível com
todas as plataformas nas quais você pode provisionar um host de migração. Para obter uma
lista completa de plataformas suportadas nas quais você pode provisionar um host de
migração, consulte
Pré-requisitos do Cloud Manager
no Cloud Manager ou
Pré-requisitos do gerente de operações
no Gerenciador de operações.

Se quiser migrar seus dados em tempo real de uma implantação baseada em Windows ou
macOS para o Atlas, você deverá provisionar seu host de migração em uma das
plataformas suportadas.

A migração ao vivo do Atlas (push) oferece suporte aos seguintes caminhos de migração:

Conjunto de réplicas de origem


Versão do MongoDB
Conjunto de réplicas do Atlas de destino
Versão do MongoDB
4,0
4.4
4.2
4,4, 5,0
4.4
4,4, 5,0
5,0
5,0
Acesso à rede para migração ao vivo do Ops Manager ou Cloud Manager
Entre em contato com o administrador de serviço do Cloud Manager ou do Ops Manager e
obtenha endereços IP externos para os seguintes componentes:

Endereço IP externo do cluster de origem no Ops Manager


Se você estiver migrando do Ops Manager, o serviço de migração em tempo real no Atlas
exigirá um endereço IP externo ou um bloco CIDR externo da instância do Ops Manager na
implantação do cluster de origem. Esse endereço pode ser de uma única instância do Ops
Manager ou, se a implantação de origem usar várias instâncias do Ops Manager, do
gateway que as instâncias do Ops Manager usarão para acessar o Atlas.

O serviço de migração ao vivo usa esse endereço IP externo ao gerar um token de link. Um
token de link é uma string que contém as informações necessárias para conectar-se do
Cloud Manager ou do Ops Manager ao Atlas durante uma migração ao vivo de uma
implantação do Cloud Manager ou do Ops Manager para um cluster no Atlas.

Endereço IP externo do host de migração no Ops Manager ou Cloud Manager


Antes de iniciar o procedimento de migração em tempo real, adicione os endereços IP ou
blocos CIDR dos seus hosts de migração à lista de acesso IP do projeto. O Atlas permite
conexões com o cluster de destino apenas a partir de hosts com entradas na lista de acesso
do projeto.

Validação pré-migração
Antes de iniciar o procedimento de migração ao vivo, o Atlas executa verificações de
validação nos clusters de origem e destino.

O cluster de origem é um conjunto de réplicas.

Se o cluster de origem for independente,


converter
o nó MongoDB autônomo no Ops Manager ou
converter
o nó MongoDB autônomo no Cloud Manager para um conjunto de réplicas de nó único e,
em seguida, migrá-lo ao vivo para o Atlas usando o procedimento nesta seção.

O cluster de origem permite coletar estatísticas de banco de dados para seu projeto no
Cloud Manager ou no Ops Manager. Isso permite que o Atlas colete estatísticas do banco
de dados MongoDB durante o processo de migração ao vivo. Para confirmar se a opção
Coletar estatísticas específicas do banco de dados está habilitada,
revise as configurações do projeto
para o cluster de origem no Cloud Manager ou
revise as configurações do projeto
para o cluster de origem no Ops Manager.

O cluster Atlas de destino é um conjunto de réplicas e não tem o BI Connector for Atlas
habilitado.

Requisitos de segurança para o host de migração


Para migrações ao vivo do tipo push, você é responsável por provisionar, proteger e
executar o host de migração. O host de migração criptografa apenas a comunicação de
saída com clusters Atlas.

Para aprender mais e sobre a segurança do Atlas, consulte o


Segurança Atlas
papel branco.
Limites de chave de índice
Se a sua implantação do MongoDB contém índices com chaves que excedem o
Limite de chave de índice
, antes de iniciar o procedimento de migração ao vivo, modifique os índices para que não
contenham chaves superdimensionadas. Para saber mais sobre estratégias para lidar com
chaves superdimensionadas, consulte
failIndexKeyTooLong
na documentação do servidor MongoDB.

IMPORTANTE
Limite de chave de índice
failIndexKeyTooLong
foi descontinuado no MongoDB versão 4.2 e foi removido no MongoDB 4.4 e posterior.
Para MongoDB anterior a 4.2, defina esse parâmetro como false.

Considerações
Criptografia de rede
Durante migrações push ao vivo, se o cluster de origem não usar criptografia TLS para seus
dados, o tráfego do cluster de origem para o host de migração não será criptografado, mas
o tráfego do host de migração para o Atlas será criptografado. Determine se isso é aceitável
antes de iniciar um procedimento de migração push ao vivo.

Usuários e funções do banco de dados


Se o cluster de origem não usar autenticação, você deverá criar um usuário no Atlas porque
o Atlas não dá suporte à execução sem autenticação.

O Atlas não migra nenhum dado de usuário ou função para o cluster de destino.

Se o cluster de origem impôs autenticação, antes de migrar você deverá recriar o


mecanismo de autenticação apropriado usado por seus aplicativos no cluster Atlas de
destino. A tabela a seguir lista os mecanismos de autenticação e como configurá-los no
Atlas.

Mecanismo de Autenticação
Método de configuração
SCRAM
Crie usuários de banco de dados com SCRAM para autenticação por senha.
LDAP

Configure o LDAP.
AWS KMS, Azure Key Vault, Google Cloud KMS
Configure a criptografia KMS.
Configuração do Cluster de Destino
Para o cluster de destino, considere o seguinte:

O cluster de destino no Atlas deve corresponder ou exceder a implantação de origem em


termos de RAM, CPU e armazenamento. Provisione um cluster de destino de tamanho
adequado para que ele possa acomodar o processo de migração e a carga de trabalho
esperada ou aumente a escala do cluster de destino para uma camada com mais poder de
processamento, largura de banda ou E/S de disco.

Para maximizar o desempenho da migração, utilize pelo menos um cluster M40 para o
cluster de destino. Ao migrar grandes conjuntos de dados, use um cluster M80 com discos
de 6.000 IOPS ou superiores.

Você também pode optar por aumentar temporariamente o tamanho do cluster Atlas de
destino durante o processo de migração. Depois de migrar a carga de trabalho do seu
aplicativo para um cluster no Atlas, entre em contato com o suporte para obter assistência
com ajuste adicional de desempenho e dimensionamento do cluster de destino para
minimizar custos.

Para evitar alterações inesperadas de dimensionamento, desative o escalonamento


automático no cluster de destino. Para saber mais, consulte Gerenciar clusters.

Para evitar o crescimento ilimitado da coleção de oplogs, defina um tamanho fixo de oplog
durante o processo de migração em tempo real. Para saber mais, consulte Acesso
necessário e opções de configuração do Atlas. Se você observar problemas de
desempenho mesmo depois de seguir essas recomendações, entre em contato com o
suporte.

O cluster Atlas de destino deve ser um conjunto de réplicas.

Não é possível selecionar um cluster de nível compartilhado M0 (nível gratuito) ou M2/M5


como destino para migração ao vivo.

Não altere o sinalizador featureCompatibilityVersion enquanto a migração ao vivo do Atlas


estiver em execução.

Evite cargas de trabalho no cluster de destino


Evite executar quaisquer cargas de trabalho, incluindo aquelas que possam estar em
execução em namespaces que não se sobrepõem ao processo de migração ao vivo, no
cluster de destino. Esta ação evita potenciais conflitos de bloqueio e degradação do
desempenho durante o processo de migração em direto.

Não execute várias migrações para o mesmo cluster de destino ao mesmo tempo.

Não inicie o processo de transferência dos seus aplicativos para o cluster de destino
enquanto o processo de migração ao vivo estiver sincronizando.

Evite backups na nuvem


O Atlas para de tirar snapshots de backup em nuvem sob demanda do cluster de destino
durante a migração ao vivo. Depois de concluir a etapa de transição no procedimento de
migração ao vivo nesta página, o Atlas retoma a obtenção de snapshots de backup na
nuvem com base em sua política de backup.

Evite alterações de namespace


Não faça alterações no namespace durante o processo de migração, como usar o
renomearCollection
comando ou executando um pipeline de agregação que inclui o
$ fora
fase de agregação.

Evite eleições
O processo de migração em tempo real faz o melhor possível para continuar uma migração
durante interrupções temporárias da rede e eleições nos clusters de origem ou de destino.
No entanto, esses eventos podem causar falha no processo de migração em tempo real. Se
o processo de migração ao vivo não puder ser recuperado automaticamente, reinicie-o
desde o início.

Ambientes de preparação e produção


Considere executar o procedimento a seguir duas vezes. Execute uma migração parcial que
pare primeiro na etapa Executar a substituição. Isso cria um cluster de teste atualizado
apoiado pelo Atlas para testar o comportamento e o desempenho do aplicativo usando o
mais recente
versão do driver
que suporta a versão MongoDB do cluster Atlas.

Depois de testar seu aplicativo, execute o mig completo procedimento de racionamento


usando um cluster Atlas separado para criar seu ambiente de produção apoiado pelo Atlas.

Migrando da comunidade MongoDB


Se você estiver
migrando
para Atlas da comunidade MongoDB usando o Ops Manager, você deve aceitar o
Contrato de migração do gerente de operações
como o primeiro passo no
Procedimento de migração ao vivo.

Migre seu cluster


IMPORTANTE
Evite fazer alterações na configuração do cluster de origem enquanto o procedimento de
migração em tempo real é executado, como remover membros do conjunto de réplicas ou
modificar
mondeus
configurações de tempo de execução, como featureCompatibilityVersion.

Procedimento
1
Inicie o processo de migração.
No painel esquerdo da página da sua organização, clique em Live Migration.

Clique em Migrar do Ops Manager ou Cloud Manager.

Clique em Estou pronto para começar e, se estiver


migrando
da comunidade MongoDB usando o Ops Manager, clique em Contrato de licença do Ops
Manager para lê-lo e aceitá-lo. Para ler o contrato fora do Live Migration Wizard, consulte o
Contrato de migração do gerente de operações.

O Atlas exibe um assistente de migração ao vivo com instruções sobre como prosseguir
com o processo. O processo envia os dados do cluster de origem para o novo cluster de
destino. Depois de concluir as etapas do assistente, você poderá apontar seu aplicativo
para o novo cluster.

2
Link com Atlas.
Clique em Gerar token de link. Atlas exibe a página para gerar um token de link.

Se você estiver migrando do Ops Manager, insira os endereços IP externos ou um bloco


CIDR de suas instâncias do Ops Manager para adicioná-los à lista de acesso da chave de
API incorporada no token de link. Isso permite que o Ops Manager envie informações de
projeto e cluster para o Atlas. O Ops Manager não envia nenhum dado armazenado em
seus bancos de dados MongoDB nesta etapa. Por exemplo, insira 23.248.95.14.

Se você estiver migrando do Cloud Manager, ignore esta etapa.

Clique em Avançar para ver uma página que contém o token de link gerado.

Copie o token do link e armazene-o em um local seguro. O Atlas nunca exibe o conteúdo do
token do link. O Atlas também não exibe o token do link após gerá-lo. Não compartilhe
publicamente.

OBSERVAÇÃO
Use um token de link exclusivo para migrar em tempo real todos os projetos em uma
organização Cloud Manager ou Ops Manager para o Atlas.

Clique em Concluído.

3
Cole o token do link no Ops Manager ou Cloud Manager.
Acesse a organização no Cloud Manager ou no Ops Manager:

Abra o Ops Manager ou o Cloud Manager e navegue até a organização cujo cluster do
projeto você está migrando ao vivo para o Atlas.

Clique em Configurações no painel de navegação esquerdo.

Na seção Live Migration: Connect to Atlas, clique em Connect to Atlas. A caixa de diálogo
Conectar ao Atlas é aberta.

Cole o token de link gerado na etapa anterior do assistente de migração ao vivo e clique em
Conectar ao Atlas. Cloud Manager ou Ops Manager estabelece a conexão com o Atlas. Use
o botão Atualizar para enviar uma atualização ao Atlas, se necessário. Para saber mais,
consulte
Conecte-se ao Atlas para migração ao vivo
no Gerenciador de operações ou
Conecte-se ao Atlas para migração ao vivo
no Gerenciador de nuvem.

4
Crie o cluster Atlas de destino.
Se ainda não o fez, crie um cluster de destino no Atlas. Ver
Pré-requisitos.

5
Inicie a migração do cluster de destino.
Clique em Selecionar cluster de destino em projetos.

Vá para o projeto do cluster Atlas de destino e encontre o cluster de destino.

Clique e selecione Migrar dados para este cluster na lista suspensa para iniciar a migração.
A página Migrar dados para este cluster é aberta.

Clique em Migrar do Ops Manager ou Cloud Manager e preencha os campos conforme a


seguir:

Selecione o projeto de origem no Cloud Manager ou no Ops Manager, se ainda não estiver
selecionado.

Selecione um host de migração para lidar com a migração.

Revise a lista de acesso de endereços IP e verifique se o endereço IP externo do host de


migração está incluído nessa lista. Se não estiver adicionado, adicione-o agora:

Clique em Definir acesso à rede para host

Clique em + Adicionar endereço IP

Retorne ao assistente de migração ao vivo. Selecione o cluster de origem no menu


suspenso e escolha Migrar dados para este cluster em .

Selecione o cluster de origem no menu suspenso.

Se você suspender o cluster de origem da automação no Cloud Manager ou Ops Manager,


mas continuar monitorando o cluster de origem com o Agente de Monitoramento, o Nome
de Usuário e a Senha serão exibidos. Se sua implementação exigir autenticação de usuário,
forneça o nome de usuário e a senha nesses campos. O usuário do banco de dados cujas
credenciais você fornece deve ter pelo menos o
função de backup
no banco de dados admin e deve ser autenticado usando
tanto SCRAM-SHA-1 quanto SCRAM-SHA-256.

Se o cluster de origem usar TLS/SSL, alterne a opção A criptografia em trânsito está


habilitada? botão.

Se o cluster de origem usar TLS/SSL com uma autoridade de certificação raiz (CA)
personalizada, copie o caminho para o arquivo CA do seu host de migração e cole esse
caminho na caixa de texto fornecida. O arquivo deve estar presente no host de migração
para garantir que o host de migração possa ler o certificado. O Atlas verifica se o certificado
está presente e legível.

Se o cluster de destino do conjunto de réplicas tiver dados e você quiser preservá-los,


lembre-se deixe a opção Limpar quaisquer dados existentes no cluster de destino
desmarcada. O serviço de migração ao vivo avisa se encontrar namespaces duplicados. Se
você deseja excluir os dados existentes, marque esta opção.

Escolha uma conexão para se conectar ao cluster. A conexão Padrão sempre aparece
como disponível na IU. No entanto, outras opções de conexão serão habilitadas somente se
você tiver configurado anteriormente uma conexão de peering de VPC ou um endpoint
privado. Se o Atlas detectar que você não tem conexões VPC ou endpoints privados
configurados, essas opções ficarão esmaecidas.

Se você não estiver usando peering de VPC ou um endpoint privado, clique em Conexão
padrão e prossiga para o estágio de validação desta etapa.

Se você configurou uma conexão de peering de VPC entre o host de migração e o cluster
Atlas, a opção de peering de VPC estará ativa. Clique em peering de VPC para conectar-se
usando peering de VPC para migração em tempo real. Se a opção VPC Peering estiver
esmaecida, configure uma conexão de peering de VPC antes de iniciar este procedimento.
Para saber mais, consulte
Suporte para peering de VPC e endpoints privados.

Se você estiver migrando um conjunto de réplicas e configurado um ponto final privado


entre o host de migração e o cluster Atlas, a opção Ponto Final Privado estará ativa. Clique
em Ponto Final Privado para conectar-se a um ponto final privado e, em seguida, selecione
um ponto final privado previamente configurado no menu suspenso. Apenas os pontos finais
privados que estão no estado AVAILABLE são válidos. Se a opção Private Endpoint estiver
esmaecida, configure um endpoint privado antes de iniciar este procedimento. Para saber
mais, consulte
Suporte para peering de VPC e endpoints privados.

OBSERVAÇÃO
Os pontos finais privados são suportados SOMENTE para migração em tempo real de
conjuntos de réplicas implantados num único fornecedor de nuvem e numa única região.
Clusters fragmentados, clusters multirregionais e clusters multinuvem não suportam a
migração ao vivo através de pontos finais privados.
Clique em Validar. O processo de validação verifica se o seu host de migração está
acessível e executa as verificações de validação a seguir para garantir que você possa
iniciar a migração em tempo real para o Atlas.

Para aproveitar as seguintes verificações de validação,


atualizar o agente MongoDB no Ops Manager
, ou
atualizar o agente MongoDB no Cloud Manager
para a versão mais recente. Se o processo de migração ao vivo detectar que o cluster de
origem está executando uma versão do MongoDB Agent anterior a 12.0.11.7606 para Ops
Manager ou 12.5.0.7713 para Cloud Manager, ele exibirá um aviso de banner sugerindo que
você atualize o MongoDB Agent.

As seguintes verificações de validação são executadas durante a migração em tempo real:

O host de migração pode se conectar ao cluster de destino.

Se o cluster de origem usar TLS/SSL com uma autoridade de certificação raiz (CA)
personalizada, o host de migração poderá acessar o cluster de origem usando TLS/SSL.

As credenciais do usuário do banco de dados são válidas. Essa verificação de validação


será executada somente se você suspender o cluster de origem da automação no Cloud
Manager ou no Ops Manager, mas continuar monitorando o cluster de origem com o Agente
de Monitoramento.

Se você estiver migrando do Ops Manager antes da versão 5.0.9, o processo de migração
em tempo real validará se o cluster de destino tem espaço em disco suficiente com base no
tamanho dos dados. Se você estiver migrando do Cloud Manager ou do Ops Manager 5.0.9
ou posterior, o processo de migração validará se o cluster de destino tem espaço em disco
suficiente com base no tamanho de armazenamento dos dados compactados. Para saber
mais sobre dados e tamanhos de armazenamento, consulte
dbStats.

Se a validação falhar, verifique o host de migração, a validade dos seus endereços IP


externos ou bloco CIDR e o token do link. Verifique também as credenciais do usuário do
banco de dados, seus certificados TLS/SSL e a quantidade de tamanho de armazenamento
em disco no cluster de destino.

Se a validação for bem-sucedida, clique em Avançar. A página Migrar do Ops Manager ou


Cloud Manager é exibida.

6
Inicie a migração.
Revise o relatório que lista sua organização, projeto e cluster de origem e o host de
migração que o processo de migração em tempo real usará.

Clique em Iniciar a migração.


7
Prepare-se para cortar.
Um valor de tempo de atraso é exibido durante a fase final do oplog que representa o atraso
atual entre os clusters de origem e de destino. Esse tempo de atraso pode variar
dependendo da taxa de geração de oplog no cluster de origem, mas deve diminuir com o
tempo, à medida que o processo de migração ao vivo copia as entradas de oplog para o
cluster de destino.

Quando o temporizador e o botão Preparar para transição ficarem verdes, clique nele para
prosseguir para a próxima etapa.

8
Execute a transição.
Quando o Atlas detecta que os clusters de origem e destino estão quase sincronizados, ele
inicia um cronômetro extensível de 120 horas (5 dias) para iniciar o estágio de transição do
procedimento de migração ao vivo. Se o período de 120 horas passar, o Atlas interromperá
a sincronização com o cluster de origem. Você pode estender o tempo restante em 24 horas
clicando em Prolongar tempo abaixo do <tempo> restante para interromper o cronômetro.

Para concluir a migração dos dados do MongoDB para o cluster do Atlas, conclua as etapas
a seguir na página Sua migração está quase concluída! página:

Prepare-se para apontar para seu cluster do Atlas er. Copie o novo
cadeia de conexão
para que você possa atualizá-lo e apontar seu aplicativo para o cluster Atlas de destino.

Pare seu aplicativo. Esta ação garante que não ocorram mais gravações no cluster de
origem.

Aguarde até que a lacuna ideal chegue a zero. Quando o contador chega a zero, os clusters
de origem e de destino estão sincronizados.

Aguarde mais algum tempo até que o Atlas configure seu cluster de destino e esteja pronto
para uso. Para clusters menores, esse tempo é de 3 a 5 minutos. Para clusters maiores,
esse tempo pode se estender por até 10 minutos ou mais, dependendo do tamanho e da
configuração do cluster.

Reinicie seu aplicativo usando a nova cadeia de conexão do Atlas e confirme se seu
aplicativo está funcionando com o cluster Atlas.

Clique em Cut Over para concluir o processo de migração.

Se você clicar em Cancelar na barra de progresso da migração ao vivo, o Atlas


interromperá a sincronização de gravações do cluster de origem. Todos os dados migrados
permanecem no cluster Atlas.

Você pode clicar em Cortar novamente para permitir que o Atlas conclua o processo de
migração.
APIs de migração push ao vivo
Para executar tarefas associadas ao procedimento de migração em tempo real, consulte
API de migração push ao vivo.

Apoio à migração
Se você tiver alguma dúvida sobre o suporte à migração além do que é abordado nesta
documentação ou se encontrar um erro durante a migração, solicite suporte por meio da UI
do Atlas.

Para registrar um ticket de suporte:

Clique em Suporte na navegação à esquerda.

Clique em Solicitar suporte.

Para Categoria do Problema, selecione Ajuda com migração em tempo real.

Para Prioridade, selecione a prioridade apropriada. Para perguntas, selecione Prioridade


Média. Se houve uma falha na migração, selecione Alta Prioridade.

Para Resumo da solicitação, inclua Migração ao vivo em seu resumo.

Para obter mais detalhes, inclua quaisquer outros detalhes relevantes à sua pergunta ou
erro de migração.

Clique no botão Solicitar suporte para enviar o formulário.

Enviar comandos CLI de migração ao vivo


Para migrar um cluster usando a CLI do Atlas, você pode executar as seguintes etapas:

Crie ou exclua um token de link

Criar ou visualizar um trabalho de validação

Criar ou visualizar um job de migração

Execute a transição

Para outras etapas do


procedimento de migração ao vivo
, você deverá usar a IU do Cloud Manager ou a IU do Atlas. Para saber mais, consulte o
fluxo de trabalho de migração ao vivo.

Antes de migrar um cluster usando a CLI do Atlas, conclua o


validação pré-migração.

OBSERVAÇÃO
Antes de executar qualquer comando Atlas CLI, você deve:

Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Criar ou excluir um token de link


Para criar um novo token de link usando a CLI do Atlas, execute o seguinte comando:

atlas liveMigrations link create [options]

Para excluir o token de link especificado usando a CLI do Atlas, execute o seguinte
comando:

atlas liveMigrations link delete [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
atlas liveMigrações link criar
e
exclusão do link atlas liveMigrations.

Se você estiver migrando do Ops Manager, solicite um endereço IP externo e especifique-o


no token de link. Para saber mais, consulte
Solicite um endereço IP externo
na documentação do Ops Manager.

Criar e visualizar um trabalho de validação


Para criar uma nova solicitação de validação usando a CLI do Atlas, execute o seguinte
comando:

atlas liveMigrations validation create [options]

Para retornar os detalhes da solicitação de validação especificada usando a CLI do Atlas,


execute o seguinte comando:

atlas liveMigrations validation describe [options]


Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
atlas liveMigrations validação criar
e
descrição da validação do atlas liveMigrations.

Para saber o que o Atlas valida, consulte o marcador Validar na seção Migrar seu cluster
nesta página.

Criar e visualizar um trabalho de migração


Para criar um novo trabalho de migração usando a CLI do Atlas, execute o seguinte
comando:

atlas liveMigrations create [options]

Para retornar os detalhes do trabalho de migração especificado usando a CLI do Atlas,


execute o seguinte comando:

atlas liveMigrations describe [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para descrever atlas liveMigrações criar e atlas liveMigrations.

Execute a transição
Para iniciar a transferência para migração ao vivo usando a CLI do Atlas, execute o
seguinte comando:

atlas liveMigrations cutover [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
atlas liveMigrations cutover.

Quando a transição for concluída, o Atlas concluirá o processo de migração em tempo real
e interromperá a sincronização com o cluster de origem. Para saber mais, consulte a seção
Migrar seu cluster nesta página.
Migrar um conjunto de réplicas do MongoDB
da AWS para o MongoDB Atlas na AWS
O MongoDB Atlas Live Migration Service ajuda você a migrar bancos de dados MongoDB
para nosso banco de dados em nuvem totalmente gerenciado, MongoDB Atlas, executado
na AWS de forma rápida e segura. Ele funciona conectando-se ao seu banco de dados
MongoDB existente e sincronizando-o com um cluster em execução no Atlas enquanto seu
aplicativo continua funcionando normalmente. Depois que os dados entre os dois clusters
forem sincronizados, você pode simplesmente atualizar a cadeia de conexão do banco de
dados em seu aplicativo para passar para seu cluster no Atlas.

Tempo necessário: 20 minutos

O que você precisará


Seus dados estão atualmente em um banco de dados MongoDB.

Este guia se concentra na migração para o MongoDB Atlas na AWS a partir de uma
implantação autogerenciada existente do MongoDB na AWS. Se você tiver dados em outros
sistemas de banco de dados, como MySQL, PostgreSQL ou DynamoDB, por favor
Contate-nos
para obter ajuda com sua migração.

Atualize seu
Drivers MongoDB
e faça todas as alterações necessárias no código no nível do aplicativo para garantir a
compatibilidade.

Sua implantação atual é um conjunto de réplicas do MongoDB ou um cluster fragmentado.

Se sua implantação for atualmente uma instância autônoma, você deverá primeiro
convertê-lo em um conjunto de réplicas.

Se você estiver migrando um conjunto de réplicas, ele estará executando o MongoDB 2.6
ou superior.

O Atlas Live Migration Service pode mover seus dados diretamente para uma versão mais
recente do banco de dados. Para obter mais informações sobre os caminhos de atualização
suportados, consulte o
Documentação do Atlas.

Se você estiver executando uma versão anterior à 2.6, consulte Atualize o MongoDB para
2.6 para obter instruções de atualização.

Se você estiver migrando um cluster fragmentado, ele estará executando o MongoDB 4.0
ou superior.
O Atlas Live Migration Service pode mover seus dados diretamente para a mesma versão
do banco de dados. Para obter mais informações sobre os caminhos de atualização
suportados, consulte o Documentação do Atlas.

Se você estiver executando uma versão anterior à 4.0, consulte Atualize o MongoDB para
4.0 para obter instruções de atualização.

(Opcional) Autenticação habilitada na implantação de origem.

O processo de migração exige que a autenticação esteja habilitada no cluster de origem na


AWS. Ver Habilitar autenticação para obter instruções sobre como ativar a autenticação.
Você pode verificar se a autenticação está habilitada em seu cluster de origem usando o
comando mangusto:

mongosh <mongodb-connection-string> -u <mongodb-username> -p


--authenticationDatabase admin

O usuário do banco de dados do cluster de origem na AWS que você usará para realizar a
migração tem as funções necessárias do MongoDB.

O usuário deve ter as funções clusterMonitor e backup. Para verificar se o usuário do banco
de dados que você pretende usar para migração possui as funções apropriadas, execute o
comando
db.getUser()
comando no banco de dados administrativo.

usar administrador
db.getUser("admin")

use admin
db.getUser("admin")
{
"_id" : "admin.admin",
"user" : "admin",
"db" : "admin",
"roles" : [
{
"role" : "backup",
"db" : "admin"
},
{
"role" : "clusterMonitor",
"db" : "admin"
}
]
} ...
Procedimento
1
Inicie seu conjunto de réplicas de destino no MongoDB Atlas em execução na AWS.
Consulte Criar uma conta MongoDB e
Crie um novo cluster
para obter instruções.

OBSERVAÇÃO
Seu cluster de destino deve usar nós de instância M10 ou maiores. Para ambientes de
desenvolvimento ou de preparo, implante um cluster com nós de instância M10 ou M20.
Para cargas de trabalho de produção, selecione nós de instância M30 ou maiores.

2
Abra o serviço de migração Atlas Live.
1
Navegue até o cluster do Atlas. Clique no botão de reticências (...) e selecione Migrar dados
para este cluster.

Esta imagem destaca a migração de dados para este cluster


opção em um cartão de cluster no Atlas.
Clique para ampliar
2
Clique em Migração Geral ao Vivo.
3
Clique em Estou pronto para migrar.
4
Adicione o endereço IP do Atlas Live Migration Service ao cluster de origem da AWS.
Na parte superior do modal Migrate Data to Cluster, o Atlas exibe os intervalos de
endereços IP que devem estar acessíveis no cluster de origem. Os intervalos de endereços
exibidos dependem da localização do cluster de destino e podem mudar, portanto, verifique
se você inseriu os intervalos de endereços conforme exibidos no modal.

Os servidores AWS EC2 são protegidos contra acesso não autorizado à rede usando
Grupos de segurança
. Para adicionar novos intervalos de endereços IP à lista de acesso IP, crie um novo grupo
de segurança ou modifique seu grupo de segurança existente para permitir acesso de
entrada à rede a partir dos intervalos de endereços IP exibidos.

Aqui está um exemplo de grupo de segurança que concede acesso ao Atlas Live Migration
Service.

A imagem mostra a edição e adição de regras de entrada.


Clique para ampliar
Se você criar um novo grupo de segurança, deverá associá-lo às instâncias do EC2 que
executam seu cluster de origem. No console AWS EC2, clique no menu suspenso Ações e
selecione Alterar grupo de segurança.
GIF demonstrando a alteração de um grupo de segurança.
Clique para ampliar
Para obter informações adicionais sobre como criar ou modificar grupos de segurança,
consulte
Adicionando regras a um grupo de segurança
na documentação do AWS EC2.

5
Valide suas credenciais da AWS com o Atlas Live Migration Service.
1
No modal Migrar dados para cluster, insira o nome do host e o número da porta do nó
primário no cluster de origem da AWS que Atlas usará para realizar a migração de dados.

OBSERVAÇÃO
O endereço deve poder ser resolvido pela Internet pública, portanto, não use o endereço IP
privado do nó.

2
Insira o nome de usuário e a senha do MongoDB do cluster de origem da AWS em Nome de
usuário/Senha.

3
Se o TLS/SSL estiver habilitado no cluster de origem, alterne TLS/SSL habilitado para Sim e
carregue o arquivo CA que seu cluster AWS de origem usa.

4
Clique em Validar.
6
Clique em Iniciar migração.
Um cronômetro de contagem regressiva em uma barra de progresso indica quanto tempo
resta antes que o cluster de destino esteja pronto para migrar dados do cluster de origem.
Aguarde até que o cronômetro de contagem regressiva e o botão Preparar para transição
fiquem verdes antes de prosseguir para a próxima etapa.

7
Clique em Preparar para transição.
8
Execute a transição.
Quando o Atlas detecta que os clusters de origem e destino estão quase sincronizados, ele
inicia um temporizador extensível de 72 horas para iniciar o procedimento de transição. Se
o período de 72 horas passar, o Atlas interromperá a sincronização com o cluster de origem.
Você pode estender o tempo restante em 24 horas clicando no hiperlink Estender tempo
abaixo do <tempo> restante para reduzir o cronômetro.

1
Quando estiver preparado para transferir seus aplicativos para o cluster Atlas de destino,
clique em Preparar para transferência.
2
O Atlas exibe uma tela passo a passo com instruções sobre como proceder com a
transição. Essas etapas também são descritas abaixo:

Pare seu aplicativo. Isso garante que nenhuma gravação adicional seja gerada no cluster de
origem.

Aguarde até que a lacuna ideal chegue a zero. Quando o contador chega a zero, os clusters
de origem e de destino estão sincronizados.

Reinicie seu aplicativo usando a nova cadeia de conexão fornecida na etapa 3 da UI de


substituição do Live Migrate.

3
Depois de concluir o procedimento de transferência e confirmar que seus aplicativos estão
funcionando normalmente com o cluster Atlas, clique em Substituição para concluir o
procedimento de migração. Isso permite que a Atlas:

Marque o plano de migração como concluído.

Remova as sub-redes do Application Server da lista de acesso IP do cluster de destino.

Remova o usuário MongoDB que o Live Migrate usou para importar dados para o cluster de
destino.

Apoio à migração
Se você tiver alguma dúvida sobre a migração além do que é abordado nesta
documentação ou se encontrar um erro durante a migração, consulte a documentação do
Atlas em solicitando apoio.

Resumo
Você criou um cluster Atlas, migrou dados do cluster anterior do AWS MongoDB e atualizou
seus aplicativos para usar o novo cluster MongoDB Atlas em execução na AWS. Para obter
mais informações sobre o processo de migração de dados, consulte Migração ao vivo do
seu conjunto de réplicas para o Atlas e mongomirror.
Migrar dados com ferramentas
autogerenciadas
Você pode trazer dados de implantações existentes do MongoDB, arquivos JSON ou CSV
para o Atlas usando uma das seguintes ferramentas executadas fora do Atlas.

OBSERVAÇÃO
Para importar dados usando o
Ferramentas MongoDB, incluindo mongodump, mongorestore, mongoexport e
mongoimport, você deve ter Ferramentas MongoDB versão 100.5.x ou posterior. Para
mover dados para uma instância sem servidor, você também pode usar o Compass para
exportar e importar dados.

Para saber mais sobre as limitações de instância sem servidor, consulte Limitações de
instância sem servidor.

Ferramenta
Descrição
mongosync

O mongosync binário é o principal processo usado em


Sincronização cluster a cluster. Use o mongosync para migrar dados de um cluster para
outro no Atlas. O Atlas sincroniza dados do cluster de origem para o cluster de destino até
que você transfira seus aplicativos para o cluster Atlas de destino.
mongomirror
Migre de um conjunto de réplicas do MongoDB para um cluster Atlas sem desligar o
conjunto de réplicas ou aplicativos existentes. mongomirror não importa dados de
usuário/função nem copia o banco de dados de configuração.
mongorestore
Propague um cluster Atlas com um dump de backup de dados BSON de uma implantação
existente do MongoDB. mongorestore não restaura dados de coleta system.profile.
mongoimportação
Carregue dados de um arquivo JSON ou CSV em um cluster Atlas.
mongoimportação usa representação de modo estrito para certos tipos de BSON.
Bússola MongoDB
Use uma GUI para carregar dados de um arquivo JSON ou CSV em um cluster Atlas.
Você também pode restaurar dados de backup de um cluster Atlas para outro cluster Atlas.
Para obter informações, consulte Restaurar a implantação do seu banco de dados.
mongosync
Nesta página

Descrição
Opções
Opções globais
Comportamento
Independência de Cluster
Arquivo de configuração
Consistência
Perfil
Clusters fragmentados
Visualizações
Bloqueio de gravação
Comprometer-se
Coleções limitadas
Coleções do sistema
Exemplos
Descrição
O binário mongosync é o processo principal usado na sincronização cluster a cluster.
mongosync migra dados de um cluster para outro e pode manter os clusters em
sincronização contínua.

Este documento fornece uma visão geral completa das opções de linha de comando do
mongosync.

OBSERVAÇÃO
Tanto o cluster de origem quanto o cluster de destino devem usar o MongoDB 6.0 ou
posterior.

mongosync oferece suporte a conjuntos de réplicas e clusters fragmentados.

Instâncias autônomas do MongoDB não são suportadas.


Converter a instância autônoma
para um conjunto de réplicas antes de usar a sincronização cluster a cluster.

mongosync não oferece suporte a clusters compartilhados Atlas ou instâncias sem servidor.

Para obter uma lista completa de limitações, consulte Limitações de sincronização de


cluster para cluster.

Opções
Opções globais
--cluster0 <URI>
Define o
URI de conexão
para o primeiro cluster. O primeiro cluster pode servir como origem ou destino no processo
de sincronização. Designe os clusters de origem e destino na chamada para o endpoint
inicial da API.

Para obter mais informações sobre como conectar o mongosync, consulte Conexões.

Para definir a opção --cluster0 de um arquivo de configuração, consulte a configuração


cluster0.

--cluster1 <URI>
Define o
URI de conexão
para o primeiro cluster. O primeiro cluster pode servir como origem ou destino no processo
de sincronização. Designe os clusters de origem e destino na chamada para o endpoint
inicial da API.

Para obter mais informações sobre como conectar o mongosync, consulte Conexões.

Para definir a opção --cluster1 de um arquivo de configuração, consulte a configuração


cluster1.

--config <nome do arquivo>


Define o caminho para o arquivo de configuração.

Para mais informações, veja


Independência do Cluster.

--disableTelemetria
Novo na versão 1.4.0.

Desativa a coleta de dados de telemetria para mongosync.

Por padrão, o mongosync coleta dados de uso agregados e anônimos para melhorar os
produtos MongoDB. Ao executar o mongosync, você pode desabilitar a coleta desses dados
de telemetria.

Para definir a opção --disableTelemetry de um arquivo de configuração, consulte a


configuração disableTelemetry.

Para obter mais informações, consulte Coleta de dados do usuário.

--ajuda, -h
Imprime informações de uso em stdout.

--id<ID>
Define um identificador para a instância do mongosync.
Use esta opção ao executar múltiplas instâncias do mongosync em um cluster fragmentado,
para sincronizar os fragmentos individualmente.

O valor do identificador para esta opção deve corresponder ao ID do fragmento que ela
sincroniza. Para encontrar o ID do fragmento, use o
listaShards
comando.

Para definir a opção --id de um arquivo de configuração, consulte a configuração do id.

--loadLevel <nível>
Tipo: inteiro

Padrão: 3

Define o nível de carga de trabalho do cluster para sincronizar dados entre os clusters de
origem e de destino:

4, a configuração mais alta, maximiza a carga de trabalho do cluster e sincroniza os dados


com mais rapidez.

1, a configuração mais baixa, minimiza a carga de trabalho do cluster e sincroniza os dados


mais lentamente.

Para definir a opção --loadLevel de um arquivo de configuração, consulte a configuração


loadLevel.

AVISO
Definir loadLevel superior ao padrão 3 pode impactar negativamente o desempenho do
cluster de destino.

--logPath <DIR>
Define o caminho para o diretório de log. O Cluster-to-Cluster Sync grava logs em arquivos
neste diretório.

Para obter mais informações, consulte Registro em log.

Para definir a opção --logPath de um arquivo de configuração, consulte a configuração


logPath.

--porta
Padrão: 27182

Configura a porta usada pelo servidor HTTP para a API HTTP de sincronização cluster a
cluster.

Para definir a opção --port de um arquivo de configuração, consulte a configuração da porta.


--verbosidade <nível>
Padrão: DEBUGAR

Define o nível de detalhamento a ser usado em mensagens de log. A sincronização cluster


a cluster registra todas as mensagens no nível especificado e todas as mensagens em
níveis inferiores.

A opção --verbosity suporta os seguintes valores:

VESTÍGIO

DEPURAR

INFORMAÇÕES

AVISAR

ERRO

FATAL

PÂNICO

Para definir a opção --verbosity de um arquivo de configuração, consulte a configuração de


verbosidade.

--versão, -v
Imprime informações da versão do mongosync em stdout.

Comportamento
Independência de Cluster
mongosync sincroniza dados de coleta entre um cluster de origem e um cluster de destino.
mongosync não sincroniza Usuários ou papéis. Como resultado, você pode criar usuários
com diferentes permissões de acesso em cada cluster.

Arquivo de configuração
As opções para mongosync podem ser definidas em um arquivo de configuração YAML.
Use o
--config
opção. Por exemplo:

$ mongosync --config /etc/mongosync.conf

Para obter informações sobre as configurações disponíveis, consulte Configuração.

Consistência
suporte mongosync
consistência eventual no cluster de destino. A consistência de leitura não é garantida no
cluster de destino; os clusters de origem e de destino podem ser diferentes em um
determinado momento. No entanto, se novas gravações forem interrompidas no cluster de
origem, os clusters de origem e de destino eventualmente reterão os mesmos dados.

As gravações individuais podem ser reordenadas ou combinadas à medida que são


retransmitidas da origem ao destino. Para um determinado documento, o número total de as
gravações podem diferir entre origem e destino.

As transações podem aparecer de forma não atômica no cluster de destino. As gravações


repetíveis podem não ser repetíveis no cluster de destino.

Perfil
Se a criação de perfil estiver habilitada em um banco de dados de origem, o MongoDB
criará uma coleção especial chamada <db>.system.profile. Depois que a sincronização for
concluída, a sincronização cluster a cluster não eliminará a coleção <db>.system.profile do
destino, mesmo que o banco de dados de origem seja eliminado posteriormente. A coleção
<db>.system.profile não alterará a precisão dos dados do usuário no destino.

Clusters fragmentados
A sincronização cluster a cluster oferece suporte à replicação entre clusters fragmentados.
Os fragmentos individuais são replicados em paralelo do cluster de origem para o cluster de
destino, no entanto, um
migração de pedaços
ou uma atualização de origem semelhante pode mover documentos para um novo
fragmento de origem durante a replicação.

Mesmo que os documentos sejam movidos entre fragmentos de origem durante a


replicação, o Cluster-to-Cluster Sync mantém o
consistência eventual
garantia no cluster de destino.

Visualizações
Se um banco de dados com visualizações for descartado na origem, o destino poderá
mostrar uma coleção system.views vazia nesse banco de dados. A coleção system.views
vazia não alterará a precisão dos dados do usuário no destino.

Bloqueio de gravação
mongosync não habilita o bloqueio de gravação por padrão. Se você ativar o bloqueio de
gravação, o mongosync bloqueará as gravações:

No cluster de destino durante a sincronização.

No cluster de origem enquanto o commit está em execução.

Para ativar o bloqueio de gravação, use a API inicial para definir enableUserWriteBlocking
como verdadeiro. Você não pode ativar o bloqueio de gravação após o início da
sincronização.
Você deve habilitar o bloqueio de gravação ao iniciar o mongosync se quiser usar a
sincronização reversa posteriormente.

Comprometer-se
Para interromper a sincronização, use o comando commit no cluster de destino para
converter índices e finalizar as alterações. Por padrão, as operações de confirmação não
têm efeito nas gravações, a menos que você habilite
bloqueio de gravação
. Se você ativar o bloqueio de gravação:

commit bloqueia gravações no cluster de origem.

commit bloqueia gravações no cluster de destino até que o mongosync comece a validação
do índice.

A operação de confirmação deve levar menos de alguns minutos. Para monitorar o


processo de commit, use o comando progress:

O cluster de destino é gravável quando canWrite é verdadeiro.

A conversão do índice é concluída quando o mongosync entra no estado COMMITTED.

Permissões do usuário
Para definir enableUserWriteBlocking, o usuário mongosync deve ter uma função que inclua
o
setUserWriteBlockMode
e
bypassWriteBlockingMode
Tipos de ação.

OBSERVAÇÃO
Ao usar enableUserWriteBlocking, as gravações são bloqueadas apenas para usuários que
não possuem o
bypassWriteBlockingMode
Tipo de acão. Os usuários que possuem esse ActionType podem realizar gravações.

Gravações permitidas
Para ver em que estado o mongosync está, chame o endpoint da API /progress. A saída
/progress inclui um valor booleano, canWrite.

Quando canWrite for verdadeiro, é seguro gravar no cluster de destino.

Quando canWrite for falso, não grave no cluster de destino.

Você pode gravar com segurança no cluster de origem enquanto o mongosync está
sincronizando. Não grave no cluster de destino, a menos que canWrite seja verdadeiro.
Coleções limitadas
A partir da versão 1.3.0, a sincronização cluster a cluster oferece suporte
coleções limitadas
com algumas limitações.

A versão mínima do servidor é 6.0.

convertToCapped
não é suportado. Se você executar convertToCapped, o mongosync será encerrado com
um erro.

cloneCollectionAsCapped
não é suportado.

As coleções limitadas no cluster de origem funcionam normalmente durante a


sincronização.

As coleções limitadas no cluster de destino apresentam alterações temporárias durante a


sincronização:

Não há número máximo de documentos.

O tamanho máximo da coleção é 1PB.

mongosync restaura os valores originais para o número máximo de documentos e tamanho


máximo do documento durante a confirmação.

Coleções do sistema
A sincronização cluster a cluster não é replicada
coleções do sistema
para o cluster de destino.

Se você emitir um
dropDatabase
comando no cluster de origem, essa alteração não será aplicada diretamente no cluster de
destino. Em vez disso, a sincronização cluster a cluster descarta coleções e visualizações
de usuários no banco de dados do cluster de destino, mas não descarta coleções do
sistema nesse banco de dados.

Por exemplo, no cluster de destino:

A operação de descarte não afeta um arquivo criado pelo usuário


sistema.js
coleção.

Se você ativar o perfil, o


sistema.perfil
resta a coleção.
Se você criar visualizações no cluster de origem e depois descartar o banco de dados, a
replicação da eliminação removerá as visualizações, mas deixará um campo vazio
visualizações do sistema
coleção.

Nesses casos, a replicação do dropDatabase remove do banco de dados todas as coleções


criadas pelo usuário, mas deixa suas coleções do sistema no cluster de destino.

Exemplos
Implante um cluster de origem e um cluster de destino.

Inicialize a sincronização cluster a cluster:

mongosync \
--cluster0 "mongodb://192.0.2.10:27017,192.0.2.11:27017,192.0.2.12:27017"\
--cluster1 "mongodb://192.0.2.20:27017,192.0.2.21:27017,192.0.2.22:27017"

Use a conexão apropriada cordas para o


--cluster0
e
--cluster1
opções para que possam se conectar aos seus conjuntos de réplicas.

Para iniciar o processo de sincronização, use um cliente HTTP como cURL para enviar o
comando start ao mongosync:

curl localhost:27182/api/v1/start -X POST\


--data '{ "fonte": "cluster0", "destino": "cluster1" }'

Exemplo de saída:

{ "sucesso": verdadeiro }
Migrar com mongomirror
Nesta página

Pré-requisitos
Caminho de atualização
Baixar mongomirror
Processo mongomirror
Execute mongomirror
Mudar para Atlas
Monitoramento
Desempenho
Sintaxe de comando, opções e exemplos
Solução de problemas
mongomirror é uma ferramenta para migrar manualmente dados de um conjunto de réplicas
existente do MongoDB para um conjunto de réplicas do MongoDB Atlas. mongomirror não
exige que você desligue seu conjunto de réplicas ou aplicativos existentes e não importa
dados de usuário ou função nem copia o banco de dados de configuração.

Use mongomirror para:

Executar uma migração única de um conjunto de dados para um cluster do MongoDB Atlas
a partir de uma implantação do MongoDB hospedada fora do MongoDB Atlas.

Executar uma migração única de um conjunto de dados de um cluster Atlas para outro
cluster Atlas.

Consulte também Escolhendo uma ferramenta de importação e migração de dados.

Pré-requisitos
Implantação de origem do MongoDB
A implantação de origem do MongoDB deve ser um conjunto de réplicas. Se a origem for
uma implantação autônoma do MongoDB, antes de executar o mongomirror,
converter o autônomo em um conjunto de réplicas.

O conjunto de réplicas de origem deve executar o MongoDB versão 2.6 ou superior.

O conjunto de réplicas de origem do MongoDB não pode ser um cluster livre M0 ou um


cluster compartilhado M2/M5.

Não altere o sinalizador featureCompatibilityVersion em nenhum momento durante o


procedimento.

Ao migrar do MongoDB 4.4 ou anterior para um cluster Atlas que executa o MongoDB 5.0
ou posterior, elimine qualquer
índices geoHaystack
de suas coleções.
mongomirror não é compatível com
Índices TTL
. Elimine quaisquer índices TTL existentes e reconstrua-os quando o processo de migração
for concluído. Se você não quiser descartar um índice existente porque ele é importante
para o desempenho da consulta, entre em contato com o suporte para obter opções
alternativas.

Não faça alterações no namespace durante o processo de migração, como usar o


renomearCollection
comando ou executando um pipeline de agregação que inclui o
$ fora
fase de agregação.

Você não pode usar o


renomearCollection
comando ou o
$ fora
estágio de agregação como parte da sincronização inicial, que é executada como parte do
processo mongomirror.

Você não deve reiniciar o primário durante o estágio inicial de sincronização da migração.

Se a sua implantação do MongoDB contém índices com chaves que excedem o


Limite de chave de índice
, antes de iniciar o procedimento de migração ao vivo, modifique os índices para que não
contenham chaves superdimensionadas. Para saber mais sobre estratégias para lidar com
chaves superdimensionadas, consulte
failIndexKeyTooLong
na documentação do servidor MongoDB.

IMPORTANTE
Limite de chave de índice
failIndexKeyTooLong
foi descontinuado no MongoDB versão 4.2 e foi removido no MongoDB 4.4 e posterior.
Para MongoDB anterior a 4.2, defina esse parâmetro como false.

Acesso necessário no conjunto de réplicas de origem


mongomirror deve ter acesso de rede ao conjunto de réplicas de origem. Se o conjunto de
réplicas de origem exigir autenticação, você deverá incluir credenciais de usuário ao
executar o mongomirror. Você deve especificar um usuário do banco de dados com, no
mínimo, os seguintes privilégios:

Leia todos os bancos de dados e coleções. O


leiaAnyDatabase
A função no banco de dados administrativo cobre esse requisito.

Leia o
registrar
. Consulte Acesso Oplog.

Execute o
getParameter
comando.

Se esse usuário não existir, crie o usuário em seu conjunto de réplicas do MongoDB de
origem. Diferentes versões do servidor MongoDB possuem diferentes funções integradas.
Selecione uma função integrada com base na versão do seu servidor MongoDB e execute
os comandos apropriados no
mangusto:

Para clusters de origem, um usuário deve ter o


leiaAnyDatabase
,
clusterMonitor
,e
cópia de segurança
papéis.

Para verificar se o usuário do banco de dados que executará o processo de migração em


tempo real possui essas funções, execute o comando
db.getUser()
comando no banco de dados admin.

use admin
db.getUser("admin")
{
"_id" : "admin.admin",
"user" : "admin",
"db" : "admin",
"roles" : [
{
"role" : "backup",
"db" : "admin"
},
{
"role" : "clusterMonitor",
"db" : "admin"
}
{
"role" : "readAnyDatabase",
"db" : "admin"
}
]
} ...
Além disso, o usuário do banco de dados do seu cluster de origem deve ter a função de ler
o oplog no seu banco de dados administrativo. Para saber mais, consulte Acesso Oplog.

Para clusters de origem executando o MongoDB 3.4, um usuário deve ter, no mínimo,
ambos os papéis clusterMonitor e leiaAnyDatabase. Por exemplo:

use admin
db.createUser(
{
user: "mySourceUser",
pwd: "mySourceP@$$word",
roles: [ "clusterMonitor", "readAnyDatabase" ]
}
)

Para clusters de origem executando o MongoDB 3.2, um usuário deve ter, no mínimo,
ambas as funções gerenciador de clusters e leiaAnyDatabase, bem como acesso de leitura
no banco de dados local. Isto requer uma função personalizada, que você pode criar com os
seguintes comandos:

use admin
db.createRole(
{
role: "migrate",
privileges: [
{ resource: { db: "local", collection: "" }, actions: [ "find" ] }
],
roles: ["readAnyDatabase", "clusterManager"]
}
)
db.createUser(
{
user: "mySourceUser",
pwd: "mySourceP@$$word",
roles: [ "migrate" ]
}
)

Para clusters de origem executando MongoDB 2.6 ou 3.0 um usuário deve ter, no mínimo, o
leiaAnyDatabase
papel. Por exemplo:

usar administrador
db.createUser(
{
usuário: "mySourceUser",
pwd: "minhaFonteP@$$palavra",
funções: ["readAnyDatabase"]
}
)

Implantação do Atlas de Destino


A implantação do Atlas de destino:

Não pode ser um cluster livre M0, um cluster compartilhado M2 ou M5.

Não pode ser uma instância sem servidor.

Deve ser um conjunto de réplicas.

Deve ter a versão igual ou posterior à versão do cluster de origem MongoDB. Ver
Caminho de atualização.

Não deve conter nenhum namespace que se sobreponha ao cluster de origem. Se o


mongomirror detectar namespaces sobrepostos no cluster de destino, ele falhará antes de
iniciar o processo. Se o cluster de destino contiver namespaces sobrepostos, exclua todos
os dados do cluster de destino com --drop ou liste os namespaces para importar do cluster
de origem com --includeNamespace.

Deve incluir em sua lista de acesso IP:

O endereço IP público do servidor no qual o mongomirror está sendo executado, ou

Se configurado para peering de VPC, o bloco CIDR da VPC do peer (ou um subconjunto) ou
o grupo de segurança da VPC do peer.

OBSERVAÇÃO
Para encontrar o endereço IP público de qualquer nó em seu cluster, use a ferramenta
nslookup na linha de comando. Para saber mais, consulte Os IPs públicos dos clusters Atlas
alguma vez mudam?.

Acesso necessário no cluster de destino


mongomirror deve ter acesso de rede ao cluster de destino.

Você deve especificar um usuário de banco de dados com a função de administrador do


Atlas para executar o mongomirror. Para saber mais, consulte Adicionar usuários do banco
de dados.

Caminho de atualização
mongomirror suporta os seguintes caminhos de migração.

IMPORTANTE
Você não pode usar o mongomirror para migrar de um conjunto de réplicas de origem 6.0.x
ou posterior para um conjunto de réplicas de destino 6.0.x ou posterior. Para migrar
conjuntos de réplicas 6.0.x ou posterior, atualize o MongoDB para pelo menos 6.0.8 e use
este procedimento de migração em tempo real.

Conjunto de réplicas de origem


Versão do MongoDB
Conjunto de réplicas do Atlas de destino
Versão do MongoDB
5,0
4,4, 5,0
4.4
4,4, 5,0
4.2
4,4, 5,0
4,0
4,4, 5,0
3.6
4,4, 5,0
3.4
4,4, 5,0
3.2
4,4, 5,0
3,0
4,4, 5,0
2.6
4,4, 5,0
OBSERVAÇÃO
Para fazer o downgrade de 5.0 para 4.4, a fonte
FCV
deve corresponder ao destino.

Baixar mongomirror
OBSERVAÇÃO
No macOS de 64 bits, um alerta de segurança aparece quando você tenta abrir o arquivo
mongomirror pela primeira vez após baixá-lo. Para prosseguir, veja
Abra um aplicativo substituindo as configurações de segurança.

Sistema operacional
Download
Amazon Linux 1
mongomirror-linux-x86_64-enterprise-amzn64-0.12.8.tgz
Amazon Linux 2
mongomirror-linux-x86_64-enterprise-amazon2-0.12.8.tgz
Debian 8.1
mongomirror-linux-x86_64-debian81-0.12.8.tgz
Debian 9.2
mongomirror-linux-x86_64-debian92-0.12.8.tgz
Debian 10
mongomirror-linux-x86_64-debian10-0.12.8.tgz
macOS de 64 bits
mongomirror-osx-x86_64-0.12.8.tgz
RHEL 6.2
mongomirror-linux-x86_64-rhel62-0.12.8.tgz
RHEL 7.0
mongomirror-linux-x86_64-rhel70-0.12.8.tgz
RHEL 7.1 PPC64LE
mongomirror-linux-ppc64le-rhel71-0.12.8.tgz
RHEL 7.2 s390x
mongomirror-linux-s390x-rhel72-0.12.8.tgz
RHEL 8.0
mongomirror-linux-x86_64-rhel80-0.12.8.tgz
RHEL 8.1 PPC64LE
mongomirror-linux-ppc64le-rhel81-0.12.8.tgz
LES 12
mongomirror-linux-x86_64-suse12-0.12.8.tgz
LES 15
mongomirror-linux-x86_64-suse15-0.12.8.tgz
Ubuntu 14.04
mongomirror-linux-x86_64-ubuntu1404-0.12.8.tgz
Ubuntu 16.04
mongomirror-linux-x86_64-ubuntu1604-0.12.8.tgz
Ubuntu 16.04 ARM
mongomirror-linux-arm64-ubuntu1604-0.12.8.tgz
Ubuntu 16.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1604-0.12.8.tgz
Ubuntu 18.04
mongomirror-linux-x86_64-ubuntu1804-0.12.8.tgz
Ubuntu 18.04 ARM
mongomirror-linux-arm64-ubuntu1804-0.12.8.tgz
Ubuntu 18.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1804-0.12.8.tgz
Ubuntu 20.04
mongomirror-linux-x86_64-ubuntu2004-0.12.8.tgz
Ubuntu 20.04 ARM
mongomirror-linux-arm64-ubuntu2004-0.12.8.tgz
janelas
mongomirror-win32-x86_64-0.12.8.zip
Processo mongomirror
Quando você inicia o mongomirror, ele:

Conecta-se ao Atlas por TLS/SSL.

Executa uma sincronização inicial, copiando coleções do conjunto de réplicas existente do


MongoDB para o cluster de destino no Atlas.
Após a sincronização inicial, segue continuamente o oplog do conjunto de réplicas para
alterações recebidas e as reproduz no cluster de destino no Atlas. mongomirror não copia o
banco de dados de configuração. A partir da versão 0.9.0, o mongomirror usa compactação
de fio se você ativá-lo no cluster de origem ou de destino e usar --compressors para
especificar quais bibliotecas de compactação permitir.

OBSERVAÇÃO
A partir da versão 0.5.0, o mongomirror constrói todos os índices no cluster de destino em
primeiro plano, independentemente de como os índices foram construídos no cluster de
origem. As compilações de índice em primeiro plano bloqueiam todas as outras operações
no banco de dados. Para saber mais, consulte
Operações de criação de índice em uma coleção preenchida.

Uma vez iniciado, o mongomirror é executado continuamente até você desligá-lo:

Se você encerrar o mongomirror durante o estágio inicial de sincronização, antes de


reiniciar o mongomirror, verifique se o cluster de destino está vazio ou execute o
mongomirror com --drop.

Se você desligar o mongomirror durante o


registrar
estágio de rejeito, o processo deixa de seguir o registrar
. Você pode reiniciar o mongomirror para continuar seguindo o último registro de oplog
processado usando --bookmarkFile.

Execute mongomirror
1
Configure o usuário do banco de dados no conjunto de réplicas de origem.
Se o conjunto de réplicas de origem exigir autenticação, você deverá incluir credenciais de
usuário ao executar o mongomirror. Para requisitos, consulte
Acesso necessário no conjunto de réplicas de origem.

Anote o nome de usuário e a senha desse usuário, pois você deve especificar essas
credenciais ao executar o mongomirror.

2
Configure um usuário de banco de dados no cluster Atlas de destino.
Você deve especificar um usuário de banco de dados com a função de administrador do
Atlas para executar o mongomirror. Consulte Adicionar usuários de banco de dados para
obter documentação sobre como criar um usuário de banco de dados.

Se esse usuário não existir, crie o usuário:

Na seção Segurança da navegação esquerda, clique em Acesso ao Banco de Dados. A


guia Usuários do banco de dados é exibida.

Clique em Adicionar novo usuário do banco de dados.


Adicione um usuário administrador do Atlas.

Anote o nome de usuário e a senha selecionados para o novo usuário, pois você deve
especificar essas credenciais ao executar o mongomirror.

3
Atualizar lista de acesso IP.
Se o host onde você executará o mongomirror não estiver na lista de acesso IP do seu
cluster, atualize a lista. Você pode especificar:

O endereço IP público do servidor no qual o mongomirror será executado, ou

Se configurado para peering de VPC, o bloco CIDR da VPC do peer (ou uma sub-rede) ou o
grupo de segurança da VPC do peer.

4
Abra a caixa de diálogo de conexão.
Clique em Banco de dados no canto superior esquerdo do Atlas.

Na visualização Implementações de Banco de Dados, clique em Conectar para o cluster


Atlas para o qual você deseja migrar dados.

5
Copie as informações do host do cluster de destino.
Você pode obter as informações do nome do host do cluster Atlas na interface do usuário do
Atlas.

OBSERVAÇÃO
Você não precisa usar um driver para migrar dados com o mongomirror.

Na caixa de diálogo Conectar, clique em Conectar com o Shell do MongoDB.

Na lista suspensa, selecione 3.4 ou anterior. A cadeia de conexão deve ser semelhante ao
exemplo a seguir. Este exemplo foi dividido em várias linhas para facilitar a leitura:

mongodb://<nomedeusuário>:<SENHA>@
00.foo.mongodb.net:27017,
01.foo.mongodb.net:27017,
02.foo.mongodb.net:27017/test?
ssl=true&replicaSet=myAtlasRS&authSource=admin
Em um editor de texto, cole o valor de replicaSet, adicione uma barra (/) e anexe a lista de
hosts como valores separados por vírgula, conforme mostrado no exemplo a seguir:

myAtlasRS/00.foo.mongodb.net:27017,01.foo.mongodb.net:27017,02.foo.mongodb.net:270
17
Use este valor para --destination na próxima etapa.

6
Inicie o mongomirror.
Inicie o mongomirror com as seguintes opções:

--host definido como a string de host do cluster de origem.

--ssl se o cluster de origem tiver TLS/SSL habilitado.

--username para o nome de usuário do cluster de origem criado para este procedimento.

--password para a senha do nome de usuário do cluster de origem.

--authenticationDatabase para o banco de dados no cluster de origem onde o nome de


usuário especificado para --username foi criado.

--destination para a string do host do cluster Atlas.

--destinationUsername para o nome de usuário do cluster Atlas de destino.

--destinationPassword para a senha do nome de usuário do cluster Atlas de destino.

Seu comando final deve ser semelhante ao exemplo a seguir:

mongomirror --host
"MySourceRS/host1.example.net:27017,host2.example.net:27017,host3.example.net:27017
"\
--ssl\
--nomedeusuário "meuUsuárioFonte"\
--password "minhaFonteP@$$palavra" \
--authenticationDatabase "admin"\
--destination
"myAtlasRS/00.foo.mongodb.net:27017,01.foo.mongodb.net:27017,02.foo.mongodb.net:270
17" \
--destinationUsername "meuAtlasAdminUser" \
--destinationPassword "atlasPassword"

Veja Opções para mais opções do mongomirror.

Para concluir o processo de migração,


mude para Atlas.

Mudar para Atlas


Depois que o mongomirror concluir a sincronização inicial e seguir o oplog do conjunto de
réplicas, você poderá alternar para o cluster Atlas de destino.

1
Pare seu aplicativo.
Isso garante que nenhuma gravação adicional ocorra no cluster de origem.
2
Aguarde até que o mongomirror relate 0s de atraso entre os clusters de origem e de
destino.
Isso significa que os clusters de origem e de destino estão em um estado consistente.

3
Pare com o mongomirror.
Assim que o cluster Atlas estiver atualizado, pare o mongomirror.

4
Atualize aplicativos cliente para usar o cluster Atlas.
Atualize seus aplicativos cliente com a string de conexão do Atlas fornecida por meio do
botão Conectar no painel do cluster.

Para obter detalhes sobre conexões com o Atlas, consulte Conectar-se por meio de seu
aplicativo.

Monitoramento
mongomirror registra seu progresso na saída padrão do terminal. Durante a sincronização
inicial, o mongomirror registra uma barra de progresso para cada coleção que copia. Por
exemplo:

2021-08-09T16:35:50.227-0000 [#....................] parque.eventos 2179/34184 (6,4%)


2021-08-09T16:35:50.227-0000 [#############........] zoo.animais 29000/49778 (58,3%)
Ao seguir o oplog, o mongomirror registra o tempo de atraso, em segundos, entre a entrada
de oplog mais recente no cluster de origem e a última entrada de oplog processada no
cluster de destino. Por exemplo:

12/12/2016T16:22:17.027-0800 Atraso atual da fonte: 6s


Um atraso tempo de 6 segundos significa que a última entrada de oplog processada pelo
mongomirror ocorreu 6 segundos antes da mais recente disponível no cluster de origem.

OBSERVAÇÃO
O tempo que o mongomirror leva para recuperar o atraso pode ser maior ou menor que 6
segundos, dependendo do número de entradas que chegam por segundo.

Um tempo de atraso de 0 segundos indica que o mongomirror está processando entradas


que chegaram menos de um segundo antes da última entrada do oplog.

Se o cluster de origem tiver índices, o mongomirror construirá os mesmos índices no cluster


de destino. O log de progresso mostra os horários de início e término do processo de
construção do índice. Para visualizar o progresso das construções do índice, você pode:

Use a operação atual comando no nó primário do cluster de destino. O campo de comando


mostra informações sobre a operação em execução. As entradas de construção de índice
são semelhantes a estas:
"command" : {
"createIndexes" : "perfs",
"indexes" : [
{
"key" : {
"animal" : "text"
},
"name" : "animal_text"
}
]...

Baixe os logs do mongodb para seu cluster de destino e procure entradas recentes para
linhas relacionadas ao índice. As mensagens de log relacionadas à criação de índice são
semelhantes a estas:

{"t":{"$date":"2021-08-09T16:35:50.227+00:00"},"s":"I", "c":"INDEX", "id":20447,


"ctx":"conn1080","msg":"Index build:
completed","attr":{"buildUUID":{"uuid":{"$uuid":"c4a62739-bf19-456d-bbd6-7baa29f10
63b"}}}}

Desempenho
Para evitar contenção de recursos de rede e CPU, execute o mongomirror em hosts
diferentes do seu conjunto de réplicas mondeus hosts de instância.

mongomirror afeta o desempenho do seu conjunto de réplicas de origem semelhante a ter


um secundário:

Para o estágio inicial de sincronização, a carga é dimensionada de acordo com o tamanho


do seu conjunto de dados.

Após a conclusão de uma sincronização inicial, a carga é dimensionada com gigabytes de


oplog usados por hora.

Sintaxe de comando, opções e exemplos


Para sintaxe, opções e exemplos do mongomirror, consulte a página de referência do
mongomirror.

Solução de problemas
Para solução de problemas do mongomirror, consulte Erros comuns de pós-validação para
migração ao vivo (Pull).
mongomirror
Nesta página

Sintaxe
Opções
Exemplos
AVISO
Ao usar o mongomirror com um filtro de namespace, as transações na origem com
namespaces que estão fora do escopo de includeNamespace <database.collection> são
consideradas comportamento indefinido e incorrem em possível perda de dados.

mongomirror é uma ferramenta para migrar manualmente dados de um conjunto de réplicas


existente do MongoDB para um conjunto de réplicas do MongoDB Atlas.

Sintaxe
Para executar o mongomirror, você deve especificar:

O conjunto de réplicas de origem e o conjunto de réplicas do Atlas de destino.

Um usuário no cluster Atlas com privilégios apropriados, a senha correspondente e os


privilégios apropriados, se o conjunto de réplicas de origem exigir autenticação.

mongomirror --host <sourceReplSet> \


--destination <atlasCluster> \
--destinationUsername <atlasAdminUser> \
--destinationPassword <atlasPassword> \
[Additional options]

Você pode especificar algumas opções no


arquivo de configuração
em vez de incluí-los no comando.

Opções
--host<host>
As informações do host para o conjunto de réplicas de origem. Especifique o nome do
conjunto de réplicas e uma lista inicial dos membros, como a seguir:

<RSname>/<host1>:<port1>,<host2>:<port2>,<host3>:<port3>

--username <nome de usuário>


Se o conjunto de réplicas de origem exigir autenticação, o nome de um usuário no conjunto
de réplicas de origem com privilégios para ler qualquer banco de dados, incluindo o banco
de dados local. Um usuário com acópia de segurança role fornece os privilégios
apropriados. Para obter detalhes sobre os privilégios específicos necessários, consulte o
Acesso necessário no conjunto de réplicas de origem.

--senha <senha>
Senha do usuário especificado em --username.

--authenticationDatabase <authenticationDatabase>
O banco de dados no conjunto de réplicas de origem onde o usuário especificado em
--username foi criado. O banco de dados de autenticação para:

Usuários autenticados por SCRAM são o banco de dados administrativo.

Usuários autenticados por X.509 são o banco de dados $external.

Os usuários autenticados pelo AWS IAM são o banco de dados $external.

Para saber mais, consulte


Banco de dados de autenticação.

--authenticationMechanism <authenticationMechanism>
O mecanismo de autenticação a ser usado para autenticar o usuário no conjunto de réplicas
de origem.

Valor
Descrição
SCRAM-SHA-1
RFC 5802
Mecanismo de autenticação de resposta de desafio salgado padrão usando a função hash
SHA-1.
SCRAM-SHA-256
RFC 5802
Mecanismo de autenticação de resposta de desafio salgado padrão usando a função hash
SHA-256.
MONGODB-CR
Autenticação de desafio/resposta do MongoDB.
MONGODB-X509
Autenticação de certificado MongoDB TLS/SSL.
GSSAPI
(Cérbero)
Autenticação externa usando Kerberos. Este mecanismo está disponível apenas em
MongoDB Empresarial.
SIMPLES
(LDAP SASL)
Autenticação externa usando LDAP. Você também pode usar PLAIN para autenticar
usuários no banco de dados. PLAIN transmite senhas em texto simples. Este mecanismo
está disponível apenas em
MongoDB Empresarial.
MONGODB-IAM
Novo na versão 0.10.0

Autenticação externa com


AWS IAM.

Para autenticar com credenciais AWS IAM, use as seguintes opções:

--nome de usuário
<ID da chave de acesso AWS>

--senha
<id da chave de acesso secreta>

--awsSessionToken
<token de sessão AWS>

Para saber mais, consulte


Mecanismos de autenticação.

--awsSessionToken
Novo na versão 0.10.0

Um token de sessão da AWS para uso com o mecanismo de autenticação MONGODB-IAM.

--compressores <mal-humorado,...>
Novo na versão 0.9.0

Lista separada por vírgulas de compressores a serem habilitados. Use 'nenhum' para
desativar. Padrão: rápido,zstd,zlib

--config=<arquivo>
Arquivo YAML que armazena opções e valores para mongomirror. Especifique o arquivo
usando caminhos relativos ou absolutos para executar o mongomirror com as opções que o
arquivo contém.

O arquivo de configuração oferece suporte às seguintes opções:

senha
<senha>

sslPEMKeyPassword
<senha>

senha de destino
<senha>

uri <cluster de origem


Cadeia de conexão URI>

Especifique opções no arquivo de configuração usando a opção: sintaxe de valor. Não


inclua opções -- before no arquivo de configuração. Se você definir uma opção no arquivo
de configuração, não será necessário especificar essa opção no comando mongomirror.

EXEMPLO
Crie um arquivo de configuração chamado myconfig.yaml que contenha o seguinte:

password: <passwordForUser>
destinationPassword: <passwordForDestinationUser>

Você pode executar o mongomirror sem incluir os sinalizadores --password e


--destinationPassword:

mongomirror --host <sourceReplSet> \


--ssl \
--username <atlasAdminUser> \
--destinationUsername <atlasAdminUser> \
--config=myconfig.yaml \
--destination <atlasCluster> \
[Additional options]

--destino <destino>
As informações do host para o conjunto de réplicas do Atlas de destino.

Especifique o nome do conjunto de réplicas e uma lista inicial dos membros, como a seguir:

<RSname>/<host1>:<port1>,<host2>:<port2>,<host3>:<port3>

--destinationAuthenticationDatabase <banco de dados de autenticação>


Banco de dados de autenticação para o usuário do banco de dados no cluster Atlas. O
banco de dados de autenticação
para usuários autenticados por SCRAM é o banco de dados administrativo.

Para saber mais, consulte Autenticação de usuário do banco de dados.

--destinationAuthenticationMechanism <mecanismo de autenticação>


Autenticação mecanismo para o usuário do banco de dados no cluster Atlas. Atlas oferece
as seguintes formas de autenticação para usuários de banco de dados:
Valor
Descrição
SCRAM-SHA-1
RFC 5802
Mecanismo de autenticação de resposta de desafio salgado padrão usando a função hash
SHA-1.
SCRAM-SHA-256
RFC 5802
Mecanismo de autenticação de resposta de desafio salgado padrão usando a função hash
SHA-256.
MONGODB-CR
Autenticação de desafio/resposta do MongoDB.
SIMPLES
(LDAP SASL)
Autenticação externa usando LDAP. Você também pode usar PLAIN para autenticar
usuários no banco de dados. PLAIN transmite senhas em texto simples. Este mecanismo
está disponível apenas em
MongoDB Empresarial.
Para saber mais, consulte Autenticação de usuário do banco de dados.

--destinationUsername <Nome de usuário do Atlas>


Nome de um usuário de banco de dados no cluster Atlas com privilégios para ler, gravar e
administrar qualquer banco de dados. Um usuário com função de administrador do Atlas
fornece os privilégios apropriados. Para obter detalhes sobre os privilégios específicos
necessários, consulte Acesso necessário no cluster de destino.

--destinationPassword <senha>
Senha do usuário do banco de dados especificado em --destinationUsername.

--derrubar
Bandeira que indica que
mongomirror
deve eliminar todas as coleções de usuários (visíveis em cada banco de dados com
listaColeções
) no cluster de destino. Esta opção não elimina coleções internas como local.system* e o
oplog.

--noIndexRestore
Novo na versão 0.10.0

Omita índices ao migrar dados.

--includeNamespace <database.collection>
Especifique um namespace no cluster de origem para espelhar no cluster de destino. Pode
ser fornecido várias vezes.

OBSERVAÇÃO
Se uma transação abranger vários namespaces, apenas as operações de gravação
aplicadas aos namespaces especificados em
--includeNamespace
ou
--includeDB
são aplicados ao cluster de destino.

--includeDB <banco de dados>


Especifique um banco de dados no cluster de origem para espelhar no cluster de destino.
Pode ser fornecido várias vezes.

OBSERVAÇÃO
Se uma transação abranger vários namespaces, apenas as operações de gravação
aplicadas aos namespaces especificados em
--includeNamespace
ou
--includeDB
são aplicados ao cluster de destino.

--ssl
Permite conexões criptografadas TLS/SSL com o conjunto de réplicas de origem.

--sslPEMKeyFile <arquivo>
O arquivo .pem se o conjunto de réplicas de origem exigir que os clientes apresentem um
certificado. O arquivo .pem contém o certificado e a chave TLS/SSL. Especifique o arquivo
usando caminhos relativos ou absolutos.

--sslPEMKeyPassword <valor>
Senha para descriptografar o arquivo de chave de certificado especificado em
--sslPEMKeyFile. Use se --sslPEMKeyFile estiver criptografado.

--sslCAArquivo <arquivo>
O arquivo .pem que contém a cadeia de certificados raiz da Autoridade de Certificação (CA)
para o conjunto de réplicas de origem. Especifique o arquivo usando caminhos relativos ou
absolutos.

--sslCRLFarquivo <nome do arquivo>


O arquivo .pem que contém a Lista de Revogação de Certificados do conjunto de réplicas
de origem. Especifique o arquivo usando caminhos relativos ou absolutos.

--sslAllowInvalidHostnames
Descontinuada. Use tlsInsecure em vez disso.

Desabilita a validação dos certificados TLS/SSL apresentados pelo conjunto de réplicas de


origem. Permite
mongomirror
para conectar-se ao conjunto de réplicas de origem se o nome do host nos certificados não
corresponder ao nome do host especificado.
IMPORTANTE
Esta opção ignora toda a validação de certificados, o que pode resultar na aceitação de
certificados inválidos.

--sslAllowInvalidCertificados
Descontinuada. Use tlsInsecure em vez disso.

Ignora as verificações de validação de certificados apresentados pelo conjunto de réplicas


de origem. Ao usar a configuração --allowInvalidCertificates, o MongoDB registra como um
aviso o uso do certificado inválido.

IMPORTANTE
Esta opção ignora toda a validação de certificados, o que pode resultar na aceitação de
certificados inválidos.

--tlsInseguro
Ignora as verificações de validação da cadeia de certificados e do nome do host do servidor.
Isso permite que você use certificados e nomes de host inválidos.

Isso substitui as opções obsoletas sslAllowInvalidHostnames e sslAllowInvalidCertificates.

--gssapiServiceName <nome>
Se o conjunto de réplicas de origem usar a autenticação Kerberos, o nome do serviço que
usa GSSAPI/Kerberos. Necessário apenas se o serviço não usar o nome padrão mongodb.

Esta opção está disponível apenas no MongoDB Enterprise.

--gssapiHostName <host>
Se o conjunto de réplicas de origem usar autenticação Kerberos, o nome do host de um
serviço usando GSSAPI/Kerberos. Necessário apenas se o nome do host de uma máquina
não corresponder ao nome do host resolvido pelo DNS.

Esta opção está disponível apenas no MongoDB Enterprise.

--readPreference <preferência de leitura>


Obsoleto desde a versão 0.9.0

mongomirror sempre lê do primário, a menos que a origem seja um único host sem um
nome de conjunto de réplicas; nesse caso, ele faz uma conexão direta apenas com esse
host.

--writeConcern <gravação de preocupação>


Obsoleto desde a versão 0.2.3: mongomirror sempre usa preocupação de gravação
majoritária.

--numParallelCollections <num>, -j <num>


Padrão: 4
O número de coleções a serem copiadas e restauradas em paralelo.

--bypassDocumentValidation
Obsoleto desde a versão 0.2.3: o mongomirror sempre ignora a validação do documento.

--bookmarkArquivo <arquivo> Padrão: mongomirror.bookmark

Nome do arquivo de marcador de carimbo de data/hora do oplog.

--forceDump
Bandeira que indica que
mongomirror
sincronizar novamente todas as coleções de origem, mesmo se existir um arquivo de
favoritos não vazio.

--oplogPath <caminho>
Novo na versão 0.5.0

Habilita
mongomirror
para armazenar em buffer a janela inicial do oplog de sincronização no disco. Ao
especificar um valor para esta opção,
mongomirror
transmite as entradas do oplog de origem para o diretório especificado em um único
arquivo: <oplogPath>/oplog-mongomirror.bson.sz. Depois que todo o arquivo oplog for
reproduzido no cluster de destino,
mongomirror
remove o arquivo e começa a seguir o oplog de origem sem buffer.

Por padrão,
mongomirror
transmite entradas de oplog da origem e as aplica ao cluster de destino. No entanto, a
migração poderá falhar se o oplog de origem não for grande o suficiente para conter toda a
janela inicial do oplog de sincronização. Para evitar esse erro, você pode
aumentar o tamanho do oplog de origem
ou especifique esta opção para garantir que o oplog de origem não ficará sem espaço
durante o processo de migração.

IMPORTANTE
Deve haver espaço em disco suficiente para acomodar todas as entradas de oplog de
origem que ocorrem durante o
mongomirror
sincronizar.

EXEMPLO
Se o oplog de origem tiver 10 GB e cobrir 24 horas de alterações, e
mongomirror
a sincronização está estimada em 48 horas, deve haver pelo menos 20 GB de espaço livre
em disco no diretório especificado.

--oplogBatchSize <num>
Padrão: 10.000

Especifique o número de entradas de oplog a serem enviadas em lote.


mongomirror
permite um tamanho máximo de volume de dados de 16 MB de documentos para enviar
em lote.

--httpStatusPort <num>
Diretos
mongomirror
para iniciar um servidor HTTP na porta especificada. Você pode recuperar o status atual
de
mongomirror
emitindo uma solicitação HTTP GET para http://localhost:<num>.

Ao correr com
--httpStatusPort
,
mongomirror
não sai quando encontra um erro. Em vez disso, ele registra o erro normalmente e relata o
erro por HTTP para a porta especificada.

mongomirror
retorna um documento em resposta à solicitação HTTP. O exemplo de sintaxe a seguir
representa todos os campos de saída possíveis - a resposta real pode retornar apenas um
subconjunto desses campos. Consulte a tabela a seguir para obter uma descrição dos
campos e quando esperá-los.

{
"estágio": "<nome do estágio>",
"fase" : "<Nome da fase>",
"detalhes" : {
"currentTimestamp": "<timestamp BSON>",
"latestTimestamp": "<timestamp BSON>",
"lastWriteOnSourceTimestamp": "<timestamp BSON>",
"<espaço de nomes>": {
"completo": <booleano>,
"copiadoBytes": <inteiro>,
"totalBytes": <inteiro>,
"createIndexes": <inteiro>
},
...
},
"errorMessage": "<mensagem de erro>"
}

A tabela a seguir descreve cada campo e seus possíveis valores:

Campo
Descrição
estágio
O nome da etapa em andamento. Os valores possíveis são:

inicializando

mongomirror
foi iniciado, mas ainda não está copiando nenhum dado.

sincronização inicial

mongomirror
está copiando documentos e índices que já existem na implantação de origem.
mongomirror
também segue e aplica entradas do oplog.

sincronização de registro

mongomirror
está seguindo e aplicando entradas do oplog.

Estágio
O nome da fase. Fornece detalhes mais específicos sobre qual parte do estágio está em
andamento.
detalhes
Um documento que fornece uma descrição detalhada do progresso da fase atual.

Durante o estágio inicial de sincronização, cada subdocumento em detalhes representa uma


única coleção sendo copiada pelo
espelho mongo.

Dependendo do estágio ou fase,


mongomirror
não pode incluir este campo na resposta.

detalhes.<namespace>
O namespace completo da coleção que está sendo copiada, exibido como
<database>.<collection>.

Exibido somente durante a fase inicial de sincronização ao copiar documentos ou índices.

detalhes.<namespace>.complete
Exibe verdadeiro ou falso dependendo se ou não
mongomirror
copiou todos os documentos ou índices da coleção para o cluster Atlas de destino.

Exibido somente durante a fase inicial de sincronização ao copiar documentos ou índices.

detalhes.<namespace>.copiedBytes
O número de bytes copiados até agora. Observe que esta é uma medida diferente da
mongomirror
logs, que informam o número atual/total de documentos copiados.

Exibido apenas durante a fase inicial de sincronização ao copiar dados não indexados.

detalhes.<namespace>.totalBytes
O tamanho total (em bytes) da coleção.

Exibido apenas durante a fase inicial de sincronização ao copiar dados não indexados.

detalhes.<namespace>.createIndexes
O número de índices que foram ou serão criados.

Exibido apenas durante o estágio inicial de sincronização ao copiar índices.

detalhes.currentTimestamp
O
Carimbo de data e hora BSON
valor da entrada oplog processada mais recentemente.
mongomirror
atualiza esse ponto de dados apenas a cada 10 segundos, então
mongomirror
pode estar um pouco mais adiantado em relação ao tempo relatado.

Exibido apenas durante os estágios iniciais de sincronização ou sincronização de oplog ao


seguir ou aplicar entradas de oplog.

detalhes.latestTimestamp
Durante o inicial estágio de sincronização, isso representa o
Carimbo de data e hora BSON
valor da última entrada de oplog disponível depois que os dados iniciais foram copiados
durante a sincronização inicial.

Durante o estágio de sincronização do oplog, isso representa o valor do carimbo de


data/hora BSON da última entrada do oplog disponível na implantação de origem.

Exibido apenas durante os estágios iniciais de sincronização ou sincronização de oplog ao


seguir ou aplicar entradas de oplog.

detalhes
.lastWriteOnSourceTimestamp
O
Carimbo de data e hora BSON
valor da entrada de oplog mais recente que não é autônoma. As entradas autônomas
geralmente são operações em nível de sistema, como heartbearts, que não gravam ou
editam dados no banco de dados.
mongomirror
atualiza esse valor a cada 10 segundos. As operações que gravam ou editam dados no
banco de dados podem não ser relatadas até que ocorra a próxima atualização.

O campo lastWriteOnSourceTimestamp é útil como uma confirmação de que nenhuma nova


gravação está ocorrendo na implantação de origem antes do corte durante uma migração.

mensagem de erro
Uma string que descreve qualquer erro encontrado por
espelho mongo.
--collStatsThreshold <num>
Novo na versão 0.9.0

Número máximo de coleções que podem existir antes


colStats
está desabilitado. Use -1 para sempre executar o collStats ou 0 para nunca executar o
collStats. Padrão: -1

--removeAutoIndexId
Novo na versão 0.12.0

Remove a opção autoIndexId das coleções durante a sincronização inicial com o cluster de
destino. Também remove a opção autoIndexId de quaisquer coleções que o mongomirror
cria durante a migração.

--preserveUUIDs
Permite que o Atlas preserve o UUID durante a migração ao vivo. Esta opção funciona
apenas com o processo de migração ao vivo executado pelo Atlas. Se você usar a opção
--preserveUUIDs na linha de comando, ela falhará devido a erros de permissão. Esses erros
são esperados porque esta opção não se destina a ser usada na linha de comando em um
processo de migração autogerenciado que executa o mongomirror.

Exemplos
Migrar um conjunto de réplicas para o Atlas: sem autenticação na origem
O exemplo a seguir migra de um conjunto de réplicas de origem que não requer
autenticação:

mongomirror --host fonteRS/source-host1:27017,source-host2:27017 \


--destino meuAtlasRS/atlas-host1:27017,atlas-host2:27017 \
--destinationUsername meuAtlasUser\
--destinationPassword meuAtlasPwd
Para migrar de um conjunto de réplicas de origem que não requer autenticação, execute o
mongomirror com as seguintes opções:

--hospedar
<sourceReplSet/lista inicial de membros>

--destino
<Aglomerado Atlas>

--destinationNome de usuário
<atlasUser>

--destinationPassword
<atlasSenha>

Para o destino, especifique o nome do conjunto de réplicas seguido por uma lista inicial de
membros no seguinte formato:

<replicaSetName>/<host1>:<porta1>,<host2>:<porta2>,<host3>:<porta3>,...

O usuário especificado deve ter a função de administrador do Atlas no Atlas.

Migrar um conjunto de réplicas: o conjunto de réplicas de origem usa autenticação


SCRAM-SHA1
O exemplo a seguir migra um conjunto de réplicas de origem que usa autenticação
SCRAM-SHA1 para Atlas:

mongomirror --host fonteRS/source-host1:27017,source-host2:27017,source-host3:27017 \


--nomedeusuário meuUsuárioFonte\
--password minhaSenhaFonte \
--authenticationDatabase admin \
--destino meuAtlasRS/atlas-host1:27017,atlas-host2:27017 \
--destinationUsername meuAtlasUser\
--destinationPassword atlasPassw0Rd

Para migrar de um conjunto de réplicas de origem que usa autenticação SCRAM-SHA1,


execute
mongomirror
com as seguintes opções:

--hospedar
<sourceReplSet/lista inicial de membros>

--nome de usuário
<usuáriofonte>

--senha
<fonteSenha>
--authenticationDatabase
<base de dados de origem>

--destino
<Aglomerado Atlas>

--destinationNome de usuário
<atlasUser>

--destinationPassword
<atlasSenha>

O usuário do conjunto de réplicas de origem deve ter o acesso necessário no cluster de


origem. A função de backup fornece os privilégios apropriados.

Para o destino, especifique o nome do conjunto de réplicas seguido por uma lista inicial de
membros no seguinte formato:

<replicaSetName>/<replicaMember>,<replicaMember>,<replicaMember>,...

O usuário especificado deve ter o administrador do Atlas no Atlas.

Migrar um conjunto de réplicas: o conjunto de réplicas de origem requer autenticação de


cliente X.509
O exemplo a seguir migra de um conjunto de réplicas de origem que usa autenticação
X.509:

mongomirror --host fonteRS/source-host1:27017,source-host2:27017,source-host3:27017 \


--username
"CN=meuNome,OU=minhaUnidadeOrg.,O=minhaOrg.,L=minhaLocalidade,ST=meuEstado,
C=meuPaís" \
--authenticationDatabase '$externo' \
--authenticationMechanism MONGODB-X509 \
--ssl\
--sslPEMKeyFile <caminho para meu certificado-cliente.pem> \
--sslCAFile <caminho para meu certificado-autoridade-certificado.pem> \
--destino meuAtlasRS/atlas-host1:27017,atlas-host2:27017 \
--destinationUsername meuAtlasUser\
--destinationPassword atlasPassw0Rd

Para migrar de um conjunto de réplicas de origem que usa autenticação X.509, execute
mongomirror
com as seguintes opções:

--hospedar
<sourceReplSet/lista inicial de membros>
--nome de usuário
<assunto do certificado do cliente>

--authenticationMecanismo
MONGODB-X509

--authenticationDatabase
'$externo'

--ssl

--ssl Arquivo PEMKey


<caminho-para-meu-certificado-cliente.pem>

--sslCAArquivo
<caminho para o arquivo raiz do CA PEM>

--destino
<Aglomerado Atlas>

--destinationNome de usuário
<atlasUser>

--destinationPassword
<atlasSenha>

O usuário do conjunto de réplicas de origem deve ter o acesso necessário no cluster de


origem. A função de backup fornece os privilégios apropriados.

Para o destino, especifique o nome do conjunto de réplicas seguido por uma lista inicial de
membros no seguinte formato:

<replicaSetName>/<replicaMember>,<replicaMember>,<replicaMember>,...

O usuário especificado deve ter o administrador do Atlas no Atlas.

Migrar um conjunto de réplicas: o conjunto de réplicas de origem requer autenticação


Kerberos/GSSAPI
O exemplo a seguir migra de um conjunto de réplicas de origem que usa autenticação
Kerberos:

mongomirror --host fonteRS/source-host1:27017,source-host2:27017,source-host3:27017 \


--username sourceUser/administrator@MYREALM.COM \
--authenticationDatabase '$externo' \
--authenticationMechanism GSSAPI\
--destino meuAtlasRS/atlas-host1:27017,atlas-host2:27017,atlas-host3:27017 \
--destinationUsername atlasUser\
--destinationPassword atlasPass
Para migrar de um conjunto de réplicas de origem que usa autenticação Kerberos, execute
mongomirror
com as seguintes opções:

--hospedar
<sourceReplSet/lista inicial de membros>

--nome de usuário
<principal do usuário Kerberos>

--authenticationDatabase
'$externo'

--authenticationMecanismo
GSSAPI

--destino
<Aglomerado Atlas>

--destinationNome de usuário
<atlasUser>

--destinationPassword
<atlasSenha>

O usuário do conjunto de réplicas de origem deve ter o acesso necessário no cluster de


origem. A função de backup fornece os privilégios apropriados.

Para o destino, especifique o nome do conjunto de réplicas seguido por uma lista inicial de
membros no seguinte formato:

<replicaSetName>/<replicaMember>,<replicaMember>,<replicaMember>,...

O usuário especificado deve ter o administrador do Atlas no Atlas.

Salvar a saída do mongomirror em um arquivo


Você pode salvar os logs de saída de um procedimento mongomirror em um arquivo para
exame e depuração posteriores. Use o seguinte formato para salvar a saída em um arquivo
mongomirror.log:

mongomirror <args> 2>&1 | tee -a mongomirror.log


mongomirror Registo de alterações
Nesta página

mongomirror 0.12.8
mongomirror 0.12.7
mongomirror 0.12.6
mongomirror 0.12.5
mongomirror 0.12.4
mongomirror 0.12.3
mongomirror 0.12.2
mongomirror 0.12.1
mongomirror 0.12.0
mongomirror 0.11.2
mongomirror 0.11.1
mongomirror 0.10.0
mongomirror 0.9.1
mongomirror 0.9.0
mongomirror 0.8.0
mongomirror 0.7.0
mongomirror 0.6.0
mongomirror 0.5.2
mongomirror 0.5.1
mongomirror 0.5.0
mongomirror 0.4.1
mongomirror 0.4.0
mongomirror 0.3.1
mongomirror 0.12.8
Correções de bugs:

Corrige um problema com o manuseio de bancos de dados de série temporal.

Ignora o
registrar
entrada com o identificador startRangeDeletion na coleção admin.system.version.

mongomirror 0.12.7
Correções de bugs:

Corrige um problema em que o mongomirror permitiria que você passasse para um cluster
de destino do MongoDB 4.2 antes que o cluster estivesse pronto. A correção garante que o
mongomirror aguarde a conclusão da construção do índice em todos os nós do cluster
durante uma sincronização inicial antes de passar para o oplog tailing e permitir que você
inicie o processo de transição.

mongomirror 0.12.6
Correções de bugs:
Corrige um problema em que o mongomirror ignorava índices válidos como se fossem
duplicados devido a ignorar opções durante a comparação de índices.

mongomirror 0.12.5
Recursos e melhorias:

Melhora a capacidade de repetição de problemas de conexão transitórios.

mongomirror 0.12.4
Recursos e melhorias:

Esclarece a mensagem de erro que o mongomirror retorna quando existe uma coleção na
implantação do banco de dados de origem e de destino.

Correções de bugs:

Corrige um problema em que o mongomirror retorna o seguinte erro ao tentar construir um


índice para um namespace que não está presente durante uma sincronização inicial:

Falha ao registrar o progresso da construção do índice: o namespace `` não possui um


progressor de coleção

mongomirror 0.12.3
Correções de bugs:

Corrige um problema ao lidar com grandes quantidades de entradas de oplog anteriores.

Corrige um bug onde a sincronização inicial falharia se a última entrada de oplog aplicada
durante a sincronização inicial fosse uma operação de transação.

Corrige um problema em que o mongomirror detectava a refragmentação incorretamente, o


que causava falsos positivos ao verificar o status de uma operação de refragmentação.

mongomirror 0.12.2
Correções de bugs:

Corrige um problema de conexão introduzido no mongomirror 0.12.0.

Corrige um bug em que apenas uma opção de índice legado é removida se existirem duas
ou mais opções de índice legado para uma coleção no banco de dados de origem.

Atualiza o driver Go para 1.7.1.

mongomirror 0.12.1
Correções de bugs:

Corrige um problema de conexão introduzido no mongomirror 0.12.0.


Reverte o driver Go para 1.5.4.

mongomirror 0.12.0
Recursos e melhorias:

mongomirror agora suporta migração


coleções de séries temporais.

Nova opção --removeAutoIndexId para remover autoIndexId: false das coleções que você
migra do MongoDB 3.6 ou anterior.

mongomirror agora falha quando você tenta migrar


índices geoHaystack
para um cluster Atlas executando MongoDB 5.0 ou posterior.

mongomirror falha se um
operação de reestilhaçamento
ocorre no cluster de origem durante uma migração.

mongomirror agora suporta RHEL 8 em plataformas IBM zSeries.

Driver Go atualizado para 1.6.

mongomirror 0.11.2
Recursos e melhorias:

Os binários do mongomirror agora são assinados para garantir a autenticidade.

O MongoDB agora suporta apenas a distribuição RHEL mais recente nas plataformas IBM
zSeries. Estas plataformas zSeries não são mais suportadas:

rhel67-zseries-*

suse12-zseries-*

suse15-zseries-*

ubuntu1604-zseries-*

ubuntu1804-zseries-*

Correções de bugs:

Corrige um problema com relatórios de uso de driver no Atlas.

mongomirror 0.11.1
Recursos e melhorias:
Oferece suporte à especificação de credenciais de usuário com um arquivo de configuração
ou variáveis de ambiente.

Apresenta logs de progresso de construção de índice para a sincronização do Oplog.

Atualiza notas de versão de terceiros para


https://github.com/youmark/pkcs8

Correções de bugs:

Melhora os relatórios de status de sincronização.

Corrige a lentidão introduzida no mongomirror 0.11.0.

mongomirror 0.10.0
Recursos e melhorias:

Nova opção --noIndexRestore para omitir índices ao migrar dados.

Nova opção --awsSessionToken para autenticação com uma função AWS IAM.

MongoDB v4.4 agora está disponível como versão de banco de dados de origem e de
destino.

Correções de bugs:

Tratamento de erros aprimorado quando uma string de conexão URI é fornecida para a
opção --host.

mongomirror 0.9.1
Recursos e melhorias:

Melhore o desempenho da sincronização inicial para


WiredTiger
fontes.

mongomirror 0.9.0
Recursos e melhorias:

Nova opção --compressors para compactação de rede (habilitada por padrão).

Nova opção --collStatsThreshold para desabilitar


colStats
quando um número especificado de coletas é excedido.

Crie primeiro índices para coleções maiores.


Reinicie o buffer do oplog entre a cópia da coleção e a construção do índice.

Melhore a liberação de lotes oplog para minimizar lotes pequenos.

O nível de log padrão agora registra quando os índices começam a ser construídos.

Correções de bugs:

Remova o suporte para a opção --readPreference. mongomirror deve sempre ler do


primário.

mongomirror 0.8.0
Recursos e melhorias:

A sincronização inicial insere lotes de até 100 mil documentos em vez de 1.000.

Aumente o tamanho do lote applyOps.

Correções de bugs:

Erros de buffer de Oplog lidando com entradas de oplog acima de 16 MB.

Desative o tempo limite do soquete.

O cliente de sincronização inicial não deve fazer detecção primária para conexões diretas.

mongomirror 0.7.0
Recursos e melhorias:

Atualize para o driver Go 1.1.1.

Adicione suporte para MongoDB 4.2.

Envie writeConcern com collMod quando o cluster de destino for a versão 3.6+.

Remova o uso legado de JSON estendido.

Correções de bugs:

Utilize a ligação direta ao cluster de origem quando o nome do conjunto de réplicas não for
fornecido.

Erro de autorização no oplog de leitura do banco de dados local da fonte de sincronização


inicial.

Regressão: operação sem transação processada como operação de transação.

Capture QuitNotifier em applyOplogEntries.


Altere o cálculo do atraso para evitar varreduras de coleta.

O cursor Oplog é reiniciado em vez de seguir para o lote vazio.

mongomirror 0.6.0
OBSERVAÇÃO
A versão 0.6.0 do mongomirror foi retirada e não está mais disponível.

Suporte MongoDB:

Adiciona suporte para MongoDB 4.2 apenas como destino

Correções de bugs:

O executável do Windows deve ter o sufixo .exe

Recursos e melhorias:

Migrar e sincronizar um subconjunto de bancos de dados/coleções (BETA)

Remover parâmetro --tailOnly

Agora usando o MongoDB


Vá motorista

Atualize para Go 1.12

mongomirror 0.5.2
Recursos e melhorias:

Importe coleções em ordem decrescente de tamanho da coleção para evitar que uma
coleção grande bloqueie a conclusão.

Distinguir entre erros não é possível conectar e não é um conjunto de réplicas.

noCursorTimeout agora evita tempos limite ao sincronizar coleções grandes.

Correções de bugs:

Erro ao aplicar entradas de oplog ao destino: E11000 erro de chave duplicada.

Recuperação após erros CannotCreateIndex.

mongomirror 0.5.1
Esta versão corrige um bug relacionado a dicas de índice ruins para
coleções limitadas.
mongomirror 0.5.0
Esta versão adiciona os seguintes recursos e melhorias:

Suporte para armazenar em buffer o oplog em disco durante a sincronização inicial. Isso
garante que o oplog de origem não ficará sem espaço durante o processo de migração.
Para obter mais informações, consulte a documentação da nova opção de linha de
comando --oplogPath.

Use TLS Go-native no Windows (em vez de OpenSSL 1.0.2n).

Atualize para Go 1.11 (de 1.8).

mongomirror agora remove o sinalizador de fundo de todos os índices que cria. Os índices
de segundo plano criados no cluster de origem serão criados como índices de primeiro
plano no cluster de destino. Para obter mais informações sobre construções de índice em
primeiro plano, consulte
Operações de criação de índice em uma coleção preenchida.

mongomirror 0.4.1
Esta versão corrige um erro de instalação em alguns hosts Windows.

mongomirror 0.4.0
Esta versão adiciona suporte para MongoDB 4.0 como origem e destino para mongomirror.

mongomirror 0.3.1
Esta versão adiciona os seguintes recursos e melhorias:

Suporte para MongoDB 4.0 como destino apenas para mongomirror.

Suporte para tolerar eleições e erros de rede no destino durante a sincronização inicial.

Suporte para sincronização de coleções "system.js".

Use TLS Go-native no MacOS (em vez de OpenSSL 0.9.8).

mongomirror deve ignorar o no-ops ao relatar o carimbo de data/hora do oplog mais


recente.

Esta versão também remove o suporte para Debian 7. Debian 7 é EOL e não é suportado
pelo MongoDB 4.0.
mongomirror Versões anteriores
Nesta página

mongomirror 0.12.7
mongomirror 0.12.6
mongomirror 0.12.5
mongomirror 0.12.4
Use os links a seguir para baixar versões anteriores do mongomirror.

mongomirror 0.12.7
Sistema operacional
Download
Amazon Linux 1
mongomirror-linux-x86_64-enterprise-amzn64-0.12.7.tgz
Amazon Linux 2
mongomirror-linux-x86_64-enterprise-amazon2-0.12.7.tgz
Debian 8.1
mongomirror-linux-x86_64-debian81-0.12.7.tgz
Debian 9.2
mongomirror-linux-x86_64-debian92-0.12.7.tgz
Debian 10
mongomirror-linux-x86_64-debian10-0.12.7.tgz
macOS de 64 bits
mongomirror-osx-x86_64-0.12.7.tgz
RHEL 6.2
mongomirror-linux-x86_64-rhel62-0.12.7.tgz
RHEL 7.0
mongomirror-linux-x86_64-rhel70-0.12.7.tgz
RHEL 7.1 PPC64LE
mongomirror-linux-ppc64le-rhel71-0.12.7.tgz
RHEL 8.0
mongomirror-linux-x86_64-rhel80-0.12.7.tgz
RHEL 7.2 s390x
mongomirror-linux-s390x-rhel72-0.12.7.tgz
RHEL 8.1 PPC64LE
mongomirror-linux-ppc64le-rhel81-0.12.7.tgz
LES 12
mongomirror-linux-x86_64-suse12-0.12.7.tgz
LES 15
mongomirror-linux-x86_64-suse15-0.12.7.tgz
Ubuntu 14.04
mongomirror-linux-x86_64-ubuntu1404-0.12.7.tgz
Ubuntu 16.04
mongomirror-linux-x86_64-ubuntu1604-0.12.7.tgz
Ubuntu 16.04 ARM
mongomirror-linux-arm64-ubuntu1604-0.12.7.tgz
Ubuntu 16.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1604-0.12.7.tgz
Ubuntu 18.04
mongomirror-linux-x86_64-ubuntu1804-0.12.7.tgz
Ubuntu 18.04 ARM
mongomirror-linux-arm64-ubuntu1804-0.12.7.tgz
Ubuntu 18.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1804-0.12.7.tgz
Ubuntu 20.04
mongomirror-linux-x86_64-ubuntu2004-0.12.7.tgz
Ubuntu 20.04 ARM
mongomirror-linux-arm64-ubuntu2004-0.12.7.tgz
janelas
mongomirror-win32-x86_64-0.12.7.zip
mongomirror 0.12.6
Sistema operacional
Download
Amazon Linux 1
mongomirror-linux-x86_64-enterprise-amzn64-0.12.6.tgz
Amazon Linux 2
mongomirror-linux-x86_64-enterprise-amazon2-0.12.6.tgz
Debian 8.1
mongomirror-linux-x86_64-debian81-0.12.6.tgz
Debian 9.2
mongomirror-linux-x86_64-debian92-0.12.6.tgz
Debian 10
mongomirror-linux-x86_64-debian10-0.12.6.tgz
macOS de 64 bits
mongomirror-osx-x86_64-0.12.6.tgz
RHEL 6.2
mongomirror-linux-x86_64-rhel62-0.12.6.tgz
RHEL 7.0
mongomirror-linux-x86_64-rhel70-0.12.6.tgz
RHEL 7.1 PPC64LE
mongomirror-linux-ppc64le-rhel71-0.12.6.tgz
RHEL 8.0
mongomirror-linux-x86_64-rhel80-0.12.6.tgz
RHEL 7.2 s390x
mongomirror-linux-s390x-rhel72-0.12.6.tgz
RHEL 8.1 PPC64LE
mongomirror-linux-ppc64le-rhel81-0.12.6.tgz
LES 12
mongomirror-linux-x86_64-suse12-0.12.6.tgz
LES 15
mongomirror-linux-x86_64-suse15-0.12.6.tgz
Ubuntu 14.04
mongomirror-linux-x86_64-ubuntu1404-0.12.6.tgz
Ubuntu 16.04
mongomirror-linux-x86_64-ubuntu1604-0.12.6.tgz
Ubuntu 16.04 ARM
mongomirror-linux-arm64-ubuntu1604-0.12.6.tgz
Ubuntu 16.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1604-0.12.6.tgz
Ubuntu 18.04
mongomirror-linux-x86_64-ubuntu1804-0.12.6.tgz
Ubuntu 18.04 ARM
mongomirror-linux-arm64-ubuntu1804-0.12.6.tgz
Ubuntu 18.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1804-0.12.6.tgz
Ubuntu 20.04
mongomirror-linux-x86_64-ubuntu2004-0.12.6.tgz
Ubuntu 20.04 ARM
mongomirror-linux-arm64-ubuntu2004-0.12.6.tgz
janelas
mongomirror-win32-x86_64-0.12.6.zip
mongomirror 0.12.5
Sistema operacional
Download
Amazon Linux 1
mongomirror-linux-x86_64-enterprise-amzn64-0.12.5.tgz
Amazon Linux 2
mongomirror-linux-x86_64-enterprise-amazon2-0.12.5.tgz
Debian 8.1
mongomirror-linux-x86_64-debian81-0.12.5.tgz
Debian 9.2
mongomirror-linux-x86_64-debian92-0.12.5.tgz
Debian 10
mongomirror-linux-x86_64-debian10-0.12.5.tgz
macOS de 64 bits
mongomirror-osx-x86_64-0.12.5.tgz
RHEL 6.2
mongomirror-linux-x86_64-rhel62-0.12.5.tgz
RHEL 7.0
mongomirror-linux-x86_64-rhel70-0.12.5.tgz
RHEL 7.1 PPC64LE
mongomirror-linux-ppc64le-rhel71-0.12.5.tgz
RHEL 8.0
mongomirror-linux-x86_64-rhel80-0.12.5.tgz
RHEL 7.2 s390x
mongomirror-linux-s390x-rhel72-0.12.5.tgz
RHEL 8.1 PPC64LE
mongomirror-linux-ppc64le-rhel81-0.12.5.tgz
LES 12
mongomirror-linux-x86_64-suse12-0.12.5.tgz
LES 15
mongomirror-linux-x86_64-suse15-0.12.5.tgz
Ubuntu 14.04
mongomirror-linux-x86_64-ubuntu1404-0.12.5.tgz
Ubuntu 16.04
mongomirror-linux-x86_64-ubuntu1604-0.12.5.tgz
Ubuntu 16.04 ARM
mongomirror-linux-arm64-ubuntu1604-0.12.5.tgz
Ubuntu 16.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1604-0.12.5.tgz
Ubuntu 18.04
mongomirror-linux-x86_64-ubuntu1804-0.12.5.tgz
Ubuntu 18.04 ARM
mongomirror-linux-arm64-ubuntu1804-0.12.5.tgz
Ubuntu 18.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1804-0.12.5.tgz
Ubuntu 20.04
mongomirror-linux-x86_64-ubuntu2004-0.12.5.tgz
Ubuntu 20.04 ARM
mongomirror-linux-arm64-ubuntu2004-0.12.5.tgz
janelas
mongomirror-win32-x86_64-0.12.5.zip
mongomirror 0.12.4
Sistema operacional
Download
Amazon Linux 1
mongomirror-linux-x86_64-enterprise-amzn64-0.12.4.tgz
Amazon Linux 2
mongomirror-linux-x86_64-enterprise-amazon2-0.12.4.tgz
Debian 8.1
mongomirror-linux-x86_64-debian81-0.12.4.tgz
Debian 9.2
mongomirror-linux-x86_64-debian92-0.12.4.tgz
Debian 10
mongomirror-linux-x86_64-debian10-0.12.4.tgz
macOS de 64 bits
mongomirror-osx-x86_64-0.12.4.tgz
RHEL 6.2
mongomirror-linux-x86_64-rhel62-0.12.4.tgz
RHEL 7.0
mongomirror-linux-x86_64-rhel70-0.12.4.tgz
RHEL 7.1 PPC64LE
mongomirror-linux-ppc64le-rhel71-0.12.4.tgz
RHEL 8.0
mongomirror-linux-x86_64-rhel80-0.12.4.tgz
RHEL 7.2 s390x
mongomirror-linux-s390x-rhel72-0.12.4.tgz
RHEL 8.1 PPC64LE
mongomirror-linux-ppc64le-rhel81-0.12.4.tgz
LES 12
mongomirror-linux-x86_64-suse12-0.12.4.tgz
LES 15
mongomirror-linux-x86_64-suse15-0.12.4.tgz
Ubuntu 14.04
mongomirror-linux-x86_64-ubuntu1404-0.12.4.tgz
Ubuntu 16.04
mongomirror-linux-x86_64-ubuntu1604-0.12.4.tgz
Ubuntu 16.04 ARM
mongomirror-linux-arm64-ubuntu1604-0.12.4.tgz
Ubuntu 16.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1604-0.12.4.tgz
Ubuntu 18.04
mongomirror-linux-x86_64-ubuntu1804-0.12.4.tgz
Ubuntu 18.04 ARM
mongomirror-linux-arm64-ubuntu1804-0.12.4.tgz
Ubuntu 18.04 PPC64LE
mongomirror-linux-ppc64le-ubuntu1804-0.12.4.tgz
Ubuntu 20.04
mongomirror-linux-x86_64-ubuntu2004-0.12.4.tgz
Ubuntu 20.04 ARM
mongomirror-linux-arm64-ubuntu2004-0.12.4.tgz
janelas
mongomirror-win32-x86_64-0.12.4.zip
Semente com mongorestore
Você pode usar mongodump e mongorestore para propagar o cluster MongoDB Atlas com
dados de um conjunto independente ou de réplicas existente do MongoDB. Para obter
orientação sobre a propagação de dados de um cluster fragmentado do MongoDB
existente, entre em contato com o suporte do Atlas clicando em Suporte na navegação à
esquerda da UI do Atlas.

Embora você possa escalar um cluster de nível gratuito M0 para um cluster pago M10+
usando a UI do Atlas, você também pode usar
mongodump
e
mongorestore
procedimentos nesta seção para copiar dados de um cluster M0 de nível gratuito para um
cluster M10+.

Considerações
Versão recomendada do mongodump e mongorestore
Use a versão estável mais recente do
mongodump
e
mongorestore
para este procedimento.

Tempo de inatividade necessário


Para garantir uma migração atualizada, agende uma janela de manutenção onde você pode
interromper todas as gravações no cluster de origem. Quaisquer operações de gravação
emitidas para o cluster de origem após o
mongodump
parte do procedimento concluído não é migrada para o cluster de destino.

Depois
mongorestore
concluir a restauração dos dados, você deverá transferir seus aplicativos para o cluster
Atlas de destino antes de retomar as operações de gravação. Para se conectar a um cluster
Atlas, consulte Conectar-se a uma implantação de banco de dados.

A quantidade total de tempo de inatividade necessário depende de fatores como o tamanho


dos dados que estão sendo migrados e a conexão de rede entre o cluster de origem e o
Atlas. Se você tiver dúvidas ou preocupações sobre o tempo de inatividade prolongado,
entre em contato com o suporte do Atlas clicando em Suporte na navegação à esquerda da
UI do Atlas.

Para obter um procedimento de migração guiado com tempo de inatividade mínimo,


consulte Migração em tempo real de conjunto de réplicas ou Migração em tempo real de
cluster fragmentado.
Segurança de cluster
Atlas gerencia a criação de usuários de banco de dados. Se o cluster de origem impor
autenticação:

Permitir acesso de leitura ao primário.

Se você quiser usar


mongorestore
com o
--oplogReplay
opção, você deve excluir os diretórios admin e config do diretório dump que
mongodump
cria. Os diretórios admin e config contêm informações do usuário do banco de dados que
não podem ser adicionadas a um cluster Atlas com mongorestore. Use o
mongorestore

--nsExcluir
para excluir o namespace admin.system.*.

Você não pode migrar nenhuma informação de usuário ou função existente para o Atlas.
Para o cluster Atlas de destino, crie os usuários de banco de dados apropriados para dar
suporte aos padrões de uso do seu aplicativo. Atualize seus aplicativos como parte do
procedimento de transferência para usar os novos usuários do banco de dados. Para saber
mais, consulte Configurar usuários do banco de dados.

Desempenho
Este procedimento requer a execução
mongodump
e
mongorestore
em um host no cluster de origem. Esses programas usam recursos do sistema, como CPU
e memória, e podem afetar o desempenho do host.

Execute este procedimento fora dos horários de pico de uso do sistema ou durante uma
janela de manutenção programada. Se a origem for um conjunto de réplicas, você poderá
executar este procedimento no host de um
secundário
membro. Depois de interromper as gravações no cluster, permita que o secundário alcance
o primário antes de iniciar este procedimento.

Comportamento do tubo
Este procedimento usa
tubos linux
para transmitir a saída de
mongodump
para
mongorestore
. Se o
mongorestore
processo não consegue acompanhar o
mongodump
processo, você poderá ver erros de tubos quebrados.

Para obter orientação sobre como lidar com erros persistentes de tubos quebrados, entre
em contato com o suporte do Atlas clicando em Suporte na navegação à esquerda da UI do
Atlas.

Procedimento
O tutorial a seguir usa
mongodump
e
mongorestore
para fazer upload de dados de um cluster MongoDB existente para um cluster Atlas:

1
Opcional: Crie um usuário de banco de dados no conjunto de réplicas de origem.
IMPORTANTE
Opcional
Se o seu cluster de origem não impor autenticação, ignore esta etapa.

Se a implantação de origem impor autenticação, você deverá fornecer privilégios a um


usuário do banco de dados para ler qualquer banco de dados como parte deste
procedimento. Para saber mais sobre privilégios de usuário do banco de dados, consulte
Controle de acesso baseado em função do MongoDB.

Se esse usuário não existir, crie um usuário em seu conjunto de réplicas do MongoDB de
origem com o
cópia de segurança
função no banco de dados administrativo.

EXEMPLO
Execute o seguinte comando em
mangusto
para criar o mySourceUser no banco de dados administrativo e atribuir a ele a função de
backup. Para conjuntos de réplicas, você deve executar esse comando no primário.

usar administrador
db.createUser(
{
usuário: "<mySourceUser>",
pwd: "<minhaSenhaFonte>",
funções: [ "backup"]
}
)

2
Monte o comando mongodump.
Com base no tipo de cadeia de conexão que você usa, copie um dos seguintes modelos em
seu editor de texto preferido:

OBSERVAÇÃO
Para se conectar a clusters Atlas, recomendamos que você se conecte com uma string de
conexão de lista de valores iniciais de DNS usando a opção --uri.

Conecte-se com uma string de conexão padrão

Conecte-se com uma string de conexão de lista de valores iniciais de DNS

mongodump --uri
"mongodb://username:password@mongodb0.example.com:<Port>,mongodb1.example
.com:<Port1>,mongodb2.example.com:<Port2>/?replicaSet=<ReplicaSetName>&auth
Source=admin" \
--archive

Substitua os exemplos de host pelas informações dos membros do conjunto de réplicas.


Substitua <ReplicaSetName> pelo nome do conjunto de réplicas de origem.

Para implementações independentes, exclua replicaSet=<ReplicaSetName> e especifique


apenas o nome do host da implementação independente. Por exemplo, --uri
"mongodb://standalone-mongod.example.net:27017"

OBSERVAÇÃO
Se sua senha contiver caracteres especiais, ela deverá ser codificada em porcentagem.

Não execute este comando ainda. Prossiga para a próxima etapa depois de modificar o
modelo.

3
Configure o usuário do banco de dados no cluster Atlas de destino.
Para correr
mongorestore
em um cluster Atlas, você deve especificar um usuário de banco de dados no cluster Atlas
que tenha a função de administrador do Atlas.

Se esse usuário não existir, crie o usuário:

Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na


barra de navegação.

Clique em Access Manager na barra lateral ou clique em Access Manager na barra de


navegação e clique em sua organização.
Clique em Adicionar novo usuário do banco de dados.

Adicione um usuário administrador do Atlas.

Para saber mais sobre o gerenciamento de usuários, consulte Configurar usuários do banco
de dados.

4
Navegue até a página Implantações de banco de dados do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Se a página Implantações de banco de dados ainda não estiver exibida, clique em Banco de
dados na barra lateral.

5
Escolha Ferramentas de linha de comando para o cluster desejado.
No menu do cluster, clique em Ferramentas de Linha de Comando.

6
Recupere e modifique o modelo de conexão mongorestore.
A seção Ferramentas Binárias de Importação e Exportação da guia Ferramentas de Linha
de Comando exibe um modelo copiável com as opções mínimas necessárias para conexão
mongorestor para o seu cluster Atlas.

O modelo inclui valores de espaço reservado para determinadas opções. Copie e cole o
modelo em seu editor de texto preferido e faça as seguintes modificações:

senha: substitua pela senha do usuário especificado em nome de usuário. O modelo inclui
um usuário de banco de dados para o projeto como nome de usuário. Se você deseja
autenticar como um usuário diferente, substitua o valor de nome de usuário e especifique a
senha desse usuário em senha.

Adicionar
--nsExcluir
e defina seu valor como "admin.system.*".

Adicionar
--arquivo.

Com base no tipo de cadeia de conexão que você usa, seu modelo deve ser semelhante a
um dos seguintes comandos:

Conecte-se com uma string de conexão padrão


Conecte-se com uma string de conexão de lista de valores iniciais de DNS
mongorestore --uri
mongorestore --uri
"mongodb://username:password@00.foo.mongodb.net:27017,01.foo.mongodb.net:270
17,02.foo.mongodb.net:27017/?replicaSet=myRepl&authSource=admin" \
--archive \
--ssl \
--nsExclude "admin.system.*"

7
Correr mongodump e mongorestore
.
IMPORTANTE
Certifique-se de que o host onde você está executando
mongodump
e
mongorestore
está na lista de acesso IP do projeto.

Para revisar a lista de acesso IP do seu projeto, clique em Acesso à rede na seção
Segurança da barra lateral. A guia Lista de acesso IP é exibida.

DICA
Veja também:
Lista de acesso IP

No seu editor de texto preferido, use o pipe | operador para separar o


mongodump
e
mongorestore
comandos. Com base no tipo de cadeia de conexão usada, o comando final deve ser
semelhante a um dos seguintes:

Conecte-se com uma string de conexão padrão

Conecte-se com uma string de conexão de lista de valores iniciais de DNS

mongodump --uri
"mongodb://username:password@mongodb0.example.com:27017,mongodb1.example.
com:27017,mongodb2.example.com:27017/?replicaSet=sourceRS&authSource=admin
"\
--archive \
|\
mongorestore --uri
"mongodb://username:password@00.foo.mongodb.net:27017,01.foo.mongodb.net:270
17,02.foo.mongodb.net:27017/?replicaSet=myAtlasRS&authSource=admin" \
--archive \
--ssl \
--nsExclude "admin.system.*"

Execute o comando concluído em um terminal ou shell conectado a uma máquina host no


cluster de origem.

Após a conclusão bem-sucedida do procedimento, conecte-se ao seu cluster Atlas usando


mangusto
e verifique o resultado do procedimento. Para saber como, consulte Conectar via
mongosh.

Você deve atualizar seus aplicativos para apontarem para o cluster Atlas antes de retomar
as operações de gravação. Para saber como conectar aplicativos ao Atlas, consulte
Conectar por meio do seu aplicativo.

DICA
Veja também:
página de referência do mongodump

página de referência do mongorestore


Carregar arquivo com mongoimport
Você pode usar
mongoimportação
para importar dados de um arquivo JSON ou CSV para o cluster MongoDB Atlas.

Considerações
mongoimportação
usa
representação de modo estrito
para certos tipos de BSON.

Procedimento
O tutorial a seguir usa
mongoimportação
para carregar dados de um arquivo JSON para um cluster Atlas:

1
Configure um usuário de banco de dados no cluster Atlas de destino.
Para correr
mongoimportação
para gravar no cluster Atlas, você deve especificar um usuário de banco de dados que
tenha
ler escrever
privilégios no banco de dados para o qual importar dados. Por exemplo, um usuário com
função de administrador do Atlas fornece esses privilégios.

Se esse usuário não existir, crie o usuário:

Na seção Segurança da navegação esquerda, clique em Acesso ao Banco de Dados. A


guia Usuários do banco de dados é exibida.

Clique em Adicionar novo usuário do banco de dados.

Adicione um usuário administrador do Atlas.

2
Abra a caixa de diálogo de conexão.
Clique em Banco de dados no canto superior esquerdo do Atlas.

Na visualização Implementações de Banco de Dados, clique em Conectar para o cluster


Atlas para o qual você deseja migrar dados.

3
Atualizar lista de acesso IP.
Se o host onde você executará
mongoimportação
não estiver na lista de acesso IP, atualize a lista. Você pode especificar:
O endereço IP público do servidor no qual
mongoimportação
será executado, ou

Se configurado para peering de VPC, o bloco CIDR da VPC do par (ou uma sub-rede) ou o
grupo de segurança da VPC do par, se você escolheu AWS como seu provedor de nuvem.

4
Copie as informações do URI/host do cluster de destino.
Você pode se conectar ao seu cluster Atlas usando seu
URI da cadeia de conexão
. Na caixa de diálogo de conexão, execute as seguintes etapas:

Clique em Conectar seu aplicativo.

Copie a string de conexão encontrada na etapa 1.

Substitua PASSWORD pela senha do usuário root e DATABASE pelo nome do banco de
dados ao qual você deseja se conectar.

IMPORTANTE
Você deve escapar de qualquer instância do caractere @ na <SENHA> fornecida. Por
exemplo, p@ssword deve ser p%40ssword.

Esta cadeia de conexão é especificada para mongoimportação


na opção --uri.

Ao usar --host, se o cluster Atlas for um conjunto de réplicas, você também deverá
recuperar o nome do conjunto de réplicas. Por exemplo:

myAtlasRS/atlas-host1:27017,atlas-host2:27017,atlas-host3:27017

5
Execute mongoimport.
O exemplo a seguir importa dados do arquivo /somedir/myFileToImport.json para a coleção
myData no banco de dados testdb. A operação inclui a opção --drop para descartar a
coleção primeiro, se ela existir.

Usando --uri:

mongoimport --uri
"mongodb://root:<PASSWORD>@atlas-host1:27017,atlas-host2:27017,atlas-host3:27017/
<DATABASE>?ssl=true&replicaSet=myAtlasRS&authSource=admin" --collection myData
--drop --file /somedir/myFileToImport.json

Usando --host:

mongoimport --host myAtlasRS/atlas-host1:27017,atlas-host2:27017,atlas-host3:27017


--ssl -u myAtlasAdminUser -p 'myAtlasPassword' --authenticationDatabase admin --db
testdb --collection myData --drop --file /somedir/myFileToImport.json

Adicione/edite o mongoimportação opções de linha de comando conforme apropriado para


sua implantação. Ver mongoimportação para mais opções de mongoimportação.

Informações adicionais
Para mais informações sobre mongoimportação, incluindo comportamento, opções e
exemplos, consulte a página de referência do mongoimport.
Importar e exportar dados
Nesta página

Importar dados para uma coleção


Exportar dados de uma coleção
Importar e exportar dados da linha de comando
Você pode usar o MongoDB Compass para importar e exportar dados de e para coleções.
O Compass suporta importação e exportação de arquivos JSON e CSV. Para importar ou
exportar dados de ou para uma coleção, navegue até a visualização detalhada da coleção
selecionando a coleção na guia Bancos de dados ou clicando na coleção na navegação do
lado esquerdo.

Importar dados para uma coleção


O MongoDB Compass pode importar dados para uma coleção de um arquivo JSON ou
CSV.

Limitações
A importação de dados para uma coleção não é permitida no MongoDB Compass Readonly
Edition.

A importação de dados não estará disponível se você estiver conectado a um


Lago de dados.

Formate seus dados


Antes de importar seus dados para o MongoDB Compass, você deve primeiro garantir que
eles estejam formatados corretamente.

JSON

CSV
Ao importar dados de um arquivo JSON, você pode formatar seus dados como:

Documentos delimitados por nova linha ou

Documentos separados por vírgula em uma matriz

EXEMPLO
O seguinte arquivo .json delimitado por nova linha está formatado corretamente:

{ "tipo": "casa", "número": "212-555-1234" }


{ "tipo": "célula", "número": "646-555-4567" }
{ "tipo": "escritório", "número": "202-555-0182"}

O seguinte arquivo de matriz .json separado por vírgula também está formatado
corretamente:
[{ "type": "home", "number": "212-555-1234" }, { "type": "cell", "number": "646-555-4567" }, {
"type": "escritório", "número": "202-555-0182"}]

O Compass ignora quebras de linha em matrizes JSON.

A bússola gera automaticamente


IDs de objeto
para esses objetos na importação, pois nenhum ObjectIDs foi especificado no JSON
inicial.

Procedimento
Para importar seus dados formatados para uma coleção:

1
Conecte-se à implantação que contém a coleção para a qual você deseja importar dados.
Para saber como se conectar a uma implantação, consulte Conectar-se ao MongoDB.

2
Navegue até sua coleção de destino.
Você pode selecionar a coleção na guia Coleções ou clicar na coleção no painel esquerdo.

3
Clique no menu suspenso Adicionar dados e selecione Importar arquivo JSON ou CSV.
4
Selecione o tipo de arquivo apropriado.
Selecione um arquivo JSON ou CSV para importar e clique em Selecionar.

Se estiver importando um arquivo CSV, você poderá especificar os campos a serem


importados e os tipos desses campos em Especificar campos e tipos.

Selecione campos para importar de um arquivo CSV


Clique para ampliar
Para excluir um campo de um arquivo CSV que você está importando, desmarque a caixa
de seleção ao lado do nome do campo. Para selecionar um tipo para um campo, use o
menu suspenso abaixo do nome do campo.

5
Configure opções de importação.
Em Opções, configure as opções de importação para seu caso de uso.

Se estiver importando um arquivo CSV, você poderá selecionar como seus dados serão
delimitados.

Para importações de arquivos JSON e CSV, você pode alternar Ignorar strings vazias e
Parar em caso de erros:
Se marcada, Ignorar strings vazias descarta campos com valores de string vazios dos
documentos importados. O documento ainda é importado com todos os outros campos.

Se marcada, Parar em caso de erros evita que quaisquer dados sejam importados em caso
de erro. Se desmarcada, os dados serão inseridos até que um erro seja encontrado e as
inserções bem-sucedidas não sejam revertidas. A operação de importação não continuará
após encontrar um erro em ambos os casos.

6
Clique em Importar.
Uma barra de progresso exibe o status da importação. Se ocorrer um erro durante a
importação, a barra de progresso ficará vermelha e uma mensagem de erro aparecerá na
caixa de diálogo. Para ver todos os erros, clique em Visualizar log.

Após a importação bem-sucedida, a caixa de diálogo fecha e o Compass exibe a página da


coleção que contém os documentos recém-importados.

Exportar dados de uma coleção


O MongoDB Compass pode exportar dados de uma coleção como um arquivo JSON ou
CSV. Se você especificar um filtro ou pipeline de agregação para sua coleção, o Compass
exportará apenas documentos que correspondam à consulta especificada ou aos resultados
do pipeline.

Comportamento
Evite exportar para arquivos CSV quando possível. Os arquivos CSV podem perder
informações de tipo e não são adequados para backup de seus dados.

Você pode usar um filtro de consulta para exportar apenas os documentos que
correspondem ao filtro.

Você pode usar o campo Projeto na barra de consulta para especificar os campos a serem
retornados ou exportados.

Procedimento

Exportar coleção inteira

Exportar subconjunto filtrado de uma coleção

Exportar resultados de agregação


Para exportar uma coleção inteira para um arquivo:

1
Conecte-se à implantação que contém a coleção da qual você deseja exportar dados.
Para saber como se conectar a uma implantação, consulte Conectar-se ao MongoDB.

2
Navegue até a coleção desejada.
Você pode selecionar a coleção na guia Coleções ou clicar na coleção no painel esquerdo.

3
Clique no menu suspenso Exportar dados e selecione Exportar a coleção completa.
4
Selecione seu tipo de arquivo.
Você pode selecionar JSON ou CSV. Se você selecionar JSON, poderá expandir o menu
suspenso Formato JSON avançado e selecionar um dos seguintes formatos JSON
estendidos:

Formato JSON
Descrição
JSON estendido padrão
Um formato de string que evita qualquer perda de informações do tipo BSON. Esta é a
configuração padrão da Bússola.
Ext relaxado terminou JSON
Um formato de string que enfatiza a legibilidade e a interoperabilidade em detrimento da
preservação do tipo. Ou seja, a conversão do formato relaxado para BSON pode perder
informações de tipo.

AVISO
Este formato não é recomendado para integridade de dados.

JSON estendido canônico


Um formato de string que enfatiza a preservação do tipo em detrimento da legibilidade e da
interoperabilidade. Ou seja, a conversão de canônico para BSON geralmente preservará as
informações de tipo, exceto em certos casos específicos.
5
Clique em Exportar.
Escolha para onde exportar o arquivo e clique em Selecionar.

Uma barra de progresso exibe o status da exportação. Se ocorrer um erro durante a


exportação, a barra de progresso ficará vermelha e uma mensagem de erro aparecerá na
caixa de diálogo. Após a exportação bem-sucedida, a caixa de diálogo é fechada.

Importar e exportar dados da linha de comando


Para importar e exportar dados da linha de comando, você pode usar o MongoDB
Ferramentas de banco de dados. Ver mongoimportação e mongoexport.
Interaja com seus dados
Nesta página

Visão geral
Comportamento de leitura da interface do Atlas UI
Desativar interação de dados da UI do Atlas
Visão geral
Depois de carregar seus dados ou nossos dados de amostra, você pode usar a UI do Atlas
para interagir com os dados das seguintes maneiras:

Gerencie bancos de dados em suas implantações de banco de dados.

Gerencie coleções em suas implantações de banco de dados.

Gerencie documentos em suas coleções.

Gerencie índices em suas coleções.

Crie e execute pipelines de agregação para processar dados em suas coleções.

Shard Global Clusters para distribuir grandes conjuntos de dados uniformemente.

Construir gráficos
para visualizar dados em seus bancos de dados e coleções.

OBSERVAÇÃO
A UI do Atlas oferece suporte a todos os recursos para instâncias sem servidor, exceto a
guia Pesquisar.

Para saber mais, consulte Limitações de instância sem servidor.

Comportamento de leitura da interface do Atlas UI


A IU do Atlas lê o primário, a menos que o primário esteja indisponível. Se o primário não
estiver disponível, a UI do Atlas lê de um membro secundário não oculto e sem atraso.

Desativar interação de dados da UI do Atlas


Para interagir com seus dados na UI do Atlas, conforme descrito no
Seção de visão geral
, o Data Explorer precisa ser ativado.

IMPORTANTE
Privilégios necessários
Para ativar ou desativar o Data Explorer para um projeto, você deve ter a função de
Proprietário do Projeto para o projeto ou a função de Proprietário da Organização em sua
organização pai.
O Data Explorer está habilitado por padrão. Para desativar o Explorador de Dados:

1
Clique em Configurações.
2
Defina o botão do Data Explorer como Desativado.
IMPORTANTE
Quando o Data Explorer está desativado, você não pode:

Encerre operações lentas no Painel de desempenho em tempo real.

Crie índices do Performance Advisor. Você ainda pode visualizar recomendações do


Performance Advisor, mas deve criar esses índices a partir de
mangusto.

Para ativar o Data Explorer, defina o botão para Ligado.


Criar, visualizar e descartar bancos de dados
Nesta página

Funções obrigatórias
Crie um banco de dados
Ver bancos de dados
Eliminar um banco de dados
Você pode usar a UI do Atlas para gerenciar os bancos de dados em suas implantações de
banco de dados.

Funções obrigatórias
A tabela a seguir descreve as funções necessárias para executar diversas ações em um
banco de dados na UI do Atlas:

Ação
Funções obrigatórias
Criar bancos de dados
Uma das seguintes funções:

Proprietário do projeto ou proprietário da organização

Administrador de acesso a dados do projeto

Leitura/gravação de acesso aos dados do projeto

Ver bancos de dados


Pelo menos a função Somente leitura de acesso a dados do projeto.
Eliminar bancos de dados
Uma das seguintes funções:

Dono do projeto

Administrador de acesso a dados do projeto

Crie um banco de dados


Para criar um banco de dados por meio da UI do Atlas:

1
Navegue até a guia Coleções.
2
Clique em Criar banco de dados.
3
Insira o nome do banco de dados e o nome da coleção.
Insira o Nome do Banco de Dados e o Nome da Coleção para criar o banco de dados e sua
primeira coleção.
IMPORTANTE
Não inclua informações confidenciais em seu banco de dados e nomes de coleções.

Para obter mais informações sobre nomes de bancos de dados MongoDB e nomes de
coleções, consulte Restrições de nomenclatura.

4
Opcional. Especifique uma coleção limitada.
Selecione se a coleção é uma coleção limitada. Se você optar por criar uma coleção
limitada, especifique o tamanho máximo em bytes.

5
Opcional. Especifique uma coleção de série temporal.
Selecione se a coleção é uma coleção de séries temporais. Se você optar por criar uma
coleção de série temporal, especifique o campo de tempo e a granularidade.
Opcionalmente, você pode especificar o metacampo e o tempo para os dados antigos da
coleção expirarem.

6
Clique em Criar.
Após a criação bem-sucedida, o banco de dados e a coleção aparecem na UI do Atlas.

Ver bancos de dados


Na guia Coleções, você pode visualizar os bancos de dados e as coleções na implantação.
A UI do Atlas mostra os bancos de dados no painel esquerdo:

Captura de tela da guia Coleções na UI do Atlas.


Clique para ampliar
Visualize dados do banco de dados
Na guia Coleções, você pode iniciar gráficos do MongoDB para visualizar dados em seus
bancos de dados e coleções.

Para visualizar dados em gráficos do MongoDB na UI do Atlas, clique em Visualizar seus


dados ao visualizar um banco de dados ou coleção específica. Gráficos carrega a fonte de
dados e você pode começar a criar um gráfico na visualização Gráficos. Para etapas
detalhadas, consulte
Crie gráficos.

Eliminar um banco de dados


Para eliminar um banco de dados, incluindo todas as suas coleções, por meio da UI do
Atlas:

1
Elimine o banco de dados.
Selecione ou passe o mouse sobre o banco de dados para soltá-lo e clique no ícone da
lixeira.

2
Confirme a ação.
Confirme digitando o nome do banco de dados e clique em Eliminar.
Criar, visualizar, descartar e coleções de
fragmentos
Nesta página

Funções obrigatórias
Crie uma coleção
Ver coleções
Solte uma coleção
Fragmentar uma coleção
Você pode usar a UI do Atlas para gerenciar as coleções em suas implantações de banco
de dados.

Funções obrigatórias
A tabela a seguir descreve as funções necessárias para executar diversas ações em um
banco de dados na UI do Atlas:

Ação
Funções obrigatórias
Criar coleções
Uma das seguintes funções:

Proprietário do projeto ou proprietário da organização

Administrador de acesso a dados do projeto

Leitura/gravação de acesso aos dados do projeto

Ver coleções
Pelo menos a função Somente leitura de acesso a dados do projeto.
Soltar coleções
Uma das seguintes funções:

Dono do projeto

Administrador de acesso a dados do projeto

Coleções de fragmentos
Uma das seguintes funções:

Dono do projeto

Proprietário da organização

Crie uma coleção


DICA
Para criar a primeira coleção em um novo banco de dados, consulte Criar um banco de
dados.

IMPORTANTE
Você não pode criar novas coleções nos bancos de dados de configuração e do sistema. O
Atlas descontinuará a gravação em coleções existentes nesses bancos de dados em um
futuro próximo.

Para criar uma coleção em um banco de dados existente por meio da UI do Atlas:

1
Navegue até a guia Coleções.
2
Clique no sinal de mais + ícone de um banco de dados.
Selecione ou passe o mouse sobre o banco de dados para soltar e clique no sinal de mais +
ícone.

3
Insira o nome da coleção.
IMPORTANTE
Não inclua informações confidenciais no nome da sua coleção.

Para obter mais informações sobre nomes de coleções do MongoDB, consulte


Restrições de nomenclatura.

4
Opcional. Especifique uma coleção limitada.
Selecione se a coleção é uma
coleção limitada
. Se você optar por criar uma coleção limitada, especifique o tamanho máximo em bytes.

5
Opcional. Especifique uma coleção de série temporal.
Selecione se a coleção é uma
coleção de séries temporais
. Se você optar por criar uma coleção de série temporal, especifique o campo de tempo e a
granularidade. Opcionalmente, você pode especificar o metacampo e o tempo para os
dados antigos da coleção expirarem.

6
Clique em Criar.
Após a criação bem-sucedida, a coleção aparece abaixo do banco de dados na UI do Atlas.

Ver coleções
Na guia Coleções, você pode visualizar os bancos de dados e as coleções na implantação.
Atlas mostra os bancos de dados no painel esquerdo da UI do Atlas:

Captura de tela da guia Coleções na UI do Atlas.


Clique para ampliar
Para visualizar as coleções em um determinado banco de dados, clique no nome do banco
de dados.

OBSERVAÇÃO
O Atlas baseia a contagem de documentos que aparece na guia Coleções nos metadados
armazenados em cache usando
colStats
. Essa contagem pode ser diferente da contagem real de documentos na coleção. Por
exemplo, um
desligamento inesperado
pode atrapalhar a contagem. Use o
db.collection.countDocuments()
método para a contagem de documentos mais precisa.

Visualize dados de coleta


Na guia Coleções, você pode iniciar gráficos do MongoDB para visualizar dados em seus
bancos de dados e coleções.

Para visualizar dados em gráficos do MongoDB na UI do Atlas, clique em Visualizar seus


dados ao visualizar um banco de dados ou coleção específica. Gráficos carrega a fonte de
dados e você pode começar a criar um gráfico na visualização Gráficos. Para etapas
detalhadas, consulte
Crie gráficos.

Solte uma coleção


Para descartar uma coleção, incluindo seus documentos e índices, por meio da UI do Atlas:

1
Abandone a coleção.
Selecione ou passe o mouse sobre a coleção para soltá-la e clique no ícone da lixeira.

2
Confirme a ação.
Confirme digitando o nome da coleção e clique em Descartar.

Fragmentar uma coleção


Se você tiver grandes conjuntos de dados e executar operações de alto rendimento, poderá
fragmento
uma coleção para distribuir dados entre os fragmentos.

OBSERVAÇÃO
Antes de começar, você deve ter o seguinte:

Um cluster Atlas fragmentado

mangusto na sua máquina local


Para fragmentar uma coleção por meio da UI do Atlas:

1
Conecte-se ao MongoDB de
mangusto
.
Consulte Conectar via mongosh.

2
Habilite a fragmentação para os bancos de dados que você deseja fragmentar.
Para ativar a fragmentação, execute o seguinte comando:

sh.enableSharding("<database-name>")

EXEMPLO
Para ativar a fragmentação para o conjunto de dados sample_analytics:

sh.enableSharding("sample_analytics")

Para saber mais, consulte


Habilitar fragmentação para um banco de dados
no manual do MongoDB.

3
Opcional: Crie um índice na chave de fragmento se a coleção que você deseja fragmentar
tiver dados e não estiver vazia.
Para criar um índice na chave de fragmento, execute o seguinte comando:

db.<collection-name>.createIndex({<shard_key_definition>})

EXEMPLO
Para criar um índice na chave de fragmento da coleção sample_analytics.customers:

db.sample_analytics.runCommand( { createIndexes: "customers", indexes: [ { key: {


"username": 1 }, "name": "usernameIndex" }], "commitQuorum": "majority" } )

Para saber mais, consulte:

Escolha uma chave de fragmento


criarIndexes

4
Fragmente a coleção que você deseja fragmentar.
Para fragmentar uma coleção, execute o seguinte comando:

sh.shardCollection("<database>.<collection>", { "<indexed-field>" : 1 } )

EXEMPLO
Para fragmentar a coleção sample_analytics.customers:

sh.shardCollection("sample_analytics.customers",{"username":1})

AVISO
Se você fragmentar uma coleção que já possui um índice do Atlas Search, poderá enfrentar
um breve período de dúvida. Tempo de inatividade quando a coleção começa a aparecer
em um fragmento. Além disso, se você adicionar um fragmento para uma coleção já
fragmentada que contém um índice do Atlas Search, suas consultas de pesquisa nessa
coleção falharam até que o processo de sincronização inicial seja concluído nos fragmentos
adicionados. Para saber mais, consulte o processo de sincronização inicial.

Para saber mais, consulte Fragmentar uma coleção no manual do MongoDB.


Criar, visualizar, atualizar e excluir documentos
Nesta página

Funções obrigatórias
Inserir documentos
Visualizar, filtrar e classificar documentos
Editar um documento
Excluir um documento
Você pode usar a UI do Atlas para gerenciar documentos dentro de suas coleções.
Documentos são registros individuais em uma coleção do MongoDB e são a unidade básica
de dados no MongoDB.

A visualização de documentos e coleções na UI do Atlas pode fornecer uma visão geral de


alto nível do esquema do seu banco de dados. Você pode usar a UI do Atlas para garantir
que está seguindo os principais conceitos de modelagem de dados do MongoDB, como a
utilização de documentos e matrizes incorporados.

DICA
Veja também:
Projeto de modelo de dados

Funções obrigatórias
Para inserir, editar, ou excluir documentos, você deverá ter recebido acesso por meio de
uma das seguintes funções:

Proprietário do projeto ou proprietário da organização

Administrador de acesso a dados do projeto

Leitura/gravação de acesso aos dados do projeto

Inserir documentos
Para adicionar um ou mais documentos a uma coleção por meio da UI do Atlas, você pode
especificar os documentos a serem inseridos do zero ou clonar um documento existente e
modificar seus campos e valores conforme necessário.

Insira um documento
1
Vá para a guia Localizar na interface do Atlas.
Selecione a coleção e vá para a guia Localizar.

2
Clique em Inserir documento.
O editor de documentos aparece com o campo _id com um
ID do objeto valor que reflete o tempo de sua geração e não o tempo de inserção do
documento. Como tal, o ID do objeto não representa um pedido de inserção estrito.
3
Modifique o documento.
Para adicionar um novo campo após um campo existente, passe o mouse sobre o campo e
clique no sinal de mais que aparece sobre o número da linha do campo.

Para excluir um campo, passe o mouse sobre ele e clique no sinal x que aparece à
esquerda do número da linha do campo. Você não pode excluir o campo _id.

Para editar um nome, valor ou tipo de campo, clique no nome, valor ou tipo do campo.

4
Clique em Inserir.
Insira vários documentos
1
Vá para a guia Localizar na interface do Atlas.
Selecione a coleção e vá para a guia Localizar.

2
Clique em Inserir documento.
A UI do Atlas abre a caixa de diálogo Inserir na coleção.

3
Selecione a visualização JSON.
4
Digite ou cole uma série de documentos para inserir.
EXEMPLO
A seguinte matriz de documentos insere três documentos na coleção:

[
{
"name": "Alice",
"age": 26,
"email": "alice@abc.com"
},
{
"name": "Bob",
"age": 43,
"email": "bob@def.com"
},
{
"name": "Carol",
"age": 19,
"email": "carol@xyz.com"
}
]

5
Clique em Inserir.
Clonar um documento
1
Vá para a guia Localizar na UI do Atlas.
Selecione a coleção e vá para a guia Localizar.

Até 20 documentos são exibidos na guia.

2
Opcional. Especifique um filtro.
Para especificar a condição do filtro, digite um
filtro de consulta
documento na barra de filtros. Por exemplo, para especificar a condição de igualdade, use
um documento de filtro no formato:

{ <field1>: <value1>, ... }

Para usar operadores de consulta para especificar uma condição de filtro, use um
documento de filtro no formato:

{ <field1>: { <queryoperator>: <value1> }, ... }

3
Clone o documento.
Para clonar um documento exibido nos resultados da consulta, passe o mouse sobre o
documento e clique no ícone do documento clonado.

Clonar ícone de documento


O editor de documentos aparece com o campo _id com um
ID do objeto
valor que reflete o tempo de sua geração e não o tempo de inserção do documento. Como
tal, o
ID do objeto
não representa um pedido de inserção estrito.

4
Modifique o documento.
Para adicionar um novo campo após um campo existente, passe o mouse sobre o campo e
clique no sinal de mais que aparece sobre o número da linha do campo.

Para excluir um campo, passe o mouse sobre ele e clique no sinal x que aparece à
esquerda do número da linha do campo. Você não pode excluir o campo _id.
Para editar um nome, valor ou tipo de campo, clique no nome, valor ou tipo do campo.

5
Clique em Inserir.
Visualizar, filtrar e classificar documentos
Na guia Coleções, você pode visualizar documentos de uma coleção. Para visualizar
documentos de uma coleção:

1
Selecione o banco de dados para a coleção.
O painel principal e Namespaces no lado esquerdo listam as coleções no banco de dados.

Captura de tela destacando bancos de dados na UI do Atlas.


Clique para ampliar
2
Selecione a coleção no lado esquerdo ou no painel principal.
O painel principal exibe a visualização Localizar e a visualização Índices.

3
Selecione a visualização Localizar.
O painel exibe os documentos da coleção. Coleções de documentos menores exibem até
20 documentos por página. Coleções de documentos maiores exibem um único documento
por página.

4
Opcional: Especifique uma consulta para localizar documentos específicos.
Você pode usar a barra de consulta para pesquisar documentos específicos em sua
coleção. Você executa as seguintes ações com a barra de consulta:

Filtrar uma consulta

Campos do projeto para incluir ou excluir campos específicos nos resultados da consulta

Classifique os documentos nos resultados

Aplicar agrupamento para especificar regras específicas do idioma

Filtrar resultados da consulta


Para especificar uma condição de filtro, digite um filtro de consulta no campo Filtro. Por
exemplo, para especificar uma condição de igualdade, use um filtro com o formato:

{ <field1>: <value1>, ... }


Usar operadores de consulta para especificar uma condição de filtro, use um filtro com o
seguinte formato:

{ <field1>: { <queryoperator>: <value1> }, ... }

OBSERVAÇÃO
A UI do Atlas não oferece suporte a consultas de data que usam a função IsoDate(). Em vez
disso, use o
JSON estendido do MongoDB (v2)
Tipo de dados $date para consultas de data.

Por exemplo, a consulta a seguir retorna todos os documentos em que a data adicionada a
um campocreate_at é igual ou mais recente que meia-noite de 1º de janeiro de 2019,
horário UTC:

{ created_at: { $gte: { $date: "2019-01-01T00:00-00:00" } } }

Para obter mais informações sobre como especificar filtros de consulta, incluindo condições
compostas, consulte
Consultar documentos.

Campos do projeto nos resultados da consulta


Para especificar os campos do documento a serem incluídos ou excluídos nos resultados,
clique em Mais opções na barra de consulta e especifique os campos do documento no
campo Projeto.

Para incluir campos, especifique o nome do campo e defina como 1 no documento do


projeto. Por exemplo, para incluir os campos ano e nome nos documentos:

{ ano: 1, nome: 1 }
Atlas retorna os campos especificados no campo Projeto e no campo _id, que é retornado a
menos que seja explicitamente excluído.

Para excluir campos, especifique o nome do campo e defina-o como 0 no documento do


projeto. Por exemplo, para excluir os campos ano e nome nos documentos:

{ ano: 0, nome: 0 }
Atlas retorna todos os campos, exceto os campos especificados no Projeto.

Para saber mais sobre documentos do projeto, consulte


$projeto.
Classificar resultados da consulta
Para classificar a ordem dos documentos nos resultados, clique em Mais opções na barra
de consulta e insira o documento de classificação no campo Classificar.

Para especificar a ordem crescente de um campo, defina o campo como 1 no documento de


classificação.

Para especificar a ordem decrescente para um campo, defina o campo como -1 nos
documentos de classificação.

Por exemplo, o seguinte documento de classificação classifica os resultados primeiro por


ano em ordem decrescente e, dentro de cada ano, classifica por nome em ordem crescente:

{ ano: -1, nome: 1 }


Para saber mais sobre classificar documentos, consulte
$ classificar.

Especifique o agrupamento
IMPORTANTE
Recurso indisponível em instâncias sem servidor
As instâncias sem servidor não oferecem suporte a esse recurso no momento. Para saber
mais, consulte Limitações de instância sem servidor.

Para especificar regras específicas de idioma para comparação de strings, como regras
para letras maiúsculas e acentos, clique em Mais opções na barra de consulta e insira o
documento de agrupamento no campo Agrupamento. Use o campo de localidade no
documento de ordenação para especificar o
Código local da UTI
para o idioma desejado. Por exemplo, para usar a variante pinyin do agrupamento chinês,
use o seguinte documento de agrupamento:

{ "locale" : "zh@collation=pinyin" }

Para saber mais sobre documentos de agrupamento, consulte


Agrupamento.

OBSERVAÇÃO
À medida que você digita, o botão Aplicar é desativado e o nome do campo na interface do
usuário fica vermelho até que uma consulta válida seja inserida.

5
Clique em Aplicar para executar sua consulta.
Número de documentos exibidos por página
A UI do Atlas limita o tamanho total em bytes dos documentos mostrados por página. Como
resultado, você poderá ver números variados de documentos por página, especialmente se
o tamanho dos documentos variar significativamente.

Editar um documento
Para editar um documento de uma coleção por meio da UI do Atlas:

1
Vá para a guia Localizar na UI do Atlas.
Selecione a coleção e vá para a guia Localizar.

Até 20 documentos são exibidos na guia.

2
Opcional. Especifique um filtro.
Para especificar a condição do filtro, digite um
filtro de consulta
documento na barra de filtros. Por exemplo, para especificar a condição de igualdade, use
um documento de filtro no formato:

{ <field1>: <value1>, ... }

Para usar operadores de consulta para especificar uma condição de filtro, use um
documento de filtro no formato:

{ <field1>: { <queryoperator>: <value1> }, ... }

3
Edite o documento.
Para editar um documento exibido nos resultados da consulta, passe o mouse sobre o
documento a ser editado e clique no ícone de lápis.

O documento aparece no editor de documentos:

Para adicionar um novo campo, passe o mouse sobre o campo e clique no sinal de mais
que aparece sobre o número da linha do campo.

Para excluir um campo, passe o mouse sobre ele e clique no sinal x que aparece à
esquerda do número da linha do campo. Você não pode excluir o campo _id.

Para editar um nome, valor ou tipo de campo, clique no nome, valor ou tipo do campo.
Para reverter uma alteração específica, passe o mouse sobre o campo editado e clique no
ícone de reversão que aparece à esquerda do número da linha do campo.

4
Salve ou cancele as alterações.
Para confirmar e salvar as alterações, clique no botão Atualizar.

Para cancelar todas as modificações no documento, clique no botão Cancelar.

Excluir um documento
Para excluir um documento de uma coleção por meio da UI do Atlas:

1
Vá para a guia Localizar na UI do Atlas.
Selecione a coleção e vá para a guia Localizar.

Até 20 documentos são exibidos na guia.

2
Opcional. Especifique um filtro.
Para especificar a condição do filtro, digite um
filtro de consulta
documento na barra de filtros. Por exemplo, para especificar a condição de igualdade, use
um documento de filtro no formato:

{ <field1>: <value1>, ... }

Para usar operadores de consulta para especificar uma condição de filtro, use um
documento de filtro no formato:

{ <field1>: { <queryoperator>: <value1> }, ... }

3
Exclua o documento.
Para excluir um documento exibido na consulta resultados, passe o mouse sobre o
documento para excluir e clique no ícone da lixeira.

O documento está sinalizado para exclusão.

4
Para confirmar, clique no botão Excluir.
Criar, visualizar, eliminar e ocultar índices
Nesta página

Funções obrigatórias
Considerações
Ver índices
Crie um índice
Eliminar um índice
Ocultar um índice
Você pode usar a CLI do Atlas ou a UI do Atlas para gerenciar
índices
em suas coleções.

Os índices suportam a execução eficiente de consultas no MongoDB e devem ser


considerados para campos que seu aplicativo lê com frequência. Para saber mais sobre
como criar índices eficazes, consulte
Estratégias de indexação.

Funções obrigatórias
Para criar, derrubar, ou esconder índices, você deverá ter acesso fornecido por pelo menos
uma das seguintes funções:

Proprietário do projeto ou proprietário da organização

Administrador de acesso a dados do projeto

Considerações
Por padrão, você pode ter até três criações de índice simultâneas. Para saber mais,
consulte Máximo de construções de índice simultâneo.

Ver índices
Na guia Coleções, você pode visualizar informações de índice de uma coleção. Para
visualizar informações de índice de uma coleção:

1
Selecione o banco de dados para a coleção.
O painel principal e Namespaces no lado esquerdo listam as coleções no banco de dados.

Captura de tela destacando bancos de dados na UI do Atlas.


Clique para ampliar
2
Selecione a coleção no lado esquerdo ou no painel principal.
O painel principal exibe as visualizações Localizar, Índices e Agregação.

3
Selecione a visualização Índices.
A tabela de índices lista os índices e as informações de índice associadas à coleção. As
informações do índice incluem a definição do índice, o tamanho e a frequência de uso.

Captura de tela destacando a visualização do índice na UI do Atlas.


Clique para ampliar
Crie um índice
DICA
Ao criar índices, tenha em mente a proporção de leituras e gravações na coleção de
destino. Os índices têm um custo de desempenho, mas valem mais do que o custo para
consultas frequentes em grandes conjuntos de dados. Antes de criar um índice, revise a
documentação
estratégias de indexação.

OBSERVAÇÃO
Você pode criar uma pesquisa de texto completo com o Atlas Search. Atlas Search oferece
indexação de texto refinada. Para saber mais, consulte Revisar a sintaxe do índice de
pesquisa do Atlas.

CLI do Atlas

IU do Atlas
Para criar um índice contínuo para seu cluster Atlas usando a CLI do Atlas, execute o
seguinte comando:

índices de clusters atlas criam [indexName] [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
índices de clusters atlas são criados.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Eliminar um índice
Para eliminar um índice de uma coleção usando a UI do Atlas:

1
Navegue até a guia Índices.
Na guia Coleções, selecione a coleção com o índice que você deseja eliminar. Em seguida,
clique na guia Índices.

2
Elimine o índice.
Na coluna Ação, clique no ícone Eliminar índice do índice que você deseja eliminar.
3
Confirme a ação.
Na caixa de diálogo, digite o nome do índice e clique em Eliminar.

IMPORTANTE
Você não pode excluir ou ocultar o índice _id. Para saber mais, consulte
Índices exclusivos.

Considerar ocultando o índice para avaliar o impacto da eliminação de um índice antes de


eliminá-lo. Para saber mais, consulte Índices ocultos.

OBSERVAÇÃO
Limitação CLI do Atlas
Você não pode eliminar o índice de um cluster usando a CLI do Atlas.

Ocultar um índice
Para ocultar um índice usando a UI do Atlas:

1
Navegue até a guia Índices.
Na guia Coleções, selecione a coleção com o índice que você deseja ocultar. Em seguida,
clique na guia Índices.

2
Oculte o índice.
Na coluna Ação, clique no ícone Ocultar índice do índice que você deseja ocultar.

3
Confirme a ação.
Na caixa de diálogo, clique em Confirmar.

OBSERVAÇÃO
Para exibir o índice, clique no ícone novamente e clique em Confirmar para confirmar sua
ação.
Execute pipelines de agregação
Nesta página

Funções obrigatórias
Acesse o construtor de pipeline de agregação
Crie um pipeline de agregação
Exportar um pipeline de agregação para linguagem de driver
Definir configurações de pipeline de agregação
Você pode usar a UI do Atlas para processar seus dados criando
pipelines de agregação
. Os pipelines de agregação transformam seus documentos em resultados agregados com
base em informações selecionadas.
etapas do pipeline.

O construtor de pipeline de agregação Atlas foi projetado principalmente para construir


pipelines, em vez de executá-los. O construtor de pipeline fornece uma maneira fácil de
exporte seu pipeline
para executar em um
motorista.

Funções obrigatórias
Para criar e executar pipelines de agregação na UI do Atlas, você deve ter a função
Somente leitura do Project Data Access ou superior.

Para utilizar o
$ fora
estágio em seu pipeline, você deve ter a função de leitura/gravação do Project Data
Access.

Acesse o construtor de pipeline de agregação


1
Selecione o banco de dados para a coleção.
O painel principal e Namespaces no lado esquerdo listam as coleções no banco de dados.

Captura de tela destacando bancos de dados na UI do Atlas.


Clique para ampliar
2
Selecione a coleção no lado esquerdo ou no painel principal.
O painel principal exibe as visualizações Localizar, Índices e Agregação.

3
Selecione a visualização Agregação.
Quando você abre pela primeira vez a visualização Agregação, o Atlas exibe um pipeline de
agregação vazio.

Visão inicial do construtor de pipeline de agregação.


Clique para ampliar
Crie um pipeline de agregação
1
Selecione um estágio de agregação.
Selecione um estágio de agregação no menu suspenso Selecionar no painel inferior
esquerdo.

Captura de tela mostrando a seleção de um estágio de pipeline.


Clique para ampliar
O botão de alternância à direita do menu suspenso determina se o estágio está habilitado.

2
Preencha seu estágio de agregação.
Preencha seu estágio com os valores apropriados. Se
Modo de comentário
estiver habilitado, o construtor de pipeline fornecerá diretrizes sintáticas para o estágio
selecionado.

À medida que você modifica seu estágio, o Atlas atualiza os documentos de visualização à
direita com base nos resultados do estágio atual.

Pipelines de agregação que não contêm um estágio de gravação (como


$ fora
ou
$ mesclar
) são automaticamente pós-fixados com um
$limite
estágio que restringe a saída a 10 documentos por padrão. Você pode alterar o número de
documentos permitidos através do
$limite
etapa atualizando o campo de valor para Número de documentos de visualização no
campo
Configurações do pipeline de agregação.

Captura de tela mostrando o resultado do estágio do pipeline.


Clique para ampliar
3
Adicione estágios adicionais ao seu pipeline conforme desejado.
Existem duas maneiras de adicionar estágios adicionais ao seu pipeline:

Clique no botão Adicionar estágio na parte inferior do pipeline para adicionar um novo
estágio no final do pipeline:

Clique no botão em um estágio para adicionar um novo estágio diretamente após o estágio
em que o botão foi clicado.

Captura de tela destacando o botão Adicionar estágio.


Para excluir um estágio de pipeline, clique em Excluir no estágio desejado.
4
Repita as etapas 1 e 2 para cada estágio adicional.
Agrupamento
Usar
agrupamento
para especificar regras específicas do idioma para comparação de strings, como regras
para letras maiúsculas e acentos.

Para especificar um documento de agrupamento, clique em Agrupamento na parte superior


do construtor de pipeline.

Um documento de ordenação possui os seguintes campos:

{
localidade: <string>,
caseLevel: <booleano>,
caseFirst: <string>,
força: <int>,
ordenação numérica: <boolean>,
alternativa: <string>,
maxVariável: <string>,
para trás: <booleano>
}

O campo localidade é obrigatório; todos os outros campos de agrupamento são opcionais.


Para descrições dos campos, consulte
Documento de agrupamento.

Importe um pipeline de agregação de texto


Você pode importar pipelines de agregação de texto simples para o construtor de pipeline
para modificar e verificar facilmente seus pipelines.

Para importar um pipeline de texto simples:

1
Abra a caixa de diálogo Novo pipeline a partir do texto.
Clique na seta ao lado do ícone de adição na parte superior do construtor de pipeline.

Clique em Novo pipeline do texto.

Captura de tela abrindo o novo pipeline na caixa de diálogo de texto.


Clique para ampliar
2
Digite ou cole seu pipeline na caixa de diálogo.
Seu pipeline deve corresponder à sintaxe do parâmetro de pipeline do
db.coleção.agregado()
método.
3
Clique em Criar novo.
4
Clique em Confirmar na caixa de diálogo seguinte.
Redefinir seu pipeline
Para retornar seu pipeline ao estado inicial em branco, clique no ícone de adição na parte
superior do construtor de pipeline.

Exportar um pipeline de agregação para linguagem de driver


Você pode usar o construtor de pipeline de agregação para exportar seu pipeline finalizado
para um dos canais suportados.
idiomas do driver
; Java, Node, C# e Python 3. Use esse recurso para formatar e exportar pipelines para uso
em seus aplicativos.

Para exportar seu pipeline de agregação:

1
Construa um pipeline de agregação.
Para obter instruções sobre como criar um pipeline de agregação, consulte
Crie um pipeline de agregação.

2
Clique em Exportar para idioma na parte superior do construtor de pipeline.
3
Selecione o idioma de exportação desejado.
No menu suspenso Exportar pipeline para, selecione o idioma desejado.

O painel Meu pipeline à esquerda exibe seu pipeline em


mangusto
sintaxe.

O painel à direita exibe seu pipeline no idioma selecionado.

4
Inclua instruções de importação, se desejar.
(Opcional): Marque a opção Incluir instruções de importação para incluir as instruções de
importação necessárias para o idioma selecionado.

5
Clique no botão Copiar.
Clique no botão Copiar no canto superior direito do pipeline para copiar o pipeline do idioma
selecionado para a área de transferência. Agora você pode integrar seu pipeline ao seu
aplicativo.

6
Clique em Fechar para retornar ao construtor de pipeline de agregação.
Definir configurações de pipeline de agregação
Você pode definir as configurações do pipeline de agregação na UI do Atlas.

Limitações
O Atlas limita o número de documentos de entrada para visualizações dos seguintes
estágios a 100.000:

$grupo

$balde

$bucketAuto

Esse limite permite que a visualização seja executada mais rapidamente. O Atlas não aplica
um limite quando o pipeline é executado.

Você não pode alterar o limite para visualizar documentos de entrada na UI do Atlas. Para
alterar o limite de documentos de entrada com
Bússola
, ver
Configurações do construtor de pipeline de agregação.

Modificar configurações do pipeline de agregação


Para modificar as configurações do construtor de pipeline de agregação:

1
Clique no ícone no canto superior direito do construtor de pipeline.
Captura de tela destacando o botão de configurações do pipeline.
Clique para ampliar
2
Modifique as configurações do pipeline conforme desejado.
Você pode modificar as seguintes configurações na UI do Atlas:

Contexto
Descrição
Padrão
Modo de comentário
Quando ativado, o Atlas adiciona comentários auxiliares a cada estágio.

OBSERVAÇÃO
A alteração dessa configuração afeta apenas os novos estágios e não modifica os estágios
que já foram adicionados ao pipeline.

Sobre
Número de documentos de visualização
Quantidade de documentos a serem exibidos na visualização de cada etapa.

OBSERVAÇÃO
Você só pode visualizar no máximo 20 documentos para cada etapa.

10
3
Clique em Aplicar para salvar suas alterações.
Configurar gatilhos de banco de dados
Nesta página

Gatilhos de banco de dados


Gatilhos agendados
As funções Atlas fornecem lógica do lado do servidor
Crie um gatilho
Reinicie um gatilho suspenso
Encontre o gatilho suspenso
Reinicie o gatilho
Dependências Externas
Configurar um gatilho
Atlas Triggers permitem executar lógica do lado do servidor em resposta a eventos de
banco de dados ou de acordo com um cronograma. O Atlas fornece dois tipos de gatilhos:
gatilhos de banco de dados e agendados.

Gatilhos na arquitetura MongoDB


Clique para ampliar
Gatilhos de banco de dados
Os gatilhos de banco de dados permitem executar lógica do lado do servidor sempre que
um documento é adicionado, atualizado ou removido em um cluster Atlas vinculado. Ao
contrário dos gatilhos de dados SQL, que são executados no servidor de banco de dados,
os gatilhos são executados em uma camada de computação sem servidor que é
dimensionada independentemente do servidor de banco de dados. Aciona chamada
automaticamente Funções do Atlas e pode encaminhar eventos para manipuladores
externos por meio do AWS EventBridge.

Use gatilhos de banco de dados para implementar interações de dados orientadas por
eventos. Por exemplo, você pode atualizar automaticamente as informações de um
documento quando um documento relacionado for alterado ou enviar uma solicitação a um
serviço externo sempre que um novo documento for inserido.

Gatilhos de banco de dados usam MongoDB mudar fluxos para observar alterações em
tempo real em uma coleção. Um fluxo de mudança é uma série de eventos de banco de
dados em que cada um descreve uma operação em um documento da coleção. Seu
aplicativo abre um único fluxo de mudança para cada coleção com pelo menos um gatilho
habilitado. Se vários acionadores estiverem habilitados para uma coleção, todos eles
compartilharão o mesmo fluxo de mudança.

Você controla quais operações fazem com que um gatilho seja acionado, bem como o que
acontece quando isso acontece. Por exemplo, você pode executar uma função sempre que
um campo específico de um documento for atualizado. A função pode acessar todo o
evento de mudança, para que você sempre saiba o que mudou. Você também pode passar
o evento change para AWS EventBridge lidar com o evento fora do Atlas.

Suporte a gatilhos
$correspondência
expressões para filtrar eventos de mudança e
$projeto
expressões para limitar os dados incluídos em cada evento.

IMPORTANTE
Alterar limitações de fluxo
Há limites para o número total de fluxos de mudança que você pode abrir em um cluster,
dependendo do tamanho do cluster. Ver
alterar limitações de fluxo
Para maiores informações.

Você não pode definir um gatilho de banco de dados em um instância sem servidor ou
instância de banco de dados federado porque eles não suportam fluxos de mudança.

OBSERVAÇÃO
O MongoDB Atlas executa um comando de substituição em vez de um comando de
atualização ao executar uma atualização por meio da UI do Atlas. Os acionadores de banco
de dados só reconhecerão essa atualização por meio da UI do Atlas se você tiver marcado
o evento de substituição do banco de dados para o acionador.

Gatilhos agendados
Os gatilhos agendados permitem executar a lógica do lado do servidor em uma
programação regular definida por você usando expressões CRON. Use gatilhos
programados para realizar trabalhos que acontecem periodicamente, como atualizar um
documento a cada minuto, gerar um relatório noturno ou enviar um boletim informativo
semanal automatizado por e-mail.

As funções Atlas fornecem lógica do lado do servidor


Os gatilhos executam um função que você especifica. Cada gatilho está associado a
exatamente uma Função.

Ao criar um gatilho, você verá um editor de funções onde poderá escrever o código
JavaScript a ser executado pelo gatilho. Esta função existe em um ambiente compartilhado
Serviços de aplicativos aplicativo chamado Triggers, que o Atlas cria automaticamente para
você.

Para encontrar este aplicativo, clique em App Services na navegação e selecione o


aplicativo Triggers.

OBSERVAÇÃO
Os gatilhos criados entre 9 de junho de 2020 e 1º de junho de 2022 usam o nome
Triggers_RealmApp. Os gatilhos criados antes de 9 de junho de 2020 usam o nome
Triggers_StitchApp.

Crie um gatilho
Para criar um novo banco de dados ou gatilho agendado:
Clique na guia Data Services na navegação superior da tela se você ainda não navegou
para o Atlas.

Clique em Gatilhos na navegação à esquerda.

Na guia Visão geral da página Gatilhos, clique em Adicionar gatilho para abrir a página de
configuração do gatilho.

Insira os valores de configuração para o gatilho e clique em Salvar na parte inferior da


página.

Reinicie um gatilho suspenso


Os gatilhos podem entrar em um estado suspenso em resposta a um evento que impede a
continuidade do fluxo de mudança do gatilho, como uma interrupção na rede. Quando um
gatilho é suspenso, ele não recebe eventos de alteração e não será acionado.

OBSERVAÇÃO
No caso de falha no gatilho, o Atlas App Services envia uma notificação por e-mail ao
proprietário do projeto, alertando-o sobre o problema.

Para reiniciar um gatilho suspenso:

1
Encontre o gatilho suspenso
Na guia Gatilhos do banco de dados da página Gatilhos, encontre o gatilho que você deseja
retomar na lista de gatilhos. Os acionadores suspensos são marcados com o status
Suspenso.

A lista de gatilhos na guia Gatilhos do banco de dados da página Gatilhos.


Clique para ampliar
2
Reinicie o gatilho
Clique em Reiniciar na coluna Ações do gatilho.

Você pode optar por reiniciar o gatilho com um fluxo de mudança


retomar token
ou abra um novo fluxo de mudança. Indique se deseja ou não usar um token de
continuação e clique em Resume Database Trigger.

OBSERVAÇÃO
Retomar tokens
Se você usar um
retomar token
, o Atlas tenta retomar o fluxo de mudança subjacente do gatilho no evento imediatamente
após o último evento de mudança processado. Se for bem-sucedido, o gatilho processará
todos os eventos que ocorreram enquanto ele estava suspenso.
Se você não usar um token de retomada, o acionador começará a escutar novos eventos,
mas não será acionado para nenhum evento que tenha ocorrido enquanto ele estava
suspenso.

Marque a caixa de seleção para reiniciar um gatilho com um token de retomada.


Clique para ampliar
Dependências Externas
Uma dependência externa é uma biblioteca externa que inclui lógica que você prefere não
implementar, como análise de strings, funções de conveniência para manipulações de array
e estruturas de dados ou implementações de algoritmos.

Você pode fazer upload de dependências externas do


repositório npm
para os Serviços de Aplicativo e, em seguida, importe essas bibliotecas para suas funções
usando a sintaxe padrão do módulo JavaScript. Para usar dependências externas nas
funções executadas pelos seus gatilhos, consulte Dependências Externas.

Configurar um gatilho
Para configurar um gatilho de banco de dados, consulte Configuração do gatilho de banco
de dados.

Para configurar um gatilho agendado, consulte Configuração de gatilho agendado.


Parâmetros de configuração de gatilho
Nesta página

Configuração do gatilho do banco de dados


Eventos de alteração de banco de dados
Configuração de gatilho agendado
Configuração do gatilho do banco de dados
Os gatilhos de banco de dados possuem os seguintes parâmetros de configuração:

Campo
Descrição
Tipo de gatilho
O tipo do gatilho. Defina como Banco de dados para criar um gatilho de banco de dados.
Nome
O nome do gatilho.
Habilitado
Padrão: Habilitado. Uma alternância que indica se o gatilho está habilitado ou não. Se
ativado, o gatilho escutará eventos e executará sua função associada quando os eventos
fizerem com que ele seja acionado.
Pedido de eventos
Padrão: Habilitado. Indica se a ordenação de eventos está habilitada para este gatilho.

Se a ordenação de eventos estiver habilitada, diversas execuções desse gatilho ocorrerão


sequencialmente com base nos carimbos de data/hora dos eventos de alteração. Se a
ordenação de eventos estiver desabilitada, múltiplas execuções deste gatilho ocorrerão de
forma independente.

DICA
Considere desabilitar a ordenação de eventos se o gatilho for acionado em resposta a
rajadas periódicas de eventos.

Por exemplo, suponha que você tenha um trabalho em lote diário que insere dados em uma
coleção e um gatilho de banco de dados que é acionado em inserções nessa coleção.
Sempre que o trabalho em lote for executado, haverá um grande número de eventos
acionadores para tratar.

Os gatilhos ordenados esperam para executar uma função para um evento específico até
que as funções dos eventos anteriores terminem de ser executadas. Como consequência,
os gatilhos ordenados são efetivamente limitados pela taxa pelo tempo de execução de
cada função de gatilho sequencial. Isso poderá causar um atraso significativo entre o evento
do banco de dados e o disparo do gatilho se um número suficientemente grande de
execuções do gatilho estiver na fila.

Os gatilhos não ordenados executam funções em paralelo, se possível, o que pode ser
significativamente mais rápido (dependendo do seu caso de uso), mas não garante que
múltiplas execuções de uma função de gatilho ocorram na ordem do evento.

Fontes de dados vinculadas


Os nomes de um ou mais clusters MongoDB Atlas que a função de gatilho pode acessar
depois que um evento faz com que ela seja disparada. Um gatilho poderá interagir com
coleções em um cluster se o cluster estiver listado neste campo.
Selecione Cluster Vinculado
O nome do cluster MongoDB Atlas ao qual o gatilho se aplica. O gatilho escuta eventos em
uma coleção dentro deste cluster.
Nome do banco de dados
O banco de dados MongoDB que contém a coleção monitorada.
Nome da coleção
O nome da coleção que o gatilho monitora para eventos de alteração.
Tipo de operação
Um ou mais
tipos de operação de banco de dados
que fazem o gatilho disparar.
Documento Completo
Padrão: Desativado. Se ativado, indica que os eventos de alteração UPDATE devem incluir
os dados mais atuais
comprometido pela maioria
versão do documento modificado no campo fullDocument.

OBSERVAÇÃO
Esta opção afeta apenas eventos de alteração UPDATE. Os eventos INSERT e REPLACE
sempre incluem o campo fullDocument. Os eventos DELETE nunca incluem o campo
fullDocument. Para obter mais informações, consulte o
alterar eventos
página de referência.

AVISO
As operações de atualização executadas no MongoDB Compass ou na UI do MongoDB
Atlas substituem totalmente o documento anterior. Como resultado, as operações de
atualização desses clientes gerarão eventos de alteração REPLACE em vez de eventos
UPDATE.

Documento completo antes da alteração


(Beta) Se ativado, os eventos de alteração incluem uma pré-imagem do documento, uma
cópia do documento modificado imediatamente antes do MongoDB aplicar a alteração. Você
pode acessar a pré-imagem do documento no campo fullDocumentBeforeChange dos
eventos UPDATE, REPLACE e DELETE.

IMPORTANTE
Configurações de pré-imagem em nível de coleção
Para incluir pré-imagens de documentos em eventos de mudança, o MongoDB armazena a
pré-imagem para cada mudança como parte da entrada da mudança no arquivo
registrar
. Dependendo do seu caso de uso, esses dados adicionais de pré-imagem podem ter
implicações negativas no desempenho e fazer com que as operações saiam do oplog mais
rapidamente do que aconteceriam de outra forma.
O MongoDB armazena pré-imagens para coleções inteiras. Depois que as pré-imagens
estiverem habilitadas para qualquer gatilho em uma determinada coleção, você poderá
habilitar pré-imagens para outros gatilhos na mesma coleção sem sobrecarga adicional.

Uma vez ativadas, as entradas de oplog de uma coleção continuam a incluir dados de
pré-imagem, mesmo que nenhum gatilho os utilize ativamente. Para parar de incluir
pré-imagens no oplog, você deve desativar explicitamente as pré-imagens para a coleção.

Para saber mais, consulte


Pré-imagens em nível de coleção
na documentação dos Serviços de Aplicativo.

Função
um atlas
função
, escrito em JavaScript, que o gatilho é executado sempre que é acionado. O gatilho passa
o
objeto de evento de banco de dados
que fez com que ele disparasse como o único argumento para esta função.

Esta função existe em um ambiente compartilhado


Serviços de aplicativos
aplicativo chamado Triggers, que o Atlas cria automaticamente para você.

OBSERVAÇÃO
Os gatilhos criados entre 9 de junho de 2020 e 1º de junho de 2022 usam o nome
Triggers_RealmApp. Os gatilhos criados antes de 9 de junho de 2020 usam o nome
Triggers_StitchApp.

DICA
Veja também:
Funções fornecem lógica do lado do servidor

OBSERVAÇÃO
AWS EventBridge
Você pode configurar um gatilho para enviar um evento ao AWS EventBridge em vez de
chamar uma função.

DICA
Veja também:
Enviar eventos de gatilho para AWS EventBridó.

Expressão de correspondência
Padrão: {} ou seja, "Corresponder a todos". A
$correspondência
documento de expressão que é anexado ao início do pipeline de agregação de fluxo de
mudança subjacente do gatilho. Todos os objetos de evento de mudança para o gatilho são
avaliados em relação a essa expressão de correspondência e o gatilho não será acionado a
menos que a expressão seja avaliada como verdadeira para um determinado evento de
mudança. Isso é útil quando você deseja filtrar eventos de alteração usando dados
diferentes do tipo de operação.

O documento Match Expression a seguir evita que o gatilho seja acionado, a menos que o
campo de status do documento seja atualizado para ter o valor "bloqueado"

{
"updateDescription.updatedFields.status": "bloqueado"
}

Eventos de alteração de banco de dados


Os eventos de alteração do banco de dados representam alterações individuais em uma
coleção específica de um cluster MongoDB.

Cada evento de banco de dados tem o mesmo tipo de operação e estrutura que o
alterar evento
objeto que foi emitido pelo fluxo de mudança subjacente. Os eventos de mudança têm os
seguintes tipos de operação:

Tipo de operação
Representa
INSERIR
Um novo documento que foi adicionado à coleção.
ATUALIZAR
Uma alteração em um documento existente na coleção.
SUBSTITUIR
Um novo documento que substituiu um documento da coleção.
EXCLUIR
Um documento que foi excluído da coleção.
Os objetos de evento de alteração de banco de dados têm o seguinte formato geral:

{
_id: <ObjectId>,
"operaçãoType": <string>,
"fullDocument": <documento>,
"ns": {
"db": <string>,
"coll": <string>
},
"documentKey": {
"_id": <ObjectId>
},
"updateDescription": <documento>,
"clusterTime": <carimbo de data/hora>
}

DICA
Veja também:
alterar eventos
para obter descrições detalhadas desses campos.

Configuração de gatilho agendado


Os gatilhos programados possuem os seguintes parâmetros de configuração:

Campo
Descrição
Tipo de gatilho
O tipo do gatilho. Defina como Agendado para criar um gatilho Agendado.
Nome
O nome do gatilho.
Habilitado
Padrão: Habilitado. Uma alternância que indica se o gatilho está habilitado ou não. Se
ativado, o gatilho executará sua função associada dentro do cronograma.
Tipo de agendamento
Padrão: Básico. O agendamento no qual executar o gatilho.

No modo Básico, os menus suspensos controlam a frequência de disparo. Você pode


configurar o gatilho para repetir por minutos, por horas, em um dia específico da semana ou
em um dia específico do mês. A caixa Próximos Eventos mostra uma prévia de quando o
gatilho será executado de acordo com as configurações do menu suspenso.

No modo Avançado, uma expressão CRON determina quando disparar o gatilho. A caixa
Próximos Eventos mostra uma prévia de quando o gatilho será executado de acordo com a
expressão CRON.

Clusters habilitados
Os nomes de um ou mais clusters MongoDB Atlas que a função de gatilho pode acessar
depois que um evento faz com que ela seja disparada. Um gatilho poderá interagir com
coleções em um cluster se o cluster estiver listado neste campo.
Função atlas, escrito em JavaScript, que o gatilho é executado sempre que é acionado.
Esta função existe em um ambiente compartilhado Serviços de aplicativos aplicativo
chamado Triggers, que o Atlas cria automaticamente para você.

OBSERVAÇÃO
Os gatilhos criados entre 9 de junho de 2020 e 1º de junho de 2022 usam o nome
Triggers_RealmApp. Os gatilhos criados antes de 9 de junho de 2020 usam o nome
Triggers_StitchApp.

DICA
Veja também:
Funções fornecem lógica do lado do servidor.
Enviar eventos de gatilho para AWS
EventBridge
Visão geral
MongoDB oferece um AWS Event Bridge fonte de evento parceira que permite enviar
eventos de gatilho para um barramento de eventos em vez de chamar uma função. Você
pode configurar qualquer gatilho para enviar eventos ao EventBridge.

Tudo o que você precisa para enviar eventos de gatilho para o EventBridge é um ID de
conta da AWS. Este guia explica como encontrar o ID da sua conta, configurar o acionador
e associar a origem do evento do acionador a um barramento de eventos.

OBSERVAÇÃO
Guia oficial de origem de eventos de parceiros da AWS
Este guia é baseado no Amazon
Recebendo eventos de um parceiro SaaS
documentação.

Procedimento
1
Comece a configuração da fonte de eventos do parceiro MongoDB
Para enviar eventos de gatilho para o AWS EventBridge, você precisa do ID da conta da
AWS que deve receber os eventos.

Abra o
Console do Amazon EventBridge
e clique em Fontes de eventos de parceiros no menu de navegação. Procure a origem do
evento do parceiro MongoDB e clique em Configurar.

A fonte de eventos do parceiro MongoDB no EventBridge


Clique para ampliar
Na página de origem do evento do parceiro MongoDB, clique em Copiar para copiar o ID da
sua conta da AWS para a área de transferência.

A solicitação para copiar o ID da sua conta AWS no EventBridge


Clique para ampliar
2
Configurar o gatilho
Depois de obter o ID da conta AWS, você pode configurar um gatilho para enviar eventos ao
EventBridge. Na UI do Atlas, crie e configure um novo gatilho de banco de dados ou gatilho
agendado e selecione o tipo de evento EventBridge.

Cole o ID da conta da AWS que você copiou do EventBridge e selecione uma região da
AWS para a qual enviar os eventos de gatilho.

As caixas de entrada do EventBridge na configuração do acionador.


Clique para ampliar
OBSERVAÇÃO
Regiões da AWS compatíveis
Para obter uma lista completa das regiões suportadas da AWS, consulte o site da Amazon
Recebendo eventos de um parceiro SaaS
guia.

3
Associe a fonte de eventos do gatilho a um barramento de eventos
Volte para o console do EventBridge e escolha Fontes de eventos do parceiro no painel de
navegação. Na tabela Fontes de eventos do parceiro, localize e selecione a origem do
acionador pendente e clique em Associar ao barramento de eventos.

A tabela de fontes de eventos do parceiro MongoDB no EventBridge


Clique para ampliar
Na tela Associar ao barramento de eventos, defina quaisquer permissões de acesso
necessárias para outras contas e organizações e clique em Associar.

A tela para associar a fonte de eventos do MongoDB a um barramento de eventos no


EventBridge
Clique para ampliar
Depois de confirmado, o status da origem do evento acionador muda de Pendente para
Ativo e o nome do barramento de eventos é atualizado para corresponder ao nome da
origem do evento. Agora você pode começar a criar regras que são acionadas em eventos
dessa fonte de eventos do parceiro. Para mais informações, veja Criando uma regra que é
acionada em um evento de parceiro SaaS.

A tabela de fontes de eventos do parceiro MongoDB no EventBridge mostrando a fonte de


eventos do acionador ativo
Expressões CRON
Nesta página

Expressão sintática
Formatar
Valores de campo
Expressões CRON são strings definidas pelo usuário que usam
tarefa cron
sintaxe para definir quando um gatilho programado deve ser executado. Sempre que todos
os campos em uma expressão CRON corresponderem à data e hora atuais, o Atlas dispara
o gatilho associado à expressão.

Expressão sintática
Formatar
Expressões CRON são strings compostas por cinco campos delimitados por espaço. Cada
campo define uma parte granular da programação na qual seu gatilho associado é
executado:

*****
│ │ │ │ └── weekday...........[0 (SUN) - 6 (SAT)]
│ │ │ └──── month.............[1 (JAN) - 12 (DEC)]
│ │ └────── dayOfMonth........[1 - 31]
│ └──────── hour..............[0 - 23]
└────────── minute............[0 - 59]

Campo
Valores válidos
Descrição
minuto
[0 - 59]
Representa um ou mais minutos dentro de uma hora.

EXEMPLO
Se o campo de minuto de uma expressão CRON tiver o valor 10, o campo corresponderá a
qualquer horário dez minutos após a hora (por exemplo, 9h10).

hora
[0 - 23]
Representa uma ou mais horas de um dia em um relógio de 24 horas.

EXEMPLO
Se o campo de hora de uma expressão CRON tiver o valor 15, o campo corresponderá a
qualquer horário entre 15h e 15h59.

dia do mês
[1 - 31]
Representa um ou mais dias dentro de um mês.

EXEMPLO
Se o campo dayOfMonth de uma expressão CRON tiver o valor 3, o campo corresponderá a
qualquer momento no terceiro dia do mês.

mês
1 (JAN) 7 (JUL)
2 (fevereiro) 8 (agosto)
3 (MAR) 9 (SET)
4 (ABR) 10 (OUT)
5 (MAIO) 11 (NOV)
6 (JUN) 12 (DEZ)
Representa um ou mais meses dentro de um ano.

Um mês pode ser representado por um número (por exemplo, 2 para fevereiro) ou por uma
sequência de três letras (por exemplo, APR para abril).

EXEMPLO
Se o campo mês de uma expressão CRON tiver o valor 9, o campo corresponderá a
qualquer momento do mês de setembro.

dia da semana
0 (SOL)
1 (SEG)
2 (terça)
3 (QUA)
4 (QUI)
5 (sexta-feira)
6 (SÁBADO)
Representa um ou mais dias dentro de uma semana.

Um dia da semana pode ser representado por um número (por exemplo, 2 para terça-feira)
ou uma sequência de três letras (por exemplo, THU para quinta-feira).

EXEMPLO
Se o campo do dia da semana de uma expressão CRON tiver o valor 3, o campo
corresponderá a qualquer hora de uma quarta-feira.

Valores de campo
Cada campo em uma expressão CRON pode conter um valor específico ou uma expressão
avaliada como um conjunto de valores. A tabela a seguir descreve valores e expressões de
campos válidos:

Tipo de expressão
Descrição
Todos os valores
(*)
Corresponde a todos os valores de campo possíveis.

Disponível em todos os campos de expressão.

EXEMPLO
A seguinte expressão CRON agenda um gatilho para ser executado uma vez a cada minuto
de cada dia:

*****

Valor Específico
(<Valor>)
Corresponde a um valor de campo específico. Para campos diferentes de dia da semana e
mês este valor será sempre um número inteiro. Um campo de dia da semana ou mês pode
ser um número inteiro ou uma sequência de três letras (por exemplo, TUE ou AUG).

Disponível em todos os campos de expressão.

EXEMPLO
A seguinte expressão CRON agenda um gatilho para ser executado uma vez por dia às 11h
UTC:

0 11 * * *

Lista de Valores
(<Expressão1>,<Expressão2>,...)
Corresponde a uma lista de duas ou mais expressões de campo ou valores específicos.

Disponível em todos os campos de expressão.

EXEMPLO
A seguinte expressão CRON agenda um gatilho para ser executado uma vez por dia em
janeiro, março e julho às 11h UTC:

0 11 * 1,3,7 *

Faixa de valores
(<Valor inicial>-<Valor final>)
Corresponde a um intervalo contínuo de valores de campo entre e incluindo dois valores de
campo específicos.

Disponível em todos os campos de expressão.

EXEMPLO
A seguinte expressão CRON agenda um gatilho para ser executado uma vez por dia, de 1º
de janeiro até o final de abril, às 11h UTC:

0 11 * 1-4 *
Etapa de tempo modular
(<Expressão de campo>/<Valor da etapa>)
Corresponde a qualquer momento em que o valor da etapa divide uniformemente o valor do
campo sem resto (ou seja, quando Valor% Etapa == 0).

Disponível nos campos de expressão de minutos e horas.

EXEMPLO
A seguinte expressão CRON agenda um gatilho para ser executado nos dias 0, 25 e 50
minutos de cada hora:

*/25 * * * *
Dependências Externas
Nesta página

Visão geral
Carregar dependências externas
Procedimento
Importar dependências externas
Uso
Importe um módulo completo
Importar uma subpasta de módulo
Restrições
Visão geral
Uma dependência externa é uma biblioteca externa que inclui lógica que você prefere não
implementar, como análise de strings, funções de conveniência para manipulações de array
e estruturas de dados ou implementações de algoritmos.

Você pode fazer upload de dependências externas do repositório npm para os Serviços de
Aplicativo e, em seguida, importe essas bibliotecas para suas funções usando a sintaxe
padrão do módulo JavaScript. Para começar com dependências externas, confira os guias a
seguir.

OBSERVAÇÃO
Crie seus próprios módulos
Embora a maioria dos módulos npm sejam escritos por terceiros, você pode criar e publicar
seus próprios módulos npm para abrigar lógica específica para seu aplicativo. Você pode
disponibilizar seus módulos para a comunidade Node.js ou reservá-los para uso privado.
Para saber mais, consulte o guia do npm em
Contribuindo com pacotes para o registro
.

Carregar dependências externas


Você pode fazer upload de módulos npm no aplicativo App Services que hospeda seus
gatilhos e funções. Isso permite que funções em seu aplicativo dependam de bibliotecas
externas.

Para usar dependências externas, carregue um arquivo de uma pasta npm node_modules
por meio da interface do usuário dos Serviços de Aplicativo. Depois de carregada, qualquer
função pode importar e usar quaisquer dependências listadas na página de dependências
da interface do usuário dos Serviços de Aplicativo.

IMPORTANTE
Restrições de tamanho de dependência externa
Os arquivos zip enviados estão sujeitos a um limite de tamanho de 10 MB.

Procedimento
1
Instale suas dependências localmente.
Para fazer upload de dependências externas para Atlas App Services, primeiro você precisa
de uma pasta node_modules local contendo pelo menos um pacote Node.js. Você pode
usar o seguinte snippet de código para instalar localmente uma dependência que deseja
carregar:

npm install <package name>

Se a pasta node_modules ainda não existir, este comando a cria automaticamente.

OBSERVAÇÃO
Métodos alternativos de instalação
Você também pode configurar um package.json e executar o comando npm install para
instalar todos os pacotes (e suas dependências) listados em seu package.json.

Para saber mais sobre npm e node_modules, consulte o


documentação npm
.

2
Crie um arquivo de dependência.
Agora que baixou todos os seus módulos npm, você precisa empacotá-los em um arquivo
para poder carregá-los nos Serviços de Aplicativo. Crie um arquivo contendo a pasta
node_modules:

tar -czf node_modules.tar.gz node_modules/

OBSERVAÇÃO
Formatos de arquivo suportados
Os Serviços de Aplicativos oferecem suporte aos formatos de arquivo .tar, .tar.gz e .zip.

3
Carregue o arquivo de dependência.
Depois de criar um arquivo contendo suas dependências, tudo o que resta fazer é
carregá-las nos Serviços de Aplicativos. Você pode carregar seu arquivo de dependência
usando a UI dos Serviços de Aplicativo:

Selecione Serviços de aplicativos na navegação do lado esquerdo.

Selecione o aplicativo Gatilhos.

OBSERVAÇÃO
Os gatilhos criados entre 9 de junho de 2020 e 1º de junho de 2022 usam o nome
Triggers_RealmApp. Os gatilhos criados antes de 9 de junho de 2020 usam o nome
Triggers_StitchApp.

Selecione Funções na navegação do lado esquerdo.

Selecione a guia Dependências.

Clique no botão Carregar pasta.

No seletor de arquivos, selecione o arquivo node_modules.tar.gz que você acabou de criar


e clique em Abrir. Os Serviços de Aplicativos carregam automaticamente o arquivo
compactado, o que pode levar vários minutos dependendo da velocidade da sua conexão
com a Internet e do tamanho do seu arquivo de dependência. Independentemente de a
operação ter sido bem-sucedida ou falhar, os Serviços de Aplicativos exibem um banner
indicando o sucesso ou a falha da operação. Se for bem-sucedido, a guia Dependências
exibirá uma lista das dependências incluídas em seu arquivo de dependências.

Se os rascunhos estiverem ativados, você também precisará clicar em Revisar e implantar


no banner para aplicar essas alterações. Se os rascunhos estiverem desativados, a
alteração entrará em vigor dentro de 5 a 60 segundos.

Agora que suas dependências foram carregadas, tente


importando-os para uma função.

Importar dependências externas


Depois de carregado em seu aplicativo, você poderá importar módulos npm listados na
página de dependências da interface do usuário dos Serviços de Aplicativo para suas
funções.

OBSERVAÇÃO
Pré-requisitos para Importação
Você deve
carregar dependências
antes de poder importá-los.

Uso
Você pode importar dependências para qualquer função usando a palavra-chave require
dentro da função exports. Você não pode usar a sintaxe de importação do Módulo ES. Você
deve importar dependências no estilo de uma importação de módulo node_modules, pois os
Serviços de Aplicativo não dão suporte à importação de arquivo ou módulo local. Para saber
mais sobre a sintaxe require, consulte o
Documentação do Node.js para a palavra-chave require
.

IMPORTANTE
Onde posso importar módulos?
Os projetos Node.js geralmente colocam instruções require no escopo global de cada
arquivo, mas os Serviços de Aplicativos não dão suporte a esse padrão. Você deve colocar
instruções de função require dentro de um escopo de função.

Importe um módulo completo


Abaixo, você encontrará um exemplo simples de função que usa a palavra-chave require
dentro de uma função para importar o módulo ramda e chamar
Ramda
método de mapa:

exports = () => {
const R = require("ramda");
return R.map(x => x*2, [1,2,3]);
}

Importar uma subpasta de módulo


O exemplo a seguir demonstra como usar require para importar um único submódulo de
uma dependência externa para uma função:

exports = function(arg){
const cloneDeep = require("lodash/cloneDeep");

var original = { name: "Deep" };


var copy = cloneDeep(original);
copy.name = "John";

console.log(`original: ${original.name}`);
console.log(`copy: ${copy.name}`);
return (original != copy);
};

Restrições
As dependências externas estão sujeitas às seguintes limitações:

As instruções Require devem aparecer dentro de uma declaração de função, não fora dela.
Atualmente, o Atlas App Services não oferece suporte a declarações no escopo global.

Atualmente, o Atlas App Services oferece suporte a um subconjunto de módulos integrados


do Node.js. Para obter uma lista de módulos suportados e não suportados, consulte
restrições de função.

← Configuração de expressões CRON e consulta à federação de dados →


Lago de dados do Atlas
Nesta página

Sobre o Atlas Data Lake


Exemplos de usos
Regiões do Atlas Data Lake
Cobrança
Procurando documentação sobre o que costumava ser chamado de "Atlas Data Lake"?
Atlas Data Lake agora é chamado de Atlas Data Federation. Para saber mais sobre o
serviço renomeado do mecanismo de consulta federado, consulte
Federação de Dados Atlas
.
Sobre o Atlas Data Lake
MongoDB Atlas Data Lake agora é um serviço de armazenamento de objetos otimizado
para análise para dados extraídos. O Atlas Data Lake fornece um serviço de
armazenamento analítico otimizado para dados simples ou aninhados com desempenho de
consulta de baixa latência.

Pré-requisitos
O Atlas Data Lake requer um cluster Atlas habilitado para backup M10 ou superior com
tarefas de backup em nuvem em execução em uma cadência especificada. Para saber mais
sobre backups na nuvem, consulte
Faça backup da implantação do seu banco de dados.

Tipos de fontes de dados compatíveis


O Atlas Data Lake oferece suporte a instantâneos de coleta de clusters Atlas como fonte de
dados para dados extraídos. O Atlas Data Lake ingere automaticamente dados dos
snapshots, particiona e armazena dados em um formato otimizado para análise. Não
oferece suporte à criação de pipelines para
Visualizações.

Formato de armazenamento de dados e suporte a consultas


O Atlas Data Lake armazena dados em um formato analítico baseado em padrões de
código aberto com suporte para dados polimórficos. Os dados são totalmente gerenciados,
indexados em nível de partição e balanceados à medida que os dados crescem. Atlas Data
Lake otimiza a extração de dados para consultas de tipo analítico. Quando o Atlas Data
Lake extrai novos dados, ele reequilibra os arquivos existentes para garantir um
desempenho consistente e minimizar a varredura de dados.

O Atlas Data Lake armazena dados em um formato que melhor se adapta à sua estrutura
para permitir consultas pontuais rápidas e consultas agregadas. Para consultas pontuais, o
formato de armazenamento do Atlas Data Lake melhora o desempenho ao encontrar
partições com mais rapidez. As consultas de tipo agregado verificam apenas a coluna
necessária para fornecer resultados. Além disso, os índices de partição do Atlas Data Lake
melhoram o desempenho de consultas agregadas, retornando resultados diretamente do
índice de partição, sem a necessidade de verificar os arquivos subjacentes.
Exemplos de usos
Você pode usar o Atlas Data Lake para:

Isole cargas de trabalho analíticas do seu cluster operacional.

Forneça uma visão consistente dos dados do cluster a partir de um instantâneo para
agregações de longa duração usando $out.

Consulte e compare versões dos dados do seu cluster em diferentes momentos.

Regiões do Atlas Data Lake


Atlas Data Lake fornece armazenamento otimizado nas seguintes regiões da AWS:

Regiões do Data Lake


Regiões da AWS
Virgínia, EUA
nós-leste-1
Oregon, EUA
nós-oeste-2
São Paulo, Brasil
sa-leste-1
Irlanda
eu-oeste-1
Londres, Inglaterra
eu-oeste-2
Frankfurt, Alemanha
eu-central-1
Mumbai, índia
ap-sul-1
Cingapura
ap-sudeste-1
Sydney, Austrália
ap-sudeste-2
O Atlas Data Lake seleciona automaticamente a região mais próxima do cluster Atlas para
armazenar dados ingeridos.

Cobrança
Você incorre em cobranças do Atlas Data Lake por GB por mês com base na região da
AWS onde os dados ingeridos são armazenados. Você incorre em custos do Atlas Data
Lake para os seguintes itens:

Ingestão de dados da sua fonte de dados

Armazenamento no armazenamento de objetos em nuvem

Custos de extração
O Atlas Data Lake cobra pelos recursos utilizados para extrair, fazer upload e transferir
dados. O Atlas Data Lake cobra pelo
exportação de instantâneo
operações é baseada no seguinte:

Custo por GB para extração de snapshot

Custo por hora no servidor AWS para download de exportação de snapshot

Custo por GB por hora para armazenamento de restauração de exportação de snapshot

Custo por IOPS por hora para IOPS de armazenamento de exportação de snapshots

Custos de armazenamento
As cobranças do Atlas Data Lake para armazenamento e acesso aos dados armazenados
são baseadas no seguinte:

Custo por GB por dia

Custo para cada mil solicitações de acesso ao armazenamento ao consultar conjuntos de


dados do Data Lake usando o Atlas Data Federation. Cada solicitação de acesso
corresponde a uma partição de dados de um conjunto de dados do Data Lake que a Atlas
Data Federation busca para processar para uma consulta.

OBSERVAÇÃO
Agora você pode definir limites na quantidade de dados que o Atlas Data Federation
processa para suas consultas para controlar custos. Para saber mais, consulte
Gerenciar limites de consulta da Federação de Dados Atlas.

Para saber mais, consulte a página de preços do Atlas.


Configurar e consultar a federação de dados
Consulte, transforme e agregue dados de um ou mais bancos de dados MongoDB Atlas,
buckets AWS S3 e conjuntos de dados Atlas Data Lake com facilidade. Obtenha os insights
que você precisa ou coloque os dados nas mãos de quem precisa!

Iniciar
Saiba mais sobre a Federação de Dados Atlas

Imagem principal da página de destino do MongoDB Atlas Data Federation


O QUE VOCÊ PODE FAZER
Flexibilidade para seus dados
A Federação de Dados oferece a capacidade de federar consultas em dados armazenados
em vários formatos de armazenamento compatíveis, incluindo Clusters Atlas, conjuntos de
dados de Data Lake, buckets AWS S3 e armazenamentos HTTP. Você pode obter insights
ou mover dados entre qualquer um dos formatos de armazenamento suportados do serviço.

Alimentar sistemas downstream

Consultar dados em clusters

Consultar conjuntos de dados do Data Lake


1
Conecte seu cluster Atlas como fonte de dados
Use o assistente para criar uma instância de banco de dados federado e conectar as
coleções de clusters do Atlas que você deseja como fontes de dados.

Consulte Usar o Assistente de Alimentação de Sistemas Downstream.

2
Conecte seu armazenamento de objetos de destino
Forneça credenciais para seu armazenamento de objetos em nuvem, autorizando sua
instância de banco de dados federado a exportar dados para ele.

3
Especifique a frequência e o formato de exportação
Grave dados do cluster Atlas no armazenamento de objetos na nuvem em
Parquete
, CSV, BSON ou
JSON estendido do MongoDB
em uma programação usando o operador $out do MongoDB.

Imagem de bancos de dados federados de consulta do MongoDB Atlas Data Federation


PRODUTOS E RECURSOS RELACIONADOS
Tutoriais para você começar!
Siga os tutoriais abaixo para começar a resolver seus desafios mais urgentes!
Ícone MongoDB Atlas Data Federation para exportação de dados
Exporte dados do seu Atlas Cluster para arquivos Parquet

Siga o tutorial

Ícone MongoDB Atlas Data Federation para consultar bancos de dados Atlas
Consultar dados de vários clusters Atlas

Consultar vários bancos de dados

Ícone MongoDB Atlas Data Federation para sandbox


Aprenda com um passo a passo e consulte seus próprios dados em um sandbox

Experimente em uma caixa de areia


Visão geral da Federação de Dados Atlas
Nesta página

Sobre a Federação de Dados Atlas


Conceitos chave
Arquitetura da Federação de Dados Atlas
Exemplos de usos
Regiões da Federação de Dados Atlas
Sobre a Federação de Dados Atlas
Atlas Data Federation é um mecanismo de consulta distribuído que permite consultar,
transformar e mover dados nativamente entre várias fontes dentro e fora do MongoDB
Atlas.

Conceitos chave
Instância de banco de dados federado
Uma instância de banco de dados federado é uma implantação do Atlas Data Federation.
Cada instância de banco de dados federado contém bancos de dados virtuais e coleções
que são mapeadas para dados em seus armazenamentos de dados.

Banco de dados
O armazenamento de dados refere-se à localização dos seus dados. A Atlas Data
Federation oferece suporte aos seguintes armazenamentos de dados:

Aglomerado Atlas

Arquivo on-line do Atlas

Conjuntos de dados Atlas Data Lake

Baldes AWS S3

Pontos de extremidade HTTP e HTTPS

Configuração de armazenamento
A configuração de armazenamento contém mapeamentos entre seus bancos de dados
virtuais e coleções e fontes de dados no formato JSON. Você pode definir esses
mapeamentos na configuração de armazenamento para acessar e executar consultas em
seus dados.

Arquitetura da Federação de Dados Atlas


Arquitetura da Federação de Dados Atlas
Clique para ampliar
O Plano de Dados no diagrama anterior é onde residem seus dados. Você pode configurar
o Atlas Data Federation para acessar dados em diversos serviços de armazenamento.
Especificamente, você pode configurar o Atlas Data Federation para acessar dados em
seus buckets AWS S3 em regiões da AWS, clusters Atlas, URLs HTTP e HTTPS e
conjuntos de dados Atlas Data Lake. Para saber mais sobre como configurar o Atlas Data
Federation para acessar seus armazenamentos de dados, consulte Definir
armazenamentos de dados para uma instância de banco de dados federado.

Você pode então configurar o controle de acesso baseado em função para suas instâncias
de banco de dados federado. Você pode controlar como seu cliente se conecta à sua
instância de banco de dados federado, seja por meio de uma opção de conexão global ou
fixando-o em uma região específica. Para saber mais, consulte Configurar conexão para
sua instância de banco de dados federado.

A Atlas Data Federation preserva a localidade dos dados e maximiza a computação local,
sempre que possível, para minimizar a transferência de dados e otimizar o desempenho. O
Plano de Computação no diagrama anterior mostra onde o Atlas Data Federation processa
todas as solicitações. O Atlas Data Federation fornece um pool elástico de agentes na
região mais próxima dos seus dados, onde o Atlas Data Federation pode processar os
dados para suas consultas. Para saber mais sobre regiões suportadas, consulte
Regiões da Federação de Dados Atlas.

O Atlas Data Federation não persiste os dados dentro do sistema e, depois que sua
consulta é processada, ele armazena apenas os metadados na sua instância de banco de
dados federado. Isto permite-lhe cumprir os regulamentos de soberania de dados e garante
que os seus dados são armazenados e processados em conformidade com os requisitos
legais.

O Plano de Controle no diagrama anterior, que é igual ao Plano de Controle Atlas, é onde o
Atlas Data Federation equilibra as solicitações do usuário e agrega os resultados finais.

A Atlas Data Federation executa certas partes de uma consulta diretamente no serviço de
armazenamento subjacente, em vez de transferir todos os dados para os nós de
computação para processamento. Além disso, quando você executa uma consulta, ela é
primeiro processada por um componente front-end da Federação de Dados, que planeja a
consulta e depois a distribui aos nós no back-end. Os nós de back-end acessam seu
armazenamento de dados diretamente para executar a lógica de consulta e retornar os
resultados ao front-end. Este processo reduz a quantidade de dados a serem
movimentados, tornando todo o processo mais rápido e barato. Para saber mais, consulte
Consultar uma instância de banco de dados federado.

Para otimizar o desempenho de suas consultas, a Atlas Data Federation faz o seguinte:

Para o Cloud Object Storage, ele usa particionamento de dados para selecionar os arquivos
que precisa processar com base nos parâmetros de consulta. Para saber mais, consulte
Definir caminho para dados S3 e usar tipos de atributos de partição. Além disso, ele usa
metadados Parquet para reduzir a quantidade de dados verificados em arquivos parquet
usando seleção de grupo de linhas ou projeção de colunas. Para saber mais, consulte o
Formato de dados Parquet.

Para clusters Atlas, ele tenta "enviar" o máximo possível da consulta para o cluster. Por
exemplo, se o seu pipeline de agregação tiver um estágio e se puder ser processado
localmente, o Atlas Data Federation tenta processar esse estágio no cluster Atlas e apenas
retorna os documentos resultantes de volta à camada federada para processamento dos
estágios subsequentes. Para saber mais, consulte Consultando dados em seu cluster Atlas.

Para conjuntos de dados do Atlas Data Lake, ele usa índices de partição para acelerar
consultas em conjuntos de dados. Os índices de partição do Atlas Data Lake contêm
contagens retornadas, em vez de verificar o armazenamento de arquivos subjacente para
satisfazer consultas. Para saber mais, consulte Conjunto de dados do Atlas Data Lake ou
Arquivo online.

Para saber mais, consulte Otimizar o desempenho da consulta.

Você pode se conectar ao Atlas Data Federation usando o idioma específico do MongoDB
motoristas
,
mangusto
e Atlas SQL. Para saber mais, consulte Conectar-se à sua instância de banco de dados
federado.

Exemplos de usos
Você poden use o Atlas Data Federation para:

Copie os dados do cluster Atlas em arquivos Parquet ou CSV gravados em buckets AWS
S3.

Consulte vários clusters do Atlas e arquivos on-line para obter uma visão holística dos
dados do Atlas.

Materialize dados de agregações em clusters Atlas e buckets AWS S3.

Leia e importe dados de seus buckets AWS S3 para um cluster Atlas.

Regiões da Federação de Dados Atlas


OBSERVAÇÃO
Para evitar cobranças excessivas em sua fatura, crie sua Atlas Data Federation na mesma
região da AWS ou do Azure que sua fonte de dados S3 ou Azure Blob Storage. Você pode
consultar o AWS S3 somente usando instâncias de banco de dados federado criadas na
AWS e pode consultar o Azure Blob Storage somente usando instâncias de banco de dados
federado criadas no Azure.

A Atlas Data Federation roteia suas solicitações de banco de dados federado por meio de
uma das seguintes regiões:

AWS

Azul
Regiões de Federação de Dados
Regiões da AWS
Virgínia, EUA
nós-leste-1
Oregon, EUA
nós-oeste-2
São Paulo, Brasil
sa-leste-1
Irlanda
eu-oeste-1
Londres, Inglaterra
eu-oeste-2
Frankfurt, Alemanha
eu-central-1
Mumbai, índia
ap-sul-1
Cingapura
ap-sudeste-1
Sydney, Austrália
ap-sudeste-2
OBSERVAÇÃO
Você incorrerá em cobranças ao executar consultas federadas. Para obter mais
informações, consulte Custos de Federação de Dados.
Iniciar
Nesta página

Visão geral
Índice
Visão geral
Atlas Data Federation é a solução do MongoDB para consultar dados armazenados em
buckets S3 de baixo custo, clusters Atlas, armazenamentos HTTP e conjuntos de dados
Atlas Data Lake usando a linguagem de consulta MongoDB. Isso permite que os aplicativos
armazenem dados na solução de armazenamento apropriada para seu caso de uso.

Este tutorial orienta você no processo de criação e conexão a uma instância de banco de
dados federado de amostra no Atlas, configurando caminhos para coleções de arquivos
armazenados no S3 e executando operações MongoDB Query Language (MQL).

Captura de tela da instância do banco de dados federado após a execução de consultas.


Clique para ampliar
Índice
Parte 1: Implantar uma instância de banco de dados federado.

Parte 2: Configurar a conexão para sua instância de banco de dados federado.

Parte 3: Conecte-se à sua instância de banco de dados federado.

Parte 4: Execute consultas em sua instância de banco de dados federado.


Implantar uma instância de banco de dados
federado
Nesta página

Acesso obrigatório
Pré-requisitos
Use o assistente de alimentação de sistemas downstream
Use o Assistente Explorar com Dados de Amostra
Usar o assistente de consulta de dados entre clusters
Próximos passos
Tempo estimado de conclusão: 15 minutos

Esta parte do tutorial orienta você na implantação de uma instância de banco de dados
federado usando os seguintes assistentes de início rápido na UI do Atlas:

O
Alimentar sistemas downstream
O assistente ajuda a configurar uma instância de banco de dados federado que exporta
dados do seu cluster Atlas, transforma os dados em
Parquete
, CSV, BSON ou
JSON estendido do MongoDB
e copia os dados para seus buckets AWS S3 em intervalos especificados usando
Gatilhos Atlas.

O
Explore com dados de amostra
O assistente ajuda a configurar uma instância de banco de dados federado carregada com
dados de amostra para demonstrar como conectar-se à instância de banco de dados
federado e executar consultas.

O
Consultar dados em clusters
O assistente ajuda a configurar uma instância de banco de dados federado que acessa
dados de vários clusters do Atlas para que você possa executar consultas federadas em
coleções de todos eles.

Para saber mais sobre as opções de configuração de armazenamento, incluindo opções de


configuração de armazenamento para conjuntos de dados do Atlas Data Lake e URLs
acessíveis publicamente, consulte Definir armazenamentos de dados para uma instância de
banco de dados federado.

Acesso obrigatório
Para implementar uma instância de banco de dados federado, você deve ter acesso de
Proprietário do Projeto ao projeto. Os usuários com acesso de Proprietário da Organização
devem adicionar-se como Proprietários do Projeto ao projeto antes de implementar uma
instância de banco de dados federado.

Pré-requisitos
Para concluir esta parte do tutorial, certifique-se de atender aos seguintes pré-requisitos:

Criar uma
Atlas MongoDB
conta, se você ainda não tiver uma.

Para o assistente Feed Downstream Systems, você precisa de:

O
CLI da AWS
,
configurado para acessar sua conta AWS
. Alternativamente, você deve ter acesso ao AWS Management Console com permissão
para criar
Funções do IAM.

Um bucket S3 para armazenar dados extraídos.

Pelo menos um cluster Atlas com banco de dados.

Para o assistente Consultar dados entre clusters, você precisa de:

Pelo menos um cluster Atlas implantado no mesmo projeto que você usará para sua
instância de banco de dados federado.

Pelo menos uma coleção de banco de dados. Você pode carregar dados de amostra se
ainda não tiver coleções.

Use o assistente de alimentação de sistemas downstream


O assistente Feed Downstream Systems ajuda a configurar uma instância de banco de
dados federado que grava dados do cluster Atlas no bucket AWS S3 continuamente de
acordo com uma programação.

1
Faça login no MongoDB Atlas.
2
Selecione a opção Federação de Dados na navegação à esquerda.
3
Crie uma instância de banco de dados federado.
Clique no menu suspenso Criar novo banco de dados federado.

Selecione Alimentar Sistemas Downstream.

4
Clique em Começar.
5
Digite um nome para sua instância de banco de dados federado no campo Nome da
Instância de Banco de Dados Federado e clique em Continuar.
O padrão é FederatedDatabaseInstance[n]. Depois que sua instância de banco de dados
federado for criada, você não poderá alterar seu nome.

6
Especifique suas fontes de dados.
Selecione um cluster Atlas para usar como fonte de dados no menu suspenso. Por padrão,
o Atlas Data Federation adiciona todas as coleções neste cluster. Para usar um subconjunto
de dados, clique em Coleções Específicas, expanda os bancos de dados e selecione as
coleções que deseja adicionar à sua instância de banco de dados federado.

DICA
Para filtrar os bancos de dados e coleções, insira o texto no campo Coleções Específicas. A
caixa de diálogo exibe apenas bancos de dados e coleções com nomes que correspondem
aos seus critérios de pesquisa.

Clique em Continuar.

7
Selecione uma função AWS IAM para Atlas.
Você pode selecionar uma função existente do AWS IAM para a qual o Atlas está autorizado
na lista suspensa de seleção de funções ou escolher Autorizar uma função do AWS IAM
para autorizar uma nova função.

Se você selecionou uma função existente para a qual o Atlas está autorizado, prossiga para
a próxima etapa para listar seus buckets AWS S3.

Se você estiver autorizando o Atlas para uma função existente ou criando uma nova função,
conclua as etapas a seguir antes de prosseguir para a próxima etapa:

No menu suspenso, selecione Autorizar uma função do AWS IAM para autorizar uma nova
função ou selecionar uma função existente.

Use o AWS ARN e o ID externo exclusivo na seção Autorização de função para adicionar o
Atlas às relações de confiança de uma função AWS IAM existente ou nova.

Na UI do Atlas, clique em uma das seguintes opções:

A função Criar nova função AWS IAM mostra como usar o ARN e o ID externo exclusivo
para adicionar o Atlas às relações de confiança de uma nova função AWS IAM. Siga as
etapas na UI do Atlas para criar uma nova função. Para saber mais, consulte
Crie uma nova função com a AWS CLI.

Ao autorizar uma nova função, se você sair do fluxo de trabalho:


Antes de validar a função, o Atlas não criará a instância do banco de dados federado. Você
pode ir para a página Integrações do Atlas para
autorizar
uma nova função e, em seguida, inicie o procedimento para
implantando uma instância de banco de dados federado
novamente quando você tiver o ARN da função AWS IAM.

Depois de validar a função, o Atlas não criará a instância do banco de dados federado. No
entanto, a função está disponível no menu suspenso de seleção de funções e pode
serusado para criar uma instância de banco de dados federado. Você não precisa autorizar
a função novamente.

A função Usar AWS IAM existente mostra como usar o ARN e o ID externo exclusivo para
adicionar o Atlas às relações de confiança de uma função AWS IAM existente. Siga as
etapas na UI do Atlas para adicionar o Atlas à relação de confiança para uma função
existente. Para saber mais, consulte
Adicionar relações de confiança a uma função existente
.

IMPORTANTE
Se você modificar o ARN da função personalizada da AWS no futuro, certifique-se de que a
política de acesso da função inclua o acesso apropriado aos recursos do S3 para a
instância do banco de dados federado.

DICA
Veja também:
Configurar o acesso unificado da AWS

Crie uma função de acesso de provedor de nuvem

Clique em Validar função do AWS IAM.

8
Atribua uma política de acesso à sua função AWS IAM.
Insira o nome do seu bucket S3.

Siga as etapas na IU do Atlas para atribuir uma política de acesso à sua função AWS IAM.

Clique em Validar acesso ao bucket AWS S3.

Clique em Continuar.

9
Agende suas extrações de dados.
Agende um
acionar
para copiar continuamente dados do cluster Atlas para o bucket S3 usando
$ fora
na seção Agendar consultas.

Especifique com que frequência você deseja extrair dados do cluster Atlas usando os
menus suspensos Repetir uma vez por.

Opcional. Especifique se o Atlas Data Federation deve executar novamente a mesma


consulta caso ela tenha sido perdida por algum motivo. Por padrão, isso está desabilitado
para permitir que o Atlas Data Federation execute novamente consultas perdidas. Como
alternativa, para pular consultas perdidas e não recuperar o atraso, ative Ignorar eventos de
recuperação.

Opcional. Escolha o formato desejado para seus dados quando o Atlas Data Federation os
gravar em seu bucket S3. A Federação de Dados Atlas suporta
Parquete
, CSV , BSON e
JSON estendido do MongoDB.

Especifique o Tamanho máximo do arquivo para limitar o tamanho de cada arquivo que o
Atlas Data Federation grava em seu bucket do S3. Por exemplo, se você definir o tamanho
máximo do arquivo como 100 MB e uma consulta retornar 1 GB de dados, o Atlas Data
Federation gravará a consulta em seu bucket S3 em 10 arquivos, cada um com 100 MB.

Introduzir o
Prefixo AWS
para seu bucket S3 de destino.

Digite o nome do
indexado
campo de data em Campo de data e especifique o formato de seu valor usando o menu
suspenso. Cada coleção que você deseja copiar downstream deve ter um
indexado
campo que armazena um carimbo de data/hora como seu valor.

Clique em Continuar.

10
Clique em Criar.
Use o Assistente Explorar com Dados de Amostra
O assistente Explorar com Dados de Amostra ajuda a configurar uma instância de banco de
dados federado carregada com dados de amostra.

1
Faça login no MongoDB Atlas.
2
Selecione a opção Federação de Dados na navegação à esquerda.
3
Crie uma instância de banco de dados federado.
Clique no menu suspenso Criar novo banco de dados federado.
Selecione Explorar com dados de exemplo.

4
Clique em Começar.
5
Clique em Criar.
Essa instância de banco de dados federado inclui os seguintes conjuntos de dados de
amostra que podem ser usados para praticar a execução de consultas:

/airbnb/listingsAndReviews/{bedrooms int}/{review_scores.review_scores_rating int}/

Este caminho faz referência ao conjunto de dados do Airbnb, que contém os detalhes da
listagem de casas de férias e avaliações de clientes. Para saber mais sobre este conjunto
de dados, consulte
Exemplo de conjunto de dados de listagens do AirBnB.

Para esse caminho, a instância do banco de dados federado usa partições otimizadas para
consultas no campo rooms e nos campos review_scores.review_score_ratings.

/analítica/contas/{limit int}/

Este caminho faz referência ao conjunto de dados analíticos, que contém dados para um
aplicativo típico de serviços financeiros. Para saber mais sobre este conjunto de dados,
consulte
Exemplo de conjunto de dados analíticos.

Para esse caminho, a instância do banco de dados federado utiliza partições otimizadas
para consultas no campo de limite.

/analytics/customers/{data de nascimento}/

Esses dados fazem referência ao conjunto de dados analíticos, que contém coleções para
um aplicativo típico de serviços financeiros. Para saber mais sobre este conjunto de dados,
consulte
Exemplo de conjunto de dados analíticos.

Para esse caminho, a instância do banco de dados federado utiliza partições otimizadas
para consultas no campo de data de nascimento.

/analítica/transações/{account_id int}/

Este caminho faz referência ao conjunto de dados analíticos, que contém dados para uma
aplicação típica de serviços financeiros. Para saber mais sobre este conjunto de dados,
consulte
Exemplo de conjunto de dados analíticos.
Para esse caminho, a instância do banco de dados federado utiliza partições otimizadas
para consultas no campo account_id.

/mflix/movies/{tipo string}/{ano int}/

Este caminho faz referência ao conjunto de dados mflix, que contém dados sobre filmes e
salas de cinema. Para saber mais sobre este conjunto de dados, consulte
Exemplo de conjunto de dados Mflix.

Para esse caminho, a instância do banco de dados federado utiliza partições otimizadas
para consultas nos campos de tipo e ano.

/mflix/sessions.json

Este caminho faz referência ao conjunto de dados mflix, que contém dados sobre filmes e
salas de cinema. Para saber mais sobre este conjunto de dados, consulte
Exemplo de conjunto de dados Mflix.

Esse caminho não contém nenhum atributo de partição e, portanto, para consultas nos
dados da coleção, a Federação de Dados pesquisa todos os arquivos da coleção.

/mflix/theaters/{theaterId string}/{location.address.zipcode string}/

Este caminho faz referência ao conjunto de dados mflix, que contém dados sobre filmes e
salas de cinema. Para saber mais sobre este conjunto de dados, consulte
Exemplo de conjunto de dados Mflix.

Para esse caminho, a instância do banco de dados federado usa partições otimizadas para
consultas nos campos theaterId e location.address.zipcode.

/mflix/users.json

Este caminho faz referência à coleção mflix, que contém dados sobre filmes e salas de
cinema. Para saber mais sobre este conjunto de dados, consulte
Exemplo de conjunto de dados Mflix.

Esse caminho não contém nenhum atributo de partição e, portanto, para consultas nos
dados da coleção, a instância do banco de dados federado procura todos os arquivos da
coleção.

/nyc-yellow-cab-trips/{trip_start_isodate isodate}/{passenger_count int}/{fare_type string}/

Este caminho faz referência ao conjunto de dados nyc-yellow-cab-trips, que contém dados
sobre as viagens, incluindo data da viagem, tarifa e número de passageiros.

Para esse caminho, a instância do banco de dados federado usa partições otimizadas para
consultas nos campos trip_start_isodate, passageiro_count e fare_type.
Usar o assistente de consulta de dados entre clusters
O assistente Consultar dados entre clusters ajuda a configurar uma instância de banco de
dados federado que acessa dados de vários clusters Atlas.

1
Faça login no MongoDB Atlas.
2
Selecione a opção Federação de Dados na navegação à esquerda.
3
Crie uma instância de banco de dados federado.
Clique no menu suspenso Criar novo banco de dados federado.

Selecione Consultar dados em clusters.

4
Clique em Começar.
5
Digite um nome para sua instância de banco de dados federado no campo Nome da
Instância de Banco de Dados Federado e clique em Continuar.
O padrão é FederatedDatabaseInstance[n]. Depois que sua instância de banco de dados
federado for criada, você não poderá alterar seu nome.

6
Especifique os clusters Atlas para usar como fontes de dados.
Selecione um cluster Atlas para usar como fonte de dados no menu suspenso. O Atlas
exibe apenas clusters em seu projeto Atlas atual neste menu suspenso.

Expanda os bancos de dados e selecione as coleções que deseja incluir na instância do


banco de dados federado.

DICA
Para filtrar os bancos de dados e coleções, insira o texto no campo Coleções específicas. A
caixa de diálogo exibe apenas bancos de dados e coleções com nomes que correspondem
aos seus critérios de pesquisa.

Opcional. Expanda as configurações de Preferência de leitura de cluster para configurar os


campos a seguir.

Nome do campo
Descrição
Modo de preferência de leitura
Especifica o membro do conjunto de réplicas para o qual você deseja rotear as solicitações
de leitura. Você pode escolher uma das seguintes opções no menu suspenso:

primário - para rotear todas as solicitações de leitura para o conjunto de réplicas


primário

primárioPreferido - para rotear todas as solicitações de leitura do conjunto de réplicas


primário
e para
secundário
membros somente se o primário não estiver disponível

secundário - para rotear todas as solicitações de leitura para o


secundário
membros do conjunto de réplicas

secundárioPreferido - para rotear todas as solicitações de leitura para o


secundário
membros do conjunto de réplicas e o
primário
em clusters fragmentados somente se os membros secundários não estiverem disponíveis

mais próximo - para rotear todas as solicitações de leitura para um membro aleatório do
conjunto de réplicas elegível, independentemente de esse membro ser um
primário
ou
secundário

Se você adicionar um cluster Atlas como um armazenamento, o valor padrão será


secundário.

Se você não definir nada na configuração de armazenamento da instância de banco de


dados federado, o valor padrão será o mais próximo. Para saber mais, consulte
Modo de preferência de leitura.

Conjuntos de tags
Especifica a lista de tags ou documentos de especificação de tags que contêm pares de
nome e valor para o membro do conjunto de réplicas para o qual você deseja rotear
solicitações de leitura. Para saber mais, consulte
Leia Conjuntos de tags de preferência.
Segundos de Maxstalness
Especifica o atraso máximo de replicação, ou "inatividade", para leituras de secundários.
Para saber mais, consulte
Leia Preferência maxStalenessSeconds.
Clique em Incluir cluster e coleção do Atlas e repita essas etapas para todos os clusters do
Atlas que você deseja usar como fontes de dados.

Quando terminar de adicionar clusters, clique em Continuar.

7
Clique em Criar.
Próximos passos
Agora que sua instância de banco de dados federado foi implementada, prossiga para
Configurar a conexão para sua instância de banco de dados federado.
Configure a conexão para sua instância de
banco de dados federado
Você deve configurar o tipo de conexão para sua instância de banco de dados federado.
Você pode configurar uma conexão padrão ou um endpoint privado para se conectar à sua
instância de banco de dados federado.

Para este tutorial, configure uma conexão padrão. Para concluir esta parte do tutorial,
primeiro você deve implantar uma instância de banco de dados federado.

Procedimento
Para configurar o tipo de conexão:

1
Abra a caixa de diálogo Conectar.
Clique no botão Conectar para sua instância de banco de dados federado.

2
Escolha o tipo de conexão que deseja configurar.
Você pode escolher uma das seguintes opções:

Conexão padrão - para configurar este tipo de conexão, você deve fazer o seguinte:

Adicione seu endereço IP à lista de acesso IP

Crie um usuário de banco de dados para sua instância de banco de dados federado

Endpoint privado - para configurar este tipo de conexão, você deve fazer o seguinte:

Configurar um endpoint privado para uma instância de banco de dados federado

Crie um usuário de banco de dados para sua instância de banco de dados federado

OBSERVAÇÃO
Se você especificar 0.0.0.0 em seu projeto
Lista de acesso IP
, o Atlas aceitará todas as conexões, incluindo aquelas via PrivateLink.

Próximos passos
Agora que você configurou uma conexão padrão, conecte-se à sua instância de banco de
dados federado.
Adicione seu endereço IP à lista de acesso IP
Um endereço IP é um identificador numérico exclusivo para um dispositivo conectado a uma
rede. No Atlas, você pode criar uma lista de endereços IP confiáveis que podem se conectar
à sua instância de banco de dados federado e acessar seus dados. O Atlas só permite
conexões com uma instância de banco de dados federado a partir de endereços listados na
lista de acesso IP.

OBSERVAÇÃO
Se você já adicionou seu endereço IP na lista de acesso IP do seu projeto e criou um
usuário MongoDB, você pode prosseguir para Conectar usando o Shell MongoDB.

Acesso obrigatório
Para gerenciar entradas da Lista de Acesso IP, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao projeto.

Procedimento
Tempo estimado de conclusão: 2 minutos

1
Clique em Conectar para sua instância de banco de dados federado.
2
Clique em Adicionar seu endereço IP atual.
O menu se expande para mostrar o modal Adicionar um endereço IP de conexão.

3
Insira seu endereço IP e uma descrição opcional e clique em Adicionar endereço IP.
Configurar um endpoint privado para uma
instância de banco de dados federado
Nesta página

Acesso necessário
Pré-requisitos
Procedimento
MongoDB oferece suporte a endpoints privados da AWS usando o
AWS PrivateLink recurso para sua instância de banco de dados federado. Você pode
configurar os endpoints privados na CLI do Atlas, na interface do usuário do Atlas e na API.

Acesso obrigatório
Para configurar um ponto final privado, você deve ter acesso de Proprietário do Projeto ao
projeto. Os usuários com acesso de proprietário da organização devem adicionar-se como
proprietários do projeto ao projeto antes de configurar um ponto final privado.

Pré-requisitos
Tenha uma conta de usuário da AWS com uma política de usuário do IAM que conceda
permissões para criar, modificar, descrever e excluir endpoints. Para saber mais sobre como
controlar o uso de endpoints de interface, consulte o
Documentação da AWS.

Instale a AWS CLI.

Caso ainda não tenha feito isso, crie suas instâncias VPC e EC2 na AWS. Para saber mais,
consulte a Documentação da AWS para orientação.

OBSERVAÇÃO
Você não pode usar seu ID de endpoint privado do cluster Atlas para Atlas Data Federation.
O ID do endpoint do Atlas Data Federation deve ser diferente do ID do endpoint do cluster
Atlas, se você tiver um.

Procedimento

CLI do Atlas

API de administração do Atlas

IU do Atlas
Para criar um novo endpoint privado da Federação de Dados usando a CLI do Atlas,
execute o seguinte comando:

atlas dataFederation privateEndpoints create <endpointId> [options]


Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do
Atlas CLI para
atlas dataFederation privateEndpoints criado.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Crie um usuário de banco de dados para sua instância de banco de dados federado
Você deve criar um usuário de banco de dados para acessar sua implementação. Por
motivos de segurança, o Atlas exige que os clientes se autentiquem como usuários do
banco de dados MongoDB para acessar instâncias de bancos de dados federados.

OBSERVAÇÃO
Se você já criou um usuário MongoDB e adicionou seu endereço IP na lista de acesso IP do
seu projeto, você pode prosseguir para Conectar usando o Shell MongoDB.

Acesso necessário
Para criar um usuário de banco de dados, você deve ter acesso de Proprietário da
Organização ou Proprietário do Projeto ao projeto.

Procedimento
Tempo estimado de conclusão: 2 minutos

Para adicionar um usuário de banco de dados ao cluster:

1
Abra a caixa de diálogo Conectar.
Clique no botão Conectar para sua instância de banco de dados federado.

2
Na etapa Criar um usuário MongoDB da caixa de diálogo, insira um nome de usuário e uma
senha para o usuário do seu banco de dados.
Você usará essa combinação de nome de usuário e senha para acessar dados em seu
cluster.

OBSERVAÇÃO
Se a sua senha contiver caracteres especiais, você precisará codificá-los. Para mais
informações, veja
Caracteres especiais na senha da cadeia de conexão.

3
Clique em Criar usuário MongoDB.
DICA
Veja também:
Para obter informações sobre como configurar usuários de banco de dados adicionais em
seu cluster, consulte
Configurar usuários do banco de dados.
Configurar a autenticação X.509
autogerenciada
Nesta página

Pré-requisitos
Configurar um projeto para usar uma infraestrutura de chave pública
Adicionar um usuário de banco de dados usando autenticação X.509 autogerenciada
Os certificados X.509 autogerenciados fornecem aos usuários do banco de dados acesso
às implantações de banco de dados em seus projetos. Os usuários do banco de dados são
separados dos usuários do Atlas. Os usuários do banco de dados têm acesso aos bancos
de dados MongoDB, enquanto os usuários do Atlas têm acesso ao próprio aplicativo Atlas.

Pré-requisitos
Para usar certificados X.509 autogerenciados, você deve ter uma infraestrutura de chave
pública para integração com o MongoDB Atlas.

Configurar um projeto para usar uma infraestrutura de chave pública


1
Ative a autenticação X.509 autogerenciada.
Na seção Segurança do painel de navegação esquerdo do Atlas, clique em Avançado.

Alterne a autenticação X.509 autogerenciada para ATIVADA.

2
Forneça uma autoridade de certificação codificada em PEM.
Você pode fornecer uma Autoridade de Certificação (CA) ao:

Clicando em Upload e selecionando um arquivo .pem do seu sistema de arquivos.

Copiando o conteúdo de um arquivo .pem na área de texto fornecida.

Você pode concatenar diversas CAs no mesmo arquivo .pem ou na área de texto. Os
usuários podem autenticar com certificados gerados por qualquer uma das CAs fornecidas.

Quando você carrega uma CA, um alerta em nível de projeto é criado automaticamente
para enviar uma notificação 30 dias antes da expiração da CA, repetindo-se a cada 24
horas. Você pode visualizar e editar este alerta na página Configurações de alerta do Atlas.
Para obter mais informações sobre como configurar alertas, consulte Definir configurações
de alerta.

3
Clique em Salvar.
Para editar sua CA depois de carregada, clique no ícone Configurações de autenticação
X.509 autogerenciadas.

Adicionar um usuário de banco de dados usando autenticação X.509 autogerenciada


1
Abra a caixa de diálogo Adicionar novo usuário do banco de dados.
Na seção Segurança da navegação esquerda, clique em Acesso ao Banco de Dados. A
guia Usuários do banco de dados é exibida.

Clique em Adicionar novo usuário do banco de dados.

2
Selecione CERTIFICADO.
3
Insira as informações do usuário.
Campo
Descrição
Nome comum
O nome comum (CN) do usuário protegido pelo certificado TLS/SSL. Para mais
informações, veja
RFC 2253
.

EXEMPLO
Se o seu nome comum for "Jane Doe", sua organização for "MongoDB" e seu país for
"EUA", insira o seguinte no campo Nome comum:

CN=Jane Doe,O=MongoDB,C=EUA
Privilégios de usuário
Você pode atribuir funções de uma das seguintes maneiras:

Selecione Atlas admin, que fornece ao usuário readWriteAnyDatabase, bem como vários
privilégios administrativos.

Selecione Ler e gravar em qualquer banco de dados, que fornece ao usuário privilégios
para ler e gravar em qualquer banco de dados.

Selecione Ler apenas qualquer banco de dados que fornece ao usuário privilégios para ler
qualquer banco de dados.

Selecione Selecionar função personalizada para selecionar uma função personalizada


criada anteriormente no Atlas. Você pode criar funções personalizadas para usuários de
banco de dados nos casos em que o
funções de usuário de banco de dados integradas
não consegue descrever o conjunto desejado de privilégios. Para obter mais informações
sobre funções personalizadas, consulte Configurar funções de banco de dados
personalizadas.

Clique em Adicionar privilégios padrão. Ao clicar nesta opção, você pode selecionar funções
individuais e especificar o banco de dados ao qual as funções se aplicam. Opcionalmente,
para as funções read e readWrite, você também pode especificar uma coleção. Se você não
especificar uma coleção para read e readWrite, a função se aplicará a todas as coleções
que não sejam do sistema no banco de dados.

OBSERVAÇÃO
A tabela a seguir descreve os privilégios específicos do Atlas, o banco de dados ao qual ele
se aplica e o
ações privilegiadas
eles representam.

Privilégio específico do Atlas


Base de dados
Ações Privilegiadas
cópia de segurança
administrador
listabancos de dados

listaColeções

índices de lista

anexarOplogNote

getParameter

status do servidor

clusterMonitor
administrador
connPoolStats

getCmdLineOpts

getDefaultRWConcern

obterLog

getParameter

getShardMap

hostInfo

em andamento

listabancos de dados

listaSessões
listaShards

netstat

replSetGetConfig

replSetGetStatus

status do servidor

estado de fragmentação

principal

administrador de banco de dados


Usuário configurado
ignorarDocumentValidation

mudançaStream

colMod

colStats

compactar

convertToCapped

criarColeção

criarIndex

criarSearchIndex

dbHash

dbStats

dropCollection

dropDatabase

dropIndex

dropSearchIndex

habilitarProfiler
encontrar

matarCursores

listaColeções

índices de lista

listSearchIndexes

planCacheIndexFilter

planCacheRead

planCacheWrite

reIndexar

renomearCollectionSameDB

Detalhes de armazenamento

atualizarSearchIndex

validar

dbAdminAnyDatabase
Usuário configurado, exceto local e configuração
dbAdminAnyDatabase

ativarfragmentação
ativarfragmentação

ler
Usuário configurado
mudançaStream

colStats

dbHash

dbStats

encontrar

matarCursores

índices de lista
listaColeções

listSearchIndexes

ler escrever
Usuário configurado
mudançaStream

colStats

convertToCapped

criarColeção

criarSearchIndex

dbHash

dbStats

dropCollection

criarIndex

dropIndex

dropSearchIndex

encontrar

inserir

matarCursores

índices de lista

listaColeções

listSearchIndexes

remover

renomearCollectionSameDB

atualizar

killOpSession
Usuário configurado
em andamento

matar

matarAnySession

listaSessões

readWriteAnyDatabase
Usuário configurado, exceto local e configuração
readWriteAnyDatabase

mudançaStream

colStats

convertToCapped

criarColeção

criarSearchIndex

dhash

dbStats

dropCollection

dropSearchIndex

criarIndex

dropIndex

encontrar

inserir

matarCursores

índices de lista

listaColeções

listabancos de dados

listSearchIndexes
remover

renomearCollectionSameDB

atualizar

leiaAnyDatabase
Usuário configurado, exceto local e configuração
leiaAnyDatabase

mudançaStream

colStats

dbHash

dbStats

encontrar

matarCursores

índices de lista

listaColeções

listabancos de dados

listSearchIndexes

Para obter informações sobre os privilégios integrados do Atlas, consulte Funções


integradas.

Para obter mais informações sobre autorização, consulte Controle de acesso baseado em
função e Funções integradas no manual do MongoDB.

4
Clique em Adicionar usuário.
Conecte-se à sua instância de banco de dados
federado
Nesta página

Pré-requisitos
Conecte-se usando o shell do MongoDB
Próximos passos
Tempo estimado de conclusão: 15 minutos

Esta parte do tutorial orientará você na conexão com sua instância de banco de dados
federado usando o MongoDB Shell,
mangusto.

Pré-requisitos
Para concluir esta parte do tutorial, você precisará ter concluído o seguinte:

Parte 1: Implantar uma instância de banco de dados federado

Parte 2: Configurar a conexão para sua instância de banco de dados federado

Conecte-se usando o shell do MongoDB


A conexão com sua instância de banco de dados federado depende se você possui o shell
do MongoDB, mangusto, instalado:

Instalado

Não instalado
1
Abra a caixa de diálogo Conectar.
Clique no botão Conectar para sua instância de banco de dados federado.

2
Clique em Conectar-se ao Shell do MongoDB.
3
Clique em Tenho o MongoDB Shell instalado.
4
Selecione mongosh no menu suspenso.
5
Copie a string de conexão fornecida para sua área de transferência.
Esta é uma cadeia de conexão exclusiva específica para sua instância de banco de dados
federado. O Atlas substitui o nome de usuário da cadeia de conexão pelo nome de usuário
do usuário do banco de dados que você criou.

6
Cole e execute sua string de conexão em seu terminal.
7
Quando solicitado, digite a senha do usuário do banco de dados.
Você será solicitado a inserir a senha especificada ao criar seu usuário de banco de dados
no Atlas.

Agora você deve estar conectado à sua instância de banco de dados federado no MongoDB
Shell,
mangusto.

IMPORTANTE
Solução de problemas de conexão
Se você estiver tendo problemas para se conectar à sua instância de banco de dados
federado, verifique novamente se adicionou seu endereço IP ao seu Lista de acesso IP e
que você está especificando as credenciais corretas do usuário do banco de dados. Se
você esqueceu suas credenciais de usuário do banco de dados, você pode sempre
crie um novo usuário de banco de dados.

OBSERVAÇÃO
Apenas um usuário pode se autenticar em uma conexão com uma instância de banco de
dados federado por vez. Se um usuário autenticar e executar o comando db.auth(), a
Federação de Dados substituirá as permissões do usuário anterior pelas permissões do
novo usuário.

Ostatus da conexão. O comando mostra apenas o usuário recém-autenticado no campo de


saída authenticatedUsers.

Próximos passos
Agora que você está conectado à sua instância de banco de dados federado, prossiga para
Executar consultas em sua instância de banco de dados federado.
Execute consultas em sua instância de banco
de dados federado
Nesta página

Pré-requisitos
Consultas
Resumo
Tempo estimado de conclusão: 5 minutos

Você pode executar operações usando o MongoDB Query Language (MQL), que inclui a
maioria, mas não todos os comandos padrão do servidor. Para saber quais operações MQL
são suportadas, consulte a documentação de suporte MQL.

OBSERVAÇÃO
Os conjuntos de dados de amostra da Atlas Data Federation são somente leitura.

Pré-requisitos
Para concluir esta parte do tutorial, você precisará ter concluído:

Parte 1: Implantar uma instância de banco de dados federado

Parte 2: Configurar a conexão para sua instância de banco de dados federado

Parte 3: Conecte-se à sua instância de banco de dados federado

Você deve estar conectado à sua instância de banco de dados federado com o MongoDB
Shell antes de executar as consultas a seguir.

Consultas
Essas consultas de exemplo diferem dependendo se você usou o assistente Feed
Downstream Systems, Explore with Sample Data ou Query Data Across Clusters para
implementar sua instância de banco de dados federado. Clique na guia apropriada para ver
os exemplos correspondentes.

Rio abaixo

Dados de amostra

Entre clusters
Se ainda não tiver feito isso, faça o seguinte para executar as seguintes consultas com
êxito:

Carregue dados de amostra no cluster Atlas que você está usando como fonte de dados
para sua instância de banco de dados federado.
Configure o sistema downstream para extrair dados do cluster Atlas para o bucket AWS S3.

Airbnb

Análise

Mflix

Treinamento
Antes de executar as consultas, mude para o banco de dados sample_airbnb:

use sample_airbnb

Encontre o número de ofertas AirBnB com 3 quartos e uma alta pontuação de avaliação:

db.listingsAndReviews.aggregate([{$match: {"bedrooms" : 3,
"review_scores.review_scores_rating": {$gt: 79}} }, {$count: "numProperties"}])

OCULTAR SAÍDA

{
2
"numProperties" : 295
3
}

Encontre imóveis com 3 dormitórios e inclua apenas os campos nome e dormitórios nos
resultados. Classifique os documentos devolvidos por avaliação do cliente. Limite o número
de documentos devolvidos a 5:

db.listingsAndReviews.find({"bedrooms": 3}, {"name": 1, "bedrooms":


1}).sort({review_scores_rating: -1}).limit(5)

OCULTAR SAÍDA

[
2
{
3
_id: '20045679',
4
name: 'House Near Espinho/Santa Maria Feira',
5
bedrooms: Long("3")
6
},
7
{
8
_id: '19760228',
9
name: 'Apartment Salva - 3 bedroom in Poble Sec',
10
bedrooms: Long("3")
11
},
12
{
13
_id: '19768051',
14
name: 'Ultra Modern Pool House Maroubra',
15
bedrooms: Long("3")
16
},
17
{
18
_id: '19877706',
19
name: 'Big 3 Bedroom Garden Level Apartment Near Subway',
20
bedrooms: Long("3")
21
},
22
{
23
_id: '6291063',
24
name: 'Beautiful Tropical Oasis near beach in Kailua',
25
bedrooms: Long("3")
26
}
27
]

Resumo
Parabéns! Você acabou de configurar uma instância de banco de dados federado, criou um
banco de dados e coleções de dados armazenados em um bucket S3 e consultou os dados
usando comandos MQL.

Para obter mais informações sobre instâncias de bancos de dados federados, consulte
Atlas Data Federation.

OBSERVAÇÃO
Ao gerar coleções dinamicamente a partir de nomes de arquivos, o número de coleções não
é relatado com precisão na exibição Federação de Dados.
O que é a pesquisa do Atlas do MongoDB?
Atlas Search é uma pesquisa de texto completo incorporada no MongoDB Atlas que oferece
uma experiência contínua e escalonável para a construção de recursos de aplicativos
baseados em relevância. Construído no Apache Lucene, o Atlas Search elimina a
necessidade de executar um sistema de pesquisa separado junto com seu banco de dados.

Iniciar
Saiba mais sobre a pesquisa do Atlas

Imagem principal da página de destino do MongoDB Atlas Search


O QUE VOCÊ PODE FAZER
Pesquisa integrada no MongoDB Atlas
Crie pesquisas facilmente com base em seus dados com um mecanismo de pesquisa
integrado e totalmente gerenciado que sincroniza automaticamente com seu banco de
dados.

Comece com a Pesquisa Atlas

Use funcionalidade avançada de indexação

Entregue resultados rápidos e relevantes


1
Crie índices de pesquisa
Crie definições de índice para seus dados usando editores na UI do Atlas, com uma única
chamada de API Atlas Admin ou usando a CLI do Atlas.

Para saber mais, consulte Definição do índice de pesquisa do Atlas

2
Construir consultas de pesquisa
Crie e execute consultas do Atlas Search usando o estágio de pipeline de agregação
$search MongoDB.

Para saber mais, consulte Criar e executar consultas de pesquisa do Atlas.

3
Implementar melhores práticas
Consulte nossas diretrizes sobre dimensionamento e monitoramento de cargas de trabalho
do Atlas Search.

Para saber mais, consulte Ajustar o desempenho da pesquisa do Atlas.

Imagem de início do MongoDB Atlas Search


PRODUTOS E RECURSOS RELACIONADOS
Obtenha experiência prática com o Atlas Search
Siga tutoriais sobre recursos adicionais, aprenda como retornar mais informações com
explicação e navegue no MongoDB Developer Hub para obter mais exemplos do mundo
real.

Ícone de pesquisa do MongoDB Atlas para tutoriais


Crie índices e consultas que usam recursos como preenchimento automático, pesquisa
facetada, cláusulas compostas e muito mais.

Siga os tutoriais para casos de uso de pesquisa comuns

Ícone de pesquisa do MongoDB Atlas para a Universidade MongoDB


Saiba mais na unidade Atlas Search no curso "Introdução ao MongoDB" na MongoDB
University.

Assista e aprenda com o curso universitário MongoDB

Ícone de pesquisa do MongoDB Atlas para o Developer Hub


Explore tutoriais em vídeo e exemplos de aplicativos que usam o Atlas Search e outros
produtos MongoDB.

Procure exemplos do mundo real no MongoDB Developer Center


Visão geral da pesquisa do Atlas
Nesta página

Arquitetura de pesquisa do Atlas


Arquitetura de fonte armazenada
Arquitetura de nós de pesquisa
Índices de pesquisa do Atlas
Consultas de pesquisa do Atlas
Custo dos nós de pesquisa
Próximos passos
O Atlas Search do MongoDB permite indexação de texto refinada e consulta de dados em
seu cluster Atlas. Ele permite funcionalidade de pesquisa avançada para seus aplicativos
sem qualquer gerenciamento adicional ou sistema de pesquisa separado junto com seu
banco de dados. O Atlas Search oferece opções para vários tipos de analisadores de texto,
uma linguagem de consulta rica que usa estágios de pipeline de agregação do Atlas
Search, como $search e $searchMeta, em conjunto com outros estágios de pipeline de
agregação do MongoDB, e classificação de resultados baseada em pontuação.

O Atlas Search está disponível apenas em instâncias do Atlas que executam o MongoDB
4.2 ou versões superiores. Para determinados recursos, o Atlas Search pode exigir uma
versão específica do MongoDB. A tabela a seguir lista os recursos do Atlas Search que
exigem versões específicas do MongoDB.

Recurso de pesquisa do Atlas


Versão MongoDB para recurso
Facetas
4.4.11+, 5.0.4+, 6,0+, 7,0+
Facetas em clusters fragmentados
6,0+, 7,0+
Campos de origem armazenados
4.4.12+, 5.0.6+, 6,0+, 7,0+
Consultar análise
5,0+
$ pesquisa com $ pesquisa
6,0+, 7,0+
$unionWith com $search
6,0+, 7,0+
Você também pode usar o Atlas Search com implantações locais do Atlas criadas com a CLI
do Atlas. Para saber mais, consulte
Crie uma implantação local do Atlas.

A Pesquisa Atlas não é compatível com


série temporal
coleções.

Arquitetura de pesquisa do Atlas


O processo mongot do Atlas Search usa Apache Lucene e é executado junto com o
mongod em cada nó do cluster Atlas. O processo mongot:

Cria índices do Atlas Search com base nas regras da definição de índice da coleção.

Monitores mudar fluxos para o estado atual dos documentos e alterações de índice para as
coleções para as quais você definiu índices do Atlas Search.

Processa consultas do Atlas Search e retorna documentos correspondentes.

Arquitetura da Pesquisa Atlas


Arquitetura de fonte armazenada
Se você definir campos de origem armazenados em seu índice do Atlas Search, o processo
mongot armazenará os campos especificados e, para documentos correspondentes,
retornará os campos armazenados diretamente do mongot em vez de fazer uma pesquisa
completa do documento no banco de dados se você especificar a opção
returnStoredSource em seu consulta.

Arquitetura de origem armazenada do Atlas Search


Arquitetura de nós de pesquisa
OBSERVAÇÃO
Os nós de pesquisa do Atlas Search estão disponíveis como um recurso de visualização. O
recurso e a documentação correspondente podem mudar a qualquer momento durante o
período de visualização.

Para clusters Atlas dedicados (M10 ou superior) na AWS, você pode implantar nós de
pesquisa separados que executam apenas o processo mongot para isolamento de carga de
trabalho. A implementação de nós de procura separados fornece os seguintes benefícios:

Dimensiona o armazenamento independente do cluster MongoDB.

Dimensiona a carga de consulta independente do MongoDB.

Ao implementar nós de procura separados, os processos mongot são executados em nós


de procura separados que podem ser configurados de forma independente.

Arquitetura de nós de pesquisa separados do Atlas Search


É possível configurar nós de pesquisa para executar o processo mongot separadamente
dos nós de banco de dados que executam o processo mongod em seu cluster Atlas.
Também é possível configurar o número de nós de procura e a quantidade de recursos
provisionados para cada nó de procura.

Você pode configurar nós de pesquisa apenas para clusters AWS de região única. Não é
possível implantar nós de pesquisa separadamente para clusters sem servidor ou com
várias nuvens. Para saber mais sobre como implementar nós de pesquisa separadamente,
consulte Nós de pesquisa para isolamento de carga de trabalho. Para implementar os nós
de pesquisa da UI ou API, consulte Criar um Cluster.
Ao implantar nós de pesquisa separados, o Atlas atribui automaticamente um mongod para
cada mongot. O mongot se comunica com o mongod para escutar e sincronizar alterações
de índice para os índices que ele armazena.

Se você excluir todos os nós de pesquisa em seu cluster, haverá uma breve interrupção no
processamento dos resultados da consulta de pesquisa. Para saber mais, consulte
Modificar um cluster. Se você excluir seu cluster Atlas, o Atlas pausará e excluirá todas as
implantações associadas do Atlas Search (processos mongot).

Índices de pesquisa do Atlas


O índice Atlas Search é uma estrutura de dados que categoriza os dados em um formato
facilmente pesquisável. É um mapeamento entre os termos e os documentos que os
contêm. Os índices do Atlas Search permitem a recuperação mais rápida de documentos
usando determinados identificadores. Você deve configurar um índice do Atlas Search para
consultar dados em seu cluster Atlas usando o Atlas Search.

Você pode criar um índice do Atlas Search em um único campo ou em vários campos.
Recomendamos que você indexe os campos que usa regularmente para classificar ou filtrar
seus dados, a fim de recuperar rapidamente os documentos que contêm os dados
relevantes no momento da consulta.

Ao configurar um ou mais índices do Atlas Search, o Atlas ativa o processo mongot nos nós
do cluster. Cada processo mongot conversa com o mongod no mesmo nó. Para criar e
atualizar índices de pesquisa, o processo mongot executa varreduras de coleta no banco de
dados backend e abre fluxos de mudança para cada índice.

Você pode especificar Configure os campos para indexar usando os seguintes métodos:

Mapeamentos dinâmicos, que permitem que o Atlas Search indexe automaticamente todos
os campos dos tipos suportados em cada documento. Isso ocupa espaço em disco e pode
impactar negativamente o desempenho do cluster.

Mapeamentos estáticos, que permitem identificar seletivamente os campos a serem


indexados. Se os campos contiverem dados polimórficos, o Atlas Search indexará apenas
documentos que correspondam ao mapeamento na definição de índice e ignorará
documentos que contenham valores que não correspondam ao mapeamento especificado
na definição de índice para os campos.

Atlas Search realiza indexação invertida e armazena os campos indexados em disco. Um


índice invertido é um mapeamento entre termos e quais documentos contêm esses termos.
Os índices do Atlas Search contêm o termo, o _id e outros metadados relevantes sobre o
termo, como a posição do termo, no documento.

Embora os dados armazenados no Atlas Search não sejam uma cópia idêntica dos dados
da coleção no seu cluster Atlas, os índices do Atlas Search ainda ocupam algum espaço em
disco e memória. Se você ativar a opção de armazenamento para campos que contêm
valores de string ou se configurar os campos de origem armazenados em seu índice, o
Atlas Search armazenará uma cópia idêntica dos campos especificados no disco, o que
pode ocupar espaço em disco.

O Atlas Search fornece analisadores integrados para a criação de termos indexáveis que
corrigem diferenças de pontuação, letras maiúsculas, palavras irrelevantes e muito mais. Os
analisadores aplicam regras de análise e linguagem à consulta. Você também pode criar um
analisador personalizado usando filtros de caracteres, tokenizadores e filtros de token
integrados disponíveis. Para saber mais sobre os analisadores integrados e personalizados,
consulte Processar dados com analisadores.

Para campos de texto, o mongot executa as seguintes tarefas para analisar texto e criar
tokens indexáveis:

Tokenização, que é a divisão de palavras em uma string em tokens indexáveis

Normalização, como transformar o texto em minúsculas, dobrar diacríticos e remover


palavras irrelevantes

Stemming, como ignorar o plural e outras formas de palavras para indexar a palavra na
forma mais reduzida

Para saber mais sobre o suporte do Atlas Search para outros tipos de dados, consulte Tipos
de dados. O processo mongot armazena os campos indexados e o campo _id no disco por
índice para as coleções no cluster.

Se você alterar um índice existente, o Atlas Search reconstruirá o índice sem tempo de
inatividade. Isso permite que você continue usando o índice antigo para consultas novas e
existentes até que a reconstrução do índice seja concluída.

Se você fizer alterações na coleção para a qual definiu os índices do Atlas Search, os dados
mais recentes poderão não estar disponíveis imediatamente para consultas. No entanto, o
mongot monitora os fluxos de mudança, o que permite atualizar as cópias armazenadas dos
dados, e os índices do Atlas Search são eventualmente consistentes.

OBSERVAÇÃO
Para nós de pesquisa dedicados
Os índices do Atlas Search podem ficar temporariamente indisponíveis quando você
executa qualquer um dos seguintes procedimentos:

Fragmento
um aglomerado.

Adicionar fragmentos
para um cluster.

Fragmentar uma coleção


com índices do Atlas Search.
Se você
reestilhaçar
uma coleção com índices do Atlas Search, os índices do Atlas Search na coleção ficarão
indisponíveis quando a operação de reestilhaçamento for concluída. Você deverá
reconstruir seus índices do Atlas Search assim que a operação de nova fragmentação for
concluída.

Depois de configurar um índice do Atlas Search para uma coleção, você poderá executar
consultas nos campos indexados.

Consultas de pesquisa do Atlas


As consultas do Atlas Search assumem a forma de um
estágio de pipeline de agregação
. O Atlas Search fornece os estágios $search e $searchMeta, ambos os quais devem ser o
primeiro estágio no pipeline de consulta. Esses estágios podem ser usados em conjunto
com outros
estágios do pipeline de agregação
em seu pipeline de consulta. Para saber mais sobre esses estágios de pipeline, consulte
Retornar resultados ou metadados da pesquisa do Atlas.

O Atlas Search também fornece operadores de consulta e coletores que você pode usar
dentro dos estágios do pipeline de agregação $search e $searchMeta. Os operadores Atlas
Search permitem localizar e recuperar dados correspondentes da coleção em seu cluster
Atlas. O coletor retorna um documento que representa os resultados dos metadados da
pesquisa.

Você pode usar os operadores Atlas Search para consultar termos, frases, formas e pontos
geográficos, valores numéricos, documentos semelhantes, termos sinônimos e muito mais.
Você também pode pesquisar usando expressões regex e curinga. O operador composto
Atlas Search permite combinar vários operadores dentro do estágio $search para realizar
uma pesquisa complexa e filtrar dados com base no que deve, não deve ou deve estar
presente nos documentos retornados pelo Atlas Search. Você também pode usar o
operador composto para combinar ou filtrar documentos no próprio estágio $search.
Correndo
$correspondência
after $search tem menos desempenho do que executar $search com o operador
composto.

Para saber mais sobre a sintaxe, as opções e o uso dos operadores de pesquisa do Atlas,
consulte Usar operadores e coletores em consultas de pesquisa do Atlas.

Ao executar uma consulta, o Atlas Search usa a preferência de leitura configurada para
identificar o nó no qual executar a consulta. A consulta primeiro st vai para o processo
MongoDB, que é mongod para um cluster de conjunto de réplicas ou mongos para um
cluster fragmentado. Para clusters fragmentados, os dados do cluster são particionados
entre instâncias do mongod e cada mongot conhece os dados do mongod apenas no
mesmo nó. Portanto, você não pode executar consultas direcionadas a um fragmento
específico. mongos direciona as consultas para todos os fragmentos, fazendo com que
essas consultas sejam dispersas.

O processo MongoDB roteia a consulta para o mongot no mesmo nó. Atlas Search realiza a
pesquisa e pontuação e retorna os IDs dos documentos e outros metadados de pesquisa
para os resultados correspondentes ao mongod. O mongod então executa implicitamente
uma pesquisa completa do documento para os resultados correspondentes e os retorna ao
cliente.

OBSERVAÇÃO
Para nós de pesquisa dedicados
Quando você executa uma consulta, ela vai primeiro para o processo do MongoDB com
base na preferência de leitura configurada. O processo mongod roteia a consulta de
pesquisa por meio de um balanceador de carga no mesmo nó, que distribui as solicitações
por todos os processos mongot. O processo mongot do Atlas Search realiza a pesquisa e a
pontuação e retorna os resultados correspondentes ao mongod, que o mongod então
retorna ao cliente. Se você usar a opção simultânea $search em sua consulta, o Atlas
Search permitirá o paralelismo intra-consulta. Para saber mais, consulte Paralelizar a
execução de consultas entre segmentos.

O Atlas Search associa uma pontuação baseada em relevância a cada documento do


conjunto de resultados. A pontuação baseada na relevância permite que o Atlas Search
retorne documentos na ordem da pontuação mais alta para a mais baixa. O Atlas Search
pontua mais alto se o termo de consulta aparece com frequência em um documento e mais
baixo se o termo de consulta aparece em muitos documentos da coleção. Atlas Search
também oferece suporte à personalização da pontuação padrão baseada em relevância,
aumentando, diminuindo ou outras opções de modificação. Para saber mais sobre como
personalizar as pontuações resultantes, consulte Pontuar os documentos nos resultados.

Custo dos nós de pesquisa


O MongoDB oferece suporte a nós de pesquisa separados apenas em clusters dedicados
da AWS de região única (M10 ou superior). Os nós de pesquisa são implantados em
instâncias NVMe com uso intensivo de computação. Você deve implementar no mínimo dois
nós. Você será cobrado diariamente pelo uso de recursos por hora por nó. Para saber mais,
consulte Custos do nó de pesquisa.

Próximos passos
Para obter experiência prática na criação de índices do Atlas Search e na execução de
consultas do Atlas Search nos conjuntos de dados de amostra, experimente os tutoriais nas
páginas a seguir:

Comece com a Pesquisa Atlas

Tutoriais de pesquisa do Atlas

Prefere aprender assistindo?


Assista a uma visão geral do Atlas e do Atlas Search e comece a configurar o Atlas Search
para seus dados. O vídeo demonstra como carregar dados de amostra em seu cluster, criar
um índice do Atlas Search e executar uma consulta de amostra usando o Search Tester e o
Data Explorer.
Práticas recomendadas de pesquisa do Atlas
Use as práticas recomendadas a seguir para determinar se deve refatorar seus aplicativos
que usam MongoDB
$texto
e
$regex
ou migre seus aplicativos para Atlas Search $search. A tabela a seguir mostra como o
MongoDB
$regex
,
$texto
e Atlas Search $search atendem aos requisitos do seu aplicativo.

OBSERVAÇÃO
Você deve preceder um
$regex
consulta em um
registrar
em um cluster livre M0 ou cluster compartilhado M2/M5 com um sinal de intercalação (^).
Caso contrário, ocorre o seguinte erro:

MongoServerError: As consultas Oplog ns RegEx devem começar com ^

Se sua aplicação requer...


Usar...
Porque...
Datastore para respeitar preocupações de gravação
$regex
Para transações com leituras pesadas após gravações, recomendamos
$regex
. Para $search, leituras após gravações devem ser raras.
Cluster otimizado para desempenho de gravação
$ pesquisa
Os índices do Atlas Search não degradam o desempenho de gravação do cluster.
Pesquisando em grandes conjuntos de dados
$ pesquisa
O Atlas Search usa um índice invertido, que permite a recuperação rápida de documentos
em escalas muito grandes.
Consciência do idioma
$ pesquisa
O Atlas Search oferece suporte a muitos analisadores de idiomas que podem tokenizar
(criar termos pesquisáveis) idiomas, remover palavras irrelevantes e interpretar diacríticos
para melhorar a relevância da pesquisa. Para saber mais, consulte Como executar
consultas de pesquisa multilíngues no Atlas.
Pesquisa de texto sem distinção entre maiúsculas e minúsculas
$ pesquisa
$search oferece mais recursos do que
$regex.
Destacando o texto do resultado
$ pesquisa
O destaque do Atlas Search permite contextualizar os documentos nos resultados, o que é
essencial para consultas em linguagem natural.
Consultas de pesquisa com reconhecimento geoespacial
$regex
ou $pesquisar
MongoDB
$regex
e Atlas Search $search tratam os parâmetros geoespaciais de maneira diferente. No
MongoDB, as linhas entre as coordenadas são esféricas, o que é adequado para
coordenadas de longa distância, como voos aéreos. O Atlas Search usa Lucene, que
desenha uma linha reta entre as coordenadas e é adequado para distâncias curtas. Para
saber mais, consulte Como executar uma consulta JSON geográfica composta do Atlas
Search.
Implantação local ou local
$regex
ou
$texto
O Atlas Search não está disponível para implantação local ou local. A Pesquisa Atlas está
disponível apenas para dados no cluster Atlas.
Preenchimento automático de consultas de pesquisa
$ pesquisa
Para preenchimento automático de caracteres (nGrams), o Atlas Search inclui edgeGrams
para preenchimento automático da esquerda para a direita, nGrams para preenchimento
automático de idiomas que não possuem espaços em branco e rightEdgeGram para
preenchimento automático de idiomas que você escreve e lê da direita para a esquerda.

Para preenchimento automático de palavras (wordGrams), o Atlas Search inclui filtro de


token shingle, que oferece suporte ao preenchimento automático baseado em palavras
concatenando palavras adjacentes para criar um único token.

Para saber mais, consulte Como usar o preenchimento automático com o Atlas Search.

Correspondência difusa na entrada de texto


$ pesquisa
Os operadores de texto e preenchimento automático do Atlas Search suportam
correspondência difusa para filtrar o texto de entrada e endereçar palavras com erros
ortográficos (erros de digitação).
Filtragem baseada em múltiplas strings
$ pesquisa
O composto Atlas Search suporta filtragem com base em mais de 10 strings.
Pesquisa classificada por pontuação de relevância
$ pesquisa
A Pesquisa Atlas usa o
Algoritmo BM25
para determinar a pontuação de relevância da pesquisa de documentos. Ele suporta
configuração avançada por meio de expressões de reforço, como multiplicação e
decaimento gaussiano, bem como analisadores, operadores de pesquisa e sinônimos. Para
saber mais, consulte Como executar consultas compostas de pesquisa do Atlas com
campos ponderados.
Índices parciais
$regex
O Atlas Search não oferece suporte à indexação parcial.
Partida amigável
$ pesquisa
Os operadores curinga e preenchimento automático do Atlas Search suportam consultas de
correspondência parcial. Para saber mais, consulte Como executar consultas de pesquisa
do Atlas de correspondência parcial.
Índice composto único em matrizes
$ pesquisa
Os índices de termos do Atlas Search são cruzados em um único índice do Atlas Search e
eliminam a necessidade de índices compostos para filtragem em matrizes.
Pesquisa de sinônimos
$ pesquisa
O Atlas Search oferece suporte a sinônimos definidos em uma coleção separada, que você
pode referenciar em seu índice de pesquisa para uso. Para saber mais, consulte Como usar
sinônimos com o Atlas Search.
Facetação para contagens
$ pesquisa
O Atlas Search fornece contagens rápidas de documentos com base em critérios de texto e
também suporta pesquisa facetada de números e datas. Para saber mais, consulte Como
usar facetas com o Atlas Search.
Analisadores personalizados
$ pesquisa
O Atlas Search oferece suporte a analisadores personalizados para atender aos seus
requisitos específicos de indexação. Por exemplo, você pode indexar e pesquisar
endereços de e-mail e URLs HTTP ou HTTPS usando analisadores personalizados. Para
saber mais, consulte Como definir um analisador personalizado e executar uma consulta
insensível a diacríticos do Atlas Search.
Pesquisando frases ou múltiplas palavras
$ pesquisa
O operador de frase Atlas Search oferece suporte à pesquisa de uma sequência de termos.
Atualize consultas de $text com Atlas Search
para melhorar o desempenho de pesquisa
Nesta página

Vantagens do recurso Atlas Search


Exemplos
Saber mais
Se suas consultas dependem muito do
$texto
estágio de pipeline de agregação, você pode modificar essas consultas para usar $search
para melhorar a flexibilidade e o desempenho dessas consultas.

Vantagens do recurso Atlas Search


O estágio de agregação $search fornece os seguintes recursos que não estão disponíveis
através do
$texto
operador, disponível, mas com menor desempenho, ou disponível apenas com trabalho de
implementação significativo por parte do usuário:

Consciência do idioma

Pesquisa sem distinção entre maiúsculas e minúsculas e diacríticos

Destaque do texto do resultado

Consultas com reconhecimento geoespacial

Preenchimento automático de caracteres e palavras com diferentes estratégias de


tokenização

Correspondência difusa

Filtrando 10 ou mais strings com o operador composto

Pontuação e classificação de relevância personalizáveis

Índices compostos únicos em matrizes

Pesquisa de sinônimo

Bucketing para navegação facetada

Analisadores personalizados

Correspondência parcial
Consultas de frase

Exemplos
Crie os índices
Os exemplos nas seções a seguir usam consultas na coleção sample_mflix.movies nos
dados de amostra para ilustrar as melhorias na flexibilidade e no desempenho que o Atlas
Search oferece em relação a
$texto
. Você pode executar as consultas de ambos os exemplos usando os seguintes índices:

Índice de texto
Índice de pesquisa do Atlas
db.movies.createIndex(

db.movies.createIndex(
{
genres: "text",
plot: "text",
year: -1
}
)

{
"mappings": {
"dynamic": false,
"fields": {
"genres": {
"type": "string"
},
"plot": {
"type": "string"
},
"year": {
"type": "number"
}
}
}
}

Qualquer definição de índice indexará os campos de gênero e plotagem como texto e o


campo de ano como numérico. Para obter instruções sobre como criar índices, veja Criar
índice de texto. Para obter instruções sobre como criar índices do Atlas Search, consulte
Criar um índice do Atlas Search.

Melhore a flexibilidade de consultas de texto completo com Atlas Search


Você pode atualizar suas consultas baseadas em $search para maior flexibilidade e
conveniência. Neste exemplo, você consultará a coleção sample_mflix.movies nos dados de
amostra para recuperar entradas com a palavra 'poeta' no campo de plotagem, classificadas
em ordem crescente por ano.

As definições de índice apresentadas na seção anterior ilustram uma das melhorias de


flexibilidade do $search: para criar o índice $text em sample_mflix.movies, você deve
primeiro exclua qualquer índice de texto existente nos dados de amostra, já que o MongoDB
suporta apenas um único índice de texto por coleção.

Por outro lado, você pode criar vários índices do Atlas Search para uma única coleção,
permitindo que seus aplicativos aproveitem consultas de texto completo distintas em
paralelo.

As consultas a seguir retornam os cinco filmes mais recentes com 'poeta' no campo enredo,
mostrando seus títulos, gêneros, enredos e anos de lançamento.

Índice Regex
Índice de pesquisa do Atlas

db.movies.find(
{
$text: { $search: "poet" }
},
{
_id: 0,
title: 1,
genres: 1,
plot: 1,
year: 1
}
).limit(5)

db.movies.aggregate([
{
"$search": {
"text": {
"path": "plot",
"query": "poet"
}
}
},
{
"$limit": 5
},
{
"$project": {
"_id": 0,
"title": 1,
"genres": 1,
"plot": 1,
"year": 1,
}
}
])

Ambas as consultas retornam os seguintes resultados:

{
plot: `It's the story of the murder of a poet, a man, a great film director: Pier Paolo
Pasolini. The story begin with the arrest of "Pelosi", a young man then accused of the
murder of the poet. ...`,
genres: [ 'Crime', 'Drama' ],
title: 'Who Killed Pasolini?',
year: 1995
},
{
plot: 'Friendship and betrayal between two poets during the French Revolution.',
genres: [ 'Biography', 'Drama' ],
title: 'Pandaemonium',
year: 2000
},
{
year: 2003,
plot: 'Story of the relationship between the poets Ted Hughes and Sylvia Plath.',
genres: [ 'Biography', 'Drama', 'Romance' ],
title: 'Sylvia'
},
{
year: 2003,
plot: 'Story of the relationship between the poets Ted Hughes and Sylvia Plath.',
genres: [ 'Biography', 'Drama', 'Romance' ],
title: 'Sylvia'
},
{
plot: 'A love-struck Italian poet is stuck in Iraq at the onset of an American invasion.',
genres: [ 'Comedy', 'Drama', 'Romance' ],
title: 'The Tiger and the Snow',
year: 2005
}

Exclusivo do Atlas Search, você pode adicionar destaques aos resultados, exibindo
correspondências nos contextos em que foram encontradas. Para fazer isso, substitua a
consulta Atlas Search acima pelo seguinte:
db.movies.aggregate([
{
"$search": {
"text": {
"path": "plot",
"query": "poet"
},
"highlight": {
"path": "plot"
}
}
},
{
"$limit": 1
},
{
"$project": {
"_id": 0,
"title": 1,
"genres": 1,
"plot": 1,
"year": 1,
"highlights": { "$meta": "searchHighlights" }
}
}
])

Os resultados da consulta acima incluem o campo, que contém o contexto em que todas as
correspondências ocorreram e as pontuações de relevância para cada uma. Por exemplo, o
exemplo a seguir mostra o campo de destaque para o primeiro documento nos resultados
de $search.

{
plot: `It's the story of the murder of a poet, a man, a great film director: Pier Paolo
Pasolini. The story begin with the arrest of "Pelosi", a young man then accused of the
murder of the poet. ...`,
genres: [ 'Crime', 'Drama' ],
title: 'Who Killed Pasolini?',
year: 1995,
highlights: [
{
score: 1.0902210474014282,
path: 'plot',
texts: [
{ value: "It's the story of the murder of a ", type: 'text' },
{ value: 'poet', type: 'hit' },
{
value: ', a man, a great film director: Pier Paolo Pasolini. ',
type: 'text'
}
]
},
{
score: 1.0202842950820923,
path: 'plot',
texts: [
{
value: 'The story begin with the arrest of "Pelosi", a young man then accused of the
murder of the ',
type: 'text'
},
{ value: 'poet', type: 'hit' },
{ value: '. ...', type: 'text' }
]
}
]
}

Melhore o desempenho de consultas usando Atlas Search


Além de maior flexibilidade e conveniência, o Atlas Search oferece vantagens significativas
de desempenho em relação a soluções análogas. Considere uma consulta na coleção
sample_mflix.movies para recuperar filmes lançados entre 2000 e 2010, no gênero
comédia, com 'poeta' no campo enredo.

Execute as seguintes consultas:

Índice de texto
Índice de pesquisa do Atlas

db.movies.aggregate([
{
$match: {
year: {$gte: 2000, $lte: 2010},
$text: { $search: "poet" },
genres : { $eq: "Comedy" }
}
},
{ "$sort": { "year": 1 } },
{
"$limit": 3
},
{
"$project": {
"_id": 0,
"title": 1,
"genres": 1,
"plot": 1,
"year": 1
},

}
])

db.movies.aggregate([
{
"$search": {
"compound": {
"filter": [{
"range": {
"gte": 2000,
"lte": 2010,
"path": "year"
}
},
{
"text": {
"path": "plot",
"query": "poet"
}
},
{
"text": {
"path": "genres",
"query": "comedy"
}
}]
}
}
},
{ "$sort": { "year": 1 } },
{
"$limit": 3
},
{
"$project": {
"_id": 0,
"title": 1,
"genres": 1,
"plot": 1,
"year": 1
}
}
])

Ambas as consultas retornarão os três documentos a seguir.


{
year: 2000,
plot: 'A film poem inspired by the Peruvian poet Cèsar Vallejo. A story about our need for
love, our confusion, greatness and smallness and, most of all, our vulnerability. It is a story
with many...',
genres: [ 'Comedy', 'Drama' ],
title: 'Songs from the Second Floor'
},
{
plot: 'When his mother, who has sheltered him his entire 40 years, dies, Elling, a
sensitive, would-be poet, is sent to live in a state institution. There he meets Kjell Bjarne, a
gentle giant and...',
genres: [ 'Comedy', 'Drama' ],
title: 'Elling',
year: 2001
},
{
plot: 'Heart-broken after several affairs, a woman finds herself torn between a Poet and a
TV Host.',
genres: [ 'Comedy', 'Romance', 'Drama' ],
title: 'Easy',
year: 2003
}

Embora é adequado para pesquisas simples e restritas como esta, à medida que o tamanho
dos conjuntos de dados e a amplitude das suas consultas aumentam, as vantagens de
desempenho do $search melhorarão significativamente a capacidade de resposta das suas
aplicações. Recomendamos que você use uma consulta Atlas Search por meio do estágio
de pipeline de agregação $search.

Saber mais
Para saber mais sobre as consultas do Atlas Search, consulte Criar e executar consultas do
Atlas Search.

A MongoDB University oferece um curso gratuito sobre otimização do desempenho do


MongoDB. Para saber mais, consulte
Monitoramento e insights.
Use Atlas Search para consultas Regex de
texto completo
Nesta página

Evite correspondência Regex ineficiente


Exemplo
Saber mais
Se suas consultas dependem de correspondência ineficiente de regex, as consultas do
Atlas Search que usam o estágio de pipeline de agregação $search podem melhorar
significativamente o desempenho das consultas de texto e oferecer mais opções para
personalizar os parâmetros de consulta.

Evite correspondência Regex ineficiente


Se você executa frequentemente consultas regex que não diferenciam maiúsculas de
minúsculas (utilizando a opção i), recomendamos consultas do Atlas Search que usam o
estágio de pipeline de agregação $search. Alternativamente, você pode criar um
índice que não diferencia maiúsculas de minúsculas para apoiar suas dúvidas. Você
também pode especificar um agrupamento em um índice para definir regras específicas do
idioma para comparação de strings, como regras para letras maiúsculas e acentos. No
entanto, agrupamento pode causar alguma perda de funcionalidade em comparação com as
consultas do Atlas Search. Embora um índice que não diferencia maiúsculas de minúsculas
melhore o desempenho para consultas que não diferenciam maiúsculas de minúsculas, as
consultas do Atlas Search melhoram significativamente o desempenho de consultas de
texto e oferecem mais opções para personalizar parâmetros de consulta.

Exemplo
Considere uma coleção de funcionários com os seguintes documentos. Esta coleção não
possui índices além do índice _id padrão:

//coleção de funcionários
{
"_id": 1,
"primeiro_nome": "Hannah",
"sobrenome": "Simmons",
"depto": "Engenharia"
},
{
"_id": 2,
"primeiro_nome": "Michael",
"sobrenome": "Hughes",
"depto": "Segurança"
},
{
"_id": 3,
"primeiro_nome": "Wendy",
"sobrenome": "Crawford",
"depto": "Recursos Humanos"
},
{
"_id": 4,
"primeiro_nome": "MICHAEL",
"sobrenome": "FLORES",
"depto": "Vendas"
}

Se seu aplicativo consulta frequentemente o campo first_name, talvez você queira executar
consultas regex que não diferenciam maiúsculas de minúsculas para encontrar nomes
correspondentes com mais facilidade. A regex que não diferencia maiúsculas de minúsculas
também corresponde a diferentes formatos de dados, como no exemplo acima, onde você
tem first_names de "Michael" e "MICHAEL". No entanto, recomendamos consultas do Atlas
Search que usam o estágio de pipeline de agregação $search.

Se um usuário pesquisar a string "michael", o aplicativo poderá executar a seguinte


consulta:

db.employees.find( { primeiro_nome: { $regex: /michael/i } } )

Como esta consulta especifica o


$regex
opção i, não faz distinção entre maiúsculas e minúsculas. A consulta retorna os seguintes
documentos:

{ "_id": 2, "first_name": "Michael", "last_name": "Hughes", "dept": "Segurança" }


{ "_id": 4, "primeiro_nome": "MICHAEL", "sobrenome": "FLORES", "dept": "Vendas" }
Embora esta consulta retorne os documentos esperados, as consultas regex que não
diferenciam maiúsculas de minúsculas e sem suporte de índice não apresentam muito
desempenho.

Para melhorar o desempenho, crie um índice Atlas Search. Embora você possa criar um
índice que não diferencia maiúsculas de minúsculas
no campo first_name, as consultas do Atlas Search melhoram significativamente o
desempenho das consultas de texto e oferecem mais opções para personalizar os
parâmetros de consulta.

Índice Regex
Índice de pesquisa do Atlas
db.employees.createIndex(
{primeiro_nome: 1},
{ agrupamento: { local: 'en', força: 2 } }
)

{
"mapeamentos": {
"dinâmico": verdadeiro
}
}

Agrupamento
pode causar alguma perda de funcionalidade. Quando o campo de força do documento de
agrupamento de um índice é 1 ou 2, o índice não faz distinção entre maiúsculas e
minúsculas. Para uma descrição detalhada do documento de agrupamento e dos diferentes
valores de resistência, consulte
Documento de agrupamento.

Para que o aplicativo use o índice que não diferencia maiúsculas de minúsculas, você
também deve especificar o mesmo documento de ordenação do índice na consulta regex.
Embora você possa remover o operador $regex do anterior
encontrar()
e usar o índice recém-criado, recomendamos que você use uma consulta Atlas Search que
use o estágio de pipeline de agregação $search.

Consulta Regex
Consulta de pesquisa do Atlas

db.employees.find( { first_name: "michael" } ).collation( { locale: 'en', strength: 2 } )

db.employees.aggregate([
{
$search: {
"index": "default",
"text": {
"path": "first_name",
"query": "michael"
}
}
}
])

IMPORTANTE
Não use o operador ao usar um índice que não diferencia maiúsculas de minúsculas para
sua consulta. A implementação $regex não reconhece agrupamento e não pode utilizar
índices que não diferenciam maiúsculas de minúsculas. Em vez disso, recomendamos
consultas do Atlas Search que usam o estágio de pipeline de agregação $search.

Saber mais
Para saber mais sobre as consultas do Atlas Search, consulte Criar e executar consultas do
Atlas Search.

Para saber mais sobre índices que não diferenciam maiúsculas de minúsculas com
exemplos ilustrativos, consulte
Índices que não diferenciam maiúsculas de minúsculas.

Para saber mais sobre consultas regex no MongoDB, consulte


$regex.

A MongoDB University oferece um curso gratuito sobre otimização do desempenho do


MongoDB. Para saber mais, consulte
Monitoramento e insights.
Configurar e resolver alertas
Nesta página

Condições de alerta
Configurar alertas
Resolver alertas
Fluxo de trabalho de alertas
O Atlas emite alertas para o banco de dados e as condições do servidor configuradas nas
configurações de alerta. Quando uma condição aciona um alerta, o Atlas exibe um símbolo
de aviso no cluster e envia notificações de alerta. Suas configurações de alerta determinam
os métodos de notificação. O Atlas continua enviando notificações em intervalos regulares
até que a condição seja resolvida ou você exclua ou desative o alerta.

Condições de alerta
Ao configurar alertas, você especifica condições e limites de alerta. Revise as possíveis
condições de alerta para as quais você pode acionar alertas relacionados aos seus clusters.

OBSERVAÇÃO
Clusters gratuitos M0 e clusters compartilhados M2/M5 acionam apenas alertas
relacionados às métricas suportadas por esses clusters. Consulte Limitações do Atlas M0
(cluster gratuito), M2 e M5 para obter documentação completa sobre alertas M0/M2/M5 e
limitações métricas.

Configurar alertas
Para definir quais condições acionam alertas e como os usuários são notificados, defina as
configurações de alerta. Você pode configurar alertas no nível da organização ou do projeto.
O Atlas fornece alertas padrão no nível do projeto. Você pode clonar alertas existentes e
configurar alertas da janela de manutenção.

Resolver alertas
Quando uma condição aciona um alerta, o Atlas exibe um símbolo de aviso no cluster e
envia notificações de alerta. Resolva esses alertas e trabalhe para evitar que condições de
alerta ocorram no futuro. Para saber como corrigir o problema imediato, implementar uma
solução de longo prazo e monitorar seu progresso, consulte Resolver alertas.

Fluxo de trabalho de alertas


Quando uma condição de alerta é atendida, o seguinte ciclo de vida do alerta começa:

1
A condição de alerta foi atendida.
Para alertas informativos, como o alerta do usuário ingressou na organização, o Atlas envia
notificações assim que a condição for atendida. Esses alertas não aparecem na UI do Atlas.
O fluxo de trabalho de alertas informativos termina aqui.

Caso contrário, o Atlas recupera métricas em intervalos regulares com base na


granularidade. Quando as métricas recuperadas indicam que uma condição de alerta é
atendida, o Atlas rastreia a condição de alerta até que ela termine ou até que passe o tempo
especificado no campo enviar se a condição durar pelo menos.

OBSERVAÇÃO
Se a condição de alerta terminar entre os períodos de amostragem, o Atlas não rastreia a
condição de alerta nem envia notificações.

2
A condição de alerta permanece após o período de tempo especificado no campo enviar se
a condição durar pelo menos.
Atlas envia notificações. Os alertas aparecem na guia Todos os Alertas (alertas da
organização) ou na guia Alertas Abertos (alertas do projeto).

3
O alerta permanece ativo até ser resolvido ou até você desativá-lo ou excluí-lo.
As seguintes etapas podem ocorrer:

Você reconhece o alerta. O Atlas não envia mais notificações até que o período de
confirmação termine, você resolva a condição de alerta ou cancele a confirmação do alerta.
Se uma condição de alerta terminar durante um período de confirmação, o Atlas enviará
uma notificação.

Você cancela a confirmação de um alerta que reconheceu anteriormente. Depois de


cancelar o reconhecimento de um alerta ativo, o Atlas retoma o envio de notificações em
intervalos regulares até que a condição seja resolvida ou você exclua, desative ou
reconheça o alerta.

Você desativa o alerta. Atlas cancela alertas ativos relacionados à configuração. Uma
configuração de alerta desativada permanece visível, mas esmaecida, e você pode
reativá-la posteriormente.

Você habilita um alerta que desabilitou anteriormente.

Você exclui o alerta. Atlas cancela alertas ativos relacionados à configuração. Uma
configuração de alerta excluída não permanece visível.

A condição de alerta é resolvida. O alerta aparece na guia Todos os Alertas (alertas da


organização) ou na guia Alertas Fechados (alertas do projeto).
Revise as condições de alerta
Nesta página

Alertas de anfitrião
Alertas de segmentação de consulta
Alertas de backup na nuvem
Alertas de conjunto de réplicas
Alertas de cluster fragmentado
Alertas de serviços de aplicativos
Alertas sem servidor
Alertas de usuário
Alertas de Projeto
Alertas de cobrança
Alertas da Federação
Alertas de criptografia em repouso
Alertas da janela de manutenção
Esta página descreve as condições para as quais você pode acionar alertas. Você
especifica condições e limites ao configurar alertas. Para saber mais, consulte Fluxo de
trabalho de alertas.

OBSERVAÇÃO
Clusters gratuitos M0 e clusters compartilhados M2/M5 acionam apenas alertas
relacionados às métricas suportadas por esses clusters. Consulte Limitações do Atlas M0
(cluster gratuito), M2 e M5 para obter documentação completa sobre alertas M0/M2/M5 e
limitações métricas.

Alertas de anfitrião
As condições nesta seção se aplicam se você selecionar Host como destino do alerta ao
configurar o alerta. Você pode aplicar a condição a todos os hosts ou a um tipo específico
de host, como primário ou
servidores de configuração.

IMPORTANTE
Durante a migração ao vivo, o Atlas desativa alertas de host.

Orientador
Host tem sugestões de índice
Gerado se o Performance Advisor tiver sugestões de índice para o host.

Se a proporção de direcionamento de consulta para um host for alta por um período de 10


minutos, o Performance Advisor verificará o host em busca de consultas ineficientes e
possíveis índices para melhorar o desempenho. Se o Performance Advisor determinar que
o host se beneficia de um ou mais índices, esse alerta será acionado e direcionará você
para criar os índices sugeridos.
Esse alerta está disponível apenas para clusters M10+ e é ativado por padrão para clusters
M10+ que têm o Performance Advisor ativado. Este alerta não é acionado para clusters em
que o Performance Advisor está desativado.

Afirmações
As seguintes condições de alerta medem a taxa de declarações para um processo
MongoDB, conforme coletado do comando serverStatus do MongoDB
afirma
documento. Você pode visualizar declarações por meio do monitoramento de cluster.

Afirma: Msg é
Gerado se a taxa de declarações de mensagens atender ao limite especificado. Afirmações
de mensagens são erros internos do servidor. Os rastreamentos de pilha são registrados
para eles.

Afirma: Regular é
Gerado se a taxa de afirmações regulares atender ao limite especificado.

Afirma: o usuário é
Gerado se a taxa de erros gerada pelos usuários atender ao limite especificado.

Afirma: Aviso é
Gerado se a taxa de avisos atender ao limite especificado.

Pesquisa Atlas
As condições de alerta a seguir medem a quantidade de CPU e memória usada pelos
processos do Atlas Search. Você pode visualizar as métricas do Atlas Search por meio do
monitoramento de cluster.

Pesquisa Atlas: o atraso na replicação do índice é


Gerado se o número aproximado de milissegundos que o Atlas Search está atrasado na
replicação de alterações do
registrar
de
mondeus
está acima ou abaixo do limite.

Pesquisa Atlas: o tamanho do índice no disco é


Gerado se o tamanho total de todos os índices do Atlas Search no disco em bytes estiver
acima ou abaixo do limite.

Pesquisa Atlas: o número máximo de documentos Lucene é


Gerado se o limite superior do número de documentos Lucene usados para armazenar
índices do Atlas Search para um determinado conjunto de réplicas ou fragmento estiver
acima do limite.

Pesquisa Atlas: o número de consultas de erro é


Gerado se o número de consultas para as quais o Atlas Search não consegue retornar uma
resposta estiver acima ou abaixo do limite.

Pesquisa Atlas: o número de campos de índice é


Gerado se o número total de campos exclusivos presentes no índice do Atlas Search estiver
acima ou abaixo do limite.

Pesquisa Atlas: o número de consultas bem-sucedidas é


Gerado se o número de consultas para as quais o Atlas Search retornou uma resposta com
êxito estiver acima ou abaixo do limite.

Pesquisa Atlas: o número total de consultas é


Gerado se o número de consultas enviadas ao Atlas Search estiver acima ou abaixo do
limite.

Atlas Search Opcounter: Excluir é


Gerado se o número total de documentos ou campos (especificados na definição do índice)
removidos por segundo estiver acima ou abaixo do limite.

Opcounter de pesquisa do Atlas: Getmore é


Gerado se o número total de comandos getmore executados em todas as consultas do
Atlas Search por segundo estiver acima ou abaixo do limite.

Atlas Search Opcounter: Inserir é


Gerado se o número total de documentos ou campos (especificados na definição do índice)
que o Atlas Search indexa por segundo estiver acima ou abaixo do limite.

Opcounter de pesquisa do Atlas: a atualização é


Gerado se o número total de documentos ou campos (especificados na definição do índice)
que o Atlas Search atualiza por segundo estiver acima ou abaixo do limite.

Espaço em disco insuficiente para suportar a reconstrução de índices de pesquisa


Gerado se a implantação do seu banco de dados ficar sem espaço livre em disco suficiente
para suportar seus índices do Atlas Search.

Memória de pesquisa: Residente é


Gerado se o total de bytes de memória residente ocupados pelo processo Atlas Search
estiver acima ou abaixo do limite.

Memória de pesquisa: compartilhada é


Gerado se o total de bytes de memória compartilhada ocupados pelo processo Atlas Search
estiver acima ou abaixo do limite.

Memória de pesquisa: Virtual é


Gerado se o total de bytes de memória virtual ocupados pelo processo Atlas Search estiver
acima ou abaixo do limite.

Processo de pesquisa: CPU (Kernel)% é


Aumentado se a porcentagem de tempo que a CPU gastou em manutençãoas chamadas
do sistema operacional para o processo Atlas Search estão acima do limite.

Processo de pesquisa: CPU (usuário)% é


Gerado se a porcentagem de tempo que a CPU gastou atendendo ao processo Atlas
Search estiver acima do limite.

Processo de pesquisa: o espaço em disco usado é


Gerado se o total de bytes de espaço em disco usado pelo processo Atlas Search estiver
acima do limite.

Processo de pesquisa: ficou sem memória


Gerado se o processo de pesquisa (mongot) ficar sem memória. Se o processo de pesquisa
ficar sem memória, a indexação e as consultas falharão.

Tempo Médio de Execução


As condições de alerta a seguir medem o tempo médio de execução de leituras, gravações
ou comandos para um processo MongoDB, conforme coletado do comando serverStatus do
MongoDB
opLatências
documento. Você pode visualizar declarações por meio do monitoramento de cluster.

Tempo Médio de Execução: Comandos é


O tempo médio de execução para operações de comando atende ao limite especificado.

Tempo médio de execução: as leituras são


O tempo médio de execução para operações de leitura atende ao limite especificado.

Tempo médio de execução: as gravações são


O tempo médio de execução para operações de gravação atende ao limite especificado.

Contador de operações
As seguintes condições de alerta medem a taxa de operações de banco de dados em um
processo MongoDB desde o último início do processo, conforme coletado do comando
serverStatus do MongoDB
contadores de operação
documento. Você pode visualizar opcounters por meio do monitoramento de cluster.

Contador de opções: Cmd é


Gerado se a taxa de comandos executados atender ao limite especificado.

Opcounter: Excluir é
Gerado se a taxa de exclusões atender ao limite especificado.

Opcounter: Getmores é
Gerado se a taxa de operações getmore para recuperar o próximo lote de cursores atender
ao limite especificado.
DICA
Veja também:
Para saber mais, consulte
Lotes de cursores
no manual do MongoDB.

Opcounter: Inserir é
Gerado se a taxa de inserções atender ao limite especificado.

Opcounter: A consulta é
Gerado se a taxa de consultas atender ao limite especificado.

Opcounter: A atualização é
Gerado se a taxa de atualizações atender ao limite especificado.

Contador de opções - Repl


As seguintes condições de alerta medem a taxa de operações de banco de dados no
MongoDB
secundários
, conforme coletado do comando serverStatus do MongoDB
contadores de operaçõesRepl
documento. Você pode visualizar essas métricas no gráfico Opcounters - Repl, acessado
por meio do monitoramento de cluster.

Opcounter: Repl Cmd é


Gerado se a taxa de comandos replicados atender ao limite especificado.

Opcounter: Repl Delete é


Gerado se a taxa de exclusões replicadas atender ao limite especificado.

Opcounter: Repl Insert é


Gerado se a taxa de inserções replicadas atender ao limite especificado.

Opcounter: Atualização de Repl é


Gerado se a taxa de atualizações replicadas atender ao limite especificado.

Digitalização e pedido de operações


Você pode definir alertas para as operações de varredura e pedido de um processo
MongoDB.

Operações: Digitalizar e solicitar é


Taxa média por segundo acima do limite especificado de consultas que retornam resultados
classificados que não podem executar a operação de classificação usando um índice.

OBSERVAÇÃO
Como é medido
O MongoDB relata o Oplog de replicação usando o documento
métricas.operação.scanAndOrder que o
status do servidor
comando retorna.

Clusters gratuitos do Atlas


O tamanho lógico é
Gerado se o tamanho total dos dados e índices estiver fora do limite especificado.

Aplicável apenas para clusters gratuitos do Atlas

Memória
As seguintes condições de alerta medem a memória para um processo MongoDB, conforme
coletado do comando serverStatus do MongoDB
mem
documento. Você pode visualizar essas métricas nos gráficos Memória Atlas e Memória
Virtual Não Mapeada, acessados por meio do monitoramento de cluster.

Memória: Calculado é
Gerado se o tamanho da memória virtual que não é contabilizado pelo mapeamento de
memória atender ao limite especificado. Se esse número for muito alto (vários gigabytes),
indica que memória excessiva está sendo usada fora do mapeamento de memória.

DICA
Veja também:
Para saber como usar essa métrica, visualize o gráfico Memória Virtual Não Mapeada e
clique no ícone i do gráfico.

Memória: Residente é
Gerado se o tamanho da memória residente atender ao limite especificado. É normal, com o
passar do tempo, em um servidor de banco de dados dedicado, que o tamanho da memória
residente se aproxime da quantidade de RAM física na caixa.

Memória: Virtual é
Gerado se o tamanho da memória virtual para o
mondeus
processo atende ao limite especificado. Você pode usar esse alerta para sinalizar memória
excessiva fora do mapeamento de memória.

DICA
Veja também:
Para saber mais, clique no ícone i do gráfico de memória.

Memória do sistema: Disponível é


Gerado se a quantidade de memória disponível do sistema cair abaixo do limite
especificado.

Memória do sistema: o máximo disponível é


Gerado se a quantidade máxima de memória disponível do sistema cair abaixo do limite
especificado.
Memória do sistema: o máximo usado é
Gerado se o valor máximo de uso de memória do sistema atender ao limite especificado.

Memória do sistema: usada é


Gerado se a memória total do sistema usada menos buffers, cache e memória livre atender
ao limite especificado.

Conexões
A condição de alerta a seguir mede conexões com um processo MongoDB, conforme coleta
editado a partir do comando serverStatus do MongoDB
conexões
documento. Você pode visualizar essa métrica no gráfico Atlas Connections, acessado por
meio do monitoramento de cluster.

Conexões é
Gerado se o número de conexões ativas com o host atender à média especificada.

A % de conexões do limite configurado é


Gerado se o número de conexões abertas com o host exceder a porcentagem especificada.

Filas
As condições de alerta a seguir medem as operações que aguardam bloqueios, conforme
coletadas do comando serverStatus do MongoDB
bloqueio global
documento. Você pode visualizar essas métricas no gráfico Atlas Queues, acessado por
meio do monitoramento de cluster.

Filas: Leitores é
Gerado se o número de operações aguardando um
bloqueio de leitura
atende à média especificada.

Filas: Total é
Gerado se o número de operações aguardando um
trancar
de qualquer tipo atenda à média especificada.

Filas: Escritores é
Gerado se o número de operações aguardando um
bloqueio de gravação
atende à média especificada.

Falhas de página
A seguinte condição de alerta mede a taxa de falhas de página para um processo
MongoDB, conforme coletado do comando serverStatus do MongoDB
extra_info.page_faults
campo.
Falhas de página são
Gerado se a taxa de falhas de página (independentemente de uma exceção ser lançada ou
não) atender ao limite especificado. Você pode visualizar essa métrica no gráfico Atlas Page
Faults, acessado por meio do monitoramento de cluster.

Cursores
As seguintes condições de alerta medem o número de
cursores
para um processo MongoDB, conforme coletado do comando serverStatus do MongoDB
métricas.cursor
documento. Você pode visualizar essas métricas no gráfico Atlas Cursors, acessado por
meio do monitoramento de cluster.

Cursores: Abrir é
Gerado se o número de cursores que o servidor mantém para clientes atender à média
especificada.

Cursores: O tempo limite é


Gerado se o número de cursores expirados que o servidor está mantendo para clientes
atender à média especificada.

Rede
As condições de alerta a seguir medem o rendimento do processo MongoDB, conforme
coletado do comando serverStatus do MongoDB
rede
documento. Você pode visualizar essas métricas no gráfico de rede de um host, acessado
por meio do monitoramento de cluster.

Rede: Bytes In é
Gerado se o número de bytes enviados ao MongoDB atender ao limite especificado.

Rede: Bytes Out é


Gerado se o número de bytes enviados do MongoDB atender ao limite especificado.

Rede: Num Requests é


Gerado se o número de solicitações enviadas ao MongoDB atender à média especificada.

Oplog de replicação
As seguintes condições de alerta se aplicam ao processo MongoDB
registrar
. Você pode visualizar essas métricas nos gráficos a seguir, acessados por meio do
monitoramento de cluster:

Oplog GB/hora

Espaço de replicação
Atraso na replicação

Janela Oplog de Replicação

As seguintes condições de alerta se aplicam ao oplog:

Dados de Oplog por hora são


Gerado quando a quantidade de dados por hora gravados no oplog de um primário atende
ao limite especificado.

O espaço de replicação é
Gerado quando a diferença entre a janela de oplog do membro da origem de sincronização
e o tempo de atraso de replicação no secundário atende ao limite especificado.

O atraso de replicação é
Gerado se a quantidade aproximada de tempo que o
secundário
está atrás do primário atende ao limite especificado. Atlas calcula o atraso de replicação
usando a abordagem descrita em
Verifique o atraso de replicação
no manual do MongoDB.

A janela Oplog de replicação é


Gerado se a quantidade aproximada de tempo disponível na replicação do primário
registrar
atende ao limite especificado.

Armazenamento de banco de dados


As seguintes condições de alerta se aplicam ao armazenamento do banco de dados,
conforme coletado para um processo do MongoDB pelo MongoDB
dbStats
comando. Para obter detalhes sobre como o Atlas lida com o alcance dos limites de
armazenamento do banco de dados, consulte a página de perguntas frequentes. Estas
condições são baseadas na soma total de todos os bancos de dados no processo
MongoDB:

OBSERVAÇÃO
O Atlas recupera métricas do banco de dados a cada 20 minutos por padrão, mas ajusta a
frequência quando necessário para reduzir o impacto no desempenho do banco de dados.

O tamanho dos dados do banco de dados é


Aumentado se o tamanho aproximado de todos os documentos (e seus preenchimentos)
atender ao limite especificado.

Armazenamento de banco de dados é


Gerado se o armazenamento alocado atender ao limite especificado. Essa condição de
alerta pode ser visualizada no gráfico de armazenamento de banco de dados de um host,
acessado por meio do monitoramento de cluster.
Mecanismo de armazenamento WiredTiger
As seguintes condições de alerta se aplicam ao processo MongoDB
WiredTiger
mecanismo de armazenamento, conforme coletado do comando serverStatus do
MongoDB
wiredTiger.cache
e
wiredTiger.concurrentTransactions
documentos.

Você pode visualizar essas métricas nos gráficos a seguir, acessados por meio do
monitoramento de cluster:

Atividade de cache

Uso de cache

Ingressos disponíveis

A seguir estão as condições de alerta que se aplicam ao WiredTiger:

Cache: os bytes lidos no cache são


Gerado quando o número de bytes lidos no cache do WiredTiger atende ao limite
especificado.

Cache: os bytes gravados no cache são


Gerado quando o número de bytes gravados no cache do WiredTiger atende ao limite
especificado.

Cache: bytes sujos são


Gerado quando o número de bytes sujos no cache do WiredTiger atende ao limite
especificado.

Cache: os bytes usados são


Gerado quando o número de bytes usados no cache do WiredTiger atende ao limite
especificado.

Ingressos disponíveis: Reads é


Gerado se o número de tickets de leitura disponíveis para o mecanismo de armazenamento
WiredTiger atender ao limite especificado.

Ingressos disponíveis: Writes is


Gerado se o número de tickets de gravação disponíveis para o mecanismo de
armazenamento WiredTiger atender ao limite especificado.

Alertas de sistema e disco


As seguintes condições de alerta medem o uso em clusters de servidores Atlas:
OBSERVAÇÃO
Atualmente, o Atlas usa uma única partição para arquivos de dados, índices e diários.
Embora os alertas façam referência a partições individuais, eles apontam para a mesma
métrica.

A profundidade da fila de disco na partição de dados é


Gerado se o comprimento médio da fila de solicitações emitidas para a partição de dados
usada pelo MongoDB exceder o limite especificado.

IOPS de leitura de disco na partição de dados é


Gerado se o número médio de operações de leitura de disco por segundo exceder o limite
especificado.

A latência de leitura do disco na partição de dados é


Gerado se a quantidade de latência nas operações de leitura de disco exceder o limite
especificado.

A % de espaço em disco usado na partição de dados é


A porcentagem de espaço em disco usado em qualquer partição que contém os dados da
coleção MongoDB.

Para encontrar possíveis soluções para este alerta, consulte Resoluções de alerta.

IOPS de gravação de disco na partição de dados é


Gerado se o número médio de operações de gravação em disco por segundo exceder o
limite especificado.

A latência de gravação do disco na partição de dados é


Gerado se a quantidade de latência nas operações de gravação em disco exceder o limite
especificado.

A profundidade máxima da fila de disco na partição de dados é


Gerado se o comprimento médio máximo da fila de solicitações emitidas para a partição de
dados usada pelo MongoDB exceder o limite especificado.

O máximo de IOPS de leitura de disco na partição de dados é


Gerado se o número médio máximo de operações de leitura de disco por segundo exceder
o limite especificado.

A latência máxima de leitura do disco na partição de dados é


Gerado se a quantidade máxima de latência nas operações de leitura de disco exceder o
limite especificado.

A porcentagem máxima de espaço em disco usado na partição de dados é


Gerado se a porcentagem máxima de espaço em disco usado em qualquer partição que
contém os dados da coleção MongoDB exceder o limite especificado.
O máximo de IOPS de gravação de disco na partição de dados é
Gerado se o número médio máximo de operações de gravação em disco por segundo
exceder o limite especificado.

A latência máxima de gravação do disco na partição de dados é


Gerado se a quantidade máxima de latência nas operações de gravação em disco exceder
o limite especificado.

A entrada máxima da rede do sistema é


Gerado se o número máximo de bytes enviados ao MongoDB atender ao limite
especificado.

Saída máxima de rede do sistema é


Gerado se o número máximo de bytes enviados do MongoDB atender ao limite
especificado.

Sistema: CPU (roubo)% é


Aplicável quando o saldo de crédito do cluster EC2 se esgota.

A porcentagem pela qual o uso da CPU excede a taxa de acumulação de créditos de CPU
da linha de base garantida. Os créditos de CPU são unidades de utilização de CPU que
você acumula. Os créditos acumulam-se a uma taxa constante para proporcionar um nível
de desempenho garantido. Esses créditos podem ser usados para desempenho adicional
da CPU. Quando o saldo de crédito se esgota, apenas a linha de base garantida de
desempenho da CPU é fornecida e a quantidade de excesso é mostrada como
porcentagem de roubo.

OBSERVAÇÃO
O Atlas aciona esse alerta apenas para clusters AWS EC2 que suportam
Desempenho expansível
. Atualmente, estes são tipos de cluster M10 e M20.

Sistema: CPU (Usuário)% é


O uso de CPU dos processos no nó, normalizado pelo número de CPUs. Esse valor é
dimensionado para um intervalo de 0 a 100%.

Sistema: CPU máxima (roubo)% é


Gerado se a porcentagem máxima pela qual o uso da CPU excede a taxa de acumulação
de créditos de CPU da linha de base garantida exceder o limite especificado.

Sistema: CPU máxima (usuário)% é


Gerado se o uso máximo de CPU dos processos no nó, normalizado pelo número de CPUs,
exceder o limite especificado.

A entrada da rede do sistema é


Gerado se a taxa média de bytes físicos recebidos por segundo pela interface de rede eth0
atingir o limite especificado.
A saída da rede do sistema é
Gerado se a taxa média de bytes físicos transmitidos por segundo pela interface de rede
eth0 atingir o limite especificado.

Reinicia
A reinicialização na última hora é
Gerado se o número de vezes que um host for reiniciado na hora anterior exceder o limite
especificado.

Host desativado
O host está inativo
Gerado se o Atlas não conseguir alcançar um host por vários minutos.

IMPORTANTE
Você só deve configurar esse alerta se depender de leituras secundárias. Para obter mais
informações sobre leituras secundárias, consulte Consulta usando tags de conjunto de
réplicas predefinidas e
Leia Preferência.

Este alerta geralmente é acionado por uma das seguintes condições:

O cluster sofreu uma falha e está sendo reparado automaticamente.

Não foi possível acessar o cluster devido a um problema de rede.

O MongoDB Atlas verifica se o tempo de inatividade não ocorreu devido às suas ações,
como
compilações de índice contínuo
. Se o MongoDB Atlas confirmar Se o tempo de inatividade não foi intencional, o MongoDB
Atlas tenta substituir o nó afetado. Se ocorrerem falhas, os clusters Atlas manterão a
disponibilidade dos nós para leituras e gravações, desde que a maioria dos nós esteja em
execução. Para saber mais, consulte Como o MongoDB Atlas oferece alta disponibilidade?.

Trocar
As seguintes condições de alerta se aplicam ao uso do espaço de swap:

Uso de troca: Grátis é


Gerado se a quantidade de espaço de troca disponível cair abaixo do limite especificado.

Uso de troca: Max Free é


Gerado se a quantidade máxima de espaço de troca disponível cair abaixo do limite
especificado.

Uso de troca: o máximo usado é


Gerado se a quantidade total máxima de espaço de troca em uso atingir o limite
especificado.

Uso de troca: usado é


Gerado se a quantidade total de espaço de troca em uso atingir o limite especificado.

Condições de host inaplicáveis


As seguintes condições de host não se aplicam ao Atlas. O Atlas não gerará alertas para as
seguintes condições:

Acessos que não estão na memória: o total é

A média de fluxo de fundo é

Árvore B: os acessos são

Árvore B: os acertos são

Árvore B: falta é

Árvore B: razão de falta é

Cursores: o tamanho dos cursores do cliente é

% de bloqueio efetivo é

Registrar commits no diário no Write Lock é

O registro no diário MB é

Registrar no diário arquivos de dados de gravação MB é

Memória: mapeada é

Exceções de falha de página lançadas: o total é

Alertas de segmentação de consulta


Os alertas a seguir se aplicam aos índices das suas coleções. Qualquer alerta pode indicar
um índice ausente ou ineficiente.

DICA
Veja também:
Para saber mais sobre indexação para melhorar o desempenho, consulte
Estratégias de indexação.

Segmentação de consulta: digitalizada/retornada


Gerado se a proporção de chaves de índice digitalizadas para documentos retornados
atender ou exceder o limite especificado.

Direcionamento de consulta: objetos verificados/devolvidos


Gerado se a proporção de documentos digitalizados em relação aos documentos devolvidos
atender ou exceder o limite especificado.
OBSERVAÇÃO
O
mudar fluxos
cursores que o processo Atlas Search (mongot) usa para manter os índices do Atlas
Search atualizados podem contribuir para a proporção de direcionamento da consulta e
acionar
alertas de segmentação de consulta
se a proporção for alta.

Alertas de backup na nuvem


Os alertas a seguir se aplicam aos snapshots do Cloud Backup.

Falha na restauração do backup


Gerado quando uma restauração falha.

Restauração de backup bem-sucedida


Gerado quando uma restauração é bem-sucedida.

Falha no instantâneo substituto


Gerado quando um instantâneo de fallback falha.

Instantâneo substituto obtido


Gerado quando um backup regular falha, mas o Atlas conseguiu tirar um instantâneo de
fallback.

DICA
Veja também:
Instantâneos substitutos.

Falha na solicitação de download do instantâneo


Gerado quando uma solicitação de download falha.

A programação de snapshots ficou para trás


Gerado quando um instantâneo não foi obtido durante o período configurado.

Instantâneo obtido com sucesso


Gerado quando um instantâneo foi obtido com sucesso.

Alertas de conjunto de réplicas


As seguintes condições de alerta se aplicam a conjuntos de réplicas:

O número de eleições na última hora é > X


Gerado quando o número de eleições que ocorreram na última hora excede o valor de X
especificado pelo usuário. O valor de X é definido quando você cria o alerta. Este alerta
pode indicar que a replicação do cluster não está num estado íntegro, como evidenciado por
eleições constantes.
Conjunto de réplicas elegeu um novo primário
Gerado quando um conjunto de réplicas elege um novo primário.

O conjunto de réplicas não tem primário


Gerado quando um conjunto de réplicas não possui um primário. Especificamente, quando
nenhum dos membros de um conjunto de réplicas tem o status PRIMARY, o alerta é
acionado. Por exemplo, esta condição pode surgir quando um conjunto tem um número par
de membros votantes, resultando em empate.

Se o Atlas coletar dados durante um


eleição
, esse alerta poderá enviar um falso positivo. Para evitar esses falsos positivos, defina a
configuração do alerta após o intervalo de espera (na seção Enviar para da configuração).

Para encontrar possíveis soluções para este alerta, consulte Resoluções de alerta.

Alertas de cluster fragmentado


A seguinte condição de alerta se aplica a clusters fragmentados:

Cluster está faltando um mongos ativo


Aumentado se o Atlas não conseguir alcançar nenhum
mongos
para o aglomerado.

Alertas de serviços de aplicativos


As seguintes condições de alerta se aplicam a
Serviços de aplicativos Atlas.

Um limite geral de taxa de solicitação foi atingido


Gerado quando o número de solicitações simultâneas excede o limite. Este alerta indica que
um aplicativo pode estar fazendo um número inesperadamente alto de solicitações.

Falha no login de autenticação é


Gerado se o número de solicitações de login de cliente com falha por segundo atingir o
limite especificado.

O tempo de computação dos endpoints é


Gerado se os endpoints HTTPS
tempo de computação
por segundo atende ao limite especificado.

Os bytes de saída do endpoint são


Gerado se os endpoints HTTPS
saída de dados
bytes por segundo atende ao limite especificado.

Solicitações com falha - Endpoints é


Gerado se o número de solicitações de endpoints HTTPS que falham por segundo atender
ao limite especificado.

Solicitações com falha - GraphQL é


Gerado se o número de solicitações GraphQL que falham por segundo atender ao limite
especificado.

Solicitações com falha - No geral é


Gerado se o número total de solicitações com falha por segundo atender ao limite
especificado.

Solicitações com falha - SDK (funções) é


Gerado se o número de solicitações de função SDK que falham por si só cond atende ao
limite especificado.

Solicitações com falha - a sincronização é


Aumentado se o número de falhas
Sincronização de dispositivos Atlas
solicitações por segundo atende ao limite especificado.

Solicitações com falha - os gatilhos são


Gerado se o número de solicitações de acionadores que falham por segundo atender ao
limite especificado.

O tempo de computação do GraphQL é


Gerado se o GraphQL
tempo de computação
por segundo atende ao limite especificado.

Bytes de saída GraphQL são


Gerado se o GraphQL
saída de dados
bytes por segundo atende ao limite especificado.

A duração da solicitação GraphQL P95 é


Gerado se o 95º percentil de duração em milissegundos para solicitações GraphQL atender
ao limite especificado.

A duração da solicitação de endpoint HTTP P95 é


Gerado se o 95º percentil de duração em milissegundos para solicitações de endpoint
HTTPS atender ao limite especificado.

A duração da solicitação MQL P95 é


Gerado se o 95º percentil de duração em milissegundos para solicitações MQL atender ao
limite especificado.

O tempo geral de computação é


Aumentado se o total
tempo de computação
por segundo atende ao limite especificado.

Os bytes de saída gerais são


Aumentado se o total
saída de dados
bytes por segundo atende ao limite especificado.

O tempo de computação das funções do SDK é


Gerado se o SDK funcionar
tempo de computação
por segundo atende ao limite especificado.

Os bytes de saída das funções do SDK são


Gerado se o SDK funcionar
saída de dados
bytes por segundo atende ao limite especificado.

A duração da solicitação de funções do SDK P95 é


Gerado se o 95º percentil de duração em milissegundos para solicitações de função SDK
atender ao limite especificado.

O tempo de computação do SDK MQL é


Gerado se o SDK MQL
tempo de computação
por segundo atende ao limite especificado.

Os bytes de saída do SDK MQL são


Gerado se o SDK MQL
saída de dados
bytes por segundo atende ao limite especificado.

Sessão encerrada - a sincronização é


Gerado se o número de sessões encerradas por segundo durante
Sincronização de dispositivos Atlas
atende ao limite especificado.

O tempo de inicialização do cliente de sincronização é


Aumentado se o percentil 95 do tempo de bootstrap para o
Sincronização de dispositivos Atlas
cliente atende ao limite especificado.

Os uploads do cliente de sincronização que falharam são


Gerado se o número de uploads que falharam por segundo no
Sincronização de dispositivos Atlas
cliente atende ao limite especificado.

Sincronizar uploads de clientes inválidos


Gerado se o número de uploads inválidos por segundo no
Sincronização de dispositivos Atlas
cliente atende ao limite especificado.

A soma do atraso do Oplog atual de sincronização é


Gerado se a quantidade aproximada de tempo que o
Sincronização de dispositivos Atlas
está por trás do MongoDB
registrar
atende ao limite especificado.

Sincronizar bytes de saída é


Elevado se o
Sincronização de dispositivos Atlas

saída de dados
bytes por segundo atende ao limite especificado.

Sincronização de número de documentos não sincronizáveis % é


Aumentado é o número de serviços de aplicativos
documentos não sincronizáveis
atende ao limite especificado.

O tempo de cálculo dos gatilhos é


Gerado se os gatilhos
tempo de computação
por segundo atingiu o limite especificado.

A soma do atraso do Oplog atual é


Gerado se o tempo aproximado que os Serviços de Aplicativo acionam estiver atrasado em
relação ao MongoDB
registrar
atende ao limite especificado.

Os bytes de saída dos gatilhos são


Gerado se os gatilhos
saída de dados
bytes por segundo atende ao limite especificado.

A duração da solicitação dos gatilhos P95 é


Gerado se o 95º percentil de duração em milissegundos para gatilhos atender ao limite
especificado.

Alertas sem servidor


As seguintes condições de alerta se aplicam a instâncias sem servidor:

Conexões é
A % de conexões do limite configurado é

O tamanho dos dados do banco de dados é

Rede: Bytes In é

Rede: Bytes Out é

Rede: Num Requests é

Contador de opções: Cmd é

Opcounter: Excluir é

Opcounter: Getmores é

Opcounter: Inserir é

Opcounter: A consulta é

Opcounter: A atualização é

Métrica sem servidor fora do limite


Gerado se alguma das seguintes condições se aplicar:

O número de conexões abertas com o host excede 80% do total de conexões abertas
permitidas.

O tamanho aproximado de todos os documentos (e seus preenchimentos) e o índice excede


0,75 terabytes.

As unidades de processamento de leitura (RPUs) por segundo excedem 250 K por 30


minutos ou mais e são alertadas novamente a cada 12 horas.

As unidades de processamento de leitura (RPUs) por segundo excedem 1 milhão por 5


minutos ou mais e são alertadas novamente a cada 2 horas.

O total de unidades de leitura é


Gerado se o total de unidades de processamento de leitura (RPUs) exceder o limite
especificado.

O total de unidades de gravação é


Gerado se o total de unidades de processamento de gravação (WPUs) exceder o limite
especificado.

Alertas de usuário
As seguintes condições de alerta se aplicam aos usuários do Atlas.
Os usuários da organização não têm a autenticação multifator ativada
Gerado quando um ou mais usuários em uma organização não têm a autenticação
multifator habilitada.

O usuário teve sua função alterada


Gerado quando as funções de projeto ou organização de um usuário do Atlas são alteradas.

O usuário ingressou na organização


Gerado quando um novo usuário ingressa na organização Atlas.

O usuário entrou no projeto


Gerado quando um novo usuário ingressa no projeto Atlas.

O usuário saiu da organização


Gerado quando um usuário sai da organização Atlas.

O usuário saiu do projeto


Gerado quando um usuário sai do projeto Atlas.

Alertas de Projeto
O seguinte um condições de alerta se aplicam ao seu projeto Atlas.

Usuários aguardando aprovação para ingressar no projeto


Gerado se houver usuários que pediram para ingressar no projeto. Um usuário pode pedir
para ingressar em um projeto ao se registrar pela primeira vez no Atlas.

Os usuários não têm a autenticação multifator ativada


Gerado se o projeto ou organização tiver usuários que não configuraram a autenticação
multifator.

Alertas de cobrança
As seguintes condições de alerta se aplicam ao faturamento do Atlas. Você pode configurar
alertas de cobrança na UI do Atlas no nível da organização ou no nível do projeto.

Para configurar alertas no nível da organização, selecione sua organização e navegue até
Alertas.

Para configurar alertas no nível do projeto, selecione seu projeto. Navegue até as
configurações do seu projeto e depois até Alertas ou clique no ícone no canto superior
direito da visualização do cluster do seu projeto.

OBSERVAÇÃO
Todos os valores faturados estão em dólares americanos.

O valor faturado ($) ontem está acima do limite


Gerado se o último valor diário faturado da organização ou do projeto exceder o limite
configurado. A Atlas não contabiliza nenhum crédito aplicado no dia anterior no cálculo do
valor faturado.
Esta condição se aplica tanto a organizações quanto a projetos.

O cartão de crédito está prestes a expirar


Gerado se o cartão de crédito registrado estiver prestes a expirar. O alerta é acionado no
início do mês em que o cartão expira. O Atlas ativa esse alerta quando um cartão de crédito
é adicionado pela primeira vez.

Esta condição se aplica tanto a organizações quanto a projetos.

A fatura atual ($) de qualquer projeto único está acima do limite


Gerado se o total mensal de qualquer projeto da organização exceder o limite configurado
para todos os projetos. Quando a fatura pendente atual for fechada, esse alerta será
redefinido.

Esta condição de alerta aplica-se apenas a organizações.

A fatura atual ($) da organização está acima do limite


Gerado se o total mensal da organização exceder o limite configurado. Quando a fatura
pendente atual for fechada, esse alerta será redefinido.

Esta condição de alerta aplica-se apenas a organizações.

Alertas da Federação
O certificado IdP da organização está prestes a expirar
Gerado quando um certificado IdP associado a uma organização para a qual você tem a
função de Proprietário da Organização expira em 14 dias. O Atlas envia esse alerta
diariamente até que você o reconheça.

OBSERVAÇÃO
O Atlas cria esse alerta automaticamente quando você mapeia uma organização para um
provedor de IdP. Se você remover o mapeamento, o Atlas excluirá todas as instâncias
desse alerta.

Alertas de criptografia em repouso


As condições de alerta a seguir se aplicam a projetos que usam criptografia em repouso
usando o gerenciamento de chaves do cliente.

O tempo decorrido da chave de criptografia da AWS desde a última rotação é superior a (n)
dias
Gerado se a chave mestra do cliente (CMK) da AWS usada pelo projeto Atlas estiver ativa
por mais do que o número de dias configurado (90 por padrão). Você pode modificar o limite
de alerta na guia Configurações de alerta da visualização Alertas.

O Atlas alterna automaticamente as chaves mestras de criptografia do MongoDB a cada 90


dias, mas não alterna a CMK do projeto. Para evitar o recebimento prematuro desse alerta,
você pode modificar o período de alerta padrão. Se você configurar o padrão de 90 dias
alerta
for maior que a rotação da CMK do AWS KMS, o Atlas não criará o alerta porque a AWS
teria alternado automaticamente sua CMK.

Esse alerta é redefinido automaticamente se você alternar a CMK do projeto. Para obter
documentação sobre como alternar a CMK do seu projeto, consulte Alternar sua chave
mestra do cliente da AWS.

O tempo decorrido da chave de criptografia do Azure desde a última rotação está acima de
(n) dias
Gerado se o identificador de chave do Azure Key Vault usado pelo projeto Atlas estiver ativo
por mais do que o número de dias configurado (90 por padrão). Você pode modificar o limite
de alerta na guia Configurações de alerta da visualização Alertas.

O Atlas alterna automaticamente as chaves mestras de criptografia do MongoDB a cada 90


dias, mas não alterna o identificador de chave do projeto.

Este alerta é redefinido automaticamente se você alternar o identificador chave do projeto.


Para obter documentação sobre como girar o Identificador de Chave do seu projeto,
consulte Girar seu Identificador de Chave do Azure.

O tempo decorrido da chave de criptografia do GCP desde a última rotação é superior a (n)
dias
Gerado se o ID do recurso da versão da chave do GCP usado pelo projeto Atlas estiver
ativo por mais do que o número de dias configurado (90 por padrão). Você pode modificar o
limite de alerta na guia Configurações de alerta da visualização Alertas.

O Atlas alterna automaticamente as chaves mestras de criptografia do MongoDB a cada 90


dias, mas não alterna o ID do recurso de versão da chave do projeto.

Este alerta é redefinido automaticamente se você alternar o ID do recurso da versão chave


do projeto.

DICA
Veja também:
Para saber como alternar o ID do recurso da versão da chave do seu projeto, consulte
Alternar o ID do recurso da versão da chave do GCP.

Alertas da janela de manutenção


As seguintes condições de alerta se aplicam a projetos com janelas de manutenção
configuradas.

OBSERVAÇÃO
Você só poderá configurar alertas de janela de manutenção se um projeto tiver uma janela
de manutenção ativa.

A manutenção está agendada


Levantado 72 horas antes da manutenção programada para um projeto.
Manutenção não é mais necessária
Gerado se programado A manutenção não é mais necessária para um projeto.

Manutenção iniciada
Gerado quando a manutenção de um projeto é iniciada.
Definir configurações de alerta
Nesta página

Acesso obrigatório
Configurações de alerta padrão
Opções de notificação
Configurar um alerta
Configurar um alerta de janela de manutenção
Ver configurações de alerta
Desabilitar um alerta
Habilitar um alerta
Excluir um alerta
Para cada organização e projeto, você pode selecionar quais condições acionam alertas e
como os usuários são notificados.

OBSERVAÇÃO
Clusters gratuitos M0 e clusters compartilhados M2/M5 acionam apenas alertas
relacionados às métricas suportadas por esses clusters. Consulte Limitações do Atlas M0
(cluster gratuito), M2 e M5 para obter documentação completa sobre alertas M0/M2/M5 e
limitações métricas.

Acesso obrigatório
Para gerenciar todos os alertas da organização, você deve ter a função de Proprietário da
organização.

A função Administrador de faturamento da organização concede autorização limitada para


gerenciar alertas de faturamento.

Para gerenciar alertas de projeto, você deve ter acesso de proprietário do projeto ao projeto.
Os usuários com acesso de Proprietário da Organização devem adicionar-se ao projeto
como Proprietário do Projeto.

Configurações de alerta padrão


O Atlas não fornece alertas padrão para organizações.

Opções de notificação
Ao configurar um alerta, você seleciona como as notificações serão enviadas. Você pode
selecionar vários métodos de notificação, como email, mensagem de texto ou ferramentas
de colaboração em equipe.

Atlas oferece suporte ao Slack como método de notificação. No menu Configurações da


organização, clique em Adicionar ao Slack nas Configurações do Slack e faça login no seu
espaço de trabalho preferido do Slack.

O Atlas oferece suporte à configuração de todos os seguintes métodos de notificação


durante a configuração do alerta:
Organização Atlas

Usuário Atlas

E-mail

SMS

PagerDuty

Cão de dados

VictorOps

Opsgênio

Equipes da Microsoft

Configurar um alerta
Ao criar um novo alerta, você pode clonar um alerta existente. Você também pode atualizar
uma configuração de alerta existente.

1
Navegue até a página Alertas da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Alertas na barra lateral.

2
Escolha se deseja criar uma nova configuração de alerta, clonar uma configuração de alerta
existente ou atualizar uma configuração de alerta existente.
Para criar um novo alerta:

Clique em Adicionar alerta.

Para clonar uma configuração de alerta existente:

Clique na guia Configurações de alerta.

Localize a configuração de alerta que você deseja clonar.

Clique em Clonar na linha dessa configuração de alerta.

Para atualizar uma configuração de alerta existente:

Clique na guia Configurações de alerta.


Localize a configuração de alerta que você deseja atualizar.

Clique em Editar na linha dessa configuração de alerta.

3
Escolha o alvo.
Clique em Usuário ou Faturamento em Selecionar um Destino.

4
Escolha a condição.
Em Selecione uma condição:

Se você escolheu Usuário, selecione:

Os usuários da organização não têm MFA ativado

O usuário ingressou na organização

O usuário saiu da organização

A função do usuário foi alterada

Se você escolheu Faturamento:

Selecione uma das seguintes opções:

O cartão de crédito está prestes a expirar

O valor faturado ontem está acima

A fatura atual de qualquer projeto está acima

A fatura atual da organização está acima

Se $ acima aparecer ao lado da opção selecionada, especifique o valor em USD onde o


Atlas deve acionar o alerta se a condição selecionada exceder esse valor.

5
Selecione o método de notificação.
Sob o título Adicionar método de notificação, clique no botão do método de notificação
específico que deseja usar.

Opção de notificação
Alertas de usuário
Alertas de cobrança
Descrição
Organização Atlas
Envia o alerta por e-mail ou mensagem de texto para usuários com funções específicas na
Organização.

Selecione as funções da organização que devem receber os alertas nas caixas de seleção
Selecionar função(ões) ou selecione Todas as funções para que todos os usuários na
organização recebam o alerta.

Selecione SMS para enviar esses alertas para o número de celular configurado para cada
usuário da Organização Atlas em sua página Conta.

Selecione Email para enviar esses alertas para o endereço de email configurado para cada
usuário da Organização Atlas em sua página Conta. O e-mail é verificado por padrão.

Usuário Atlas
Envia o alerta por e-mail ou mensagem de texto para um usuário específico do Atlas.

Selecione SMS para enviar esses alertas para o número de celular configurado para o
usuário Atlas na página Conta.

Selecione Email para enviar esses alertas para o endereço de email configurado para o
usuário Atlas na página Conta. O e-mail é verificado por padrão.

E-mail
Envia o alerta para qualquer endereço de e-mail que você fornecer.
Número de telemóvel
Envia o alerta para um número de celular. Atlas remove toda pontuação e letras e usa
apenas os dígitos. Se você estiver fora dos Estados Unidos ou Canadá, inclua 011 e o
Código do país porque a Atlas usa o sistema baseado nos EUA Twilio para enviar
mensagens de texto. Como alternativa ao seu número de telefone fora dos EUA, use um
Google Voz número de telefone.

EXEMPLO
Para a Nova Zelândia, digite 01164 antes do número de telefone.

Folga
Envia o alerta para um canal do Slack no local de trabalho autorizado do Slack para a
organização. Para saber mais sobre a autorização do Slack, consulte Autorizar o Slack para
receber alertas da organização. Digite o nome do canal.

OBSERVAÇÃO
Depois de criar uma notificação que requer uma API ou chave de integração, a chave
aparece parcialmente editada quando você:

Vvisualize ou edite o alerta por meio da UI do Atlas.

Consulte o alerta para a notificação por meio da API de administração do Atlas.

PagerDuty
Envia o alerta para um
PagerDuty
conta. Insira apenas a chave de serviço PagerDuty. Defina regras de escalonamento e
atribuições de alerta diretamente no PagerDuty.

Reconheça alertas do PagerDuty no painel do PagerDuty.

OBSERVAÇÃO
Todas as novas chaves do PagerDuty usam seus
API de eventos v2.

Se você tiver uma chave da API de eventos v1, poderá continuar a usar essa chave com o
Atlas.

OBSERVAÇÃO
Depois de criar uma notificação que requer uma API ou chave de integração, a chave
aparece parcialmente editada quando você:

Visualize ou edite o alerta por meio da UI do Atlas.

Consulte o alerta para a notificação por meio da API de administração do Atlas.

Cão de dados
Envia o alerta para um
Cão de dados
conta como um evento Datadog.

Quando o alerta é aberto pela primeira vez, o Atlas envia o alerta como um evento de “erro”.
As atualizações subsequentes são enviadas como eventos "info". Quando o alerta é
fechado, o Atlas envia um evento de “sucesso”.

Insira sua chave de API DataDog em Chave de API e clique em Validar chave de API
Datadog.

Insira sua região de API.

O Atlas oferece suporte às seguintes regiões do Datadog na IU do Atlas:

EUA1

EUA3

EUA5

EU1

Datadog usa US1 por padrão.


Para saber mais sobre as regiões do Datadog, consulte
Sites Datadog.

OBSERVAÇÃO
Depois de criar uma notificação que requer uma API ou chave de integração, a chave
aparece parcialmente editada quando você:

Visualize ou edite o alerta por meio da UI do Atlas.

Consulte o alerta para a notificação por meio da API de administração do Atlas.

VictorOps
Envia o alerta para um
VictorOps
conta.

Digite o alfanumérico
Chave API
do VictorOps para integrar o endpoint VictorOps para alertas. Adicione traços à chave de
API para que ela corresponda ao formato xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. Por
exemplo, 489f7he7-790b-9896-a8cf-j4757def1161. Insira um opcional
chave de roteamento
para encaminhar alertas para um grupo específico do VictorOps. Clique em Alerta
pós-teste para testar a configuração do VictorOps. Defina regras de escalonamento e
roteamento diretamente no VictorOps.

Esta opção está disponível apenas para alertas que você deve confirmar. Você pode
receber alertas informativos deste serviço de monitoramento de terceiros no Atlas. No
entanto, você deve resolver esses alertas no serviço externo. Reconheça os alertas do
VictorOps no painel do VictorOps.

OBSERVAÇÃO
Depois de criar uma notificação que requer uma API ou chave de integração, a chave
aparece parcialmente editada quando você:

Visualize ou edite o alerta por meio da UI do Atlas.

Consulte o alerta para a notificação por meio da API de administração do Atlas.

Opsgênio
Envia o alerta para um
Opsgênio
conta. Insira apenas a chave de API do Opsgenie de uma integração da API REST do
Opsgenie. Defina regras de escalonamento e atribuições de alerta no Opsgenie.

Esta opção está disponível apenas para alertas que você deve confirmar. Você pode
receber alertas informativos deste serviço de monitoramento de terceiros no Atlas. No
entanto, você deve resolver esses alertas no serviço externo.
Reconhecer alertas do Opsgenie
no painel do Opsgenie.

OBSERVAÇÃO
Depois de criar uma notificação que requer uma API ou chave de integração, a chave
aparece parcialmente editada quando você:

Visualize ou edite o alerta por meio da UI do Atlas.

Consulte o alerta para a notificação por meio da API de administração do Atlas.

Equipes da Microsoft
Envia o alerta para um
Equipes da Microsoft
canal. Você pode visualizar esses alertas no
Cartão Adaptativo
exibido em seu canal.

Para enviar notificações de alerta para um canal do Microsoft Teams, você deve criar um
webhook de entrada do Microsoft Teams. Depois de criar o webhook, você pode usar a URL
gerada automaticamente para configurar a integração do Microsoft Teams no Atlas.

Para configurar a integração, consulte Integrar com o Microsoft Teams.

OBSERVAÇÃO
Quando você visualiza ou edita o alerta de uma notificação do Microsoft Teams, o URL
aparece parcialmente editado.

6
Clique em Salvar.
Configurar um alerta de janela de manutenção
Você pode configurar alertas de janela de manutenção para projetos com janelas de
manutenção configuradas.

1
Navegue até a página Alertas do seu projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Clique no ícone Alertas do Projeto na barra de navegação ou clique em Alertas na barra


lateral.

2
Clique em Configurações de alerta.
3
Selecione os alertas da janela de manutenção que você deseja configurar.
Você pode configurar os seguintes alertas da janela de manutenção:

A manutenção está agendada

Manutenção iniciada

Manutenção não é mais necessária

Para o alerta que você deseja configurar, clique em Editar na linha dessa configuração de
alerta.

4
Selecione os destinatários do alerta e os métodos de entrega.
Na seção Enviar para, clique em Adicionar e selecione uma das opções descritas na tabela
a seguir.

Opção de notificação
Descrição
Projeto Atlas
Envia o alerta por e-mail ou mensagem de texto para usuários com funções específicas no
Projeto.

OBSERVAÇÃO
O Projeto Atlas é o destinatário do alerta padrão. Você pode configurar as funções para as
quais o alerta é enviado e como é entregue. Você não pode adicionar um segundo projeto
Atlas como destinatário.

O Projeto Atlas estará disponível como uma opção na lista Adicionar somente se não estiver
atualmente na lista de destinatários.

Selecione as funções do projeto que devem receber os alertas nas caixas de seleção
Selecionar função(ões) ou selecione Todas as funções para que todos os usuários no
projeto recebam o alerta.

Selecione SMS para enviar esses alertas para o número de celular configurado para cada
usuário do Projeto Atlas em sua página Conta.

Selecione Email para enviar esses alertas para o endereço de email configurado para cada
usuário do Projeto Atlas em sua página Conta. O e-mail é verificado por padrão.

Organização Atlas
Envia o alerta por e-mail ou mensagem de texto para usuários com funções específicas na
Organização.

Selecione as funções da organização que devem receber os alertas nas caixas de seleção
Selecionar função(ões) ou selecione Todas as funções para que todos os usuários na
organização recebam o alerta.
Selecione SMS para enviar esses alertas para o número de celular configurado para cada
usuário da Organização Atlas na página Conta.

Selecione Email para enviar esses alertas para o endereço de email configurado para cada
usuário da Organização Atlas na página Conta. O e-mail é verificado por padrão.

Usuário Atlas
Envia o alerta por e-mail ou mensagem de texto para um usuário específico do Atlas.

Selecione SMS para enviar esses alertas para o número de celular configurado para o
usuário Atlas na página Conta.

Selecione Email para enviar esses alertas para o endereço de email configurado para o
usuário Atlas na página Conta. O e-mail é verificado por padrão.

E-mail
Envia o alerta para um endereço de e-mail.
SMS
Envia o alerta para um número de celular. Atlas remove toda pontuação e letras e usa
apenas os dígitos. Se você estiver fora dos Estados Unidos ou Canadá, inclua 011 e o
Código do país
porque a Atlas usa o sistema baseado nos EUA
Twilio
para enviar mensagens de texto. Como alternativa ao seu número de telefone fora dos
EUA, use um
Google Voz
número de telefone.

EXEMPLO
Para a Nova Zelândia, digite 01164 antes do número de telefone.

Folga
Envia o alerta para um canal do Slack. Insira o nome do canal e um token de API ou um
token de bot. Para criar um token de API, consulte o
https://api.slack.com/web
página em sua conta do Slack. Para saber mais sobre os usuários do Bot no Slack,
consulte
https://api.slack.com/bot-users.

OBSERVAÇÃO
Depois de criar uma notificação que requer uma API ou chave de integração, a chave
aparece parcialmente editada quando você:

Visualize ou edite o alerta por meio da UI do Atlas.

Consulte o alerta para a notificação por meio da API de administração do Atlas.


Webhook
Envia uma solicitação HTTP POST a um endpoint para processamento programático. O
corpo da solicitação contém um documento JSON que usa o mesmo formato da API Atlas
Administration
Recurso de alertas.

Esta opção estará disponível somente se você tiver definido as configurações do Webhook
na página Integrações.

OBSERVAÇÃO
Quando você visualiza ou edita o alerta de uma notificação de webhook, o URL aparece
parcialmente redigido e o segredo aparece completamente redigido.

No campo URL do webhook, especifique o URL de destino para alertas baseados em


webhook.

(Opcional) Se você configurar a integração do Webhook com um segredo, no campo


Segredo do Webhook, especifique o segredo de autenticação para alertas baseados em
webhook.

Cão de dados
Envia o alerta para um
Cão de dados
conta como um evento Datadog.

Quando o alerta é aberto pela primeira vez, o Atlas envia o alerta como um evento de “erro”.
As atualizações subsequentes são enviadas como eventos "info". Quando o alerta é
fechado, o Atlas envia um evento de “sucesso”.

Insira sua chave de API DataDog em Chave de API e clique em Validar chave de API
Datadog.

Insira sua região de API.

O Atlas oferece suporte às seguintes regiões do Datadog na IU do Atlas:

EUA1

EUA3

EUA5

EU1

Datadog usa US1 por padrão.

Para saber mais sobre as regiões do Datadog, consulte


Sites Datadog.
OBSERVAÇÃO
Depois de criar uma notificação que requer uma API ou chave de integração, a chave
aparece parcialmente editada quando você:

Visualize ou edite o alerta por meio da UI do Atlas.

Consulte o alerta para a notificação por meio da API de administração do Atlas.

Equipes da Microsoft
Envia o alerta para um
Equipes da Microsoft
canal como um
Cartão Adaptativo
.

Para enviar notificações de alerta para um canal do Microsoft Teams, você deve criar um
webhook de entrada do Microsoft Teams. Depois de criar o webhook, você pode usar a URL
gerada automaticamente para configurar a integração do Microsoft Teams no Atlas.

Para configurar a integração, consulte Integrar com o Microsoft Teams.

OBSERVAÇÃO
Quando você visualiza ou edita o alerta de uma notificação do Microsoft Teams, o URL
aparece parcialmente editado.

5
Clique em Salvar.
Ver configurações de alerta
Você pode visualizar todos os alertas, configurações de alerta e alertas excluídos na página
Alertas da organização. Para saber mais, consulte Fluxo de trabalho de alertas.

Para visualizar suas configurações de alerta, navegue até a página Alertas da sua
organização usando as seguintes etapas:

1
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.
2
Clique em Alertas na barra lateral.
3
Clique na guia Configurações de alerta.
Desabilitar um alerta
1
Navegue até a página Alertas da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.
Clique em Alertas na barra lateral.

2
Clique em Configurações de alerta.
3
Escolha a configuração de alerta a ser desativada.
Na linha de um alerta específico, clique em Desativar.

Clique em Ativar para reativar o alerta a qualquer momento.

Se você desabilitar uma configuração de alerta, o Atlas cancelará os alertas ativos


relacionados à configuração. Uma configuração de alerta desativada permanece visível,
mas esmaecida, e pode ser reativada posteriormente.

Habilitar um alerta
Para ativar um alerta que você desativou anteriormente:

1
Navegue até a página Alertas da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Alertas na barra lateral.

2
Clique em Configurações de alerta.
3
Reative a configuração de alerta.
Na linha de um alerta específico, clique em .

Clique em Habilitar.

Excluir um alerta
1
Navegue até a página Alertas da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Alertas na barra lateral.

2
Clique em Configurações de alerta.
3
Escolha a configuração de alerta a ser excluída.
Na linha de um alerta específico, clique em Excluir.

Clique em Excluir no modal Excluir alerta ou clique em Cancelar para deixar o alerta
conforme configurado.
OBSERVAÇÃO
Se você não tiver feito login cinco minutos depois de pressionar Excluir, será necessário
inserir sua senha novamente e clicar em Excluir novamente.

Se você excluir uma configuração de alerta, o Atlas cancelará os alertas ativos relacionados
à configuração. Uma configuração de alerta excluída não permanece visível.
Resolver alertas
Nesta página

Ver alertas
Reconhecer alertas
Desconhecer alertas
Aumente a capacidade do cluster
Ver todas as atividades
Recuperar o feed de atividades
Resoluções para alertas específicos
O Atlas emite alertas para o banco de dados e as condições do servidor configuradas nas
configurações de alerta. Quando uma condição aciona um alerta, o Atlas exibe um símbolo
de aviso no cluster e envia notificações de alerta. Suas configurações de alerta determinam
os métodos de notificação. O Atlas continua enviando notificações em intervalos regulares
até que a condição seja resolvida ou você exclua ou desative o alerta. Você deve corrigir o
problema imediato, implementar uma solução de longo prazo e visualizar métricas para
monitorar seu progresso.

OBSERVAÇÃO
Se você integrar com VictorOps, OpsGenie ou DataDog, poderá receber alertas
informativos desses serviços de monitoramento de terceiros no Atlas. No entanto, você
deve resolver esses alertas em cada serviço externo.

Alertas da organização

Alertas de Projeto
Ver alertas
Você pode visualizar todos os alertas, configurações de alerta e alertas excluídos na página
Alertas da organização. Para saber mais, consulte Fluxo de trabalho de alertas.

Para visualizar todos os alertas abertos:

1
Navegue até a página Alertas da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Alertas na barra lateral.

2
Se ainda não estiver exibido, clique na guia Todos os alertas.
Reconhecer alertas
Para reconhecer alertas:

1
Navegue até a página Alertas da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Alertas na barra lateral.

2
Selecione o alerta que deseja confirmar e clique em Marcar reconhecimento.
IMPORTANTE
Se um alerta usar o PagerDuty para notificações de alerta, você poderá confirmar o alerta
apenas no painel do PagerDuty.

Quando você confirma um alerta, o Atlas não envia mais notificações até que o período de
confirmação termine, você resolva a condição de alerta ou cancele o reconhecimento do
alerta. Se uma condição de alerta terminar durante um período de confirmação, o Atlas
enviará uma notificação.

Desconhecer alertas
Você pode cancelar a confirmação de um alerta que você reconheceu anteriormente.
Depois de cancelar o reconhecimento de um alerta ativo, o Atlas retoma o envio de
notificações em intervalos regulares até que a condição seja resolvida ou você exclua,
desative ou reconheça o alerta.

Para cancelar o reconhecimento de alertas:

1
Navegue até a página Alertas da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Alertas na barra lateral.

2
Selecione o alerta que deseja confirmar e clique em Desreconhecer no lado direito do
alerta.
IMPORTANTE
Se um alerta usar o PagerDuty para notificações de alerta, você poderá confirmar o alerta
apenas no painel do PagerDuty.

Aumente a capacidade do cluster


Para resolver um alerta aumentando a capacidade do seu cluster, consulte Modificar um
cluster.

Ver todas as atividades


Para visualizar e filtrar o feed de atividades de uma organização ou projeto, consulte
Visualizar o feed de atividades.

Recuperar o feed de atividades


Você pode recuperar eventos de uma organização usando o
pegue tudo
Recurso de API.

Resoluções para alertas específicos


As seções a seguir descrevem as condições de alerta do Atlas e sugerem etapas para
resolvê-las.

Tipo de alerta
Descrição
Alertas de pesquisa do Atlas
A quantidade de CPU e memória usada pelos processos do Atlas Search atinge um limite
especificado.
Alertas de conexão
O número de conexões com um processo MongoDB excede o máximo permitido.
Alertas de % de espaço em disco usado
A porcentagem de espaço em disco usado em uma partição atinge um limite especificado.
Alertas de segmentação de consulta
Indica consultas ineficientes.

OBSERVAÇÃO
O
mudar fluxos
os cursores que o processo Atlas Search (mongot) usa para manter os índices do Atlas
Search atualizados podem contribuir para a proporção de direcionamento de consulta e
acionar alertas de direcionamento de consulta se a proporção for alta.

O conjunto de réplicas não tem primário


Nenhum primário foi detectado no conjunto de réplicas.
Alertas de Oplog de Replicação
Quantidade de registrar os dados gerados em um membro de cluster primário são maiores
que o tamanho do oplog configurado do cluster.
Alertas de uso da CPU do sistema
O uso da CPU do processo MongoDB atinge um limite especificado.
Corrigir problemas de pesquisa do Atlas
Nesta página

Condições de alerta
Gatilhos comuns
Resolva o problema imediato
Implemente uma solução de longo prazo
Monitore seu progresso
O Atlas Search aciona alertas do Atlas Search quando a quantidade de CPU e memória
usada pelos processos do Atlas Search atinge um limite especificado. Se o processo de
pesquisa (mongot) ficar sem memória, a indexação e as consultas falharão. Você pode
configurar as condições de alerta do Atlas Search no modal de configurações de alerta do
projeto. Você também pode visualizar métricas do Atlas Search com monitoramento de
cluster.

AVISO
Se você fragmentar uma coleção que já tenha um índice do Atlas Search, poderá enfrentar
um breve período de inatividade da consulta quando a coleção começar a aparecer em um
fragmento. Além disso, se você adicionar um fragmento para uma coleção já fragmentada
que contém um índice do Atlas Search, suas consultas de pesquisa nessa coleção falharão
até que o processo de sincronização inicial seja concluído nos fragmentos adicionados.
Para saber mais, consulte processo de sincronização inicial.

Condições de alerta
Você pode configurar as seguintes condições de alerta na página de configurações de alerta
no nível do projeto para acionar alertas.

Atlas Search: O atraso na replicação do índice ocorre se o número aproximado de


milissegundos que o Atlas Search está atrasado na replicação de alterações do
registrar
de
mondeus
está acima ou abaixo do limite.

Pesquisa Atlas: Tamanho do índice no disco ocorre se o tamanho total de todos os índices
da Pesquisa Atlas no disco em bytes estiver acima ou abaixo do limite.

Pesquisa Atlas: Número máximo de documentos Lucene ocorre se o número limite superior
de documentos Lucene usados para armazenar índices de pesquisa Atlas para um
determinado conjunto de réplicas ou fragmento estiver acima do limite.

Atlas Search: Número de consultas com erro ocorre se o número de consultas para as quais
o Atlas Search não consegue retornar uma resposta estiver acima ou abaixo do limite.

Pesquisa Atlas: Número de campos de índice ocorre se o número total de campos


exclusivos presentes no índice Pesquisa Atlas estiver acima ou abaixo do limite.
Atlas Search: Número de consultas bem-sucedidas ocorre se o número de consultas para
as quais o Atlas Search retornou uma resposta com êxito estiver acima ou abaixo do limite.

Atlas Search: o número total de consultas ocorre se o número de consultas enviadas ao


Atlas Search estiver acima ou abaixo do limite.

Atlas Search Opcounter: a exclusão ocorre se o número total de documentos ou campos


(especificados na definição do índice) removidos por segundo estiver acima ou abaixo do
limite.

Atlas Search Opcounter: Getmore ocorre se o número total de comandos getmore


executados em todas as consultas do Atlas Search por segundo estiver acima ou abaixo do
limite.

Opcounter do Atlas Search: a inserção ocorre se o número total de documentos ou campos


(especificados na definição do índice) que o Atlas Search indexa por segundo estiver acima
ou abaixo do limite.

Opcounter do Atlas Search: a atualização ocorre se o número total de documentos ou


campos (especificados na definição do índice) que o Atlas Search atualiza por segundo
estiver acima ou abaixo do limite.

Espaço em disco insuficiente para suportar a reconstrução de índices de pesquisa ocorre se


a implementação do seu banco de dados ficar sem espaço livre em disco suficiente para
suportar seus índices do Atlas Search.

OBSERVAÇÃO
Este alerta pode aparecer quando o Atlas atualiza automaticamente seus índices de
pesquisa para habilitar novos recursos. A implantação do seu banco de dados deve ter
espaço em disco suficiente para a versão anterior e a nova do índice. Após a conclusão da
atualização do índice, o Atlas exclui a versão antiga do índice, o que libera espaço em
disco.

Memória de pesquisa: Residente ocorre se o total de bytes de memória residente ocupados


pelo processo de pesquisa do Atlas estiver acima ou abaixo do limite.

Memória de pesquisa: Compartilhada ocorre se o total de bytes de memória compartilhada


ocupada pelo processo Atlas Search estiver acima ou abaixo do limite.

Memória de pesquisa: Virtual ocorre se o total de bytes de memória virtual ocupados pelo
processo Atlas Search estiver acima ou abaixo do limite.

Processo de pesquisa:% de CPU (Kernel) ocorre se a porcentagem de tempo que a CPU


gastou atendendo chamadas do sistema operacional para o processo de pesquisa do Atlas
estiver acima do limite.
Processo de pesquisa:% de CPU (usuário) ocorre se a porcentagem de tempo que a CPU
gastou atendendo ao processo de pesquisa do Atlas estiver acima do limite.

Processo de pesquisa: o espaço em disco usado ocorre se o total de bytes de espaço em


disco usado pelo processo Atlas Search estiver acima do limite.

Processo de pesquisa: A falta de memória ocorre se o processo de pesquisa (mongot) ficar


sem memória. Se o processo de pesquisa ficar sem memória, a indexação e as consultas
falharão.

OBSERVAÇÃO
O alerta Processo de pesquisa: memória esgotada é executado automaticamente por
padrão. Você pode definir a configuração de alerta para desativar esta notificação.

Gatilhos comuns
Os alertas do Atlas Search geralmente ocorrem quando você tenta criar um índice de
pesquisa grande ou complexo. Esses índices permanecem na fase de sincronização inicial
até que o problema de memória seja resolvido.

Resolva o problema imediato


Se o processo de pesquisa (mongot) ficar sem memória ou espaço em disco, você poderá
atualizar seu cluster para corrigir o problema imediato. Você pode selecionar uma camada
de cluster com mais memória, armazenamento e IOPS.

Implemente uma solução de longo prazo


Para evitar a procura Atlas no futuro, revise cuidadosamente o Tune Atlas Search
Performance para Atlas Search. Trabalhe para otimizar seus índices.

Monitore seu progresso


Visualize os gráficos disponíveis do Atlas Search para monitorar as métricas do Atlas
Search.

Monitore as métricas do Atlas Search para avaliar e otimizar seus índices do Atlas Search.

Para saber mais, consulte Exibir métricas de cluster


Corrigir problemas de conexão
Nesta página

Condições de alerta
Gatilhos comuns
Resolva o problema imediato
Implemente uma solução de longo prazo
Monitore seu progresso
Os alertas de conexão normalmente ocorrem quando o número máximo de conexões
permitidas para um processo MongoDB é excedido. Uma vez excedido o limite, nenhuma
nova conexão poderá ser aberta até que o número de conexões abertas caia abaixo do
limite.

Condições de alerta
Você pode configurar as seguintes condições de alerta na página de configurações de alerta
no nível do projeto para acionar alertas.

As conexões ocorrem se o número de conexões ativas com o host atender à média


especificada.

A % de conexões do limite configurado ocorre se o número de conexões abertas com o host


exceder a porcentagem especificada.

Gatilhos comuns
Exceder o limite de conexão para um cluster Atlas pode ocorrer por vários motivos.
Diferentes níveis do Atlas têm diferentes limites de conexão; clusters de tamanho
M0/M2/M5, por exemplo, são limitados a 500 conexões, e clusters de tamanho M10 são
limitados a 1.500 conexões. Camadas de cluster maiores têm limites de conexão mais altos.
Diferentes aplicativos de acesso a banco de dados têm diferentes maneiras de implementar
pool de conexões, o que afeta quantas conexões abertas seu aplicativo mantém em um
determinado momento.

Resolva o problema imediato


Clusters M0/M2/M5
Para resolver uma condição de alerta de conexão, reinicie o aplicativo que está atualmente
fazendo conexões com seu cluster Atlas. Reiniciar o aplicativo encerra todas as conexões
existentes abertas pelo aplicativo e permite que o cluster Atlas retome as operações
normais.

Aglomerados M10+
Clusters Atlas de tamanho M10 e superiores podem utilizar a opção Testar Failover
Primário. O procedimento Testar Failover Primário reduz o atual nó primário e desencadeia
um
eleição, que descarta todas as conexões com o nó primário.

OBSERVAÇÃO
Se seu aplicativo se conectar exclusivamente a um nó secundário, talvez seja necessário
executar o procedimento Test Failover diversas vezes para garantir que o nó secundário
aplicável gire sua posição dentro do conjunto de réplicas e elimine suas conexões.

Test Failover geralmente é a solução preferível, mas outra solução possível é reiniciar o
aplicativo que está atualmente fazendo conexões com seu cluster Atlas. Reiniciar o
aplicativo encerra todas as conexões existentes e permite que o cluster Atlas retome as
operações normais.

Implemente uma solução de longo prazo


Os alertas de conexão geralmente são um sintoma de um problema maior. Empregar uma
das estratégias descritas acima resolverá o problema imediato, mas uma solução
permanente geralmente requer:

Examinando seus aplicativos de banco de dados em busca de códigos de conexão falhos.


Situações em que as conexões são abertas, mas nunca fechadas, podem permitir que
conexões antigas se acumulem e eventualmente excedam o limite de conexões. Além
disso, você pode precisar implementar alguma forma de
pool de conexões.

Atualizar para uma camada de cluster Atlas maior que permite um número maior de
conexões, se sua base de usuários for muito grande para sua camada de cluster atual.

Monitore seu progresso


Visualize o gráfico Conexões para monitorar o número total de conexões com o cluster.

Monitore as conexões para determinar se os limites de conexão atuais são suficientes. Se


necessário, atualize a camada do cluster.

Para saber mais, consulte Exibir métricas de cluster.


Corrigir problemas de IOPS
Nesta página

Condições de alerta
Gatilhos comuns
Resolva o problema imediato
Implemente uma solução de longo prazo
Monitore seu progresso
As condições de alerta do sistema e do disco podem indicar problemas de IOPS.

Condições de alerta
Você pode configurar as seguintes condições de alerta na página de configurações de alerta
no nível do projeto para acionar alertas.

A condição de alerta IOPS de leitura de disco na partição de dados é gerada se o número


médio de operações de leitura de disco por segundo exceder o limite especificado.

A condição de alerta IOPS de gravação de disco na partição de dados é gerada se o


número médio de operações de gravação de disco por segundo exceder o limite
especificado.

Sistema: CPU (Usuário) % mede o uso de CPU dos processos no nó, normalizado pelo
número de CPUs. Esse valor é dimensionado para um intervalo de 0 a 100%.

Gatilhos comuns
Alguns eventos comuns podem acionar estes alertas:

Consultas não otimizadas.

Um evento único, como um


construção de índice.

Resolva o problema imediato


Considere algumas ações possíveis para ajudar a resolver esses alertas:

Otimize suas consultas.

Use o Atlas Performance Advisor para visualizar consultas lentas e sugestões


índices.

Análise
Estratégias de Indexação
para possíveis melhorias adicionais na indexação.

OBSERVAÇÃO
Talvez seja necessário aumentar temporariamente o IOPS do cluster para criar novos
índices. Para alterar o IOPS de um cluster, acesse a página Configuração do cluster e:

Provedor de nuvem
Nível
Possíveis ações

AWS

M10, M20
Aumentar a capacidade de armazenamento ou

Atualizar nível de cluster

AWS

M30 ou maior
Aumente o IOPS do cluster ou

Aumentar a capacidade de armazenamento ou

Atualizar nível de cluster

Google Nuvem

M10 ou maior
Aumentar a capacidade de armazenamento ou

Atualizar nível de cluster

Azul
M10 ou maior
Aumentar a capacidade de armazenamento ou

Atualizar nível de cluster

Analise o desempenho da consulta


para revisar como suas consultas estão usando seus índices.

Aumente os recursos de hardware, como tamanho da instância e IOPS, na página de


configuração do cluster.

Implemente uma solução de longo prazo


Créditos de explosão de IOPS de disco para clusters Atlas no Azure
Os clusters Atlas implantados no Azure podem usar a explosão baseada em crédito, mas o
disco só explodirá se tiver créditos de explosão acumulados no seu balde de crédito. O
Azure também oferece um modelo de explosão sob demanda, onde o disco explode sempre
que as suas necessidades excedem a sua capacidade atual.
Veja o Azure
Documentação de estouro de disco
para obter mais informações sobre como funciona o bursting para discos do Azure.

Economize créditos de explosão


Se você exceder regularmente o limite de IOPS configurado, poderá evitar o esgotamento
dos créditos de intermitência aumentando o IOPS configurado com qualquer uma das
seguintes ações:

Aumente o IOPS do cluster para aumentar o limite de IOPS do cluster.

Aumente a capacidade de armazenamento. O limite de IOPS aumenta à medida que você


aumenta a capacidade de armazenamento. Clusters configurados para usar pelo menos 1
TB de armazenamento têm desempenho de IOPS de linha de base igual ou superior ao
desempenho máximo de intermitência. Esses volumes não esgotam os saldos de crédito
estourados.

Atualize o nível do cluster. Camadas de cluster maiores incluem limites de IOPS mais altos.

OBSERVAÇÃO
As camadas de cluster M140 e superiores são implantadas com pelo menos 1 TB de
capacidade de armazenamento por padrão. Clusters com 1 TB ou mais de capacidade de
armazenamento não esgotam os saldos de crédito explosivos.

Monitore seu progresso


Estes são alguns métodos possíveis para observar alta E/S de disco:

O uso de IOPS de disco no gráfico de IOPS de disco nas métricas do cluster excede o IOPS
provisionado na página de configuração do cluster Atlas.

A métrica de CPU do sistema normalizado tem uma curva IOWait alta. IOWait mede a
porcentagem de tempo que a CPU fica ociosa e aguardando a conclusão de uma operação
de E/S. O gráfico de CPU do sistema normalizado está localizado na seção Métricas de
hardware da guia Métricas.
Corrigir problemas de armazenamento
Nesta página

Condições de alerta
Gatilhos comuns
Resolva o problema imediato
Implemente uma solução de longo prazo
Monitore seu progresso
Os alertas de % de espaço em disco usado indicam que a porcentagem de espaço em
disco usado em uma partição atinge um limite especificado.

Condições de alerta
Você pode configurar as seguintes condições de alerta na página de configurações de alerta
no nível do projeto para acionar alertas.

A porcentagem de espaço em disco usado na partição de dados ocorre quando a


porcentagem de espaço em disco usado em qualquer partição que contém os dados da
coleção MongoDB atinge ou excede um determinado limite. Por padrão, o limite é 90% do
tamanho de armazenamento configurado do cluster.

Gatilhos comuns
Os seguintes eventos comuns podem acionar alertas de % de espaço em disco usado:

O disco está cheio e a expansão automática do armazenamento não está habilitada.

A expansão automática do armazenamento está habilitada, mas o disco encheu muito


rapidamente para que o Atlas expandisse o espaço de armazenamento do cluster. Isso
pode acontecer durante a migração de dados.

O armazenamento de expansão automática está habilitado, mas o Atlas não pode expandir
o espaço de armazenamento do cluster porque atingiu a capacidade máxima de
armazenamento para este cluster. Para obter mais informações sobre limites de nível de
cluster, consulte as opções de configuração de instância da Amazon Web Services, Google
Cloud Platform e Microsoft Azure.

Resolva o problema imediato


Considere as ações a seguir para ajudar a resolver alertas de % de espaço em disco usado
por meio da UI ou API do Atlas.

IU do Atlas

API de administração do Atlas


Ative o armazenamento de expansão automática.

OBSERVAÇÃO
Se o disco encher muito rapidamente, o Atlas poderá não conseguir expandir o espaço de
armazenamento do cluster a tempo, mesmo que a expansão automática do armazenamento
esteja habilitada.

Aumente manualmente o armazenamento deste cluster na seção Cluster Tier da página de


configuração.

Implemente uma solução de longo prazo


Considere as seguintes soluções de longo prazo para ajudar a resolver alertas de % de
espaço em disco usado por meio da UI ou API do Atlas.

IU do Atlas

API de administração do Atlas


Se você atingiu a capacidade máxima de armazenamento para este cluster, atualize para
uma camada de cluster maior na seção Camada de Cluster da página de configuração.

Monitore seu progresso


Você pode observar uma alta porcentagem de espaço em disco usado das seguintes
maneiras:

Nas métricas do cluster, o gráfico Uso do disco exibe o espaço em disco usado em amarelo.
Isso indica que o espaço em disco usado é aproximadamente 70% do tamanho de
armazenamento configurado do cluster Atlas.

Os nós do Atlas não estão íntegros porque o espaço em disco usado atingiu o tamanho de
armazenamento configurado do cluster.

O cluster recusa gravações e conexões do cliente.


Corrigir problemas de consulta
Nesta página

Condições de alerta
Gatilhos comuns
Resolva o problema imediato
Implemente uma solução de longo prazo
Monitore seu progresso
Os alertas de direcionamento de consulta geralmente indicam consultas ineficientes.

Condições de alerta
Você pode configurar as seguintes condições de alerta na página de configurações de alerta
no nível do projeto para acionar alertas.

Direcionamento de consulta: alertas de objetos verificados/devolvidos são acionados


quando o número médio de documentos verificados em relação ao número médio de
documentos retornados em todo o servidor em todas as operações durante um período de
amostragem excede um limite definido. O alerta padrão usa um limite de 1000:1.

Idealmente, a proporção de documentos digitalizados em relação aos documentos


devolvidos deve ser próxima de 1. Uma proporção alta impacta negativamente o
desempenho da consulta.

Direcionamento de consulta: digitalizado/devolvido ocorre se o número de chaves de índice


examinadas para atender uma consulta em relação ao número real de documentos
retornados atender ou exceder um limite definido pelo usuário. Este alerta não está
habilitado por padrão.

EXEMPLO
A seguinte entrada de log do mongod mostra estatísticas geradas a partir de uma consulta
ineficiente:

<Carimbo de data e hora> COMANDO <consulta>


planSummary: Chaves COLLSCAN examinadas: 0
docsExaminado: 10000 cursorExausto:1 numRendimentos:234
nretornado:4 protocolo:op_query 358ms
Esta consulta digitalizou 10.000 documentos e retornou apenas 4 para uma proporção de
2.500, o que é altamente ineficiente. Nenhuma chave de índice foi examinada, então o
MongoDB digitalizou todos os documentos da coleção, conhecida como
varredura de coleção.

Gatilhos comuns
O alerta de direcionamento de consulta normalmente ocorre quando não há índice para dar
suporte a uma consulta ou consultas ou quando um índice existente dá suporte apenas
parcialmente a uma consulta ou consultas.
OBSERVAÇÃO
O mudar fluxos os cursores que o processo Atlas Search (mongot) usa para manter os
índices do Atlas Search atualizados podem contribuir para a proporção de direcionamento
de consulta e acionar alertas de direcionamento de consulta se a proporção for alta.

Resolva o problema imediato


Adicione um ou mais índices para melhor atender às consultas ineficientes.

O Performance Advisor fornece a maneira mais fácil e rápida de criar um índice. O


Performance Advisor monitora consultas que o MongoDB considera lentas e recomenda
índices para melhorar o desempenho. O Atlas ajusta dinamicamente seu limite de consulta
lenta com base no tempo de execução das operações em seu cluster.

Clique em Criar índice em uma consulta lenta para obter instruções sobre como criar o
índice recomendado.

OBSERVAÇÃO
É possível receber um alerta de Query Targeting para uma consulta ineficiente sem receber
sugestões de índice do Performance Advisor se a consulta exceder o limite de consulta
lenta e a proporção de documentos digitalizados e retornados for maior que o limite
especificado no alerta.

Além disso, você pode usar os seguintes recursos para determinar qual consulta gerou o
alerta:

O painel de desempenho em tempo real monitora e exibe o tráfego de rede atual e as


operações de banco de dados em máquinas que hospedam o MongoDB em seus clusters
Atlas.

Os logs do MongoDB mantêm uma conta de atividades, incluindo consultas, para cada
instância do mongod em seus clusters Atlas.

O cursor.explicar() comando para mangusto fornece detalhes de desempenho para todas


as consultas.

O Atlas Query Profiler registra operações que o Atlas considera lentas quando comparadas
ao tempo médio de execução de todas as operações em seu cluster.

Implemente uma solução de longo prazo


Consulte o seguinte para obter mais informações sobre o desempenho da consulta:

Estratégias de indexação do MongoDB

Otimização de consulta

Analisar plano de consulta

Monitore seu progresso


O Atlas fornece dois métodos para visualizar o direcionamento da consulta:

Métricas de direcionamento de consulta, que destacam altas proporções de objetos


verificados em relação aos objetos retornados.

O Query Profiler, que descreve consultas ineficientes específicas executadas no cluster.

Métricas de segmentação de consulta


Você pode visualizar métricas históricas para ajudá-lo a visualizar o desempenho da
consulta do seu cluster. Para visualizar métricas de segmentação de consulta na UI do
Atlas:

Clique em Banco de dados no canto superior esquerdo do Atlas.

Clique em Exibir monitoramento no painel para a implementação do banco de dados.

Na página Métricas, clique no menu suspenso Adicionar gráfico e selecione Direcionamento


de consulta.

O gráfico Query Targeting exibe as seguintes métricas para consultas executadas no


servidor:

Métrica
Descrição
Objetos digitalizados/devolvidos
Indica o número médio de documentos examinados em relação ao número médio de
documentos devolvidos.
Digitalizado/devolvido
Indica o número de chaves de índice examinadas para atender uma consulta relativa ao
número real de documentos retornados.
OBSERVAÇÃO
O mudar fluxos os cursores que o processo Atlas Search (mongot) usa para manter os
índices do Atlas Search atualizados podem contribuir para a proporção de direcionamento
de consulta e acionar alertas de direcionamento de consulta se a proporção for alta.

Se alguma dessas métricas exceder o limite definido pelo usuário, o Atlas gerará o alerta
correspondente Query Targeting: Scanned Objects / Returned ou Query Targeting: Scanned
/ Returned.

OBSERVAÇÃO
Você também pode visualizar as taxas de operações de direcionamento de consulta em
tempo real usando o Painel de desempenho em tempo real.

Perfil de consulta
O Query Profiler contém Existem várias métricas que você pode usar para identificar
consultas ineficientes específicas. Você pode visualizar até as últimas 24 horas de
operações de consulta. O Query Profiler pode mostrar a proporção examinada: retornada
(chaves de índice examinadas para documentos retornados) de consultas registradas, o
que pode ajudá-lo a identificar as consultas que acionaram um alerta de direcionamento de
consulta: verificado/retornado. O gráfico mostra o número de chaves de índice examinadas
para atender uma consulta relativa ao número real de documentos retornados.

OBSERVAÇÃO
A proporção padrão de direcionamento de consulta: objetos verificados/alerta retornado
difere um pouco. A relação entre o número médio de documentos digitalizados e o número
médio de documentos devolvidos durante um período de amostragem aciona este alerta.

O Atlas pode não registrar as operações individuais que contribuem para as taxas de
segmentação de consulta devido aos limites definidos automaticamente. No entanto, você
ainda pode usar as métricas Query Profiler e Query Targeting para analisar e otimizar o
desempenho da consulta.

Para acessar o Query Profiler:

Clique em Banco de dados no canto superior esquerdo do Atlas.

Clique em Exibir monitoramento no painel para a implementação do banco de dados.

Clique na guia Criador de perfil.


Corrigir Primário Perdido
Nesta página

Condições de alerta
Gatilhos comuns
Resolva o problema imediato
Implemente uma solução de longo prazo
Monitore seu progresso
No momento T, nenhum primário foi detectado no conjunto de réplicas ABC.

Condições de alerta
Você pode configurar condições de alerta na página de configurações de alerta no nível do
projeto para acionar alertas.

Para obter mais informações sobre a condição de alerta, consulte O conjunto de réplicas
não tem primário.

Gatilhos comuns
A carga de trabalho excede os limites de produção e os recursos de computação do cluster.

Um problema de rede com o provedor de nuvem está impedindo


membros votantes
do conjunto de réplicas se comuniquem entre si, de modo que um primário não possa ser
eleito.

Resolva o problema imediato


Verifique as métricas do cluster para determinar se há recursos computacionais suficientes
para sua carga de trabalho.

Se o cluster estiver esgotando CPU, IOPS de disco, conexões ou outros recursos, atualize
para um cluster que suporte sua carga de trabalho.

Se as métricas do cluster estiverem normais, poderá haver um problema de rede com o


fornecedor de nuvem. O Atlas tenta reparar automaticamente esses problemas. Se o
problema persistir,
entre em contato com o suporte do MongoDB.

Implemente uma solução de longo prazo


Se o Atlas coletar dados durante um
eleição
, esse alerta poderá enviar um falso positivo. Para evitar esses falsos positivos, defina a
configuração do alerta após o intervalo de espera (na seção Enviar para da configuração).

Monitore seu progresso


Visualize os gráficos a seguir para monitorar se o cluster está esgotando os recursos:
CPU do sistema normalizado

Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

IOPs de disco

Monitore se o IOPS do disco se aproxima do IOPS máximo provisionado. Determine se o


cluster pode lidar com cargas de trabalho futuras.

Conexões

Monitore as conexões para determinar se os limites de conexão atuais são suficientes. Se


necessário, atualize a camada do cluster.

Para saber mais, consulte Exibir métricas de cluster.


Corrigir problemas de Oplog
Nesta página

Condições de alerta
Gatilhos comuns
Resolva o problema imediato
Implemente uma solução de longo prazo
Monitore seu progresso
Os alertas de Oplog de replicação podem ser acionados quando a quantidade de
registrar
os dados gerados em um membro de cluster primário são maiores que o tamanho do
oplog configurado do cluster.

Condições de alerta
Você pode configurar as seguintes condições de alerta na página de configurações de alerta
no nível do projeto para acionar alertas.

A Janela de Oplog de Replicação é (X) ocorre se a quantidade aproximada de tempo


disponível no oplog de replicação primária atingir ou ficar abaixo do limite especificado. Isso
se refere à quantidade de tempo que o primário pode continuar registrando, dada a taxa
atual na qual os dados de oplog são gerados.

Os dados de oplog por hora são (X) e ocorrem se a quantidade de dados por hora gravados
no oplog de replicação de um primário atender ou exceder o limite especificado.

Gatilhos comuns
Estes são alguns eventos comuns que podem levar ao aumento da atividade oplog:

Operações intensivas de gravação e atualização em um curto período de tempo.

O tamanho do oplog configurado do cluster é menor que o valor no gráfico Oplog GB/hora
observado na visualização de métricas do cluster.

Resolva o problema imediato


Estas são algumas ações possíveis a serem consideradas para ajudar a resolver alertas de
Oplog de replicação:

Aumente o tamanho do oplog editando a configuração do seu cluster para garantir que ele
seja maior que o valor de pico do gráfico Oplog GB/hora na visualização de métricas do
cluster.

Aumente o tamanho do oplog se você prevê operações intensas de gravação e atualização


ocorrendo em um curto período de tempo.

OBSERVAÇÃO
Talvez seja necessário aumentar o armazenamento do cluster para liberar espaço suficiente
para redimensionar o oplog.

Certifique-se de que todas as operações de gravação especifiquem um escreva


preocupação da maioria para garantir que as gravações sejam replicadas em pelo menos
um nó antes de passar para a próxima operação de gravação. Isso controla a taxa de
tráfego do seu aplicativo, evitando que o primário aceite gravações mais rapidamente do
que os secundários podem suportar.

Implemente uma solução de longo prazo


Referir-se
Cargas de trabalho que podem exigir um tamanho maior de Oplog para obter mais
informações sobre os requisitos de dimensionamento de oplog para seu caso de uso.

Monitore seu progresso


Você pode observar os seguintes cenários quando esses alertas são acionados:

O gráfico Oplog GB/hora na visualização de métricas aumenta.

O gráfico da janela Oplog de replicação na exibição de métricas está baixo.

O Atlas Visualiza e baixa logs do MongoDB de secundário ou nós não íntegros exibem a
seguinte mensagem:

Estamos muito obsoletos para usar <node>:27017 como fonte de sincronização.


Um nó Atlas está relatando um estado de
INICIALIZAÇÃO2
e
RECUPERANDO
por um longo período de tempo.

Normalmente, isso indica que o nó "saiu do oplog" e não consegue acompanhar os dados
do oplog gerados pelo nó primário. Neste caso, o nó exigirá um sincronização inicial para
recuperar e garantir que os dados sejam consistentes em todos os nós. Você pode verificar
o estado de um nó usando o rs.status() método shell.
Revise as métricas de implantação de banco
de dados
Nesta página

Ver métricas
Métricas importantes
Monitorando a granularidade do armazenamento de dados
Considerações sobre monitoramento de cluster gratuito e cluster compartilhado
Considerações sobre monitoramento de instâncias sem servidor
Gerenciar tags
O Atlas coleta e exibe métricas para seus servidores, bancos de dados e processos
MongoDB.

Monitore as métricas de implantação do banco de dados para identificar problemas de


desempenho e determinar se a implantação atual do banco de dados atende aos seus
requisitos. Para obter mais informações sobre as métricas disponíveis para monitorar suas
implantações de banco de dados, consulte Revisar métricas disponíveis.

OBSERVAÇÃO
O número de servidores que o Atlas exibe na página Métricas a qualquer momento depende
do tamanho da tela do navegador. Use a seção Alternar membros para controlar quais
servidores o Atlas exibe. Passe o mouse sobre os ícones S e P para descobrir quais
servidores eles representam.

Ver métricas
Ver visão geral do projeto
A visualização Implantações de banco de dados exibe todas as implantações de banco de
dados em um projeto Atlas e apresenta métricas principais por implantação de banco de
dados. Você também pode visualizar as principais métricas de uma implantação de banco
de dados específica na guia Visão geral.
Ver métricas de instância sem servidor do Atlas
Visualize as métricas de uma instância sem servidor específica em um projeto Atlas.
Ver métricas do conjunto de réplicas do Atlas
Visualize as métricas de um conjunto de réplicas específico em um projeto Atlas.
Ver métricas de cluster fragmentado do Atlas
Visualize as métricas de um cluster fragmentado específico em um projeto Atlas.
Ver processos do MongoDB
Visualize as métricas de um processo específico do MongoDB em um cluster Atlas.
Veja métricas de desempenho em tempo real
Visualize métricas de desempenho em tempo real para uma implantação específica de
banco de dados Atlas em um projeto.
Ver métricas de pesquisa do Atlas
Visualize métricas do Atlas Search para clusters do Atlas com pelo menos um índice do
Atlas Search ativo.
Métricas importantes
Você pode monitorar as métricas a seguir para avaliar rapidamente a integridade da
implantação do seu banco de dados.

Gráfico
Descrição
Conexões
Número que indica o total de conexões ativas com a implantação do banco de dados.

Monitore as conexões para determinar se os limites de conexão atuais são suficientes. Se


necessário, atualize a camada do cluster.

Para saber mais, consulte Corrigir problemas de conexão e Corrigir perda primária.

IOPS de disco
Número que indica as operações de entrada por segundo.

Monitore se o IOPS do disco se aproxima do IOPS máximo provisionado. Determine se o


cluster pode lidar com cargas de trabalho futuras.

Para saber mais, consulte Corrigir problemas de IOPS e Corrigir perda primária.

Uso de disco
Número que indica o total de bytes de espaço em disco usado para o cluster.

Monitore o tamanho combinado dos seus dados e dos dados operacionais do MongoDB
(buffer, diário e arquivos de log) no cluster.

Para saber mais, consulte Corrigir problemas de armazenamento.

Segmentação de consulta
Número que indica a eficiência das operações de leitura executadas no MongoDB.

Monitore métricas de direcionamento de consulta para identificar consultas ineficientes.

OBSERVAÇÃO
O
mudar fluxos
os cursores que o processo Atlas Search (mongot) usa para manter os índices do Atlas
Search atualizados podem contribuir para a proporção de direcionamento de consulta e
acionar alertas de direcionamento de consulta se a proporção for alta.

Para saber mais, consulte Corrigir problemas de consulta.

CPU do sistema normalizado


Número que indica o uso da CPU de todos os processos no nó, dimensionado para um
intervalo de 0 a 100% dividindo pelo número de núcleos da CPU.
Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

Para saber mais, consulte Corrigir problemas de IOPS, Corrigir perda primária e Corrigir
problemas de uso da CPU.

Oplog GB/hora
Número que indica a taxa média em gigabytes de
registrar
dados que o primário gera por hora.

Monitore os dados do oplog para determinar se é necessário aumentar o tamanho do oplog.

Para saber mais, consulte Corrigir problemas de Oplog.

Até%
Porcentagem de tempo que as solicitações são emitidas e atendidas pelo disco. Essa
métrica inclui solicitações de qualquer processo, não apenas de processos MongoDB.

Monitore se a utilização é alta. Determine se deseja aumentar o IOPS provisionado ou


atualizar o cluster.

Para saber mais, consulte Corrigir problemas de IOPS.

Monitorando a granularidade do armazenamento de dados


O Atlas armazena dados de métricas em níveis crescentes de granularidade. Para cada
nível de granularidade crescente, o Atlas calcula os dados de métricas com base nas
médias do nível de granularidade anterior. A duração da retenção depende da
granularidade. O Atlas calcula os dados de métricas com base nas médias do nível de
granularidade anterior.

O Atlas coleta dados de métricas com granularidade de 1 minuto, a menos que você se
qualifique para monitoramento premium.

EXEMPLO
Após a coleta de dados de 48 horas, cada grupo de 60 minutos é compactado em uma
única unidade de hora. Após 63 dias, cada grupo de 24 horas é compactado em uma única
unidade de dia.

Granularidade de monitoramento premium


Se você tiver pelo menos um cluster M40 ou maior, o Atlas automaticamente
Corrigir problemas de uso da CPU
Nesta página

Condições de alerta
Gatilhos comuns
Resolva o problema imediato
Implemente uma solução de longo prazo
Monitore seu progresso
Os alertas de CPU do sistema indicam que o uso da CPU do processo MongoDB atingiu um
limite especificado. Esse limite é especificado quando o alerta é criado.

Condições de alerta
Você pode configurar as seguintes condições de alerta na página de configurações de alerta
no nível do projeto para acionar alertas.

Sistema: % de CPU (roubo) ocorre quando o uso da CPU excede a taxa de acumulação de
créditos de CPU da linha de base garantida pelo limite especificado. Para obter mais
informações sobre o acúmulo de créditos de CPU, consulte a documentação da AWS para
Instâncias de desempenho expansíveis.

OBSERVAÇÃO
O alerta Sistema: % de CPU (roubo) é aplicável quando o saldo de crédito da instância do
EC2 se esgota. O Atlas aciona esse alerta apenas para instâncias do AWS EC2 que
oferecem suporte
Instâncias de desempenho expansível
. Atualmente, estes são tipos de cluster M10 e M20.

Sistema: CPU (Usuário) % ocorre quando o uso da CPU do processo MongoDB, conforme
normalizado pelo número de CPUs, excede o limite especificado.

Gatilhos comuns
Consultas não otimizadas
pode levar a alertas de CPU do sistema. Além disso, a camada de cluster atual pode não
suportar a carga de trabalho atual.

Resolva o problema imediato


Considere adicionar um ou mais
índices
para melhorar o desempenho da consulta.

Implemente uma solução de longo prazo


Considere atualizar o seu cluster para um nível superior para reduzir a percentagem de
utilização da CPU utilizada pela carga de trabalho atual. Para obter mais informações sobre
como atualizar um cluster, consulte Modificar um cluster.

Monitore seu progresso


Visualize o gráfico de CPU do sistema normalizado para monitorar o uso da CPU de todos
os processos no nó, dimensionado para um intervalo de 0 a 100% dividindo pelo número de
núcleos de CPU.

Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

Para saber mais, consulte Exibir métricas de cluster.


Revise as métricas de implantação de banco
de dados
Nesta página

Ver métricas
Métricas importantes
Monitorando a granularidade do armazenamento de dados
Considerações sobre monitoramento de cluster gratuito e cluster compartilhado
Considerações sobre monitoramento de instâncias sem servidor
Gerenciar tags
O Atlas coleta e exibe métricas para seus servidores, bancos de dados e processos
MongoDB.

Monitore as métricas de implantação do banco de dados para identificar problemas de


desempenho e determinar se a implantação atual do banco de dados atende aos seus
requisitos. Para obter mais informações sobre as métricas disponíveis para monitorar suas
implantações de banco de dados, consulte Revisar métricas disponíveis.

OBSERVAÇÃO
O número de servidores que o Atlas exibe na página Métricas a qualquer momento depende
do tamanho da tela do navegador. Use a seção Alternar membros para controlar quais
servidores o Atlas exibe. Passe o mouse sobre os ícones S e P para descobrir quais
servidores eles representam.

Ver métricas
Ver visão geral do projeto
A visualização Implantações de banco de dados exibe todas as implantações de banco de
dados em um projeto Atlas e apresenta métricas principais por implantação de banco de
dados. Você também pode visualizar as principais métricas de uma implantação de banco
de dados específica na guia Visão geral.
Ver métricas de instância sem servidor do Atlas
Visualize as métricas de uma instância sem servidor específica em um projeto Atlas.
Ver métricas do conjunto de réplicas do Atlas
Visualize as métricas de um conjunto de réplicas específico em um projeto Atlas.
Ver métricas de cluster fragmentado do Atlas
Visualize as métricas de um cluster fragmentado específico em um projeto Atlas.
Ver processos do MongoDB
Visualize as métricas de um processo específico do MongoDB em um cluster Atlas.
Veja métricas de desempenho em tempo real
Visualize métricas de desempenho em tempo real para uma implantação específica de
banco de dados Atlas em um projeto.
Ver métricas de pesquisa do Atlas
Visualize métricas do Atlas Search para clusters do Atlas com pelo menos um índice do
Atlas Search ativo.
Métricas importantes
Você pode monitorar as métricas a seguir para avaliar rapidamente a integridade da
implantação do seu banco de dados.

Gráfico
Descrição
Conexões
Número que indica o total de conexões ativas com a implantação do banco de dados.

Monitore as conexões para determinar se os limites de conexão atuais são suficientes. Se


necessário, atualize a camada do cluster.

Para saber mais, consulte Corrigir problemas de conexão e Corrigir perda primária.

IOPS de disco
Número que indica as operações de entrada por segundo.

Monitore se o IOPS do disco se aproxima do IOPS máximo provisionado. Determine se o


cluster pode lidar com cargas de trabalho futuras.

Para saber mais, consulte Corrigir problemas de IOPS e Corrigir perda primária.

Uso de disco
Número que indica o total de bytes de espaço em disco usado para o cluster.

Monitore o tamanho combinado dos seus dados e dos dados operacionais do MongoDB
(buffer, diário e arquivos de log) no cluster.

Para saber mais, consulte Corrigir problemas de armazenamento.

Segmentação de consulta
Número que indica a eficiência das operações de leitura executadas no MongoDB.

Monitore métricas de direcionamento de consulta para identificar consultas ineficientes.

OBSERVAÇÃO
O
mudar fluxos
os cursores que o processo Atlas Search (mongot) usa para manter os índices do Atlas
Search atualizados podem contribuir para a proporção de direcionamento de consulta e
acionar alertas de direcionamento de consulta se a proporção for alta.

Para saber mais, consulte Corrigir problemas de consulta.

CPU do sistema normalizado


Número que indica o uso da CPU de todos os processos no nó, dimensionado para um
intervalo de 0 a 100% dividindo pelo número de núcleos da CPU.
Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

Para saber mais, consulte Corrigir problemas de IOPS, Corrigir perda primária e Corrigir
problemas de uso da CPU.

Oplog GB/hora
Número que indica a taxa média em gigabytes de
registrar
dados que o primário gera por hora.

Monitore os dados do oplog para determinar se é necessário aumentar o tamanho do oplog.

Para saber mais, consulte Corrigir problemas de Oplog.

Até%
Porcentagem de tempo que as solicitações são emitidas e atendidas pelo disco. Essa
métrica inclui solicitações de qualquer processo, não apenas de processos MongoDB.

Monitore se a utilização é alta. Determine se deseja aumentar o IOPS provisionado ou


atualizar o cluster.

Para saber mais, consulte Corrigir problemas de IOPS.

Monitorando a granularidade do armazenamento de dados


O Atlas armazena dados de métricas em níveis crescentes de granularidade. Para cada
nível de granularidade crescente, o Atlas calcula os dados de métricas com base nas
médias do nível de granularidade anterior. A duração da retenção depende da
granularidade. O Atlas calcula os dados de métricas com base nas médias do nível de
granularidade anterior.

O Atlas coleta dados de métricas com granularidade de 1 minuto, a menos que você se
qualifique para monitoramento premium.

EXEMPLO
Após a coleta de dados de 48 horas, cada grupo de 60 minutos é compactado em uma
única unidade de hora. Após 63 dias, cada grupo de 24 horas é compactado em uma única
unidade de dia.

Granularidade de monitoramento premium


Se você tiver pelo menos um cluster M40 ou maior, o Atlas automaticamente permite
monitoramento premium para todos os clusters do projeto. Com o monitoramento premium
habilitado, o Atlas coleta dados de métricas com granularidade de 10 segundos. O
monitoramento premium permanece habilitado para todos os clusters do projeto até você
fazer downgrade ou encerrar seu último cluster M40.

Retenção de dados de métricas


O Atlas retém dados de métricas por um período que depende da granularidade dos dados:

Período de dados
Duração da retenção
10 segundos
8 horas
1 minuto
48 horas
5 minutos
48 horas
1 hora
63 dias
1 dia
Para sempre

Monitoramento premium
apenas.

O Atlas retém todas as estatísticas específicas do banco de dados. Os dados de log do


MongoDB são retidos a uma taxa máxima de 2.000 linhas por 2 minutos.

Considerações sobre monitoramento de cluster gratuito e cluster compartilhado


Clusters gratuitos M0 e clusters compartilhados M2/M5 suportam um subconjunto de
métricas e gráficos disponíveis. Para obter documentação completa sobre as limitações dos
clusters M0/M2/M5, consulte Limitações do Atlas M0 (cluster gratuito), M2 e M5.

O Atlas pausa o monitoramento de clusters livres M0 que não tiveram atividade de conexão
por 7 dias. O monitoramento é retomado assim que ocorre uma conexão bem-sucedida por
meio da API de administração do Atlas, Driver,
mangusto
ou Explorador de dados.

Considerações sobre monitoramento de instâncias sem servidor


As instâncias sem servidor oferecem suporte a um subconjunto de métricas e gráficos
disponíveis. Para obter documentação completa sobre as limitações de instâncias sem
servidor, consulte Limitações de instâncias sem servidor.

Gerenciar tags
Você pode adicionar uma tag, visualizar tags existentes e gerenciar tags na página
Implantações de banco de dados ou na página Visão geral. Para saber mais, consulte
Gerenciar tags na página Implantações de banco de dados e Gerenciar tags na página
Visão geral.

IMPORTANTE
Não inclua informações confidenciais, como informações de identificação pessoal (PII) ou
informações de saúde protegidas (PHI) em suas tags de recursos. Outros serviços
MongoDB, como Billing, podem acessar tags de recursos. As tags de recursos não se
destinam a dados privados e confidenciais. Para saber mais, consulte Informações
confidenciais.
Revise a visão geral do projeto
CLI do Atlas

IU do Atlas
Você pode visualizar métricas selecionadas do projeto usando o Atlas CLI.

Ver métricas de disco


Para retornar as métricas de uma partição de disco em um host especificado usando a CLI
do Atlas, execute o seguinte comando:

discos de métricas do atlas descrevem <hostname:port> <diskName> [opções]

Para listar discos ou partições de disco disponíveis em um host especificado usando a CLI
do Atlas, execute o seguinte comando:

lista de discos de métricas do atlas <hostname:port> [opções]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
discos de métricas do atlas descrevem
e
lista de discos de métricas do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Monitore as métricas de implantação do banco de dados para identificar problemas de


desempenho e determinar se a implantação atual do banco de dados atende aos seus
requisitos. Para obter mais informações sobre as métricas disponíveis para monitorar suas
implantações de banco de dados, consulte Revisar métricas disponíveis.

Gráficos disponíveis
O Atlas exibe até quatro dos seguintes gráficos para cada implantação de banco de dados
no projeto:

OBSERVAÇÃO
Atualmente, as métricas de instância sem servidor não oferecem suporte a serviços de
terceiros (por exemplo,
Cão de dados
).

OBSERVAÇÃO
Monitorando a granularidade do armazenamento de dados
O Atlas armazena dados de métricas em níveis crescentes de granularidade. Para obter
mais informações, consulte Monitorando a granularidade do armazenamento de dados.

Gráfico
Dados
Caso de uso
Conexões
O número total de conexões ativas com a implantação do banco de dados

Para um conjunto de réplicas, o gráfico mostra o número de conexões ativas com o


primário.

Para um cluster fragmentado, o gráfico mostra a soma de todas as conexões ativas com
cada primário no cluster.

Monitore as conexões para determinar se os limites de conexão atuais são suficientes. Se


necessário, atualize a camada do cluster.

Tamanho dos dados

Somente instâncias sem servidor

Exibe a quantidade de espaço de armazenamento em bytes que seus dados armazenados


usam.
Monitore o espaço de armazenamento para determinar se deve usar o escalonamento
automático do disco ou aumentar manualmente o tamanho do disco. Você também pode
monitorar essa métrica para verificar o faturamento de backup.

IOPS de disco

Somente clusters M10+

A soma de operações de entrada/saída de leitura e gravação por segundo (IOPS) para o


cluster.
Monitore se o IOPS do disco se aproxima do IOPS máximo provisionado. Determine se o
cluster pode lidar com cargas de trabalho futuras.

Latência de disco 1
A latência, em milissegundos, da partição de disco usada pelo MongoDB.
Monitore a latência do disco para determinar o tempo médio de leitura ou gravação no
disco.
Uso de disco

Somente instâncias sem servidor e clusters M10+

O total de bytes de espaço em disco usado para a implementação do banco de dados.


Para um conjunto de réplicas, o gráfico mostra o uso do disco da máquina host primária.

Para um cluster fragmentado, o gráfico mostra a soma do uso do disco em cada host
primário do cluster.

O gráfico de linhas é verde para menos de 75% de uso do disco, amarelo para 75% a 89%
de uso do disco e vermelho para 90% ou mais de uso do disco.

Monitore o tamanho combinado dos seus dados e dos dados operacionais do MongoDB
(buffer, diário e arquivos de log) no cluster.

Tamanho Lógico

Somente clusters M0/M2/M5

Exibe a soma do total de bytes dos documentos e dados de índice em todos os bancos de
dados na implantação do banco de dados.

O gráfico de linhas é verde para menos de 75% do tamanho máximo de armazenamento,


amarelo para 75%-89% do tamanho máximo de armazenamento e vermelho para 90% ou
mais do tamanho máximo de armazenamento.

Monitore o tamanho dos documentos e indexe os dados na implantação do banco de dados.


Rede

Somente instâncias sem servidor e clusters M0/M2/M5

Exibe a taxa média de bytes físicos ou solicitações enviadas de/para este servidor de banco
de dados por segundo durante o período de amostra selecionado.
Monitore as métricas da rede para monitorar o desempenho da rede.
Operações
Exibe as operações agregadas de leitura (R) e gravação (W) na implantação do banco de
dados.

Para um conjunto de réplicas, o gráfico mostra as operações do primário.

Para um cluster fragmentado, o gráfico mostra a soma das operações em cada primário do
cluster.

Monitore problemas de desempenho relacionados a altas cargas de trabalho.


Tamanho total do índice

Somente clusters M10+

O total de bytes de espaço em disco usado pelos índices de cada banco de dados no
cluster.
Monitore o tamanho de todos os índices em seu cluster.
Até% 1
A porcentagem de tempo durante o qual a partição recebe e atende solicitações. Essa
métrica inclui solicitações de todos os processos, não apenas dos processos do MongoDB.
Monitore se a utilização é alta. Determine se deseja aumentar o IOPS provisionado ou
atualizar o cluster.

1 Clusters que usam SSDs NVMe para armazenamento exibem gráficos de latência de
disco usando o valor máximo nas unidades físicas que compõem o RAID. As seguintes
camadas de cluster exibem métricas baseadas em RAID se usarem NVMe:

M80

M200

M400
Revise as métricas sem servidor
Nesta página

Controles de gráfico
Exibição de gráfico
Seleção de gráfico
Para visualizar as métricas de uma instância específica sem servidor do Atlas na
visualização Banco de dados de um projeto, clique no botão Exibir monitoramento dessa
instância sem servidor. Como alternativa, clique no nome da instância sem servidor para
abrir a visão geral e clique em Monitoramento e na guia Métricas.

Monitore as métricas de implantação do banco de dados para identificar problemas de


desempenho e determinar se a implantação atual do banco de dados atende aos seus
requisitos. Para obter mais informações sobre as métricas disponíveis para monitorar suas
implantações de banco de dados, consulte Revisar métricas disponíveis.

A visualização Métricas tem três seções distintas:

OBSERVAÇÃO
Monitorando a granularidade do armazenamento de dados
O Atlas armazena dados de métricas em níveis crescentes de granularidade. Para obter
mais informações, consulte Monitorando a granularidade do armazenamento de dados.

Controles de gráfico
O Atlas fornece os seguintes controles para a visualização Métrica. O ajuste de qualquer
uma dessas opções afeta todos os gráficos exibidos na visualização Métricas:

Ao controle
Função
Granularidade
Modifica a granularidade das métricas exibidas para cada gráfico. Selecione uma
granularidade, geralmente entre 1 minuto e 1 dia (24 horas). Selecione Automático para
ajustar automaticamente a granularidade com base nos controles de data Zoom ou Exibição
Atual selecionados. A granularidade automática seleciona a granularidade de maior
fidelidade disponível para o intervalo de tempo.

OBSERVAÇÃO
O Atlas oferece suporte a granularidade de 10 segundos apenas em clusters M40 e
maiores. Para saber mais, consulte Granularidade do monitoramento Premium.

Ampliação
Modifica o intervalo de datas das métricas exibidas para cada gráfico. Selecione um
intervalo de zoom entre 1 hora e 5 anos. Ajustar o zoom ajusta automaticamente o intervalo
de datas da exibição atual.
Filtrar por intervalo de tempo
Modifica o intervalo de data e hora de início e término das métricas exibidas para cada
gráfico. A modificação das datas de início e término define o valor de Zoom como
personalizado e substitui o nível de zoom selecionado anteriormente.
Adicionar gráfico
Selecione um ou mais gráficos para exibir ou ocultar.
Métricas de Opcounters de Grupo
Orienta o Atlas a agrupar os componentes individuais do gráfico Opcounters.
Exibição de gráfico
Ao visualizar gráficos, você pode fazer o seguinte:

Tarefa
Ação
Veja uma descrição detalhada de um gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique ao lado do nome do gráfico para abrir o modal Informações do gráfico. Este modal
inclui um detalhamento da série de dados do gráfico, as anotações disponíveis para esse
gráfico e as operações que o gráfico suporta.

Amplie um período de tempo.


Clique e arraste o ponteiro do mouse sobre uma parte do gráfico.

Para redefinir para o intervalo selecionado originalmente (menos zoom), clique duas vezes
no gráfico.

OBSERVAÇÃO
Quando você amplia um período de tempo, o intervalo de datas de exibição atual na seção
de controle do gráfico é atualizado automaticamente para refletir o período selecionado.

Veja estatísticas em um determinado momento.


Passe o ponteiro do mouse sobre um ponto do gráfico.
Mova um gráfico.
Clique e segure o botão no canto superior esquerdo do gráfico e arraste o gráfico para a
nova posição.
Visualize um gráfico em formato de lista ou bloco.
Clique na alternância de lista e bloco para alternar entre a visualização de lista e de bloco.
Seleção de gráfico
O Atlas exibe as métricas disponíveis para gráfico da instância sem servidor selecionada no
cabeçalho Toggle Charts.

OBSERVAÇÃO
Atualmente, as métricas de instância sem servidor não oferecem suporte a serviços de
terceiros (por exemplo,
Cão de dados
).

Conexões
Número que indica o total de conexões ativas com a implantação do banco de dados.
Monitore as conexões para determinar se os limites de conexão atuais são suficientes. Se
necessário, atualize a camada do cluster.

Tamanho dos dados


O número indica a quantidade de espaço de armazenamento em bytes que seus dados
armazenados usam.

Monitore o espaço de armazenamento para determinar se deve usar o escalonamento


automático do disco ou aumentar manualmente o tamanho do disco. Você também pode
monitorar essa métrica para verificar o faturamento de backup.

Tempo de execução
Métricas que indicam o tempo médio em segundos para executar operações.

Monitore o tempo de execução para aumentar as operações de leitura para otimizar


consultas e índices.

Rede
Métricas que indicam o desempenho da rede.

Monitore as métricas da rede para monitorar o desempenho da rede.

Contadores
Métricas que indicam as operações por segundo executadas em um processo MongoDB
desde o último início do processo.

Monitore as operações do MongoDB para validar problemas de desempenho relacionados a


altas cargas de trabalho. Confirme o tipo de operações responsáveis pela carga.

Unidades de leitura/gravação
Métricas que indicam o total de unidades de processamento de leitura (RPUs) e o total de
unidades de processamento de gravação (WPUs).

Monitore unidades de leitura e gravação para ajudar a otimizar consultas e índices.


Revise os clusters do conjunto de réplicas
Nesta página

Exibir métricas do conjunto de réplicas


Controles de gráfico
Exibição de gráfico
Seleção de gráfico
A
conjunto de réplicas
no MongoDB é um grupo de
mondeus
processos que mantêm o mesmo conjunto de dados.

Monitore as métricas de implantação do banco de dados para identificar problemas de


desempenho e determinar se a implantação atual do banco de dados atende aos seus
requisitos. Para obter mais informações sobre as métricas disponíveis para monitorar suas
implantações de banco de dados, consulte Revisar métricas disponíveis.

Exibir métricas do conjunto de réplicas

CLI do Atlas

IU do Atlas
Para retornar as métricas de um banco de dados no host especificado de um conjunto de
réplicas usando a CLI do Atlas, execute o seguinte comando:

bancos de dados de métricas atlas descrevem <hostname:port> <databaseName> [opções]

Para listar os bancos de dados disponíveis para o host especificado do conjunto de réplicas
usando a CLI do Atlas, execute o seguinte comando:

lista de bancos de dados de métricas do atlas <hostname:port> [opções]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
bancos de dados de métricas do atlas descrevem
e
lista de bancos de dados de métricas do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

A visualização Métricas na UI do Atlas tem três seções distintas:


OBSERVAÇÃO
Monitorando a granularidade do armazenamento de dados
O Atlas armazena dados de métricas em níveis crescentes de granularidade. Para obter
mais informações, consulte Monitorando a granularidade do armazenamento de dados.

Controles de gráfico
O Atlas fornece os seguintes controles para a visualização Métrica. O ajuste de qualquer
uma dessas opções afeta todos os gráficos exibidos na visualização Métricas:

Ao controle
Função
Granularidade
Modifica a granularidade das métricas exibidas para cada gráfico. Selecione uma
granularidade, geralmente entre 1 minuto e 1 dia (24 horas). Selecione Automático para
ajustar automaticamente a granularidade com base nos controles de data Zoom ou Exibição
Atual selecionados. A granularidade automática seleciona a granularidade de maior
fidelidade disponível para o intervalo de tempo.

OBSERVAÇÃO
O Atlas oferece suporte a granularidade de 10 segundos apenas em clusters M40 e
maiores. Para saber mais, consulte Granularidade do monitoramento Premium.

Ampliação
Modifica o intervalo de datas das métricas exibidas para cada gráfico. Selecione um
intervalo de zoom entre 1 hora e 5 anos. Ajustar o zoom ajusta automaticamente o intervalo
de datas da exibição atual.
Exibição Atual
Modifica o intervalo de data e hora de início e término das métricas exibidas para cada
gráfico. A modificação das datas de início e término define o valor de Zoom como
personalizado e substitui o nível de zoom selecionado anteriormente.
Alternar membros
Limite os gráficos aos membros do conjunto de réplicas selecionados. O ícone P representa
o
primário
membro do conjunto de réplicas, enquanto o ícone S representa um
secundário
membro.

OBSERVAÇÃO
Quando um membro secundário precisa replicar dados para alcançar o nó primário, ele
entra no nó primário.
recuperando
estado.

O ícone R amarelo claro representa um membro que está se recuperando.


O ícone R amarelo escuro representa um membro que ficou muito atrás do oplog do
primário e agora está preso no estado de recuperação. Quando isso acontecer, você deve
sincronizar novamente o membro.

Para obter informações sobre todos os estados membros, consulte


Estados-membros do conjunto de réplicas.

Adicionar gráfico
Selecione um ou mais gráficos para exibir ou ocultar. Adicionar gráficos usando esse menu
suspenso é idêntico a adicionar gráficos na seção Alternar gráficos da visualização
Métricas.
Exibir Opcounters em Gráficos Separados
Orienta o Atlas a dividir o gráfico Opcounters em seus componentes individuais. Você pode
então optar por traçar um ou mais desses componentes.
Exibir anotações da linha do tempo
Instrui o Atlas a exibir ou ocultar anotações do gráfico. As anotações do gráfico consistem
em linhas verticais coloridas que indicam eventos do servidor, como reinicialização do
servidor ou transição no estado membro.
Exibição de gráfico
Ao visualizar gráficos, você pode fazer o seguinte:

Tarefa
Ação
Veja uma descrição detalhada de um gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique ao lado do nome do gráfico para abrir o modal Informações do gráfico. Este modal
inclui um detalhamento da série de dados do gráfico, as anotações disponíveis para esse
gráfico e as operações que o gráfico suporta.

Expanda um gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique na seta bidirecional no canto superior direito do gráfico.

Amplie um período de tempo.


Clique e arraste o ponteiro do mouse sobre uma parte do gráfico.

Para redefinir para o intervalo selecionado originalmente (menos zoom), clique duas vezes
no gráfico.

OBSERVAÇÃO
Quando você amplia um período de tempo, o intervalo de datas de exibição atual na seção
de controle do gráfico é atualizado automaticamente para refletir o período selecionado.

Veja estatísticas em um determinado momento.


Passe o ponteiro do mouse sobre um ponto do gráfico.
Mova um gráfico.
Clique e segure o botão no canto superior esquerdo do gráfico e arraste o gráfico para a
nova posição.
Compartilhe um URL para o gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique na seta curva no gráfico. Selecione Link permanente do gráfico para recuperar um
URL para o gráfico. Selecione Gráfico por e-mail para enviar o gráfico por e-mail.

O destinatário da URL do gráfico deve ter uma conta de usuário Atlas com acesso ao
projeto e ao cluster.

Seleção de gráfico
Atlas exibe as métricas disponíveis para gráfico do cluster selecionado no cabeçalho Toggle
Charts. As métricas são agrupadas em duas seções:

Métricas do MongoDB
Métricas associadas ao processo MongoDB. Para métricas relacionadas ao desempenho do
banco de dados, como armazenamento de banco de dados, o Atlas apresenta a soma total
de todos os bancos de dados do cluster.

OBSERVAÇÃO
O Atlas recupera métricas do banco de dados a cada 20 minutos por padrão, mas ajusta a
frequência quando necessário para reduzir o impacto no desempenho do banco de dados.

Se você ativar Exibir contadores de opções em gráficos separados, o Atlas substituirá a


opção Contadores de opções pelos componentes individuais desse gráfico.

Métricas de hardware
Métricas associadas às máquinas host que dão suporte ao cluster.

Os gráficos marcados com o símbolo + estão inativos, enquanto os gráficos marcados com
o símbolo - estão ativos. Clique em qualquer gráfico para alternar o estado do gráfico.
Revise clusters fragmentados
Nesta página

Controles de gráfico
Exibição de gráfico
Fontes de dados
A
cluster fragmentado
é o conjunto de nós que compreende uma implantação fragmentada do MongoDB. Para
visualizar as métricas de um cluster Atlas específico em um projeto, clique no botão
Visualizar monitoramento desse cluster. Como alternativa, clique no nome do cluster para
abrir a visão geral do cluster e clique na guia Métricas.

A guia Métricas para clusters fragmentados fornece uma comparação lado a lado de
fragmentos em uma visualização. O menu suspenso Exibir contém muitas métricas
disponíveis.

Monitore as métricas de implantação do banco de dados para identificar problemas de


desempenho e determinar se a implantação atual do banco de dados atende aos seus
requisitos. Para obter mais informações sobre as métricas disponíveis para monitorar suas
implantações de banco de dados, consulte Revisar métricas disponíveis.

A visualização Métricas tem três seções distintas:

OBSERVAÇÃO
Monitorando a granularidade do armazenamento de dados
O Atlas armazena dados de métricas em níveis crescentes de granularidade. Para obter
mais informações, consulte Monitorando a granularidade do armazenamento de dados.

Controles de gráfico
O Atlas fornece os seguintes controles para a visualização Métrica:

Ao controle
Função
Granularidade
Modifica a granularidade das métricas exibidas para cada gráfico. Selecione uma
granularidade, geralmente entre 1 minuto e 1 dia (24 horas). Selecione Automático para
ajustar automaticamente a granularidade com base nos controles de data Zoom ou Exibição
Atual selecionados.

A granularidade automática seleciona a granularidade de maior fidelidade disponível dentro


do intervalo de tempo selecionado e dos limites de renderização de métricas de cluster
fragmentado.

OBSERVAÇÃO
Limites de renderização de métricas de cluster fragmentado
Na visualização de métricas do Cluster Fragmentado, o Atlas renderiza no máximo:
100.000 pontos de dados totais e

3.000 pontos de dados para uma única série.

Como resultado, ao renderizar métricas para grandes implantações durante um longo


período de tempo, o Atlas pode exibir métricas com uma granularidade menor do que o
esperado. Para saber mais sobre a granularidade com que o Atlas armazena dados
métricos, consulte Monitorando a granularidade do armazenamento de dados.

OBSERVAÇÃO
O Atlas oferece suporte a granularidade de 10 segundos apenas em clusters M40 e
maiores. Para saber mais, consulte Granularidade do monitoramento Premium.

Ampliação
Modifica o intervalo de datas das métricas exibidas para cada gráfico. Selecione um
intervalo de zoom entre 1 hora e 5 anos. Ajustar o zoom ajusta automaticamente o intervalo
de datas da exibição atual.
Exibição Atual
Modifica o intervalo de data e hora de início e término das métricas exibidas para cada
gráfico. A modificação das datas de início e término define o valor de Zoom como
personalizado e substitui o nível de zoom selecionado anteriormente.
Mostrar
Seleciona qual métrica será traçada. Você não pode exibir mais de um gráfico por vez.
Mostrar dados
Direciona o Atlas para exibir dados com base na opção selecionada

Individualmente – exibe as métricas selecionadas para cada fragmento como uma linha
individual.

Soma – exibe a soma das métricas selecionadas em todos os fragmentos do cluster.

Média – exibe a média das métricas selecionadas em todos os fragmentos do cluster.

Visualizar
Seleciona quais componentes do cluster fragmentado serão exibidos

SHARDS – exibe métricas para cada fragmento no cluster fragmentado.

MONGOS - exibe métricas para cada


mongos
no cluster fragmentado.

CONFIGS – exibe métricas para o servidor de configuração no conjunto de réplicas do


servidor de configuração de cluster fragmentado.

Exibição de gráfico
Ao visualizar gráficos, você pode fazer o seguinte:
Tarefa
Ação
Amplie um período de tempo.
Clique e arraste o ponteiro do mouse sobre uma parte do gráfico. Para redefinir para o
intervalo selecionado originalmente (menos zoom), clique duas vezes no gráfico.

OBSERVAÇÃO
Quando você amplia um período de tempo, o intervalo de datas de exibição atual na seção
de controle do gráfico é atualizado automaticamente para refletir o período selecionado.

Veja estatísticas em um determinado momento.


Passe o ponteiro do mouse sobre um ponto do gráfico.
Fontes de dados
O Atlas exibe cada fonte de dados que contribui para o gráfico de métricas em uma tabela
abaixo do gráfico. A tabela consiste no seguinte:

Coluna
Descrição
Nome do fragmento
Quando Visualizar está definido como SHARDS, exibe o nome de cada fragmento no
cluster fragmentado.

Quando View está definido como MONGOS ou CONFIGS, exibe o nome de cada
mongos
ou servidor de configuração
mondeus
processo no cluster.

Clique em um componente listado para abrir a visualização Métricas desse componente.

Alertas
Indica se há algum alerta aberto para o fragmento ou processo listado. Clique no ícone de
alerta para abrir a visualização Alertas desse fragmento ou processo. Para obter mais
informações sobre como responder a alertas abertos, consulte Resolver alertas.
Tamanho dos dados
Visível apenas se a Visualização estiver definida como SHARDS.

Indica o tamanho lógico de todos os documentos e índices no fragmento.

Mostrar
Visível apenas se a Visualização estiver definida como SHARDS

Indica quais membros do conjunto de réplicas serão exibidos no gráfico selecionado.


Selecione Primários, Secundários ou Todos.

Ler, escrever e colocar na fila


Dados métricos relacionados ao gráfico exibido. Passe o mouse sobre a coluna
correspondente para ver um pop-up com informações detalhadas sobre as métricas
mostradas.
Revise os processos do MongoDB
Nesta página

Controles de gráfico
Exibição de gráfico
Seleção de gráfico
Monitore as métricas de implantação do banco de dados para identificar problemas de
desempenho e determinar se a implantação atual do banco de dados atende aos seus
requisitos. Para obter mais informações sobre as métricas disponíveis para monitorar suas
implantações de banco de dados, consulte Revisar métricas disponíveis.

CLI do Atlas

IU do Atlas
Para retornar os detalhes do processo MongoDB especificado usando a CLI do Atlas,
execute o seguinte comando:

os processos do atlas descrevem <hostname:port> [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
processos do atlas descrevem.

Para listar os processos do MongoDB para o seu projeto usando a CLI do Atlas, execute o
seguinte comando:

lista de processos do atlas [opções]

Para listar os processos do MongoDB para o host especificado usando a CLI do Atlas,
execute o seguinte comando:

processos de métricas do atlas <hostname:port> [opções]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
lista de processos do atlas
e
processos de métricas do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Controles de gráfico
O Atlas fornece os seguintes controles para as visualizações Status, Hardware e
Estatísticas do banco de dados. O ajuste de qualquer uma dessas opções afeta todos os
gráficos exibidos na visualização selecionada:

Ao controle
Função
Granularidade
Modifica a granularidade das métricas exibidas para cada gráfico. Selecione uma
granularidade, geralmente entre 1 minuto e 1 dia (24 horas). Selecione Automático para
ajustar automaticamente a granularidade com base nos controles de data Zoom ou Exibição
Atual selecionados. A granularidade automática seleciona a granularidade de maior
fidelidade disponível para o intervalo de tempo.

OBSERVAÇÃO
O Atlas oferece suporte a granularidade de 10 segundos apenas em clusters M40 e
maiores. Para saber mais, consulte Granularidade do monitoramento Premium.

Ampliação
Modifica o intervalo de datas das métricas exibidas para cada gráfico. Selecione um
intervalo de zoom entre 1 hora e 5 anos. Ajustar o zoom ajusta automaticamente o intervalo
de datas da exibição atual.
Exibição Atual
Modifica o intervalo de data e hora de início e término das métricas exibidas para cada
gráfico. A modificação das datas de início e término define o valor de Zoom como
personalizado e substitui o nível de zoom selecionado anteriormente.
Adicionar gráfico
Selecione um ou mais gráficos para exibir ou ocultar. Adicionar gráficos usando esse menu
suspenso é idêntico a adicionar gráficos na seção Alternar gráficos da visualização
Métricas.
Selecione banco de dados
Visível apenas para a visualização DB Stats. Seleciona o banco de dados para o qual exibir
métricas.
Exibir Opcounters em Gráficos Separados
Orienta o Atlas a dividir o gráfico Opcounters em seus componentes individuais. Você pode
então optar por traçar um ou mais desses componentes. Se você marcar esta caixa de
seleção, o Atlas exibirá o número das seguintes operações por segundo em um processo
mongot:

excluir

pegue mais

inserir

atualizar

Se você implantou nós de pesquisa para isolamento de carga de trabalho, não poderá
visualizar contadores de operação em gráficos separados na guia Nós de Pesquisa. Você
pode agrupar métricas de contadores de operação na guia Nós de pesquisa marcando a
caixa de seleção Agrupar métricas de contadores de operação.

Exibir anotações da linha do tempo


Instrui o Atlas a exibir ou ocultar anotações do gráfico. As anotações do gráfico consistem
em linhas verticais coloridas que indicam eventos do servidor, como reinicialização do
servidor ou transição no estado membro. Se você implementou nós de pesquisa para
isolamento de carga de trabalho, não poderá exibir ou ocultar anotações de gráfico na guia
Nós de Pesquisa.
Exibição de gráfico
Ao visualizar gráficos, você pode fazer o seguinte:

Tarefa
Ação
Veja uma descrição detalhada de um gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique ao lado do nome do gráfico para abrir o modal Informações do gráfico. Este modal
inclui um detalhamento da série de dados do gráfico, as anotações disponíveis para esse
gráfico e as operações que o gráfico suporta.

Expanda um gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique na seta bidirecional no canto superior direito do gráfico.

Amplie um período de tempo.


Clique e arraste o ponteiro do mouse sobre uma parte do gráfico.

Para redefinir para o intervalo selecionado originalmente (menos zoom), clique duas vezes
no gráfico.

OBSERVAÇÃO
Quando você amplia um período de tempo, o intervalo de datas de exibição atual na seção
de controle do gráfico é atualizado automaticamente para refletir o período selecionado.

Veja estatísticas em um determinado momento.


Passe o ponteiro do mouse sobre um ponto do gráfico.
Mova um gráfico.
Clique e segure o botão no canto superior esquerdo do gráfico e arraste o gráfico para a
nova posição.
Compartilhe um URL para o gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique na seta curva no gráfico. Selecione Link permanente do gráfico para recuperar um
URL para o gráfico. Selecione Gráfico por e-mail para enviar o gráfico por e-mail.
O destinatário da URL do gráfico deve ter uma conta de usuário Atlas com acesso ao
projeto e ao cluster.

Seleção de gráfico
Atlas exibe as métricas disponíveis para gráfico para o cluster selecionado no cabeçalho
Toggle Charts.

Os gráficos marcados com o símbolo + estão inativos, enquanto os gráficos marcados com
o símbolo - estão ativos. Clique k em qualquer gráfico para alternar o estado do gráfico.
Revise as métricas em tempo real
OBSERVAÇÃO
Disponibilidade
Atlas oferece suporte a métricas de desempenho em tempo real para processos mongod ou
mongos e clusters de conjuntos de réplicas. Para clusters fragmentados, você pode
visualizar métricas de desempenho em tempo real para cada conjunto de réplicas de
fragmentos. Você deve ter a função de usuário Project Owner Atlas para acessar a guia
Tempo Real.

Para visualizar métricas de desempenho em tempo real para um cluster Atlas específico em
um projeto, clique no botão Visualizar monitoramento desse cluster. Como alternativa, clique
no nome do cluster para abrir a visão geral do cluster e clique na guia Métricas. Na guia
Métricas, clique em Tempo Real para abrir o Painel de Desempenho em Tempo Real. O
monitoramento de métricas em tempo real permite que você responda imediatamente a
problemas urgentes.

Monitore as métricas de implantação do banco de dados para identificar problemas de


desempenho e determinar se a implantação atual do banco de dados atende aos seus
requisitos. Para obter mais informações sobre as métricas disponíveis para monitorar suas
implantações de banco de dados, consulte Revisar métricas disponíveis.

Para obter documentação completa sobre as métricas de desempenho em tempo real do


Atlas, consulte Painel de desempenho em tempo real.

OBSERVAÇÃO
Monitorando a granularidade do armazenamento de dados
O Atlas armazena dados de métricas em níveis crescentes de granularidade. Para obter
mais informações, consulte Monitorando a granularidade do armazenamento de dados.
Revise as métricas de pesquisa do Atlas
Nesta página

Acesso obrigatório
Ver métricas de pesquisa do Atlas
Controles de gráfico
Exibição de gráfico
Seleção de gráfico
OBSERVAÇÃO
Disponibilidade
O Atlas fornece métricas do Atlas Search para implantações de banco de dados com pelo
menos um índice ativo do Atlas Search. Para configurar um índice do Atlas Search, consulte
O que é o MongoDB Atlas Search?.

Os clusters M0 (nível gratuito) não oferecem suporte a essas métricas.

Acesso obrigatório
Para visualizar os índices do Atlas Search, você deve ter acesso somente leitura ou
superior ao projeto.

Ver métricas de pesquisa do Atlas


Para visualizar métricas do Atlas Search para uma implantação de banco de dados:

Clique no botão Exibir monitoramento para essa implantação de banco de dados.

Se você implementou nós de procura para isolamento de carga de trabalho, clique na guia
Nós de procura para visualizar as métricas do Atlas Search e as métricas de hardware para
os nós de procura.

A guia Conjunto de réplicas exibe o MongoDB e as métricas de hardware do conjunto de


réplicas.

Selecione um ou mais gráficos de pesquisa.

Alternativamente:

Clique no nome da implantação do banco de dados para abrir a visão geral da implantação
do banco de dados.

Clique na guia Métricas.

Se você implementou nós de procura para isolamento de carga de trabalho, clique na guia
Nós de procura para visualizar as métricas do Atlas Search e as métricas de hardware para
os nós de procura.
A guia Conjunto de réplicas exibe o MongoDB e as métricas de hardware do conjunto de
réplicas.

Selecione um ou mais gráficos de pesquisa.

Se você implementou nós de procura para isolamento de carga de trabalho, também poderá
visualizar as métricas do Atlas Search e as métricas de hardware para seus nós de procura
clicando na guia Visualizar Métricas de Procura em sua página Procurar depois de criar um
índice do Atlas Search.

Se você não implantou nós de pesquisa separadamente, para visualizar as métricas do


Atlas Search para um processo específico:

Clique no link do processo.

Clique na guia Métricas de pesquisa.

Monitore as métricas de implantação do banco de dados para identificar problemas de


desempenho e determinar se a implantação atual do banco de dados atende aos seus
requisitos. Para obter mais informações sobre as métricas disponíveis para monitorar suas
implantações de banco de dados, consulte Revisar métricas disponíveis.

As seguintes métricas do Atlas Search estão disponíveis para avaliar e otimizar seus
índices do Atlas Search:

Gráfico
Dados
Pesquisar espaço em disco usado
Total de bytes de espaço em disco ocupado pelos índices de pesquisa.
Campos de pesquisa indexados
Número total de campos exclusivos presentes no índice Atlas Search.
Tamanho do índice de pesquisa
Tamanho total de todos os índices no disco em bytes.
Pesquisar memória heap JVM
Quantidade de memória que o heap JVM está usando atualmente.
Pesquisar número máximo de documentos Lucene
Limite superior do número de documentos Lucene usados para armazenar índices do Atlas
Search neste conjunto de réplicas ou fragmento.
Atraso máximo de replicação da pesquisa
Número aproximado de milissegundos que o Atlas Search está atrasado na replicação de
alterações do
registrar
de
mondeus
.
Pesquisar CPU de processo normalizado
O uso da CPU dos processos de pesquisa no nó foi dimensionado para um intervalo de 0 a
100%, dividindo-se pelo número de núcleos da CPU.
Pesquisar contadores
Número total de operações do Atlas Search.
CPU do processo de pesquisa
Porcentagem de tempo que a CPU gastou atendendo processos de pesquisa. Para
servidores com mais de 1 núcleo de CPU, esse valor pode ultrapassar 100%.
Memória do Processo de Pesquisa
Total de bytes de memória ocupados pelos processos de pesquisa.
Status da consulta de pesquisa
Número total de consultas do Atlas Search com cada status.
OBSERVAÇÃO
Monitorando a granularidade do armazenamento de dados
O Atlas armazena dados de métricas em níveis crescentes de granularidade. Para obter
mais informações, consulte Monitorando a granularidade do armazenamento de dados.

Controles de gráfico
O Atlas fornece os seguintes controles para os gráficos de métricas. O ajuste de qualquer
uma dessas opções afeta todos os gráficos exibidos na visualização selecionada:

Ao controle
Função
Granularidade
Modifica a granularidade das métricas exibidas para cada gráfico. Selecione uma
granularidade, geralmente entre 1 minuto e 1 dia (24 horas). Selecione Automático para
ajustar automaticamente a granularidade com base nos controles de data Zoom ou Exibição
Atual selecionados. A granularidade automática seleciona a granularidade de maior
fidelidade disponível para o intervalo de tempo.

OBSERVAÇÃO
O Atlas oferece suporte a granularidade de 10 segundos apenas em clusters M40 e
maiores. Para saber mais, consulte Granularidade do monitoramento Premium.

Ampliação
Modifica o intervalo de datas das métricas exibidas para cada gráfico. Selecione um
intervalo de zoom entre 1 hora e 5 anos. Ajustar o zoom ajusta automaticamente o intervalo
de datas da exibição atual.
Exibição Atual
Modifica o intervalo de data e hora de início e término das métricas exibidas para cada
gráfico. A modificação das datas de início e término define o valor de Zoom como
personalizado e substitui o nível de zoom selecionado anteriormente.
Adicionar gráfico
Selecione um ou mais gráficos para exibir ou ocultar. Adicionar gráficos usando esse menu
suspenso é idêntico a adicionar gráficos na seção Alternar gráficos da visualização
Métricas.
Selecione banco de dados
Visível apenas para a visualização DB Stats. Seleciona o banco de dados para o qual exibir
métricas.
Exibir Opcounters em Gráficos Separados
Orienta o Atlas a dividir o gráfico Opcounters em seus componentes individuais. Você pode
então optar por traçar um ou mais desses componentes. Se você marcar esta caixa de
seleção, o Atlas exibirá o número das seguintes operações por segundo em um processo
mongot:

excluir

vamos

inserir

atualizar

Se você implantou nós de pesquisa para isolamento de carga de trabalho, não poderá
visualizar contadores de operação em gráficos separados na guia Nós de Pesquisa. Você
pode agrupar métricas de contadores de operação na guia Nós de pesquisa marcando a
caixa de seleção Agrupar métricas de contadores de operação.

Exibir anotações da linha do tempo


Instrui o Atlas a exibir ou ocultar anotações do gráfico. As anotações do gráfico consistem
em linhas verticais coloridas que indicam eventos do servidor, como reinicialização do
servidor ou transição no estado membro. Se você implementou nós de pesquisa para
isolamento de carga de trabalho, não poderá exibir ou ocultar anotações de gráfico na guia
Nós de Pesquisa.
Exibição de gráfico
Ao visualizar gráficos, você pode fazer o seguinte:

Tarefa
Ação
Veja uma descrição detalhada de um gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique ao lado do nome do gráfico para abrir o modal Informações do gráfico. Este modal
inclui um detalhamento da série de dados do gráfico, as anotações disponíveis para esse
gráfico e as operações que o gráfico suporta.

Expanda um gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique na seta bidirecional no canto superior direito do gráfico.

Amplie um período de tempo.


Clique e arraste o ponteiro do mouse sobre uma parte do gráfico.

Para redefinir para o intervalo selecionado originalmente (menos zoom), clique duas vezes
no gráfico.
OBSERVAÇÃO
Quando você amplia um período de tempo, o intervalo de datas de exibição atual na seção
de controle do gráfico é atualizado automaticamente para refletir o período selecionado.

Veja estatísticas em um determinado momento.


Passe o ponteiro do mouse sobre um ponto do gráfico.
Mova um gráfico.
Clique e segure o botão no canto superior esquerdo do gráfico e arraste o gráfico para a
nova posição.
Compartilhe um URL para o gráfico.
Passe o mouse sobre o gráfico para exibir o menu de contexto.

Clique na seta curva no gráfico. Selecione Link permanente do gráfico para recuperar um
URL para o gráfico. Selecione Gráfico por e-mail para enviar o gráfico por e-mail.

O destinatário da URL do gráfico deve ter uma conta de usuário Atlas com acesso ao
projeto e ao cluster.

Seleção de gráfico
O Atlas exibe as métricas disponíveis para gráfico para a implantação do banco de dados
selecionado no cabeçalho Toggle Charts.

Os gráficos marcados com o símbolo + estão inativos, enquanto os gráficos marcados com
o símbolo - estão ativos. Clique em qualquer gráfico para alternar o estado do gráfico.
Revise as métricas disponíveis
Você pode revisar as métricas a seguir para monitorar suas implantações de banco de
dados. Todas as métricas de hardware incluem métricas ou gráficos individuais para valores
máximos.

IMPORTANTE
As métricas disponíveis dependem da função do usuário e do tipo de implantação do banco
de dados.

OBSERVAÇÃO
Atualmente, as métricas de instância sem servidor não oferecem suporte a serviços de
terceiros (por exemplo,
Cão de dados
).

Métrica
Descrição
Afirmações
Exibe as seguintes informações:

ASSERT_REGULAR exibe a taxa média de afirmações regulares geradas por segundo


durante o período de amostra selecionado.

ASSERT_WARNING exibe a taxa média de avisos por segundo durante o período de


amostra selecionado.

ASSERT_MSG exibe a taxa média de declarações de mensagens por segundo durante o


período de amostra selecionado. Esses erros internos do servidor possuem uma sequência
de texto bem definida. Os logs do Atlas acumulam rastreamentos para eles.

ASSERT_USER exibe a taxa média de afirmações do usuário por segundo durante o


período de amostra selecionado. Essa métrica inclui declarações geradas por um usuário,
como falta de espaço em disco ou erros de chave duplicada.

Monitore declarações para rastrear quantos erros ocorrem ao tentar ler ou gravar dados.
Verifique os logs do servidor para identificar a origem de quaisquer erros.

Tamanho médio do objeto


Exibe o tamanho médio do objeto em todas as coleções do banco de dados.

Monitore o tamanho do objeto para rastrear o tamanho dos seus objetos e entender melhor
o espaço do seu banco de dados.

Atividade de cache
Exibe as seguintes informações:
readInto (conjunto de réplicas) ou leitura de cache (cluster fragmentado) exibe a taxa em
bytes por segundo de dados lidos do disco para a memória para consultas de serviço.

writeFrom (conjunto de réplicas) ou cache gravado em (cluster fragmentado) exibe a taxa


em bytes por segundo de dados gravados da memória no disco para gravações de serviço.

Monitore o cache do MongDB, que armazena dados acessados com frequência na memória
para atender consultas com mais rapidez.

Uso de cache
Exibe as seguintes informações:

sujo (conjunto de réplicas) ou cache sujo (cluster fragmentado) exibe o total de bytes sujos
armazenados em cache na memória para servir leituras e gravações.

usado (conjunto de réplicas) ou cache usado (cluster fragmentado) exibe o total de bytes
armazenados em cache na memória para servir leituras e gravações.

Essas métricas incluem índices e dados do conjunto de trabalho.

O alto uso sustentado do cache indica que a RAM é muito pequena para suas cargas de
trabalho. Otimize suas consultas para evitar leituras frequentes de disco. Se as operações
de gravação aumentarem o uso do cache, limite-as.

Catálogo
Exibe as seguintes informações:

total de bancos de dados exibe o número total de bancos de dados que não são do sistema.

total de coleções exibe o número total de coleções em todos os bancos de dados que não
são do sistema.

total de visualizações exibe o número total de visualizações em todos os bancos de dados


que não são do sistema.

índices totais exibe o número total de índices em todas as coleções que não são do
sistema.

Monitore contagens de catálogo para evitar que um número excessivo de bancos de dados,
coleções, visualizações ou índices causem falhas de inicialização ao atualizar uma camada
de cluster.

Coleções
Exibe o número de coleções no banco de dados.

Monitore coleções para determinar tempos de reinicialização, desempenho de backup


contínuo e estabilidade.
Conexões (instância sem servidor/conjunto de réplicas) ou conexão (cluster fragmentado)
Exibe o número total de conexões ativas com a implantação do banco de dados.

Monitore as conexões para determinar se os limites de conexão atuais são suficientes. Se


necessário, atualize a camada do cluster.

Cursores
Exibe as seguintes informações:

totalOpen exibe o número de cursores que o servidor mantém para os clientes.

totalTimedOut exibe a taxa média de cursores que atingiram o tempo limite por segundo
durante o período de amostra selecionado.

Monitore cursores para fechar cursores desnecessários e reduzir a configuração de tempo


limite no aplicativo.

Armazenamento de banco de dados


Exibe as seguintes informações:

storageSize (conjunto de réplicas) ou tamanho de armazenamento db (cluster fragmentado)


exibe a soma total do espaço de armazenamento em disco alocado para armazenamento
de documentos em todos os bancos de dados.

Tamanho dos dados (instância sem servidor), dataSize (conjunto de réplicas) ou tamanho
dos dados do banco de dados (cluster fragmentado) exibe a quantidade de espaço de
armazenamento em bytes que seus dados armazenados usam.

tamanho dos dados db sem sistema exibe a soma do tamanho total em bytes dos dados do
documento (incluindo o fator de preenchimento) em bancos de dados que não são do
sistema.

O Atlas recupera métricas do banco de dados a cada 20 minutos por padrão, mas ajusta a
frequência quando necessário para reduzir o impacto no desempenho do banco de dados.

Monitore o espaço de armazenamento para determinar se deve usar o escalonamento


automático do disco ou aumentar manualmente o tamanho do disco. Você também pode
monitorar essa métrica para verificar o faturamento de backup.

IOPS de disco
Exibe operações de entrada por segundo.

Monitore se o IOPS do disco se aproxima do IOPS máximo provisionado. Determine se o


cluster pode lidar com cargas de trabalho futuras.

Latência de disco
Exibe as seguintes informações:
Ler exibe o tempo médio de leitura do disco.

Write exibe o tempo médio de gravação no disco.

Monitore a latência do disco para monitorar a eficiência da leitura e gravação g para o disco.

Profundidade da fila de disco


Exibe o comprimento médio da fila de solicitações emitidas para a partição de disco usada
pelo MongoDB.

Monitore a profundidade da fila de disco para identificar possíveis problemas e gargalos.

Espaço em disco livre


Exibe a quantidade total de espaço livre restante no disco.

Monitore o espaço livre em disco para determinar se deve usar o escalonamento automático
do disco ou aumentar manualmente o tamanho do disco.

Porcentagem de espaço livre em disco


Exibe a quantidade total de espaço livre restante no disco como uma porcentagem do
espaço total em disco.

Monitore a porcentagem de espaço livre em disco para determinar se deve usar o


escalonamento automático do disco ou aumentar manualmente o tamanho do disco.

Espaço em disco usado


Exibe o espaço total em disco usado.

Monitore o espaço em disco usado para determinar se deve usar o escalonamento


automático do disco ou aumentar manualmente o tamanho do disco.

Métricas de Documento
Exibe as seguintes informações:

Retornado exibe os documentos retornados por segundo.

Inseridos exibe os documentos inseridos por segundo.

Atualizado exibe os documentos atualizados por segundo.

Excluídos exibe os documentos excluídos por segundo.

Monitore as métricas do documento para medir o trabalho concluído pelo MongoDB.

Tempo de execução
Exibe o tempo médio em segundos para as seguintes métricas:

Latência operacional média de leitura


Latência operacional média de gravação

Latência operacional média de comando

Monitore o tempo de execução para aumentar as operações de leitura para otimizar


consultas e índices.

Tamanho do índice
Exibe o tamanho total de todos os índices no banco de dados. Essa métrica inclui a
sobrecarga incorrida pelos índices sobre os dados reais do documento nos quais os índices
se baseiam.

Monitore o tamanho do índice para gerenciar seus índices. Para saber mais, consulte
Estratégias de indexação.

Índices
Exibe o número total de índices no banco de dados.

Monitore índices para gerenciá-los. Para saber mais, consulte


Estratégias de indexação.

Fechaduras
Exibe as seguintes informações:

GLOBAL_LOCK_CURRENT_QUEUE_TOTAL exibe o número de operações na fila


aguardando qualquer bloqueio.

GLOBAL_LOCK_CURRENT_QUEUE_READERS exibe o número de operações na fila


aguardando um bloqueio de leitura.

GLOBAL_LOCK_CURRENT_QUEUE_WRITERS exibe o número de operações


aguardando um bloqueio de gravação.

Monitore bloqueios para otimizar consultas.

Máximo de IOPS de disco


Exibe os seguintes valores máximos de IOPS de disco durante o período especificado pela
granularidade da métrica:

máximo de iops de leitura máximo de operações de entrada de leitura de disco por


segundo.

máximo de iops de gravação máximo de operações de entrada de gravação em disco por


segundo.

Monitore se o IOPS do disco se aproxima do IOPS máximo provisionado. Determine se o


cluster pode lidar com cargas de trabalho futuras.
Profundidade máxima da fila de disco
Exibe os valores máximos de profundidade da fila de disco durante o período especificado
pela granularidade da métrica. A profundidade da fila de disco é o comprimento médio da
fila de solicitações emitidas para a partição de disco que o MongoDB usa.

Monitore a profundidade da fila de disco para identificar possíveis problemas e gargalos.

CPU máxima do sistema normalizado


Exibe os valores máximos de uso de CPU de todos os processos no nó, dimensionados
para um intervalo de 0 a 100% dividindo pelo número de núcleos de CPU.

Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

CPU máxima do processo


Exibe os seguintes valores máximos de CPU do processo durante o período especificado
pela granularidade da métrica:

max user exibe a porcentagem máxima de tempo que a CPU gastou atendendo ao
processo MongoDB.

max kernel exibe a porcentagem máxima de tempo que a CPU gastou atendendo
chamadas do sistema operacional para o processo MongoDB.

Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

CPU máxima do sistema


Exibe os valores máximos de uso da CPU de todos os processos no nó.

Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.
Memória máxima do sistema
Exibe os valores máximos de memória do sistema em bytes.

Monitore a memória para determinar se será necessário atualizar para uma camada de
cluster superior. Essa métrica representa o valor máximo durante o período especificado
pela granularidade da métrica.

Memória
Exibe o consumo total de memória em megabytes em um determinado momento:

memory_resident (conjunto de réplicas) ou residente na memória (cluster fragmentado)


exibe a memória que o processo MongoDB em execução em um nó consome. Esta métrica
exclui o consumo de outros processos e não representa a memória total que o nó consome.

memory_virtual (conjunto de réplicas) ou memória virtual (cluster fragmentado) exibe a


memória reservada no disco para atuar como espaço de troca.

Monitore a memória para determinar se será necessário atualizar para uma camada de
cluster superior. Essa métrica representa o valor médio durante o período especificado pela
granularidade da métrica.

Rede
Exibe as seguintes informações:

bytesIn exibe a taxa média de bytes físicos (após qualquer compactação de fio) enviados a
esse servidor de banco de dados por segundo durante o período de amostra selecionado.

bytesOut exibe a taxa média de bytes físicos (após qualquer compactação de ligação)
enviados deste servidor de banco de dados por segundo durante o período de amostra
selecionado.

numRequests exibe a taxa média de solicitações enviadas a esse servidor de banco de


dados por segundo durante o período de amostra selecionado.

Monitore as métricas da rede para monitorar o desempenho da rede.

CPU de processo normalizado


Exibe as seguintes informações:

o usuário exibe a porcentagem de tempo que a CPU gastou atendendo ao processo


MongoDB, dimensionada para um intervalo de 0 a 100% dividindo pelo número de núcleos
da CPU.

kernel exibe a porcentagem de tempo que a CPU gastou atendendo chamadas do sistema
operacional para o processo MongoDB, dimensionada para um intervalo de 0 a 100%
dividindo pelo número de núcleos da CPU.
Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

CPU do sistema normalizado


Exibe o uso da CPU de todos os processos no nó, dimensionado para um intervalo de 0 a
100% dividindo pelo número de núcleos da CPU.

Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

Objetos
Exibe o número de objetos no banco de dados.

Monitore essa métrica para entender melhor o espaço do seu banco de dados.

Contadores de operações
Exibe o número das seguintes operações por segundo executadas em um processo
MongoDB desde o último início do processo:

comando (conjunto de réplicas) ou cmd (cluster fragmentado)

consulta

inserir

excluir

atualizar

pegue mais

Monitore as operações do MongoDB para validar problemas de desempenho relacionados a


altas cargas de trabalho. Confirme o tipo de operações responsáveis pela carga.

Contadores de operações - Repl


Exibe as seguintes informações:
O comando exibe a taxa média de comandos replicados aplicados por segundo durante o
período de amostra selecionado.

insert exibe a taxa média de inserções replicadas aplicadas por segundo durante o período
de amostra selecionado.

delete exibe a taxa média de exclusões replicadas aplicadas por segundo durante o período
de amostra selecionado.

update exibe a taxa média de atualizações replicadas aplicadas por segundo durante o
período de amostra selecionado.

Monitore as operações do MongoDB para validar problemas de desempenho relacionados a


altas cargas de trabalho. Confirme o tipo de operações responsáveis pela carga.

Tempo de Execução da Operação


Exibe o tempo médio em milissegundos para executar as seguintes operações:

média de ms/leitura (conjunto de réplicas) ou leituras de tempo de execução (cluster


fragmentado)

média de ms/gravação (conjunto de réplicas) ou gravações em tempo de execução (cluster


fragmentado)

avg ms/command (conjunto de réplicas) ou comandos de tempo de execução (cluster


fragmentado)

Monitore o tempo de execução para aumentar as operações de leitura para otimizar


consultas e índices. Determine se você precisa atualizar sua camada de cluster.

Oplog GB/hora
Exibe a taxa média em gigabytes de
registrar
dados que o primário gera por hora.

Monitore os dados do oplog para determinar se é necessário aumentar o tamanho do oplog.

Falhas de página
Exibe a taxa média de falhas de página neste processo por segundo durante o período de
amostra selecionado. Em ambientes não Windows, isso se aplica somente a falhas de
página graves.

Monitore as falhas de página para determinar se deve aumentar sua memória.

Processar CPU
Exibe as seguintes informações:
o usuário exibe a porcentagem de tempo que a CPU gastou atendendo ao processo
MongoDB.

kernel exibe a porcentagem de tempo que a CPU gastou atendendo chamadas do sistema
operacional para o processo MongoDB.

Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

Executor de Consultas Exibe as seguintes informações:

Itens de índice verificados exibe o número de itens de índice verificados por segundo.

Documentos digitalizados exibe o número de documentos digitalizados por segundo.

Monitore o executor de consulta para determinar se você tem alguma consulta ineficiente.

Segmentação de consulta
Exibe a eficiência das operações de leitura executadas no MongoDB:

Objetos digitalizados para retornados (conjunto de réplicas) ou objetos


digitalizados/devolvidos (cluster fragmentado) exibe o número de documentos digitalizados
para retornar um documento.

Chaves digitalizadas para retornadas (conjunto de réplicas) ou chaves


digitalizadas/devolvidas (cluster fragmentado) exibe o número de chaves de índice
digitalizadas para retornar um documento.

Monitore o direcionamento de consultas para determinar a eficiência de leitura e otimizar


consultas e índices.

OBSERVAÇÃO
O
mudar fluxos
os cursores que o processo Atlas Search (mongot) usa para manter os índices do Atlas
Search atualizados podem contribuir para a proporção de direcionamento de consulta e
acionar alertas de direcionamento de consulta se a proporção for alta.

Unidades de leitura/gravação
Exibe as seguintes informações:

Total de unidades de processamento de leitura (RPUs)


Total de unidades de processamento de gravação (WPUs)

Monitore unidades de leitura e gravação para ajudar a otimizar consultas e índices.

Espaço de replicação
Exibe a diferença entre a janela de oplog de replicação do primário e o atraso de replicação
do secundário.

Monitore o espaço de replicação para determinar se o secundário pode sair do oplog.

Atraso na replicação
Exibe o número aproximado de segundos que o secundário fica atrás do primário no
aplicativo de gravação.

Monitore o atraso de replicação para determinar se o secundário pode sair do oplog.

Janela Oplog de Replicação


Exibe o número médio estimado de horas de operações de banco de dados disponíveis no
oplog de replicação do primário, com base na rotatividade do oplog. Se o atraso de
replicação em um nó secundário exceder a janela de oplog de replicação e o espaço de
replicação atingir zero, um
ressincronização completa
é necessário para que esse nó se torne íntegro novamente.

Monitore a janela de oplog de replicação, juntamente com o espaço de replicação, para


determinar se o secundário poderá exigir em breve uma ressincronização completa. A
janela de oplog de replicação geralmente ajuda a determinar antecipadamente a resiliência
dos secundários a interrupções planejadas e não planejadas.

Digitalize e encomende
Exibe o número de operações por segundo que retornam resultados que exigiram uma
classificação na memória.

Monitore essa métrica para identificar se suas consultas precisam de índices.

Tamanho dos dados do fragmento


Exibe a quantidade de espaço de armazenamento em bytes que seus dados armazenados
usam em cada fragmento. Você pode acessar este gráfico apenas para clusters
fragmentados com MongoDB 6.0+.

Monitore essa métrica para verificar se você tem


fragmentos equilibrados.

Contagem de fragmentos de documentos


Exibe o número de documentos em cada fragmento. Você pode acessar este gráfico
apenas para clusters fragmentados com MongoDB 6.0+.

Monitore essa métrica para verificar se você tem


fragmentos equilibrados.

CPU do sistema
Exibe o uso da CPU de todos os processos no nó.

Monitore o uso da CPU para determinar se os dados são recuperados do disco em vez da
memória.

Se você não conseguir ver o uso que acionou o alerta, amplie o gráfico de CPU do sistema
normalizado clicando e arrastando o mouse sobre o período de interesse. Com uma
visualização de resolução mais alta, você poderá identificar picos agudos no uso da CPU
que não eram visíveis na visão geral.

Memoria do sistema
Exibe as seguintes informações:

usado exibe o número de bytes de memória física em uso.

available exibe uma estimativa do número de bytes de memória do sistema disponíveis para
executar novos aplicativos, sem troca.

Monitore a memória para determinar se será necessário atualizar para uma camada de
cluster superior. Essa métrica representa o valor médio durante o período especificado pela
granularidade da métrica.

Ingressos disponíveis
Exibe as seguintes informações:

Tickets Available Read exibe o número de tickets de leitura disponíveis para o mecanismo
de armazenamento WiredTiger. Os tickets de leitura representam o número de operações
de leitura simultâneas permitidas no mecanismo de armazenamento. Quando esse valor
chegar a zero, novas solicitações de leitura poderão ficar na fila até que um ticket de leitura
fique disponível.

Tickets Available Write exibe o número de tickets de gravação disponíveis para o


mecanismo de armazenamento WiredTiger. Os tickets de gravação representam o número
de operações de gravação simultâneas permitidas no mecanismo de armazenamento.
Quando esse valor chegar a zero, novas solicitações de gravação poderão ficar na fila até
que um ticket de gravação fique disponível.

Monitore os tickets disponíveis para ver quando as solicitações de leitura e gravação estão
na fila.

Visualizações
Exibe o número de visualizações no banco de dados.

Monitore visualizações para ajudar a otimizar seu banco de dados.


Integrar com serviços de terceiros
Nesta página

Acesso obrigatório
Visualizar ou modificar configurações de terceiros
Você pode integrar o Atlas com serviços de monitoramento de terceiros para receber alertas
do Atlas em vários serviços de monitoramento externos e para visualizar e analisar métricas
de desempenho que o Atlas coleta sobre seu cluster.

OBSERVAÇÃO
Atualmente, as métricas de instância sem servidor não oferecem suporte a serviços de
terceiros (por exemplo, Cão de dados).

Acesso obrigatório
Para visualizar as configurações de integração de terceiros, você deve ter acesso de
proprietário da organização ou proprietário do projeto ao projeto.

Visualizar ou modificar configurações de terceiros

CLI do Atlas

IU do Atlas
OBSERVAÇÃO
Antes de executar qualquer comando Atlas CLI, você deve:

Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Cão de dados
Para criar ou atualizar uma integração do Datadog usando a CLI do Atlas, execute o
seguinte comando:

atlas integrations create OPS_GENIE [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para as integrações do atlas criam o DATADOG.

Opsgênio
Para criar ou atualizar uma integração do Opsgenie usando a CLI do Atlas, execute o
seguinte comando:
atlas integrations create OPS_GENIE [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
integrações atlas criam OPS_GENIE.

PagerDuty
Para criar ou atualizar uma integração do PagerDuty usando a CLI do Atlas, execute o
seguinte comando:

atlas integrations create PAGER_DUTY [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
as integrações do atlas criam PAGER_DUTY.

VictorOps
Para criar ou atualizar uma integração VictorOps usando a CLI do Atlas, execute o seguinte
comando:

atlas integrations create VICTOR_OPS [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
integrações atlas criam VICTOR_OPS.

Webhook
Para criar ou atualizar uma integração de webhook usando a CLI do Atlas, execute o
seguinte comando:

atlas integrations create WEBHOOK [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
integrações atlas criam WEBHOOK.

Ver integrações de terceiros


Para listar todas as integrações de terceiros para um projeto usando a CLI do Atlas, execute
o seguinte comando:

atlas integrations list [options]

Para retornar os detalhes de uma integração de terceiros usando a CLI do Atlas, execute o
seguinte comando:

atlas integrations describe <integrationType> [options]

Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a
documentação do Atlas CLI para
lista de integrações do atlas
e
integrações do atlas descrevem.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Excluir uma integração de terceiros


Para excluir uma integração de terceiros usando a CLI do Atlas, execute o seguinte
comando:

atlas integrations delete <integrationType> [options]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
exclusão de integrações do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Integrar com Datadog
Nesta página

Acesso obrigatório
Pré-requisitos
Procedimento
Métricas de desempenho disponíveis para Datadog
Você pode configurar o Atlas para enviar dados de métricas sobre o seu projeto para o seu
Cão de dados
painéis.

OBSERVAÇÃO
Se você configurar seu projeto Atlas para enviar alertas e eventos ao Datadog, não será
necessário seguir este procedimento. Atlas envia métricas de projeto para Datadog através
da mesma integração usada para enviar alertas e eventos.

Acesso obrigatório
Para integrar o Atlas com o Datadog, você deve ter acesso de proprietário do projeto ao
projeto. Os usuários com acesso de Proprietário da Organização devem adicionar-se ao
projeto como Proprietário do Projeto.

Pré-requisitos
Cão de dados
a integração está disponível apenas em clusters M10+.

Para integrar o Atlas com o Datadog, você deve ter uma conta Datadog e uma chave API
Datadog. O Datadog concede a você uma chave de API quando você cria uma conta
Datadog pela primeira vez.

Se você não possui uma conta Datadog existente, você pode se inscrever em
https://app.datadoghq.com/signup.

Procedimento

CLI do Atlas

IU do Atlas
Para criar ou atualizar uma integração do Datadog usando a CLI do Atlas, execute o
seguinte comando:

integrações atlas criam DATADOG [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
as integrações do atlas criam o DATADOG.
Métricas de desempenho disponíveis para Datadog
Cão de dados
rastreia os seguintes dados de métrica para seu cluster Atlas. Os nomes das métricas
entre parênteses são os nomes usados na IU do Datadog. O Datadog mede cada métrica
uma vez por minuto.

OBSERVAÇÃO
A tag clustername identifica o cluster Atlas associado à métrica.

Nomes de métricas
Tipo de métrica
Descrição
CONEXÕES
(mongodb.atlas.connections.current)
Processo
Número de conexões abertas atualmente abertas no cluster.
DB_STORAGE_TOTAL
(mongodb.atlas.stats.totalstoragesize)
DB_DATA_SIZE_TOTAL
(mongodb.atlas.stats.totaldatasize)
DB_INDEX_SIZE_TOTAL
(mongodb.atlas.stats.totalindexsize)
Processo
Tamanho total de armazenamento do banco de dados, tamanho dos dados e tamanho do
índice no cluster em bytes.
DISK_LATENCY_READS
(mongodb.atlas.system.disk.latency.reads)
DISK_LATENCY_WRITES
(mongodb.atlas.system.disk.latency.writes)
Disco
Taxa de latência em milissegundos para solicitações de leitura e gravação.
DISK_MAX_LATENCY_READS
(mongodb.atlas.system.disk.max.latency.reads)
DISK_MAX_LATENCY_WRITES
(mongodb.atlas.system.disk.max.latency.writes)
Disco
Medidor de latência máxima em milissegundos para solicitações de leitura e gravação.
DISK_PARTITION_UTILIZATION
(mongodb.atlas.system.disk.iops.percentutilization)
Disco
Porcentagem de tempo durante o qual as solicitações são emitidas e atendidas pela
partição do disco. Inclui solicitações de todos os processos, não apenas dos processos do
MongoDB.
DISK_QUEUE_DEPTH
(mongodb.atlas.system.disk.queueprofundidade)
Disco
Comprimento médio da fila de solicitações emitidas para a partição de disco que o
MongoDB usa durante o período especificado pela granularidade da métrica.
MAX_DISK_PARTITION_UTILIZATION_DATA
(mongodb.atlas.system.disk.max.iops.percentutilization)
Disco
Valor percentual máximo de utilização do disco durante o período especificado pela
granularidade da métrica.
MAX_DISK_QUEUE_DEPTH
(mongodb.atlas.system.disk.max.queueprofundidade)
Disco
Valores máximos durante o período especificado pela granularidade métrica para o
comprimento médio da fila de solicitações emitidas para a partição de disco que o MongoDB
usa.
DOCUMENT_METRICS_RETURNED
(mongodb.atlas.metrics.document.returned)
DOCUMENT_METRICS_INSERTED
(mongodb.atlas.metrics.document.inserted)
DOCUMENT_METRICS_UPDATED
(mongodb.atlas.metrics.document.atualizado)
DOCUMENT_METRICS_DELETED
(mongodb.atlas.metrics.document.deleted)
Processo
Número de documentos lidos ou escritos por segundo.
NETWORK_BYTES_IN
(mongodb.atlas.network.bytes.in)
Processo
Taxa média de bytes físicos (após qualquer compactação de fio) enviados ao servidor de
banco de dados por segundo.
NETWORK_BYTES_OUT
(mongodb.atlas.network.bytes.out)
Processo
Taxa média de bytes físicos (após qualquer compactação de fio) enviados do servidor de
banco de dados por segundo.
NETWORK_NUM_REQUESTS
(mongodb.atlas.network.num.requests)
Processo
Taxa média de solicitações enviadas ao servidor de banco de dados por segundo.
OPCOUNTER_CMD
(mongodb.atlas.opcounters.command)
OPCOUNTER_QUERY
(mongodb.atlas.opcounters.query)
OPCOUNTER_UPDATE
(mongodb.atlas.opcounters.update)
OPCOUNTER_DELETE
(mongodb.atlas.opcounters.delete)
OPCOUNTER_GETMORE
(mongodb.atlas.opcounters.getmore)
OPCOUNTER_INSERT
(mongodb.atlas.opcounters.insert)
Processo
Número de operações por segundo, separadas por tipo de operação.
OP_EXECUTION_TIME_READS
(mongodb.atlas.oplatencies.reads.avg)
OP_EXECUTION_TIME_WRITES
(mongodb.atlas.oplatencies.writes.avg)
OP_EXECUTION_TIME_COMMANDS
(mongodb.atlas.oplatencies.commands.avg)
Processo
Tempo médio de operação em milissegundos, separado por tipo de operação.
QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED
(mongodb.atlas.metrics.queryexecutor.scannedobjectsperretornado)
Processo
Proporção que mede o número de objetos verificados em relação aos objetos retornados.
Valores mais baixos indicam consultas mais eficientes.
REPLICATION_LAG
(mongodb.atlas.replset.replicationlag)
Processo
Quantidade de tempo em segundos que atualizam para o atraso secundário atrás das
atualizações para o primário.
REPLICATION_OPLOG_WINDOW
(mongodb.atlas.replset.oplogWindow)
Processo
Número médio estimado, em segundos, de operações de banco de dados disponíveis no
oplog de replicação do primário. Esta métrica é baseada na rotatividade de oplog. A
ressincronização completa
será necessário se o atraso de replicação em um nó secundário exceder a janela de oplog
de replicação e o espaço de replicação atingir zero.
REPLICATION_STATUS_HEALTH
(mongodb.atlas.replstatus.health)
Processo
Número que indica a integridade de um membro do conjunto de réplicas. Um valor 1 indica
que o membro do conjunto de réplicas está ativo/em execução. Um valor 0 indica que o
membro do conjunto de réplicas está inativo/não em execução.

Você poderá ver um status de integridade impreciso nos seguintes cenários:

Se você tiver uma partição de rede e o Agente MongoDB residir em um nó isolado em um


conjunto de réplicas, apenas os pings do nó isolado alcançarão o Datadog. O nó isolado e a
UI do Atlas relatam os outros nós como inativos.

Se você tiver uma partição de rede e o Agente MongoDB residir fora dos nós afetados, os
pings de todos os nós chegarão ao Datadog, mas reportarão status diferentes.

Se todos os nós não responderem ou seu estado estiver suspenso, nenhum novo ping será
recebido. A IU do Atlas relata esses nós como inativos, mas o Datadog os relata como
íntegros e o status envelhece.
Se o Datadog sofrer uma interrupção ou lentidão na ingestão de métricas, essa métrica
poderá reportar incorretamente e produzir um resultado falso positivo.

IMPORTANTE
Se o status de funcionamento for 1, mas nenhuma outra métrica aparecer no Datadog, o
conjunto de réplicas poderá estar inativo.

REPLICATION_STATUS_STATE
(mongodb.atlas.replstatus.state)
Processo
Número inteiro entre 0 e 10 que representa um membro do conjunto de réplicas
estado de réplica.
SYSTEM_MEMORY_USED
(mongodb.atlas.system.memory.used)
SYSTEM_MEMORY_AVAILABLE
(mongodb.atlas.system.memory.available)
Sistema
Medidor que indica a memória física utilizada, em bytes.
MAX_SYSTEM_MEMORY_USED
(mongodb.atlas.system.memory.max.usado)
MAX_SYSTEM_MEMORY_AVAILABLE
(mongodb.atlas.system.memory.max.disponível)
Sistema
Medidor que indica a memória física máxima utilizada, em bytes.
SYSTEM_NORMALIZED_CPU_USER
(mongodb.atlas.system.cpu.norm.user)
SYSTEM_NORMALIZED_CPU_KERNEL
(mongodb.atlas.system.cpu.norm.kernel)
SYSTEM_NORMALIZED_CPU_NICE
(mongodb.atlas.system.cpu.norm.nice)
SYSTEM_NORMALIZED_CPU_IOWAIT
(mongodb.atlas.system.cpu.norm.iowait)
SYSTEM_NORMALIZED_CPU_IRQ
(mongodb.atlas.system.cpu.norm.irq)
SYSTEM_NORMALIZED_CPU_SOFTIRQ
(mongodb.atlas.system.cpu.norm.softirq)
SYSTEM_NORMALIZED_CPU_GUEST
(mongodb.atlas.system.cpu.norm.guest)
SYSTEM_NORMALIZED_CPU_STEAL
(mongodb.atlas.system.cpu.norm.steal)
Sistema
Porcentagem de tempo utilizado por CPUs lógicas em vários processos do servidor. Esses
valores são normalizados em relação ao número de núcleos lógicos da CPU.
MAX_SYSTEM_NORMALIZED_CPU_USER
(mongodb.atlas.system.cpu.max.norm.user)
MAX_SYSTEM_NORMALIZED_CPU_KERNEL
(mongodb.atlas.system.cpu.max.norm.kernel)
MAX_SYSTEM_NORMALIZED_CPU_NICE
(mongodb.atlas.system.cpu.max.norm.nice)
MAX_SYSTEM_NORMALIZED_CPU_IOWAIT
(mongodb.atlas.system.cpu.max.norm.iowait)
MAX_SYSTEM_NORMALIZED_CPU_IRQ
(mongodb.atlas.system.cpu.max.norm.irq)
MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ
(mongodb.atlas.system.cpu.max.norm.softirq)
MAX_SYSTEM_NORMALIZED_CPU_GUEST
(mongodb.atlas.system.cpu.max.norm.guest)
MAX_SYSTEM_NORMALIZED_CPU_STEAL
(mongodb.atlas.system.cpu.max.norm.steal)
Sistema
Valores máximos durante o período especificado pela granularidade métrica para a
porcentagem de tempo utilizado pelas CPUs lógicas em vários processos do servidor.
Esses valores são normalizados em relação ao número de núcleos lógicos da CPU.
PROCESS_NORMALIZED_CPU_USER
(mongodb.atlas.system.cpu.mongoprocess.user)
PROCESS_NORMALIZED_CPU_KERNEL
(mongodb.atlas.system.cpu.mongoprocess.kernel)
PROCESS_NORMALIZED_CPU_CHILDREN_USER
(mongodb.atlas.system.cpu.mongoprocess.childrenuser)
PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL
(mongodb.atlas.system.cpu.mongoprocess.childrenkernel)
Processo
Porcentagem de tempo utilizado por CPUs lógicas em vários processos específicos do
processo MongoDB no servidor. Esses valores são normalizados em relação ao número de
núcleos lógicos da CPU.
MAX_PROCESS_NORMALIZED_CPU_USER
(mongodb.atlas.system.cpu.mongoprocess.max.norm.user)
MAX_PROCESS_NORMALIZED_CPU_KERNEL
(mongodb.atlas.system.cpu.mongoprocess.max.norm.kernel)
MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER
(mongodb.atlas.system.cpu.mongoprocess.max.norm.childrenuser)
MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL
(mongodb.atlas.system.cpu.mongoprocess.max.norm.childrenkernel)
Processo
Valores máximos durante o período especificado pela granularidade métrica para a
porcentagem de tempo utilizado pelas CPUs lógicas em vários processos específicos do
processo MongoDB no servidor. Esses valores são normalizados em relação ao número de
núcleos lógicos da CPU.
MEMORY_RESIDENT
(mongodb.atlas.mem.resident)
MEMÓRIA_VIRTUAL
(mongodb.atlas.mem.virtual)
Processo
Memória (em MB) consumida pelo processo MongoDB no servidor, separada por memtipo
de memória.
OPCOUNTER_REPL_CMD
(mongodb.atlas.opcountersrepl.command)
OPCOUNTER_REPL_UPDATE
(mongodb.atlas.opcountersrepl.update)
OPCOUNTER_REPL_DELETE
(mongodb.atlas.opcountersrepl.delete)
OPCOUNTER_REPL_INSERT
(mongodb.atlas.opcountersrepl.insert)
Processo
Medir a taxa de operações de banco de dados no MongoDB
secundários
, conforme coletado do MongoDB
status do servidor
documento opcountersRepl do comando.

Você pode visualizar essas métricas no gráfico Opcounters - Repl, acessado por meio de
Cluster Metrics.

OPLOG_RATE_GB_PER_HOUR
(mongodb.atlas.replset.oplograte)
Processo
A taxa média de
registrar
o primário gera em gigabytes por hora.
TOTAL_NUMBER_OF_GETMORE_COMMANDS
(mongodb.atlas.search.index.stats.commands.getmore)
Pesquisa Atlas

Número total de comandos getmore executados em todas as consultas do Atlas Search.


TOTAL_NUMBER_OF_DELETES
(mongodb.atlas.search.index.stats.deletes)
Pesquisa Atlas

Número total de documentos ou campos (especificados na definição do índice) removidos.


TOTAL_NUMBER_OF_INDEX_FIELD
(mongodb.atlas.search.index.stats.index.fields)
Pesquisa Atlas

Número total de campos exclusivos presentes no índice Atlas Search.


TOTAL_INDEX_SIZE_ON_DISK
(mongodb.atlas.search.index.stats.index.size)
Pesquisa Atlas

Tamanho total de todos os índices no disco.


TOTAL_NUMBER_OF_INSERTS_SERIES
(mongodb.atlas.search.index.stats.inserts)
Pesquisa Atlas
Número total de documentos ou campos (especificados na definição do índice) que o Atlas
Search indexou.
MAX_REPLICATION_LAG
(mongodb.atlas.search.index.stats.max.replication.lag)
Pesquisa Atlas

Número aproximado de milissegundos que o Atlas Search está atrasado na replicação de


alterações do
registrar
de
mondeus
.
TOTAL_NUMBER_OF_UPDATES
(mongodb.atlas.search.index.stats.updates)
Pesquisa Atlas

Número total de documentos ou campos (especificados na definição do índice) que o Atlas


Search atualizou.
TOTAL_NUMBER_OF_ERROR_QUERIES
(mongodb.atlas.search.index.stats.queries.error)
Pesquisa Atlas

Número total de consultas para as quais o Atlas Search não consegue retornar uma
resposta.
TOTAL_NUMBER_OF_SUCCESS_QUERIES
(mongodb.atlas.search.index.stats.queries.success)
Pesquisa Atlas

Número total de consultas para as quais o Atlas Search retornou uma resposta com êxito.
TOTAL_NUMBER_OF_TOTAL_QUERIES
(mongodb.atlas.search.index.stats.queries.total)
Pesquisa Atlas

Número total de consultas enviadas ao Atlas Search.


JVM_CURRENT_MEMORY
(mongodb.atlas.search.jvm.current.memory)
Pesquisa Atlas

Quantidade de memória que o heap JVM está usando atualmente.


JVM_MAX_MEMORY
(mongodb.atlas.search.jvm.max.memory)
Pesquisa Atlas

Memória total disponível no heap da JVM.


DISK_PARTITION_SPACE_FREE
(mongodb.atlas.system.disk.space.free)
DISK_PARTITION_SPACE_USED
(mongodb.atlas.system.disk.space.used)
DISK_PARTITION_SPACE_PERCENT_FREE
(mongodb.atlas.system.disk.space.percentfree)
DISK_PARTITION_SPACE_PERCENT_USED
(mongodb.atlas.system.disk.space.percentused)
Disco
Meça o espaço livre em disco e o espaço em disco usado (em bytes) na partição de disco
usada pelo MongoDB.
MAX_DISK_PARTITION_SPACE_FREE
(mongodb.atlas.system.disk.max.space.free)
MAX_DISK_PARTITION_SPACE_USED
(mongodb.atlas.system.disk.max.space.used)
MAX_DISK_PARTITION_SPACE_PERCENT_FREE
(mongodb.atlas.system.disk.max.space.percentfree)
MAX_DISK_PARTITION_SPACE_PERCENT_USED
(mongodb.atlas.system.disk.max.space.percentused)
Disco
Valores máximos durante o período especificado pela granularidade métrica para espaço
livre em disco e espaço em disco usado (em bytes) na partição de disco usada pelo
MongoDB.
DISK_PARTITION_IOPS_READ
(mongodb.atlas.system.disk.iops.reads)
DISK_PARTITION_IOPS_WRITE
(mongodb.atlas.system.disk.iops.writes)
DISK_PARTITION_IOPS_TOTAL
(mongodb.atlas.system.disk.iops.total)
Disco
Meça a taxa de transferência de IOPS para a partição de disco usada pelo MongoDB.
MAX_DISK_PARTITION_IOPS_READ
(mongodb.atlas.system.disk.max.iops.reads)
MAX_DISK_PARTITION_IOPS_WRITE
(mongodb.atlas.system.disk.max.iops.writes)
MAX_DISK_PARTITION_IOPS_TOTAL
(mongodb.atlas.system.disk.max.iops.total)
Disco
Valores máximos durante o período especificado pela granularidade métrica para a taxa de
transferência de IOPS para a partição de disco usada pelo MongoDB.
SYSTEM_NETWORK_BYTES_IN
(mongodb.atlas.system.network.bytes.in)
Sistema
Taxa média de bytes físicos recebidos por segundo.
SYSTEM_NETWORK_BYTES_OUT
(mongodb.atlas.system.network.bytes.out)
Sistema
Taxa média de bytes físicos transmitidos por segundo.
MAX_SYSTEM_NETWORK_IN
(mongodb.atlas.system.network.max.bytes.in)
Sistema
Valores máximos durante o período especificado pela granularidade métrica para a taxa
média de bytes físicos recebidos por segundo.
MAX_SYSTEM_NETWORK_OUT
(mongodb.atlas.system.network.max.bytes.out)
Sistema
Valores máximos durante o período especificado pela granularidade métrica para a taxa
média de bytes físicos transmitidos por segundo.
CACHE_BYTES_READ_INTO
(mongodb.atlas.wiredtiger.cache.bytes_read_into_cache)
CACHE_BYTES_WRITTEN_FROM
(mongodb.atlas.wiredtiger.cache.bytes_writed_from_cache)
Processo
Meça a taxa média de bytes lidos e gravados em
Cache do WiredTiger.
CACHE_USED_BYTES
(mongodb.atlas.wiredtiger.cache .bytes_atualmente_in_cache)
CACHE_DIRTY_BYTES
(mongodb.atlas.wiredtiger.cache.tracked_dirty_bytes_in_cache)
Processo
Meça o número de bytes de dados e o número de bytes de dados sujos em
Cache do WiredTiger.
TICKETS_AVAILABLE_READS
(mongodb.atlas.wiredtiger.concurrenttransactions.read.available)
TICKETS_AVAILABLE_WRITES
(mongodb.atlas.wiredtiger.concurrenttransactions.write.available)
Processo
Meça o número de operações de leitura e gravação no
mecanismo de armazenamento.
GLOBAL_LOCK_CURRENT_QUEUE_READERS
(mongodb.atlas.global.lock.current.queue.readers)
GLOBAL_LOCK_CURRENT_QUEUE_WRITERS
(mongodb.atlas.global.lock.current.queue.writers)
GLOBAL_LOCK_CURRENT_QUEUE_TOTAL
(mongodb.atlas.global.lock.current.queue.total)
Global
Medidor que indica o número de operações atualmente na fila devido as fechaduras que o
Atlas mantém em leituras, gravações ou leituras e gravações combinadas.
Integre-se com equipes da Microsoft
Nesta página

Acesso obrigatório
Pré-requisitos
Procedimento
Você pode integrar o Atlas com
Equipes da Microsoft
para receber alertas do Atlas em seu canal do Microsoft Teams.

Acesso obrigatório
Para gerenciar todos os alertas da organização, você deve ter acesso de Proprietário da
Organização à organização.

A função Administrador de faturamento da organização concede autorização limitada para


gerenciar alertas de faturamento.

Para gerenciar alertas de projeto, você deve ter acesso de proprietário do projeto ao projeto.
Os usuários com acesso de Proprietário da Organização devem adicionar-se ao projeto
como Proprietário do Projeto.

Pré-requisitos
Para integrar o Atlas ao Microsoft Teams e receber alertas em seu canal do Microsoft
Teams, você deve ter um
Conta do Microsoft Teams.

Procedimento
Para integrar o Atlas ao Microsoft Teams e receber alertas em seu canal do Microsoft
Teams:

Alertas da organização

Alertas de Projeto
1
Crie o webhook de entrada do Microsoft Teams.
Navegue até o canal do Microsoft Teams onde deseja adicionar o webhook.

Selecione na barra de navegação superior. Um menu suspenso de opções disponíveis é


exibido.

Selecione Conectores no menu suspenso. Um modal com conectores disponíveis é exibido.

Pesquise Webhook de entrada e selecione Adicionar. Um modal com informações sobre o


conector Webhook de entrada é exibido.
Clique em Adicionar.

Clique em Configurar. Uma exibição modal.

No modal, insira um nome para o seu webhook. Opcionalmente, você pode fazer upload de
uma imagem exclusiva para ajudá-lo a identificar seu webhook.

Clique em Criar.

Copie o URL do webhook recebido.

IMPORTANTE
O Atlas requer esta URL para configurar a integração.

Clique em Concluído

2
Navegue até a página Alertas da sua organização.
Se ainda não estiver exibido, selecione a organização desejada no menu Organizações na
barra de navegação.

Clique em Alertas na barra lateral.

3
Escolha se deseja criar uma nova configuração de alerta, clonar uma configuração de alerta
existente ou atualizar uma configuração de alerta existente.
Para criar um novo alerta:

Clique em Adicionar alerta.

Para clonar uma configuração de alerta existente:

Clique na guia Configurações de alerta.

Localize a configuração de alerta que você deseja clonar.

Clique em Clonar na linha dessa configuração de alerta.

Para atualizar uma configuração de alerta existente:

Clique na guia Configurações de alerta.

Localize a configuração de alerta que você deseja atualizar.

Clique em Editar na linha dessa configuração de alerta.

4
Escolha o alvo.
Clique em Usuário ou Faturamento em Selecionar um Destino.

5
Escolha a condição.
Em Selecione uma condição:

Se você escolheu Usuário, selecione:

Os usuários da organização não têm MFA ativado

O usuário ingressou na organização

O usuário saiu da organização

A função do usuário foi alterada

Se você escolheu Faturamento:

Selecione uma das seguintes opções:

O cartão de crédito está prestes a expirar

O valor faturado ontem está acima

A fatura atual de qualquer projeto está acima

A fatura atual da organização está acima

Se $ acima aparecer ao lado da opção selecionada, especifique o valor em USD onde o


Atlas deve acionar o alerta se a condição selecionada exceder esse valor.

6
Configure a integração do Microsoft Teams.
No título Adicionar método de notificação, clique no botão Microsoft Teams.

Insira o URL do webhook de entrada na caixa de texto fornecida.

Para testar a integração, clique em Alerta pós-teste.

Em Recorrência, defina as condições de recorrência nas caixas de texto fornecidas.

Clique em Adicionar.
Integrar com PagerDuty
Nesta página

Como funciona
Acesso obrigatório
Pré-requisitos
Apoiar
Procedimento
Remover uma integração PagerDuty
Você pode configurar o Atlas para enviar alertas do seu projeto para o seu
PagerDuty
painel. Com a integração do PagerDuty, você pode:

Registre incidentes e notifique os atendentes de plantão com base nos alertas do Atlas.

Resolva automaticamente incidentes no PagerDuty quando um alerta do Atlas é fechado


com sincronização bidirecional.

Como funciona
Com uma integração do PagerDuty, você pode enviar dados de eventos de cluster do Atlas
para o PagerDuty quando os alertas do Atlas especificados por você são acionados. O
PagerDuty pode criar um novo incidente para o serviço correspondente, filtrar alertas
adicionais da mesma fonte para esse incidente e alertar os usuários do PagerDuty de
plantão.

Depois que o alerta do Atlas for resolvido, o PagerDuty resolverá o incidente.

Acesso obrigatório
Para criar, atualizar ou remover uma integração do PagerDuty, você deve ter acesso de
proprietário do projeto ao projeto. Os usuários com acesso de Proprietário da Organização
devem adicionar-se ao projeto como Proprietário do Projeto.

Pré-requisitos
Para integrar o Atlas ao PagerDuty, você deve ter uma conta PagerDuty.

Se você não possui uma conta PagerDuty, você pode se inscrever em


https://www.pagerduty.com/sign-up/.

OBSERVAÇÃO
Todas as novas chaves do PagerDuty usam seus
API de eventos v2.

Se você tiver uma chave da API de eventos v1, poderá continuar a usar essa chave com o
Atlas.

Apoiar
Se precisar de ajuda com a integração do Atlas PagerDuty, entre em contato
Suporte MongoDB
.

Procedimento

CLI do Atlas

IU do Atlas
Para criar ou atualizar uma integração do PagerDuty usando a CLI do Atlas, execute o
seguinte comando:

integrações atlas criam PAGER_DUTY [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
as integrações do atlas criam PAGER_DUTY.

Remover uma integração PagerDuty

CLI do Atlas

IU do Atlas
Para excluir uma integração de terceiros usando a CLI do Atlas, execute o seguinte
comando:

integrações do atlas excluir <integrationType> [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
exclusão de integrações do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas


Integrar com Prometheus
Nesta página

Pré-requisitos
Procedimento
Exemplos de configurações
Métricas de desempenho disponíveis para Prometheus
Rótulos de métricas do MongoDB
Métricas de informação do MongoDB
Métricas de hardware
Etiquetas de métricas de hardware
Prometeu
coleta métricas de alvos configurados em determinados intervalos, avalia expressões de
regras, exibe os resultados e pode acionar alertas quando observa condições específicas.

Nossa integração permite que você configure o Atlas para enviar dados métricos sobre sua
implantação para seu
Prometeu
instância.

Pré-requisitos
Prometeu
a integração está disponível apenas em clusters M10+.

Tenha uma instância funcional do Prometheus. Para configurar uma instância funcional,
consulte seu
Guia de instalação.

Adicione o IP do dispositivo que hospeda sua instância do Prometheus à lista de acesso de


IP.

OBSERVAÇÃO
Se você adicionar 0.0.0.0/0 à lista de acesso IP, que permite acesso ao cluster de qualquer
lugar na Internet pública, o Atlas desabilitará a integração do Prometheus.

Se 0.0.0.0/0 já estiver na lista de acesso IP, o Atlas impedirá que você configure a
integração do Prometheus.

(Opcional) Usar
Grafana
para visualizar suas métricas do Prometheus.

Procedimento
Para configurar uma integração do Atlas com
Prometeu
:
1
Navegue até suas integrações de projeto.
Se ainda não estiver exibido, selecione a organização que contém o projeto desejado no
menu Organizações na barra de navegação.

Se ainda não estiver exibido, selecione o projeto desejado no menu Projetos na barra de
navegação.

Ao lado do menu Projetos, expanda o menu Opções e clique em Integrações.

2
Clique em Configurar para o cartão de integração do Prometheus.
3
Digite seu nome de usuário e senha preferidos.
IMPORTANTE
Copie seu nome de usuário e senha em um local seguro. Você não poderá acessar a senha
depois de sair desta tela.

4
Selecione seu método preferido de descoberta de serviço.
Método de descoberta
Descrição
SD HTTP
Este método requer o Prometheus v2.28 e posterior. Ele gera automaticamente o
scrape_config
parte do seu
arquivo de configuração
para descobrir alvos em um endpoint HTTP.
Descoberta de serviço de arquivo
Este método permite que o Prometheus leia documentos YAML ou JSON para configurar os
destinos dos quais extrair. Você é responsável por fornecer os destinos fazendo uma
solicitação à API Discovery e armazenando seus resultados em um arquivo targets.json.

Para fazer a solicitação, substitua o texto do placeholder em uma das abas a seguir ou crie
seu próprio script em outro idioma.

Comando shell

curl --header 'Accept: application/json'


# Sets the `Authorization` header on every scrape request with the
# username and password from the previous step.
--user <username>:<password>
# The URL that Prometheus fetches the targets from.
# Replace the <group-id> with the project ID of your Atlas instance.
--request GET
"https://cloud.mongodb.com/prometheus/v1.0/groups/<group_id>/discovery"
Para saber mais sobre a API Discovery, consulte Retornar os destinos mais recentes do
Prometheus.

5
Clique em Salvar.
6
Visualize as métricas do seu cluster no Prometheus.
Copie o snippet gerado para a sessão scrape_configs do seu arquivo de configuração e
substitua o texto do espaço reservado.

Para obter um exemplo do arquivo de configuração em qualquer método, consulte


Configurações de exemplo.

Reinicie sua instância do Prometheus.

Na sua instância do Prometheus, clique em Status na barra de navegação superior e clique


em Destinos para ver as métricas de sua implantação.

Exemplos de configurações
A seguir são apresentados exemplos de
arquivo de configuração
quando você usa o
SD HTTP
ou
Descoberta de serviço de arquivo
método.

O arquivo de configuração em ambos os métodos contém os seguintes campos:

Campo
Descrição
scrape_interval
Tempo que indica a frequência de raspagem dos alvos. Esta configuração suporta um
tempo mínimo de 10s.
nome_do_trabalho
Rótulo legível atribuído a métricas extraídas.
caminho_métrica
Caminho do recurso HTTP que indica onde buscar métricas dos destinos.
esquema
Esquema de protocolo que você deseja configurar para solicitações.
autenticação_básica
Cabeçalho de autorização para usar em cada solicitação de raspagem.
SD HTTP
O método HTTP SD também contém o campo http_sd_configs com os seguintes
subcampos:
Campo
Descrição
url
URL a partir do qual o Prometheus busca os alvos.
intervalo de atualização
Hora que indica quando consultar novamente o endpoint.
autenticação_básica
Credenciais a serem usadas para autenticação no servidor API.

global:
scrape_interval: 15s

scrape_configs:

- job_name: "Cloud-Testing-mongo-metrics"
scrape_interval: 10s
metrics_path: /metrics
scheme : https
basic_auth:
username: prom_user_618d48e05277a606ed2496fe
password: fSIMUngfTmOTVEB4
http_sd_configs:
- url:
https://cloud.mongodb.com/prometheus/v1.0/groups/618d48e05277a606ed2496fe/discov
ery
refresh_interval: 60s
basic_auth:
username: prom_user_618d48e05277a606ed2496fe
password: fSIMUngfTmOTVEB4

Descoberta de serviço de arquivo


O método File Service Discovery também contém o campo file_sd_configs com o seguinte
subcampo:

Campo
Descrição
arquivos
Lista que contém os arquivos de para extrair as metas de raspagem de métricas.

global:
scrape_interval: 15s

scrape_configs:

- job_name: "Cloud-Testing-mongo-metrics"
scrape_interval: 10s
metrics_path: /metrics
scheme : https
basic_auth:
username: prom_user_618d48e05277a606ed2496fe
password: fSIMUngfTmOTVEB4
file_sd_configs:
- files:
- /usr/local/etc/targets.json

Métricas de desempenho disponíveis para Prometheus


As seguintes métricas estão disponíveis quando você usa a integração do Prometheus com
seu cluster Atlas:

Rótulos de métricas do MongoDB

status do servidor
Métricas

replSetStatus
Métricas

Métricas de informação do MongoDB

Métricas de hardware

Rótulos de métricas do MongoDB


Cada métrica do MongoDB contém os seguintes rótulos:

Rótulo
Descrição
ID_do_grupo
String exclusiva de dígitos hexadecimais que identifica o projeto.
id_org
String exclusiva de dígitos hexadecimais que identifica a organização.
cl_role
Rótulo legível por humanos que define a função do cluster.
nome_cl
Rótulo legível que identifica o cluster.
rs_nm
Rótulo legível que identifica o conjunto de réplicas.
estado_rs
Número que indica o
estado do conjunto de réplicas.
porta_processo
Porta na qual o processo é executado.
Métricas de informação do MongoDB
mongodb_info é um medidor que sempre tem o valor 1. Esta métrica contém todos os
Rótulos de métricas do MongoDB
e também os seguintes rótulos:
Rótulo
Descrição
mongodb_versão
String que representa as versões principais, secundárias e de patch.
replica_state_name
String que indica o
status de membro do conjunto de réplicas.
tipo_processo
String que indica o processo em execução. Seus valores podem ser mongod, mongos ou
config.
Métricas de hardware
OBSERVAÇÃO
Você também pode visualizar descrições de cada métrica de hardware na seção
Navegador de expressões Prometheus.

Nome
Tipo
Descrição
hardware_disk_metrics_disk_space_free_bytes
Medidor
Espaço em disco disponível no sistema de arquivos montado.
hardware_disk_metrics_disk_space_used_bytes
Medidor
Espaço em disco usado no sistema de arquivos montado.
hardware_disk_metrics_read_count
Contador
Número de E/S de leitura processadas.
hardware_disk_metrics_read_time_milliseconds
Contador
Tempo total de espera para solicitações de leitura.
hardware_disk_metrics_sectors_read
Contador
Número de setores lidos.
hardware_disk_metrics_sectors_write
Contador
Número de setores escritos.
hardware_disk_metrics_total_time_milliseconds
Contador
Tempo total que este dispositivo de bloco está ativo.
hardware_disk_metrics_weighted_time_io_milliseconds
Contador
Tempo ponderado gasto fazendo E/S.
hardware_disk_metrics_write_count
Contador
Número de E/S de gravação processadas.
hardware_disk_metrics_write_time_milliseconds
Contador
Tempo total de espera para solicitações de gravação.
hardware_plataforma_num_logical_cpus
Medidor
Número de CPUs lógicas utilizáveis pelo processo atual.
hardware_process_cpu_children_kernel_milliseconds
Contador
Quantidade de tempo agendada no modo kernel para que esse processo aguarde pelos
filhos.
hardware_process_cpu_children_user_milliseconds
Contador
Quantidade de tempo agendada no modo de usuário para que esse processo aguarde pelos
filhos.
hardware_process_cpu_kernel_milliseconds
Contador
Quantidade de tempo agendada no modo kernel para este processo.
hardware_process_cpu_user_milliseconds
Contador
Quantidade de tempo agendada no modo de usuário para esse processo.
hardware_system_cpu_guest_milliseconds
Contador
Tempo gasto na execução de uma CPU virtual para os sistemas operacionais convidados
sob o controle do kernel Linux.
hardware_system_cpu_guest_nice_milliseconds
Contador
Tempo gasto administrando um convidado com uma gentileza ajustada.
hardware_system_cpu_idle_milliseconds
Contador
Tempo gasto na tarefa ociosa.
hardware_system_cpu_io_wait_milliseconds
Contador
Tempo de espera pela conclusão da E/S.
hardware_system_cpu_irq_milliseconds
Contador
Tempo gasto atendendo interrupções.
hardware_system_cpu_kernel_milliseconds
Contador
Tempo gasto no modo de sistema.
hardware_system_cpu_nice_milliseconds
Contador
Tempo gasto no modo de usuário com baixa prioridade (legal).
hardware_system_cpu_soft_irq_milliseconds
Contador
Tempo gasto na manutenção de softirqs.
hardware_system_cpu_steal_milliseconds
Contador
Tempo gasto em outros sistemas operacionais durante a execução em um ambiente virtual.
hardware_system_cpu_user_milliseconds
Contador
Tempo gasto no modo de usuário.
hardware_system_memory_buffers_kilobytes
Medidor
Armazenamento temporário para blocos de disco brutos que não devem ficar muito
grandes.
hardware_system_memory_cached_kilobytes
Medidor
Cache na memória para arquivos lidos do disco. Isso não inclui SwapCached.
hardware_system_memory_mem_available_kilobytes
Medidor
Uma estimativa de quanta memória está disponível para iniciar novos aplicativos, sem troca.
hardware_system_memory_mem_free_kilobytes
Medidor
Soma de LowFree + HighFree.
hardware_system_memory_mem_total_kilobytes
Medidor
RAM total utilizável (RAM física menos alguns bits reservados e o código binário do kernel).
hardware_system_memory_shared_mem_kilobytes
Medidor
Quantidade de memória consumida em sistemas de arquivos cujo conteúdo reside na
memória virtual.
hardware_system_memory_swap_free_kilobytes
Medidor
Quantidade total de espaço de troca não utilizado.
hardware_system_memory_swap_total_kilobytes
Medidor
Quantidade total de espaço de troca avdisponível.
hardware_system_network_eth0_bytes_in_bytes
Contador
Número de bytes de dados recebidos pela interface.
hardware_system_network_eth0_bytes_out_bytes
Contador
Número de bytes de dados transmitidos pela interface.
hardware_system_network_lo_bytes_in_bytes
Contador
Número de bytes de dados recebidos pela interface.
hardware_system_network_lo_bytes_out_bytes
Contador
Número de bytes de dados transmitidos pela interface.
hardware_system_vm_page_swap_in
Contador
Número de páginas que o sistema trocou do disco.
hardware_system_vm_page_swap_out
Contador
Número de páginas que o sistema trocou para o disco.
Etiquetas de métricas de hardware
Cada métrica de hardware contém os seguintes rótulos:
Rótulo
Descrição
ID_do_grupo
String exclusiva de dígitos hexadecimais que identifica o projeto.
id_org
String exclusiva de dígitos hexadecimais que identifica a organização.
porta_processo
Porta na qual o processo é executado.
nome_do_disco
Etiqueta legível que identifica o disco.
Visualizar e baixar logs do MongoDB
Nesta página

Acesso necessário
Visualizar e baixar registros de implantação em nuvem
Visualize logs de implantação local com o Atlas CLI
Logs de acesso ao banco de dados
Cada instância de mondeus, mongos, e mongosqld mantém um registro de sua atividade
em seu próprio arquivo de log. Atlas retém os últimos 30 dias de registrar mensagens e
mensagens de auditoria de eventos do sistema. O Performance Advisor retém no máximo 7
dias de logs.

OBSERVAÇÃO
Clusters gratuitos M0 e clusters compartilhados M2/M5 não fornecem logs para download.

Acesso necessário
Para fazer download de logs, você deve ter acesso somente leitura do Project Data Access
ou superior ao projeto. Os usuários com acesso de Proprietário da Organização devem
adicionar-se ao projeto como Proprietário do Projeto.

Visualizar e baixar registros de implantação em nuvem

CLI do Atlas

IU do Atlas
Para baixar um arquivo compactado contendo os logs do nome de host selecionado usando
a CLI do Atlas, execute o seguinte comando:

download de logs do atlas <hostname>


<mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz>
[opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
download de registros do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Para obter informações sobre a leitura de logs do MongoDB, consulte o


Registrar mensagens
documentação no manual do MongoDB.
Visualize logs de implantação local com o Atlas CLI
Para visualizar os logs de uma implantação usando a CLI do Atlas, execute o seguinte
comando:

logs de implantações do atlas [opções]

Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do


Atlas CLI para
logs de implantações do atlas.

DICA
Veja: Links Relacionados
Instale a CLI do Atlas

Conecte-se à CLI do Atlas

Logs de acesso ao banco de dados


OBSERVAÇÃO
Este recurso não está disponível para clusters livres M0, clusters M2 e M5. Para saber mais
sobre quais recursos não estão disponíveis, consulte Limitações do Atlas M0 (cluster
gratuito), M2 e M5.

Você pode visualizar as tentativas de autenticação feitas em seu cluster. As tentativas


bem-sucedidas e mal sucedidas são registradas, incluindo o carimbo de data/hora da
tentativa e qual usuário tenta autenticar.

Você também pode gostar