Vorgangs- und Konfigurationsreferenz für Edge Microgateway

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

Edge Microgateway v. 2.3.x

Übersicht

In diesem Thema wird erläutert, wie Sie Edge Microgateway verwalten und konfigurieren, einschließlich Monitoring, Logging und Fehlerbehebung.

Konfigurationsänderungen vornehmen

Zu den Konfigurationsdateien, die Sie kennen sollten, gehören:

  • Standard-Systemkonfigurationsdatei
  • Standardkonfigurationsdatei für eine neu initialisierte Edge Microgateway-Instanz
  • Dynamische Konfigurationsdatei für laufende Instanzen

In diesem Abschnitt werden diese Dateien und die Änderungen daran erläutert. Weitere Informationen zu den Einstellungen der Konfigurationsdatei finden Sie in der Edge Microgateway-Konfigurationsreferenz.

Standard-Systemkonfigurationsdatei

Wenn Sie Edge Microgateway installieren, wird hier eine Standard-Systemkonfigurationsdatei abgelegt:

[prefix]/lib/node_modules/edgemicro/config/default.yaml

Dabei ist [prefix] das Präfixverzeichnis npm. Siehe Wo ist Edge Microgateway installiert?.

Wenn Sie die Systemkonfigurationsdatei ändern, müssen Sie Edge Microgateway neu initialisieren, neu konfigurieren und neu starten:

  1. edgemicro init anrufen
  2. edgemicro configure [params] anrufen
  3. edgemicro start [params] anrufen

Standardkonfigurationsdatei für neu initialisierte Edge Microgateway-Instanzen

Wenn Sie edgemicro init ausführen, wird die oben beschriebene Systemkonfigurationsdatei default.yaml in diesem Verzeichnis abgelegt: ~/.edgemicro

Wenn Sie die Konfigurationsdatei in ~/.edgemicro ändern, müssen Sie Edge Microgateway neu konfigurieren und neu starten:

  1. edgemicro stop
  2. edgemicro configure [params]
  3. edgemicro start [params]

Dynamische Konfigurationsdatei für laufende Instanzen

Wenn Sie edgemicro configure [params] ausführen, wird eine dynamische Konfigurationsdatei in ~/.edgemicro erstellt. Die Datei wird nach diesem Muster benannt: [org]-[env]-config.yaml, wobei org und env die Namen Ihrer Apigee Edge-Organisation und -Umgebung sind. Sie können diese Datei verwenden, um Konfigurationsänderungen vorzunehmen und sie dann ohne Ausfallzeiten neu zu laden. Wenn Sie beispielsweise ein Plug-in hinzufügen und konfigurieren, können Sie die Konfiguration ohne Ausfallzeiten neu laden, wie unten erläutert.

Wenn Edge Microgateway ausgeführt wird (Option ohne Ausfallzeit):

  1. Laden Sie die Edge Microgateway-Konfiguration neu:
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    Wobei:

    • org ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator sein).
    • env ist eine Umgebung in Ihrer Organisation (z. B. „test“ oder „prod“).
    • key ist der Schlüssel, der zuvor vom Befehl „configure“ zurückgegeben wurde.
    • secret ist der Schlüssel, der zuvor vom Konfigurationsbefehl zurückgegeben wurde.

    Beispiel

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

Wenn Edge Microgateway beendet wurde:

  1. Starten Sie Edge Microgateway neu:
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    Wobei:

    • org ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator sein).
    • env ist eine Umgebung in Ihrer Organisation (z. B. „test“ oder „prod“).
    • key ist der Schlüssel, der zuvor vom Befehl „configure“ zurückgegeben wurde.
    • secret ist der Schlüssel, der zuvor vom Konfigurationsbefehl zurückgegeben wurde.

    Beispiel

    edgemicro start -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824

Hier sehen Sie eine Beispielkonfigurationsdatei. Weitere Informationen zu den Einstellungen der Konfigurationsdatei finden Sie in der Konfigurationsreferenz für Edge Microgateway.

edge_config:
  bootstrap: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test
  jwt_public_key: 'https://docs-test.apigee.net/edgemicro-auth/publicKey'
  managementUri: 'https://api.enterprise.apigee.com'
  vaultName: microgateway
  authUri: 'https://%s-%s.apigee.net/edgemicro-auth'
  baseUri: >-
    https://edgemicroservices.apigee.net/edgemicro/%s/organization/%s/environment/%s
  bootstrapMessage: Please copy the following property to the edge micro agent config
  keySecretMessage: The following credentials are required to start edge micro
  products: 'https://docs-test.apigee.net/edgemicro-auth/products'
edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  config_change_poll_interval: 600
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
headers:
  x-forwarded-for: true
  x-forwarded-host: true
  x-request-id: true
  x-response-time: true
  via: true
oauth:
  allowNoAuthorization: false
  allowInvalidAuthorization: false
  verify_api_key_url: 'https://docs-test.apigee.net/edgemicro-auth/verifyApiKey'
analytics:
  uri: >-
    https://edgemicroservices-us-east-1.apigee.net/edgemicro/axpublisher/organization/docs/environment/test

Umgebungsvariablen festlegen

Die Befehle der Befehlszeile, die Werte für Ihre Edge-Organisation und -Umgebung erfordern, sowie der Schlüssel und das Secret, die zum Starten von Edge Microgateway erforderlich sind, können in diesen Umgebungsvariablen gespeichert werden:

  • EDGEMICRO_ORG
  • EDGEMICRO_ENV
  • EDGEMICRO_KEY
  • EDGEMICRO_SECRET

Das Festlegen dieser Variablen ist optional. Wenn Sie sie festlegen, müssen Sie ihre Werte nicht angeben, wenn Sie die Befehlszeile (CLI) verwenden, um Edge Microgateway zu konfigurieren und zu starten.

SSL auf dem Edge Microgateway-Server konfigurieren

Sie können den Microgateway-Server so konfigurieren, dass er SSL verwendet. Wenn SSL konfiguriert ist, können Sie beispielsweise APIs über Edge Microgateway mit dem „https“-Protokoll so aufrufen:

https://localhost:8000/myapi

So konfigurieren Sie SSL auf dem Microgateway-Server:

  1. Generieren oder rufen Sie ein SSL-Zertifikat und einen Schlüssel mit dem Dienstprogramm openssl oder einer anderen Methode ab.
  2. Fügen Sie das Attribut edgemicro:ssl zur Edge Microgateway-Konfigurationsdatei hinzu. Eine vollständige Liste der Optionen finden Sie in der Tabelle unten. Weitere Informationen zum Ändern der Edge Microgateway-Konfiguration finden Sie unter Konfigurationsänderungen vornehmen. Beispiel:
     edgemicro:
         ssl:
             key: <absolute path to the SSL key file>
             cert: <absolute path to the SSL cert file>
             passphrase: admin123 #option added in v2.2.2
             rejectUnauthorized: true #option added in v2.2.2
  3. Starten Sie Edge Microgateway neu. Führen Sie die Schritte unter Konfigurationsänderungen vornehmen aus, je nachdem, welche Konfigurationsdatei Sie bearbeitet haben: die Standarddatei oder die Laufzeitkonfigurationsdatei.

Hier sehen Sie ein Beispiel für den Abschnitt „edgemicro“ der Konfigurationsdatei mit konfiguriertem SSL:

edgemicro:
  port: 8000
  max_connections: 1000
  max_connections_hard: 5000
  logging:
    level: error
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24
  plugins:
    sequence:
      - oauth
  ssl:
    key: /MyHome/SSL/em-ssl-keys/server.key
    cert: /MyHome/SSL/em-ssl-keys/server.crt
    passphrase: admin123 #option added in v2.2.2
    rejectUnauthorized: true #option added in v2.2.2

Hier finden Sie eine Liste aller unterstützten Serveroptionen:

Option Beschreibung
key Pfad zu einer ca.key-Datei (im PEM-Format).
cert Pfad zu einer ca.cert-Datei (im PEM-Format).
pfx Pfad zu einer pfx-Datei, die den privaten Schlüssel, das Zertifikat und die CA-Zertifikate des Clients im PFX-Format enthält.
passphrase Ein String, der die Passphrase für den privaten Schlüssel oder die PFX-Datei enthält.
ca Pfad zu einer Datei, die eine Liste vertrauenswürdiger Zertifikate im PEM-Format enthält.
ciphers Ein String, der die zu verwendenden Chiffren beschreibt, getrennt durch einen Doppelpunkt („:“).
rejectUnauthorized Wenn „true“, wird das Serverzertifikat mit der Liste der bereitgestellten Zertifizierungsstellen abgeglichen. Wenn die Überprüfung fehlschlägt, wird ein Fehler zurückgegeben.
secureProtocol Die zu verwendende SSL-Methode. Beispiel: SSLv3_method, um SSL auf Version 3 zu erzwingen.
servername Der Servername für die TLS-Erweiterung SNI (Server Name Indication).

SSL/TLS-Optionen für Clients verwenden

