docker compose ps

O comando docker compose ps é utilizado para listar o status dos containers gerenciados por um projeto Docker Compose. Ele fornece informações detalhadas sobre cada container, como o estado atual, as portas mapeadas, e os nomes dos containers, ajudando a monitorar e gerenciar o ambiente de containers.

Uso Básico

docker compose ps [OPTIONS] [SERVICE...]

• SERVICE: O nome de um ou mais serviços definidos no arquivo docker-compose.yml. Se não for especificado, todos os serviços serão listados.

Principais Opções

• -a, --all: Exibe todos os containers, incluindo aqueles que foram parados. Por padrão, apenas os containers em execução são listados.

• -q, --quiet: Exibe apenas os IDs dos containers. Útil para scripts que precisam identificar containers sem detalhes adicionais.

• --services: Exibe apenas os nomes dos serviços, sem detalhar o status dos containers.

• --status: Filtra os containers por status específico, como running, exited, ou paused.

• --filter key=value: Filtra os containers com base em critérios específicos, como nome ou estado, permitindo uma visualização mais focada.

• --format string: Formata a saída em um dos formatos suportados, como table, json, ou yaml, para facilitar a integração com outras ferramentas.

Exemplos de Uso

1. Listar todos os containers em execução:

   docker compose ps

   Este comando exibe uma tabela com todos os containers em execução, mostrando detalhes como o nome do serviço, ID do container, status, e portas mapeadas.

2. Listar todos os containers, incluindo os parados:

   docker compose ps -a

   Inclui na listagem os containers que foram parados ou que falharam, além dos que estão em execução.

3. Exibir apenas os IDs dos containers:

   docker compose ps -q

   Mostra apenas os IDs dos containers, sem outros detalhes.

4. Listar serviços em execução por status específico:

   docker compose ps --status running

   Filtra e exibe apenas os containers que estão no status running.

5. Filtrar containers por nome:

   docker compose ps --filter "name=web"

   Exibe apenas os containers cujo nome corresponde ao filtro fornecido.

6. Exibir a lista de containers em formato JSON:

   docker compose ps --format json

   A saída será exibida em formato JSON, ideal para integração com outras ferramentas ou scripts.

Saída Padrão

A saída padrão do comando docker compose ps exibe as seguintes colunas:

• Name: O nome completo do container, composto pelo nome do projeto, nome do serviço, e um índice numérico.

• Command: O comando de entrada (entrypoint) que está sendo executado no container.

• State: O estado atual do container (Up, Exited, Paused, etc.).

• Ports: As portas mapeadas entre o container e o host.

Casos de Uso Comuns

• Monitoramento do Ambiente de Containers: Permite acompanhar facilmente o estado de todos os serviços gerenciados por um projeto Docker Compose.

• Resolução de Problemas: Ao listar containers que falharam ou foram parados, você pode rapidamente identificar problemas em um ambiente de desenvolvimento ou produção.

• Automação: As opções de formatação e filtragem tornam o comando ps ideal para uso em scripts de automação e monitoramento, integrando-se com ferramentas de gerenciamento de infraestrutura.

Considerações Finais

O comando docker compose ps é uma ferramenta essencial para gerenciar e monitorar os containers em um projeto Docker Compose. Ele oferece uma visão centralizada do status dos serviços, permitindo identificar rapidamente problemas e gerenciar o ciclo de vida dos containers. As diversas opções de filtragem e formatação tornam este comando versátil, adequado tanto para administração manual quanto para integração em fluxos de trabalho automatizados.