Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.

Como configurar limites de taxa

É possível definir limites de taxa no GitHub Enterprise Server usando o Management Console.

Quem pode usar esse recurso

Site administrators can configure rate limits for a GitHub Enterprise Server instance.

Sobre os limites de taxa do GitHub Enterprise Server

Para evitar o uso excessivo de recursos no your GitHub Enterprise Server instance que possam afetar a disponibilidade ou o desempenho da instância para todos os usuários, você pode configurar limites de taxa. Os limites de taxa são configuráveis para a GitHub Enterprise Server APIs e o GitHub Actions.

Implemente os limites de taxa com cuidado e sempre se comunique com os usuários conforme ajusta os limites. Para evitar a interrupção do trabalho dos usuários, o GitHub recomenda que você comece com limites de taxa permissivos e ajuste-os gradualmente de acordo com o ambiente.

Você também pode configurar limites de taxa para tentativas de autenticação no Management Console. Para obter mais informações, confira "Como acessar o console de gerenciamento".

Habilitar limites de taxa para a GitHub Enterprise Server APIs

O número excessivo de solicitações à GitHub Enterprise Server APIs pode afetar a disponibilidade e o desempenho da instância. Para obter mais informações de como os limites de taxa da API afetam os usuários, confira "Recursos na API REST".

Você pode isentar uma lista de usuários dos limites de taxa de API usando o utilitário ghe-config no shell administrativo. Para obter mais informações, confira "Utilitários de linha de comando".

Observação: o Management Console lista o período (por minuto ou por hora) de cada limite de taxa.

  1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

    Captura de tela do ícone de foguete para acesso às configurações de administração do site

  2. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

    Captura de tela do link "Administração do site" 1. Na barra lateral à esquerda, clique em Management Console . Guia Management Console na barra lateral esquerda

  3. Em "Limitação de Taxa", selecione Habilitar Limitação de Taxa da API HTTP. Caixa de seleção usada para habilitar a limitação de taxa da API

  4. Informe os limites para solicitações autenticadas e não autenticadas de cada API ou aceite os limites padrão sugeridos.

  5. Na barra lateral esquerda, clique em Salvar configurações.

    Captura de tela do botão Salvar configurações no Management Console

    Observação: se você salvar as configurações no Management Console, isso reiniciará os serviços do sistema, o que poderá resultar em tempo de inatividade visível pelo usuário.

  6. Aguarde a conclusão da execução de suas configurações.

    Configurar a instância

Habilitar limites de taxa secundária

A configuração dos limites de taxa secundária protege o nível geral do serviço em your GitHub Enterprise Server instance.

  1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

    Captura de tela do ícone de foguete para acesso às configurações de administração do site

  2. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

    Captura de tela do link "Administração do site" 1. Na barra lateral à esquerda, clique em Management Console . Guia Management Console na barra lateral esquerda

  3. Em "Limitação de Taxa", selecione Habilitar Limitação de Taxa Secundária. Caixa de seleção usada para habilitar a limitação de taxa secundária

  4. Informe os limites para Solicitações totais, Limite de CPU e Limite de CPU para pesquisa ou aceite os limites padrão sugeridos.

  5. Na barra lateral esquerda, clique em Salvar configurações.

    Captura de tela do botão Salvar configurações no Management Console

    Observação: se você salvar as configurações no Management Console, isso reiniciará os serviços do sistema, o que poderá resultar em tempo de inatividade visível pelo usuário.

  6. Aguarde a conclusão da execução de suas configurações.

    Configurar a instância

Habilitar limites de taxa para Git

Se um membro da equipe do GitHub tiver recomendado isso, você poderá aplicar limites de taxa do Git por rede de repositório ou por ID de usuário. Os limites da taxa do Git são expressos em operações simultâneas por minuto e são adaptáveis com base na carga atual da CPU.

