Plug-ins verwenden

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X. info

Edge Microgateway, Version 2.4.x

Zielgruppe

Dieses Thema richtet sich an Edge Microgateway-Betreiber, die vorhandene Plug-ins verwenden möchten, die mit dem Microgateway installiert wurden. Außerdem werden die Plug-ins „Spike Arrest“ und „Kontingent“ im Detail behandelt (beide sind in der Installation enthalten). Wenn Sie ein Entwickler sind, der neue Plug-ins entwickeln möchte, lesen Sie Benutzerdefinierte Plug-ins entwickeln.

Was ist ein Edge Microgateway-Plug-in?

Ein Plug-in ist ein Node.js-Modul, das Edge Microgateway Funktionen hinzufügt. Plug-in-Module folgen einem einheitlichen Muster und werden an einem Speicherort gespeichert, der Edge Microgateway bekannt ist. So kann das Microgateway sie automatisch erkennen und laden. Edge Microgateway enthält mehrere vorhandene Plug-ins. Sie können auch benutzerdefinierte Plug-ins erstellen, wie unter Benutzerdefinierte Plug-ins entwickeln beschrieben.

Vorhandene Plug-ins, die mit Edge Microgateway gebündelt sind

Bei der Installation von Edge Microgateway werden mehrere vorhandene Plug-ins bereitgestellt. Dazu gehören:

Vorhandene Plug-ins finden

Vorhandene Plug-ins, die mit Edge Microgateway gebündelt sind, finden Sie hier, wobei [prefix] das npm Präfixverzeichnis ist. Weitere Informationen finden Sie unter Wo ist Edge Microgateway installiert.

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

Plug-ins hinzufügen und konfigurieren

Folgen Sie diesem Muster, um Plug-ins hinzuzufügen und zu konfigurieren:

1. Beenden Sie Edge Microgateway.
2. Öffnen Sie eine Edge Microgateway-Konfigurationsdatei. Weitere Informationen finden Sie unter Making Konfigurationsänderungen für Optionen vornehmen.
3. Fügen Sie das Plug-in dem plugins:sequence Element der Konfigurationsdatei hinzu, wie unten gezeigt. Plug-ins werden in der Reihenfolge ausgeführt, in der sie in dieser Liste aufgeführt sind.

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

4. Konfigurieren Sie das Plug-in. Einige Plug-ins haben optionale Parameter, die Sie in der Konfigurationsdatei konfigurieren können. Sie können beispielsweise den folgenden Abschnitt hinzufügen, um das Spike Arrest Plug-in zu konfigurieren. Weitere Informationen finden Sie unter Spike Arrest Plug-in verwenden.

   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

5. Speichern Sie die Datei.
6. Starten Sie Edge Microgateway neu oder laden Sie es neu, je nachdem, welche Konfigurationsdatei Sie bearbeitet haben. Weitere Informationen finden Sie unter Konfigurationsänderungen vornehmen.

Plug-in-spezifische Konfiguration

Sie können die in der Konfigurationsdatei angegebenen Plug-in-Parameter überschreiben, indem Sie in diesem Verzeichnis eine Plug-in-spezifische Konfiguration erstellen:

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

Dabei ist [prefix] das npm-Präfixverzeichnis. Weitere Informationen finden Sie unter Wo ist Edge Microgateway installiert.

plugins/<plugin_name>/config/default.yaml. Sie können diesen Block beispielsweise in plugins/spikearrest/config/default.yaml einfügen. Dadurch werden alle anderen Konfigurationseinstellungen überschrieben.

spikearrest:
   timeUnit: hour   
   allow: 10000   
   buffersize: 0

Spike Arrest-Plug-in verwenden

In diesem Abschnitt wird das Spike Arrest-Plug-in behandelt.

Spike Arrest

Spike Arrest schützt vor Trafficspitzen. Es drosselt die Anzahl der Anfragen, die von einer Edge Microgateway-Instanz verarbeitet werden. Weitere Informationen finden Sie unter Wie funktioniert Spike Arrest? Weitere Informationen finden Sie unter Was ist der Unterschied zwischen Spike Arrest und Kontingent?.