Sie können Edge Microgateway so konfigurieren, dass es als TLS- oder SSL-Client fungiert, wenn eine Verbindung zu Zielendpunkten hergestellt wird. Verwenden Sie in der Microgateway-Konfigurationsdatei das Element „targets“, um SSL/TLS-Optionen festzulegen.

In diesem Beispiel werden Einstellungen bereitgestellt, die auf alle Hosts angewendet werden:

targets:
   ssl:
     client:
       key: /Users/jdoe/nodecellar/twowayssl/ssl/client.key
       cert: /Users/jdoe/nodecellar/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

In diesem Beispiel werden die Einstellungen nur auf den angegebenen Host angewendet:

targets:
   host: 'myserver.example.com'
   ssl:
     client:
       key: /Users/myname/twowayssl/ssl/client.key
       cert: /Users/myname/twowayssl/ssl/ca.crt
       passphrase: admin123
       rejectUnauthorized: true

Hier ein Beispiel für TLS:

targets:
   host: 'myserver.example.com'
   tls:
     client:
       pfx: /Users/myname/twowayssl/ssl/client.pfx
       passphrase: admin123
       rejectUnauthorized: true

Hier finden Sie eine Liste aller unterstützten Clientoptionen:

Option Beschreibung
pfx Pfad zu einer pfx-Datei, die den privaten Schlüssel, das Zertifikat und die CA-Zertifikate des Clients im PFX-Format enthält.
key Pfad zu einer ca.key-Datei (im PEM-Format).
passphrase Ein String, der die Passphrase für den privaten Schlüssel oder die PFX-Datei enthält.
cert Pfad zu einer ca.cert-Datei (im PEM-Format).
ca Pfad zu einer Datei, die eine Liste vertrauenswürdiger Zertifikate im PEM-Format enthält.
ciphers Ein String, der die zu verwendenden Chiffren beschreibt, getrennt durch einen Doppelpunkt („:“).
rejectUnauthorized Wenn „true“, wird das Serverzertifikat mit der Liste der bereitgestellten Zertifizierungsstellen abgeglichen. Wenn die Überprüfung fehlschlägt, wird ein Fehler zurückgegeben.
secureProtocol Die zu verwendende SSL-Methode. Beispiel: SSLv3_method, um SSL auf Version 3 zu erzwingen.
servername Der Servername für die TLS-Erweiterung SNI (Server Name Indication).

Benutzerdefinierten Authentifizierungsdienst verwenden

Standardmäßig verwendet Edge Microgateway einen auf Apigee Edge bereitgestellten Proxy für die OAuth2-Authentifizierung. Dieser Proxy wird bereitgestellt, wenn Sie edgemicro configure zum ersten Mal ausführen. Standardmäßig wird die URL dieses Proxys in der Edge Microgateway-Konfigurationsdatei so angegeben:

authUri: https://myorg-myenv.apigee.net/edgemicro-auth

Wenn Sie Ihren eigenen benutzerdefinierten Dienst für die Authentifizierung verwenden möchten, ändern Sie den Wert authUri in der Konfigurationsdatei so, dass er auf Ihren Dienst verweist. Beispielsweise haben Sie möglicherweise einen Dienst, der LDAP zur Identitätsbestätigung verwendet.

Logdateien verwalten

Edge Microgateway protokolliert Informationen zu jeder Anfrage und Antwort. Logdateien enthalten nützliche Informationen zur Fehlerbehebung und zum Debugging.

Speicherort von Protokolldateien

Standardmäßig werden Logdateien in /var/tmp gespeichert.

Standardverzeichnis für Protokolldateien ändern

Das Verzeichnis, in dem Logdateien gespeichert werden, wird in der Edge Microgateway-Konfigurationsdatei angegeben. Weitere Informationen zum Ändern der Konfiguration finden Sie unter Konfigurationsänderungen vornehmen.

edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

Ändern Sie den Wert dir, um ein anderes Verzeichnis für die Protokolldatei anzugeben.

Logs an die Konsole senden

Sie können das Logging so konfigurieren, dass Loginformationen an die Standardausgabe statt an eine Logdatei gesendet werden. Legen Sie das Flag to_console so auf „true“ fest:

edgemicro:
  logging:
    to_console: true  

Mit dieser Einstellung werden Logs an die Standardausgabe gesendet. Derzeit können Sie Logs nicht sowohl an stdout als auch an eine Logdatei senden.

Protokollierungsebene festlegen

Sie können die folgenden Logebenen festlegen: info, warn und error. Die Info-Stufe wird empfohlen. Alle API-Anfragen und -Antworten werden geloggt. Dies ist die Standardeinstellung.

Protokollierungsintervalle ändern