Aviso: recomendamos que você deixe essa configuração desabilitada, a menos que seja recomendado diretamente por um membro da equipe do GitHub. As operações do Git raramente são o que mais gera uso de CPU e RAM. A habilitação desse recurso pode aumentar a propensão a falhas das operações do Git em condições de alta carga, mas não aborda a causa subjacente dessas condições.

  1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

    Captura de tela do ícone de foguete para acesso às configurações de administração do site

  2. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

    Captura de tela do link "Administração do site" 1. Na barra lateral à esquerda, clique em Management Console . Guia Management Console na barra lateral esquerda

  3. Em "Limitação de Taxa", selecione Habilitar Limitação de Taxa do Git. Caixa de seleção usada para habilitar a limitação de taxa do Git

  4. Digite limites para cada rede de repositório ou ID do usuário. Campos usados para a rede de repositório e os limites da ID de usuário 1. Na barra lateral esquerda, clique em Salvar configurações.

    Captura de tela do botão Salvar configurações no Management Console

    Observação: se você salvar as configurações no Management Console, isso reiniciará os serviços do sistema, o que poderá resultar em tempo de inatividade visível pelo usuário.

  5. Aguarde a conclusão da execução de suas configurações.

    Configurar a instância

Configurar limites de taxa para GitHub Actions

Você pode aplicar um limite de taxa a execuções de fluxo de trabalho de GitHub Actions. Para obter mais informações sobre GitHub Actions, confira "Sobre GitHub Actions para empresas".

Sobre os limites de taxa para GitHub Actions

Sua instância do GitHub Enterprise Server atribui cada trabalho de fluxo de trabalho GitHub Actions a um executor. Se a sua instância não puder atribuir imediatamente um trabalho a um executor disponível, o trabalho aguardará em uma fila até que um executor esteja disponível. Se o GitHub Actions ficar uma carga alta continua, a fila poderá fazer backup e o desempenho da your GitHub Enterprise Server instance} poderá diminuir.

Para evitar essa degradação de desempenho, você pode configurar um limite de taxa para GitHub Actions. Esse limite de taxa é expresso em execuções de trabalho por minuto. GitHub Enterprise Server calcula e aplica o limite de taxa para a soma total de todas as execuções de trabalho na instância. Se as execuções excederem o limite de taxa, as execuções adicionais falharão em vez de entrar na fila. O erro a seguir aparecerá nas anotações da execução.

Você excedeu o limite de taxa para solicitações de execução de fluxo de trabalho. Aguarde antes de tentar a execução novamente.

Um limite de taxa apropriado protege a your GitHub Enterprise Server instance contra o uso anormal do GitHub Actions sem interferir nas operações diárias. O limite exato depende dos recursos disponíveis da instância e do perfil de carga geral. Para obter mais informações sobre os requisitos de hardware do GitHub Actions, confira "Introdução ao GitHub Actions for GitHub Enterprise Server."

Por padrão, o limite de taxa para GitHub Actions está desabilitado. Como o GitHub Enterprise Server pode lidar com picos temporários de uso sem degradação de desempenho, esse limite de taxa destina-se a proteger contra carga alta sustentada. Recomendamos deixar o limite de taxa desabilitado, a menos que você esteja enfrentando problemas de desempenho. Em alguns casos, GitHub Support pode recomendar que você ative um limite de taxa para GitHub Actions.

Habilitar ou desabilitar limites de taxa para GitHub Actions

  1. Conecte-se via SSH ao your GitHub Enterprise Server instance. Se sua instância for composta por vários nós, por exemplo, se a alta disponibilidade ou a replicação geográfica estiver configurada, efetue SSH no nó primário. Se você usar um cluster, poderá efetuar SSH em qualquer nó. Para obter mais informações sobre o acesso SSH, confira "Como acessar o shell administrativo (SSH)".

    $ ssh -p 122 admin@HOSTNAME
  2. Para habilitar e configurar o limite de taxa, execute os dois comandos a seguir, substituindo RUNS-PER-MINUTE pelo valor de sua escolha.

    ghe-config actions-rate-limiting.enabled true
    ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE
  3. Para desabilitar o limite de taxa depois de habilitado, execute o comando a seguir.

    ghe-config actions-rate-limiting.enabled false
    
  4. Para aplicar a configuração, execute o comando a seguir.

    ghe-config-apply
    
  5. Aguarde a conclusão da execução de suas configurações.