Plug-ins verwenden

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

Edge Microgateway, Version 3.1.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 „Quota“ ausführlich in 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 Ort 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. [prefix] ist das npm Präfixverzeichnis. Informationen zum Speicherort von Edge Microgateway finden Sie unter Wo ist Edge Microgateway installiert, wenn ich dieses Verzeichnis nicht finde?.

[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 Konfigurationsänderungen für Optionen vornehmen.
3. Fügen Sie das Plug-in dem Element plugins:sequence 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.

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. Informationen zum Speicherort von Edge Microgateway finden Sie unter Wo ist Edge Microgateway installiert, wenn ich dieses Verzeichnis nicht finde?.

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

Das Spike Arrest-Plug-in schützt vor Trafficspitzen. Es drosselt die Anzahl der Anfragen, die von einer Edge Microgateway-Instanz verarbeitet werden.

Spike Arrest-Plug-in hinzufügen

Weitere Informationen 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. Weitere Informationen finden Sie unter Wenn Sie mehrere Edge Micro Prozesse.
• 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 könnten Sie denken, 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 Intervalle von Sekunden für zulässige Anfragen geglättet. Beispiel: 30 Anfragen pro Minute werden so geglättet:

60 Sekunden (1 Minute) / 30 = 2-Sekunden-Intervalle oder etwa 1 zulässige 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 Intervalle von Millisekunden für zulässige Anfragen geglättet. Beispiel: 10 Anfragen pro Sekunde werden so geglättet:

1.000 Millisekunden (1 Sekunde) / 10 = 100-Millisekunden-Intervalle oder etwa 1 zulässige 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.

Wenn Sie mehrere Edge Micro Prozesse ausführen

Die Anzahl der zulässigen Anfragen hängt von der Anzahl der ausgeführten Edge Micro-Worker-Prozesse ab, die ausgeführt werden. Spike Arrest berechnet die zulässige Anzahl von Anfragen pro Worker-Prozess. Standardmäßig entspricht die Anzahl der Edge Micro-Prozesse der Anzahl der CPUs auf dem Computer, auf dem Edge Micro installiert ist. Sie können die Anzahl der Worker-Prozesse jedoch konfigurieren, wenn Sie Edge Micro mit der --processes Option im start Befehl starten. Wenn Spike Arrest beispielsweise bei 100 Anfragen in einem bestimmten Zeitraum ausgelöst werden soll und Sie Edge Microgateway mit der Option --processes 4 starten, legen Sie allow: 25 in der Spike Arrest-Konfiguration fest. Zusammenfassend lässt sich sagen, dass Sie den allow Konfigurationsparameter auf den Wert „gewünschte Anzahl für Spike Arrest / Anzahl der Prozesse“ festlegen sollten.

Kontingent-Plug-in verwenden

Ein Kontingent gibt die Anzahl der Anfragenachrichten an, die eine App innerhalb 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

Weitere Informationen finden Sie unter Plug-ins hinzufügen und konfigurieren.

Produktkonfiguration in Apigee Edge

Sie konfigurieren Kontingente in der Apigee Edge-Benutzeroberfläche, in der 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 mit Schlüsseln in der Entwickler-App authentifizieren, 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-Benutzeroberfläche 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 Benutzeroberfläche 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

Um das Kontingent-Plug-in zu konfigurieren, fügen Sie der Konfigurationsdatei das quotas Element hinzu, wie im folgenden Beispiel gezeigt:

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
  quotas:
    bufferSize:
      hour: 20000
      minute: 500
      month: 1
      default: 10000
    useDebugMpId: true
    failOpen: true
...

edgemicro:
  ...
  quotas:
    failOpen: true

edgemicro:
  ...
  quotas:
    useDebugMpId: true
  ...

{
    "allowed": 20,
    "used": 3,
    "exceeded": 0,
    "available": 17,
    "expiryTime": 1570748640000,
    "timestamp": 1570748580323,
    "debugMpId": "6a12dd72-5c8a-4d39-b51d-2c64f953de6a"
}

Redis als Back-End-Speicher für Kontingente verwenden

Wenn Sie Redis als Back-End-Speicher für Kontingente verwenden möchten, verwenden Sie dieselbe Konfiguration wie für die Synchronizer-Funktion. Im Folgenden finden Sie die grundlegende Konfiguration, die für die Verwendung von Redis für die Kontingentspeicherung erforderlich ist:

edgemicro:
  redisHost: localhost
  redisPort: 6379
  redisDb: 2
  redisPassword: codemaster

quotas:
  useRedis: true

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-App innerhalb einer Stunde, eines Tages, einer Woche oder eines Monats an eine API senden darf. 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. Mit einem Kontingent können Sie beispielsweise den Traffic für einen kostenlosen Dienst beschränken und gleichzeitig zahlenden Kunden uneingeschränkten Zugriff gewähren.

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