Spike Arrest-Plug-in hinzufügen

Die grundlegenden Schritte für jedes Plug-in finden Sie unter Plug-ins hinzufügen und konfigurieren.

Beispielkonfiguration für Spike Arrest

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

Konfigurationsoptionen für Spike Arrest

• timeUnit: Wie oft das Ausführungsfenster für Spike Arrest zurückgesetzt wird. Gültige Werte sind „second“ oder „minute“.
• allow: Die maximale Anzahl von Anfragen, die während der timeUnit zulässig sind.
• bufferSize: (optional, Standardwert = 0) Wenn bufferSize > 0, speichert Spike Arrest diese Anzahl von Anfragen in einem Puffer. Sobald das nächste Ausführungsfenster auftritt, werden die gepufferten Anfragen zuerst verarbeitet. Weitere Informationen finden Sie unter Puffer hinzufügen.

Wie funktioniert Spike Arrest?

Mit Spike Arrest können Sie sich vor Trafficspitzen schützen, ohne den Traffic auf eine bestimmte Anzahl von Anfragen zu beschränken. APIs und das Back-End können eine bestimmte Menge an Traffic bewältigen. Die Spike Arrest-Richtlinie hilft Ihnen dabei, den Traffic auf die gewünschte allgemeine Menge zu begrenzen.

Das Laufzeitverhalten von Spike Arrest unterscheidet sich von dem, was Sie von den Literalwerten pro Minute oder pro Sekunde erwarten können.

Angenommen, Sie geben eine Rate von 30 Anfragen pro Minute an:

spikearrest:
   timeUnit: minute
   allow: 30

Beim Testen denken Sie vielleicht, dass Sie 30 Anfragen in 1 Sekunde senden können, solange sie innerhalb einer Minute eingehen. So erzwingt die Richtlinie die Einstellung jedoch nicht. Wenn Sie darüber nachdenken, könnten 30 Anfragen innerhalb einer Sekunde in einigen Umgebungen als Mini-Spike betrachtet werden.

Was geschieht dann tatsächlich? Um ein anstiegsartiges Verhalten zu verhindern, glättet Spike Arrest den zulässigen Traffic, indem Ihre Einstellungen in kleinere Intervalle unterteilt werden:

Raten pro Minute

Raten pro Minute werden in Anfragen geglättet, die in Intervallen von Sekunden zulässig sind. 30 Anfragen pro Minute werden beispielsweise so geglättet:

60 Sekunden (1 Minute) / 30 = 2-Sekunden-Intervalle oder etwa 1 Anfrage alle 2 Sekunden. Eine zweite Anfrage innerhalb von 2 Sekunden schlägt fehl. Außerdem schlägt eine 31. Anfrage innerhalb einer Minute fehl.

Raten pro Sekunde

Raten pro Sekunde werden in Anfragen geglättet, die in Intervallen von Millisekunden zulässig sind. 10 Anfragen pro Sekunde werden beispielsweise so geglättet:

1.000 Millisekunden (1 Sekunde) / 10 = 100-Millisekunden-Intervalle oder etwa 1 Anfrage alle 100 Millisekunden. Eine zweite Anfrage innerhalb von 100 Millisekunden schlägt fehl. Außerdem schlägt eine 11. Anfrage innerhalb einer Sekunde fehl.

Wenn das Limit überschritten wird

Wenn die Anzahl der Anfragen das Limit innerhalb des angegebenen Zeitintervalls überschreitet, gibt Spike Arrest diese Fehlermeldung mit dem HTTP-Status 503 zurück:

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

Puffer hinzufügen

Sie haben die Möglichkeit, der Richtlinie einen Puffer hinzuzufügen. Angenommen, Sie legen den Puffer auf 10 fest. Die API gibt nicht sofort einen Fehler zurück, wenn Sie das Spike Arrest -Limit überschreiten. Stattdessen werden Anfragen gepuffert (bis zur angegebenen Anzahl) und die gepufferten Anfragen werden verarbeitet, sobald das nächste geeignete Ausführungsfenster verfügbar ist. Der Standardwert für bufferSize ist 0.