Sie können diese Intervalle in der Edge Microgateway-Konfigurationsdatei konfigurieren. Weitere Informationen zum Vornehmen von Konfigurationsänderungen finden Sie unter Konfigurationsänderungen vornehmen.

Die konfigurierbaren Attribute sind:

  • stats_log_interval: (Standard: 60) Intervall in Sekunden, in dem der Statistikdatensatz in die API-Logdatei geschrieben wird.
  • rotate_interval: (Standard: 24) Intervall in Stunden, in dem Logdateien rotiert werden. Beispiel:
edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
    rotate_interval: 24

Hinweis: Archivierte Protokolldateien werden nicht komprimiert. Zu Beginn des Intervalls wird eine neue Logdatei mit einem neuen Zeitstempel erstellt.

Best Practices für die Wartung von Protokolldateien

Da sich im Laufe der Zeit Protokolldateidaten ansammeln, empfiehlt Apigee die folgenden Vorgehensweisen:

  • Da Protokolldateien sehr groß werden können, muss im Verzeichnis der Protokolldateien ausreichend Speicherplatz vorhanden sein. Weitere Informationen finden Sie in den folgenden Abschnitten: Wo Logdateien gespeichert werden und Standardverzeichnis für Logdateien ändern.
  • Löschen Sie Protokolldateien mindestens einmal pro Woche oder verschieben Sie sie in ein separates Archivverzeichnis.
  • Wenn Ihre Richtlinie das Löschen von Protokollen vorsieht, können Sie den Befehlszeilenbefehl edgemicro log -c verwenden, um ältere Protokolle zu entfernen (zu bereinigen).

Namenskonvention für Logdateien

Jede Edge Microgateway-Instanz erzeugt drei Arten von Protokolldateien:

  • api: Protokolliert alle Anfragen und Antworten, die über Edge Microgateway fließen. API-Zähler (Statistiken) und Fehler werden ebenfalls in dieser Datei protokolliert.
  • err: Protokolliert alles, was an stderr gesendet wird.
  • out: Protokolliert alles, was an stdout gesendet wird.

Dies ist die Namenskonvention:

edgemicro-<Host Name>-<Instance ID>-<Log Type>.log

Beispiel:

edgemicro-mymachine-local-MTQzNTgNDMxODAyMQ-api.log
edgemicro-mymachine-local-MTQzNTg1NDMODAyMQ-err.log
edgemicro-mymachine-local-mtqzntgndmxodaymq-out.log

Inhalt von Logdateien

Hinzugefügt in: v2.3.3

Standardmäßig werden im Logging-Dienst die JSON-Dateien heruntergeladener Proxys und Produkte sowie das JSON Web Token (JWT) weggelassen. Wenn Sie diese Objekte in die Logdateien ausgeben möchten, legen Sie beim Starten von Edge Microgateway die DEBUG=* fest. Beispiel:

DEBUG=* edgemicro start -o docs -e test -k abc123 -s xyz456

Inhalt der Logdatei „api“

Die Logdatei „api“ enthält detaillierte Informationen zum Ablauf von Anfragen und Antworten über Edge Microgateway. Die „api“-Logdateien sind so benannt:

edgemicro-mymachine-local-MTQzNjIxOTk0NzY0Nw-api.log

Für jede Anfrage an Edge Microgateway werden vier Ereignisse in der Protokolldatei „api“ erfasst:

  • Eingehende Anfrage vom Client
  • Ausgehende Anfrage an das Ziel
  • Eingehende Antwort vom Ziel
  • Ausgehende Antwort an den Client

Jeder dieser separaten Einträge wird in einer Kurzschreibweise dargestellt, um die Logdateien kompakter zu machen. Hier sind vier Beispieleinträge, die jeweils eines der vier Ereignisse darstellen. In der Protokolldatei sehen sie so aus (die Zeilennummern dienen nur als Referenz im Dokument und werden nicht in der Protokolldatei angezeigt).

(1) 1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
(2) 1436403888665 info treq m=GET, u=/, h=127.0.0.18080, i=0
(3) 1436403888672 info tres s=200, d=7, i=0
(4) 1436403888676 info res s=200, d=11, i=0

Sehen wir uns die einzelnen Optionen an:

1. Beispiel für eine eingehende Anfrage vom Client:

1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
  • 1436403888651: Unix-Zeitstempel
  • info: hängt vom Kontext ab. Kann je nach Logebene „info“, „warn“ oder „error“ sein. Kann „stats“ für einen Statistikdatensatz, „warn“ für Warnungen oder „error“ für Fehler sein.
  • req: Identifiziert das Ereignis. In diesem Fall die Anfrage vom Client.
  • m: Das in der Anfrage verwendete HTTP-Verb.
  • u: Der Teil der URL, der auf den Basispfad folgt.
  • h: Der Host und die Portnummer, auf denen Edge Microgateway überwacht wird.
  • r: Der Remote-Host und der Port, von dem die Clientanfrage stammt.
  • i: Die Anfrage-ID. Alle vier Ereigniseinträge haben dieselbe ID. Jeder Anfrage wird eine eindeutige Anfrage-ID zugewiesen. Die Korrelation von Logeinträgen nach Anfrage-ID kann wertvolle Einblicke in die Latenz des Ziels liefern.
  • d: Die Dauer in Millisekunden, seit die Anfrage von Edge Microgateway empfangen wurde. Im obigen Beispiel wurde die Antwort des Ziels für Anfrage 0 nach 7 Millisekunden empfangen (Zeile 3) und die Antwort wurde nach weiteren 4 Millisekunden an den Client gesendet (Zeile 4). Mit anderen Worten: Die Gesamtlatenz der Anfrage betrug 11 Millisekunden, davon 7 Millisekunden für das Ziel und 4 Millisekunden für Edge Microgateway selbst.

2. Beispiel für eine ausgehende Anfrage an das Ziel:

1436403888665 info treq m=GET, u=/, h=127.0.0.1:8080, i=0
  • 1436403888651: Unix-Zeitstempel
  • info: hängt vom Kontext ab. Kann je nach Logebene „info“, „warn“ oder „error“ sein. Kann „stats“ für einen Statistikdatensatz, „warn“ für Warnungen oder „error“ für Fehler sein.
  • treq: Identifiziert das Ereignis. In diesem Fall „target request“.
  • m: Das in der Zielanfrage verwendete HTTP-Verb.
  • u: Der Teil der URL, der auf den Basispfad folgt.
  • h: Der Host und die Portnummer des Backend-Ziels.
  • i: Die ID des Logeintrags. Alle vier Ereigniseinträge haben diese ID.

3. Beispiel für eine eingehende Antwort vom Ziel

1436403888672 info tres s=200, d=7, i=0

1436403888651: Unix-Zeitstempel

  • info: hängt vom Kontext ab. Kann je nach Logebene „info“, „warn“ oder „error“ sein. Kann „stats“ für einen Statistikdatensatz, „warn“ für Warnungen oder „error“ für Fehler sein.
  • tres: Identifiziert das Ereignis. In diesem Fall ist das die Ziel-Antwort.
  • s: Der HTTP-Antwortstatus.
  • d: Die Dauer in Millisekunden. Die Zeit, die das Ziel für den API-Aufruf benötigt hat.
  • i: Die ID des Logeintrags. Alle vier Ereigniseinträge haben diese ID.

4. Beispiel für eine ausgehende Antwort an den Client

1436403888676 info res s=200, d=11, i=0

1436403888651: Unix-Zeitstempel

  • info: hängt vom Kontext ab. Kann je nach Logebene „info“, „warn“ oder „error“ sein. Kann „stats“ für einen Statistikdatensatz, „warn“ für Warnungen oder „error“ für Fehler sein.
  • res: Identifiziert das Ereignis. In diesem Fall die Antwort an den Client.
  • s: Der HTTP-Antwortstatus.
  • d: Die Dauer in Millisekunden. Dies ist die Gesamtzeit, die für den API-Aufruf benötigt wird, einschließlich der Zeit, die für die Ziel-API und für Edge Microgateway selbst benötigt wird.
  • i: Die ID des Logeintrags. Alle vier Ereigniseinträge haben diese ID.

Zeitplan für Logdatei

Logdateien werden in dem Intervall rotiert, das im Konfigurationsattribut rotate_interval angegeben ist. Einträge werden so lange derselben Logdatei hinzugefügt, bis das Rotationsintervall abläuft. Bei jedem Neustart von Edge Microgateway erhält es jedoch eine neue UID und erstellt einen neuen Satz von Logdateien mit dieser UID. Siehe auch Best Practices für die Pflege von Logdateien.

Konfigurationsreferenz für Edge Microgateway

Speicherort der Konfigurationsdatei

Die in diesem Abschnitt beschriebenen Konfigurationsattribute befinden sich in der Edge Microgateway-Konfigurationsdatei. Weitere Informationen zum Ändern der Konfiguration finden Sie unter Konfigurationsänderungen vornehmen.

edge_config-Attribute

