Como usar plug-ins

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Edge Microgateway v. 2.4.x

Público-alvo

Este tópico é destinado a operadores do Edge Microgateway que querem usar plug-ins instalados com o microgateway. Ela também discute em detalhes a suspensão de pico e os plug-ins de cota (ambos estão incluídos na instalação). Se você for um desenvolvedor que quer desenvolver novos plug-ins, consulte Desenvolver plug-ins personalizados.

O que é um plug-in Edge Microgateway?

Um plug-in é um módulo do Node.js que adiciona funcionalidade ao Edge Microgateway. Os módulos de plug-in seguem um padrão consistente e são armazenados em um local conhecido pelo Edge Microgateway, permitindo que o microgateway os descubra e carregue automaticamente. O Edge Microgateway inclui vários plug-ins atuais, e também é possível criar plug-ins personalizados, conforme explicado em Como desenvolver plug-ins personalizados.

Plug-ins incluídos no Edge Microgateway

Vários plug-ins atuais são fornecidos com o Edge Microgateway na instalação. São eles:

Plug-in Ativado por padrão Descrição
estatísticas Sim Envia dados de análise do Edge Microgateway para o Apigee Edge.
oauth Sim Adiciona o token OAuth e a validação da chave de API ao Edge Microgateway. Consulte Como instalar e configurar o Edge Microgateway.
cota Não Aplica a cota a solicitações para o Edge Microgateway. Usa o Apigee Edge para armazenar e gerenciar as cotas. Consulte Como usar o plug-in de cota.
detenção de pico Não Protege contra picos de tráfego e ataques DoS. Consulte Como usar o plug-in de restrição de pico.
cabeçalho em maiúsculas Não Um proxy de exemplo comentado que serve como um guia para ajudar os desenvolvedores a escrever plug-ins personalizados. Consulte Plug-in de amostra do Edge Microgateway.
acumular-solicitação Não Acumula dados de solicitação em um único objeto antes de passar os dados para o próximo gerenciador na cadeia de plug-ins. Útil para escrever plug-ins de transformação que precisam operar em um único objeto de conteúdo de solicitação acumulado.
acumular-resposta Não Acumula dados de resposta em um único objeto antes de passar os dados para o próximo gerenciador na cadeia de plug-ins. Útil para programar plug-ins de transformação que precisam operar em um único objeto de conteúdo de resposta acumulado.
transformar-maiúsculas Não Transforma dados de solicitação ou resposta. Este plug-in representa uma implementação de prática recomendada de um plug-in de transformação. O plug-in de exemplo executa uma transformação trivial (converte dados de solicitação ou resposta em maiúsculas). No entanto, ele pode ser facilmente adaptado para executar outros tipos de transformações, como XML para JSON.
json2xml. Não Transforma dados de solicitação ou resposta com base em cabeçalhos de aceitação ou do tipo de conteúdo. Para mais detalhes, consulte a documentação do plug-in no GitHub (em inglês).
cota-memória Não Aplica a cota a solicitações para o Edge Microgateway. Armazena e gerencia cotas na memória local.
healthcheck Não Retorna informações sobre o processo do Edge Microgateway, como uso de memória, de CPU etc. Para usar o plug-in, chame o URL /healthcheck na instância do Edge Microgateway. Este plug-in é um exemplo que pode ser usado para implementar seu próprio plug-in de verificação de integridade.

Onde encontrar plug-ins existentes

Os plug-ins incluídos no Edge Microgateway estão localizados aqui, em que [prefix] é o diretório de prefixos npm. Consulte Onde o Edge Microgateway está instalado.

[prefix]/lib/node_modules/edgemicro/node_modules/microgateway-plugins

Como adicionar e configurar plug-ins

Siga este padrão para adicionar e configurar plug-ins:

  1. Parar o Edge Microgateway.
  2. Abra um arquivo de configuração do Edge Microgateway. Para mais detalhes, consulte Como fazer alterações na configuração para mais opções.
  3. Adicione o plug-in ao elemento plugins:sequence do arquivo de configuração da seguinte maneira: Os plug-ins são executados na ordem em que aparecem nesta lista.
edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
     level: info
     dir: /var/tmp
     stats_log_interval: 60
  plugins:
     dir: ../plugins
     sequence:   
     - oauth
     - plugin-name
  1. Configure o plug-in. Alguns plug-ins têm parâmetros opcionais que podem ser configurados no arquivo de configuração. Por exemplo, você pode adicionar a estrofe a seguir para configurar o plug-in de detenção de pico. Consulte Como usar o plug-in de detenção de pico para mais informações. 
    edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
    sequence:
      - oauth
      - spikearrest
spikearrest:
   timeUnit: minute
   allow: 10
  1. Salve o arquivo.
  2. Reinicie o Edge Microgateway, dependendo do arquivo de configuração editado, conforme explicado em Como fazer alterações na configuração.

Configuração específica do plug-in

Você pode modificar os parâmetros do plug-in especificados no arquivo de configuração criando uma configuração específica do plug-in neste diretório:

[prefix]/lib/node_modules/edgemicro/node_modules/microgateway-plugins/config

em que [prefix] é o diretório de prefixos npm. Consulte Onde o Edge Microgateway está instalado.

plugins/<plugin_name>/config/default.yaml. Por exemplo, se você colocar esse bloco em plugins/spikearrest/config/default.yaml, ele vai substituir todas as outras configurações.

spikearrest:
   timeUnit: hour   
   allow: 10000   
   buffersize: 0

Como usar o plug-in pico arrest

Esta seção discute o plug-in de captura de pico.

Sobre a detenção de pico

O controle de pico protege contra picos de tráfego. Isso limita o número de solicitações processadas por uma instância do Edge Microgateway. Para mais informações, consulte Como funciona a detenção de pico? Consulte também Qual é a diferença entre detenção de pico e cota?.

Adicionar o plug-in de detenção de pico

Para ver as etapas básicas de qualquer plug-in, consulte Como adicionar e configurar plug-ins.

Exemplo de configuração para detenção de pico

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
    sequence:
      - oauth
      - spikearrest
spikearrest:
   timeUnit: minute
   allow: 10
   bufferSize: 5

Opções de configuração para detenção de pico

  • timeUnit: a frequência com que a janela de execução da prisão de pico é redefinida. Os valores válidos são segundos ou minutos.
  • allow: o número máximo de solicitações permitidas durante o timeUnit.
  • bufferSize: (opcional, padrão = 0). Se bufferSize > 0, a retenção de pico armazenará esse número de solicitações em um buffer. Assim que a próxima "janela" de execução ocorrer, as solicitações armazenadas em buffer serão processadas primeiro. Consulte também Adicionar um buffer.

Como funciona a detenção de pico?

Pense na detenção de pico como uma maneira de se proteger geralmente contra picos de tráfego, não como uma maneira de limitar o tráfego a um número específico de solicitações. Suas APIs e seu back-end podem lidar com uma determinada quantidade de tráfego, e a política de detenção de pico ajuda a reduzir o tráfego para os valores gerais desejados.

O comportamento de detenção de pico no tempo de execução é diferente do que você pode esperar dos valores literais por minuto ou por segundo inseridos.

Por exemplo, digamos que você especifique uma taxa de 30 solicitações por minuto, assim:

spikearrest:
   timeUnit: minute
   allow: 30

Nos testes, você pode pensar que poderia enviar 30 solicitações em um segundo, contanto que elas cheguem em até um minuto. Mas não é assim que a política aplica a configuração. 30 solicitações em um período de um segundo podem ser consideradas um pequeno pico em alguns ambientes.

O que realmente acontece? Para evitar um comportamento semelhante ao de pico, a detenção de pico suaviza o tráfego permitido dividindo as configurações em intervalos menores, da seguinte maneira:

Taxas por minuto

As taxas por minuto são suavizadas em intervalos permitidos de segundos de solicitações. Por exemplo, 30 solicitações por minuto são suavizadas assim:

60 segundos (1 minuto) / 30 = intervalos de 2 segundos, ou cerca de 1 solicitação permitida a cada 2 segundos. Uma segunda solicitação dentro de dois segundos vai falhar. Além disso, a 31a solicitação em um minuto falhará.