Kontingent-Plug-in verwenden

In diesem Abschnitt wird das Kontingent-Plug-in behandelt.

Kontingent-Plug-in

Ein Kontingent gibt die Anzahl der Anfragenachrichten an, die eine App im Verlauf einer Stunde, eines Tages, einer Woche oder eines Monats an eine API senden darf. Wenn eine App das Kontingentlimit erreicht, werden nachfolgende API-Aufrufe abgelehnt. Weitere Informationen finden Sie unter Was ist der Unterschied zwischen Spike Arrest und Kontingent?.

Kontingent-Plug-in hinzufügen

Die grundlegenden Schritte für jedes Plug-in finden Sie unter Plug-ins hinzufügen und konfigurieren.

Produktkonfiguration in Apigee Edge

Sie konfigurieren Kontingente in der Apigee Edge-UI, wo Sie API-Produkte konfigurieren. Sie müssen wissen welches Produkt den Microgateway-fähigen Proxy enthält, den Sie mit einem Kontingent einschränken möchten. Dieses Produkt muss einer Entwickler-App hinzugefügt werden. Wenn Sie API-Aufrufe ausführen, die mit Schlüsseln in der Entwickler-App authentifiziert werden, wird das Kontingent auf diese API-Aufrufe angewendet.

1. Melden Sie sich im Organisationskonto Ihrer Apigee Edge-Organisation an.
2. Öffnen Sie in der Edge-UI das Produkt, das mit dem Microgateway-fähigen Proxy verknüpft ist, auf den Sie das Kontingent anwenden möchten.
   1. Wählen Sie in der UI im Menü „Veröffentlichen“ die Option Produkte aus.
   2. Öffnen Sie das Produkt, das die API enthält, auf die Sie das Kontingent anwenden möchten.
   3. Klicken Sie auf Bearbeiten.
   4. Geben Sie im Feld „Kontingent“ das Kontingentintervall an. Beispiel: 100 Anfragen pro Minute. Oder 50.000 Anfragen alle 2 Stunden.
      
      

3. Klicken Sie auf Speichern.
4. Achten Sie darauf, dass das Produkt einer Entwickler-App hinzugefügt wird. Sie benötigen die Schlüssel aus dieser App, um authentifizierte API-Aufrufe auszuführen.

Beispielkonfiguration für Kontingente

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

Konfigurationsoptionen für Kontingente

Für das Kontingent-Plug-in gibt es keine zusätzlichen Konfigurationsoptionen.

Kontingent-Plug-in testen

Wenn das Kontingent überschritten wird, wird dem Client der HTTP-Status 403 zusammen mit der folgenden Meldung zurückgegeben:

{"error": "exceeded quota"}

Was ist der Unterschied zwischen Spike Arrest und Kontingent?

Es ist wichtig, das richtige Tool für die jeweilige Aufgabe auszuwählen. Mit Kontingentrichtlinien wird die Anzahl der Anfragenachrichten konfiguriert, die eine Client-Anwendung im Laufe einer Stunde, eines Tages, einer Woche oder eines Monats an eine API senden kann. Die Kontingentrichtlinie erzwingt Nutzungsbeschränkungen für Clientanwendungen, die einen verteilten Zähler zur Verfügung stellen, der eingehende Anfragen erhöht.

Verwenden Sie eine Kontingentrichtlinie, um Geschäftsverträge oder SLAs mit Entwicklern und Partnern zu erzwingen, anstatt für die operative Trafficverwaltung. Ein Kontingent kann beispielsweise verwendet werden, um den Traffic für einen kostenlosen Dienst zu begrenzen, während zahlende Kunden vollen Zugriff erhalten. Weitere Informationen finden Sie unter Kontingent-Plug-in verwenden.

Spike Arrest schützt vor plötzlichen Spitzen im API-Traffic. Spike Arrest wird in der Regel verwendet, um mögliche DDoS- oder andere böswillige Angriffe abzuwehren.