Diese Einstellungen werden verwendet, um die Interaktion zwischen der Edge Microgateway-Instanz und Apigee Edge zu konfigurieren.

  • bootstrap: (Standard: none) Eine URL, die auf einen Edge Microgateway-spezifischen Dienst verweist, der auf Apigee Edge ausgeführt wird. Edge Microgateway verwendet diesen Dienst, um mit Apigee Edge zu kommunizieren. Diese URL wird zurückgegeben, wenn Sie den Befehl zum Generieren des öffentlichen/privaten Schlüsselpaars ausführen: edgemicro genkeys. Weitere Informationen finden Sie unter Edge Microgateway einrichten und konfigurieren.
  • jwt_public_key: (Standard: keiner) Eine URL, die auf den Edge Microgateway-Proxy verweist, der in Apigee Edge bereitgestellt wird. Dieser Proxy dient als Authentifizierungsendpunkt für die Ausgabe signierter Zugriffstokens an Clients. Diese URL wird zurückgegeben, wenn Sie den Befehl zum Bereitstellen des Proxys ausführen: edgemicro configure. Weitere Informationen finden Sie unter Edge Microgateway einrichten und konfigurieren.

edgemicro-Attribute

Mit diesen Einstellungen wird der Edge Microgateway-Prozess konfiguriert.

  • port: (Standard: 8000) Die Portnummer, auf der der Edge Microgateway-Prozess überwacht wird.
  • max_connections: (Standard: -1) Gibt die maximale Anzahl gleichzeitiger eingehender Verbindungen an, die Edge Microgateway empfangen kann. Wenn diese Anzahl überschritten wird, wird der folgende Status zurückgegeben:

    res.statusCode = 429; // Too many requests
  • max_connections_hard: (Standard: -1) Die maximale Anzahl gleichzeitiger Anfragen, die Edge Microgateway empfangen kann, bevor die Verbindung beendet wird. Diese Einstellung soll Denial-of-Service-Angriffe verhindern. In der Regel wird hier ein Wert festgelegt, der größer als „max_connections“ ist.
  • logging:
    • level: (Standard: error)
      • info: Protokolliert alle Anfragen und Antworten, die über eine Edge Microgateway-Instanz laufen.
      • warn: Es werden nur Warnmeldungen protokolliert.
      • error: Es werden nur Fehlermeldungen protokolliert.
    • dir: (Standard: /var/tmp) Das Verzeichnis, in dem Logdateien gespeichert werden.
    • stats_log_interval: (Standard: 60) Intervall in Sekunden, in dem der Statistikdatensatz in die API-Logdatei geschrieben wird.
    • rotate_interval: (Standard: 24) Intervall in Stunden, in dem Logdateien rotiert werden.
  • dir: Ein relativer Pfad vom Verzeichnis ./gateway zum Verzeichnis ./plugins oder ein absoluter Pfad.
  • sequence: Eine Liste von Plug-in-Modulen, die Ihrer Edge Microgateway-Instanz hinzugefügt werden sollen. Die Module werden in der hier angegebenen Reihenfolge ausgeführt.
  • debug: Fügt dem Edge Microgateway-Prozess Remote-Debugging hinzu.
    • port: Die Portnummer, auf der gelauscht werden soll. Sie können beispielsweise den IDE-Debugger so einstellen, dass er diesen Port überwacht.
    • args: Argumente für den Debug-Prozess. Beispiel: args --nolazy
  • config_change_poll_interval: (Standard: 600 Sekunden) Edge Microgateway lädt regelmäßig eine neue Konfiguration und führt ein erneutes Laden aus, wenn sich etwas geändert hat. Bei der Abfrage werden alle in Edge vorgenommenen Änderungen (Änderungen an Produkten, Microgateway-fähigen Proxys usw.) sowie Änderungen an der lokalen Konfigurationsdatei erfasst.
  • disable_config_poll_interval: (Standard: false) Setzen Sie den Wert auf true, um die automatische Abfrage von Änderungen zu deaktivieren.

headers-Attribute

Mit diesen Einstellungen wird festgelegt, wie bestimmte HTTP-Header behandelt werden.

  • x-forwarded-for: (Standard: true) Setzen Sie diesen Wert auf „false“, um zu verhindern, dass x-forwarded-for-Header an das Ziel übergeben werden.
  • x-forwarded-host: (Standard: true) Setzen Sie diesen Wert auf „false“, um zu verhindern, dass x-forwarded-host-Header an das Ziel übergeben werden.
  • x-request-id: (Standard: true) Legen Sie „false“ fest, um zu verhindern, dass x-request-id-Header an das Ziel übergeben werden.
  • x-response-time: (Standard: true) Setzen Sie den Wert auf „false“, um zu verhindern, dass x-response-time-Header an das Ziel übergeben werden.
  • via: (Standard: true) Setzen Sie diesen Wert auf „false“, um zu verhindern, dass „via“-Header an das Ziel übergeben werden.