Taxas por segundo

As taxas por segundo são suavizadas nas solicitações permitidas em intervalos de milissegundos. Por exemplo, 10 solicitações/segundo são suavizadas assim:

1.000 milissegundos (1 segundo) / 10 = intervalos de 100 milissegundos, ou seja, cerca de uma solicitação permitida a cada 100 milissegundos. Uma segunda solicitação em 100 ms falhará. Além disso, uma 11a solicitação dentro de um segundo falhará.

Quando o limite é excedido

Se o número de solicitações exceder o limite dentro do intervalo de tempo especificado, o alerta de pico retornará esta mensagem de erro com um status HTTP 503:

{"error": "spike arrest policy violated"}

Como adicionar um buffer

Você tem a opção de adicionar um buffer à política. Digamos que você definiu o buffer como 10. Você verá que a API não retorna um erro imediatamente quando você excede o limite de detenção de pico. Em vez disso, as solicitações são armazenadas em buffer (até o número especificado) e as solicitações em buffer são processadas assim que a próxima janela de execução adequada fica disponível. O bufferSize padrão é 0.

Como usar o plug-in de cota

Esta seção discute o plug-in de cota.

Sobre o plug-in de cota

Uma cota especifica o número de mensagens de solicitação que um app pode enviar para uma API ao longo de uma hora, dia, semana ou mês. Quando um app atinge o limite da cota, as chamadas de API subsequentes são rejeitadas. Consulte também Qual é a diferença entre detenção de pico e cota?.

Como adicionar o plug-in de cota

Para ver as etapas básicas de qualquer plug-in, consulte Como adicionar e configurar plug-ins.

Configuração de produtos na Apigee Edge

Você configura cotas na IU do Apigee Edge, em que configura os produtos de API. É necessário saber qual produto contém o proxy com reconhecimento de microgateway que você quer limitar com uma cota. Esse produto precisa ser adicionado a um app de desenvolvedor. Quando você faz chamadas de API autenticadas usando chaves no app do desenvolvedor, a cota é aplicada a essas chamadas de API.

  1. Faça login na sua conta da organização do Apigee Edge.
  2. Na IU do Edge, abra o produto associado ao proxy com reconhecimento de microgateway em que você quer aplicar a cota.
    1. Na IU, selecione Produtos no menu Publicar.
    2. Abra o produto que contém a API a que você quer aplicar a cota.
    3. Clique em Editar.
    4. No campo "Cota", especifique o intervalo da cota. Por exemplo, 100 solicitações a cada minuto. Ou 50.000 solicitações a cada 2 horas.

  1. Clique em Salvar.
  2. Confira se o produto foi adicionado a um app de desenvolvedor. Você vai precisar das chaves desse app para fazer chamadas de API autenticadas.

Exemplo de configuração de cota

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
    sequence:
      - oauth
      - quota

Opções de configuração da cota

Não há opções de configuração adicionais para o plug-in de cota.

Como testar o plug-in de cota

Quando a cota é excedida, um status HTTP 403 é retornado ao cliente, junto com a seguinte mensagem:

{"error": "exceeded quota"}

Qual é a diferença entre detenção de pico e cota?

É importante escolher a ferramenta certa para o trabalho em questão. As políticas de cotas configuram o número de mensagens de solicitação que um app cliente pode enviar a uma API ao longo de uma hora, dia, semana ou mês. A política de cotas aplica limites de consumo em apps clientes mantendo um contador distribuído que conta as solicitações recebidas.

Use uma política de cotas para aplicar contratos de negócios ou SLAs com desenvolvedores e parceiros, em vez de gerenciar o tráfego operacional. Por exemplo, uma cota pode ser usada para limitar o tráfego de um serviço sem custo financeiro e, ao mesmo tempo, permitir acesso total para clientes pagantes. Consulte também Como usar o plug-in de cota.

Use a detenção de pico para se proteger contra picos repentinos no tráfego da API. Normalmente, a detenção de pico é usada para impedir possíveis ataques DDoS ou outros ataques maliciosos.