oauth-Attribute

Mit diesen Einstellungen wird konfiguriert, wie die Clientauthentifizierung von Edge Microgateway erzwungen wird.

  • allowNoAuthorization: (Standard: false) Wenn dieser Wert auf „true“ gesetzt ist, können API-Aufrufe ohne Autorisierungsheader über Edge Microgateway geleitet werden. Legen Sie diesen Wert auf „false“ fest, um einen Autorisierungsheader anzufordern (Standard).
  • allowInvalidAuthorization: (Standard: false) Wenn dieser Wert auf „true“ gesetzt ist, werden API-Aufrufe zugelassen, wenn das im Autorisierungsheader übergebene Token ungültig oder abgelaufen ist. Setzen Sie diesen Wert auf „false“, um gültige Tokens zu erzwingen (Standard).
  • authorization-header: (Standard: Authorization: Bearer) Der Header, der zum Senden des Zugriffstokens an Edge Microgateway verwendet wird. Sie können die Standardeinstellung ändern, wenn das Ziel den Autorisierungsheader für einen anderen Zweck verwenden muss.
  • api-key-header: (Standard: x-api-key) Der Name des Headers oder Abfrageparameters, der verwendet wird, um einen API-Schlüssel an Edge Microgateway zu übergeben. Weitere Informationen finden Sie unter API-Schlüssel verwenden.
  • keepAuthHeader: (Standard: false) Wenn dieser Wert auf „true“ gesetzt ist, wird der in der Anfrage gesendete Autorisierungsheader an das Ziel weitergegeben (er bleibt erhalten).

Plug-in-spezifische Attribute

Weitere Informationen zu den konfigurierbaren Attributen für die einzelnen Plug-ins finden Sie unter „Plug-ins verwenden“.

Proxys filtern

Sie können filtern, welche Microgateway-fähigen Proxys von einer Edge Microgateway-Instanz verarbeitet werden. Wenn Edge Microgateway gestartet wird, werden alle Microgateway-fähigen Proxys in der Organisation heruntergeladen, mit der es verknüpft ist. Verwenden Sie die folgende Konfiguration, um die Proxys einzuschränken, die vom Microgateway verarbeitet werden. Diese Konfiguration beschränkt beispielsweise die Proxys, die das Microgateway verarbeitet, auf drei: edgemicro_proxy-1, edgemicro_proxy-2 und edgemicro_proxy-3:

proxies:
  - edgemicro_proxy-1
  - edgemicro_proxy-2
  - edgemicro_proxy-3

Analysedaten maskieren

Die folgende Konfiguration verhindert, dass Informationen zum Anfragepfad in Edge Analytics angezeigt werden. Fügen Sie der Microgateway-Konfiguration Folgendes hinzu, um den Anfrage-URI und/oder den Anfragepfad zu maskieren. Der URI besteht aus dem Hostnamen und dem Pfad der Anfrage.

analytics:
  mask_request_uri: 'string_to_mask'
  mask_request_path: 'string_to_mask'

Debugging und Fehlerbehebung

Verbindung zu einem Debugger herstellen

Sie können Edge Microgateway mit einem Debugger wie node-inspector ausführen. Dies ist nützlich für die Fehlerbehebung und das Debugging benutzerdefinierter Plug-ins.

  1. Starten Sie Edge Microgateway im Debug-Modus neu. Fügen Sie dazu DEBUG=* am Anfang des Startbefehls hinzu. Beispiel:

    DEBUG=* edgemicro start -o myorg -e test -k db4e9e8a95aa7fabfdeacbb1169d0a8cbe42bec19c6b98129e02 -s 6e56af7c1b26dfe93dae78a735c8afc9796b077d105ae5618ce7ed
  2. Starten Sie den Debugger und legen Sie fest, dass er die Portnummer für den Debugging-Prozess überwacht.
  3. Sie können jetzt den Edge Microgateway-Code durchgehen, Haltepunkte festlegen, Ausdrücke beobachten usw.

Sie können Standard-Node.js-Flags für den Debug-Modus angeben. --nolazy hilft beispielsweise beim Debuggen von asynchronem Code.

Logdateien prüfen

Wenn Probleme auftreten, prüfen Sie die Logdateien auf Ausführungsdetails und Fehlerinformationen. Weitere Informationen finden Sie unter Protokolldateien verwalten.

API-Schlüsselsicherheit verwenden

API-Schlüssel bieten einen einfachen Mechanismus zur Authentifizierung von Clients, die Anfragen an Edge Microgateway senden. Sie können einen API-Schlüssel abrufen, indem Sie den Wert des Consumer-Keys (auch Client-ID genannt) aus einem Apigee Edge-Produkt kopieren, das den Edge Microgateway-Authentifizierungsproxy enthält.

Caching von Schlüsseln

API-Schlüssel werden gegen Inhabertokens ausgetauscht, die im Cache gespeichert werden. Sie können das Caching deaktivieren, indem Sie den Header Cache-Control: no-cache für eingehende Anfragen an Edge Microgateway festlegen.

Erforderlicher Workaround, wenn Sie Apigee Edge Private Cloud Version 15.07 verwenden

Wenn Sie die API-Schlüsselsicherheit in Edge Private Cloud 15.07 verwenden möchten, müssen Sie die hier beschriebene Problemumgehung implementieren. Für die Problemumgehung müssen Sie eine Zeile in einer Node.js-Datei im Proxy edgemicro-auth ändern und Edge Microgateway neu starten.

Problemumgehung in der Edge-Benutzeroberfläche implementieren

Bei diesem Verfahren müssen Sie den Befehl edgemicro start noch einmal ausführen, wenn Sie fertig sind.

  1. Öffnen Sie in der Edge-Benutzeroberfläche den edgemicro-auth-Proxy im Proxy-Editor.
  2. Wählen Sie den Tab „Entwickeln“ aus.
  3. Öffnen Sie im Navigator unter „Scripts“ die JavaScript-Datei verify-api-key.js.
  4. Gehen Sie zu Zeile 109:

    api_product_list: apigeeToken.app && apigeeToken.app.apiproducts ? apigeeToken.app.apiproducts : []
  5. Ersetzen Sie den Teil nach „api_product_list:“ durch ein „hartcodiertes“ Array der Produktnamen, die mit den API-Schlüsseln verknüpft sind, die Sie verwenden möchten. Wenn Sie beispielsweise einen Schlüssel aus einer Entwickler-App verwenden möchten, die „Product-1“ und „Product-2“ enthält, codieren Sie die Zeile so:

    api_product_list: ["Product-1", "Product-2"]
  6. Klicken Sie auf „Speichern“.
  7. Führen Sie den Befehl edgemicro start aus.

In der lokalen Edge Microgateway-Codebasis implementieren

Bei diesem Verfahren müssen Sie den edgemicro-Konfigurationsbefehl noch einmal ausführen, gefolgt von edgemicro start.

  1. Öffnen Sie die Datei <microgateway-root-dir>/edge/auth/api/controllers/verify-api-key.js, wobei <microgateway-root-dir> das Verzeichnis ist, in dem Edge Microgateway installiert wurde, als Sie den Befehl npm install ausgeführt haben.
  2. Gehen Sie zu Zeile 109:

    api_product_list: apigeeToken.app && apigeeToken.app.apiproducts ? apigeeToken.app.apiproducts : []
  3. Ersetzen Sie den Teil nach „api_product_list:“ durch ein „hartcodiertes“ Array der Produktnamen, die mit den API-Schlüsseln verknüpft sind, die Sie verwenden möchten. Wenn Sie beispielsweise einen Schlüssel aus einer Entwickler-App verwenden möchten, die „Product-1“ und „Product-2“ enthält, codieren Sie die Zeile so:

    api_product_list: ["Product-1", "Product-2"]
  4. Speichern Sie die Datei.
  5. Führen Sie den Befehl edgemicro configure aus. (Oder edgemicro private configure, wenn Sie Edge Private Cloud verwenden.) Mit diesem Befehl wird der edgemicro-auth-Proxy noch einmal bereitgestellt.
  6. Führen Sie den Befehl edgemicro start aus.

OAuth2-Tokensicherheit verwenden

Weitere Informationen zur Verwendung eines OAuth-Tokens mit Proxyanfragen finden Sie unter Edge Microgateway sichern.

API-Schlüssel verwenden

Weitere Informationen zur Verwendung von API-Schlüsseln mit Proxy-Anfragen finden Sie unter Edge Microgateway sichern.

Namen des API-Schlüssels konfigurieren

Standardmäßig wird x-api-key als Name für den API-Schlüsselheader oder den Abfrageparameter verwendet. Sie können diesen Standardwert in der Konfigurationsdatei ändern, wie unter Konfigurationsänderungen vornehmen beschrieben. So ändern Sie beispielsweise den Namen in apiKey:

oauth:
 allowNoAuthorization: false
 allowInvalidAuthorization: false
 api-key-header: apiKey