Edge for Private Cloud Version 4.17.09
Alle Edge for Private Cloud-Kunden müssen Statistiken zum API-Proxy-Traffic an Apigee senden. Apigee empfiehlt Kunden, diese Informationen einmal täglich hochzuladen, z. B. über einen Cronjob.
Sie müssen die Daten für Ihre Produktions-API-Bereitstellungen einreichen, nicht jedoch für APIs in der Entwicklungsphase oder für Testbereitstellungen. Bei den meisten Edge-Installationen definieren Sie bestimmte Organisationen oder Umgebungen für Ihre Produktions-APIs. Die von Ihnen eingereichten Daten gelten nur für diese Produktionsorganisationen und ‑umgebungen.
Zum Hochladen dieser Daten stellt Apigee die Betaversion des Befehlszeilentools apigee-analytics-collector bereit. Dieses Dienstprogramm sendet den Bericht zum API-Aufrufvolumen an Apigee zurück. Jeder Edge für die Private Cloud-Installation kann dieses Dienstprogramm verwenden, um Verkehrsdaten abzurufen und an Apigee zu melden.
Auf die von Apigee-analytics-collector hochgeladenen Daten zugreifen
Nachdem Sie Daten mit dem Dienstprogramm apigee-analytics-collector hochgeladen haben, können Sie sie in Apigee 360 aufrufen.
Melden Sie sich bei Apigee 360 an und wählen Sie die Option Nutzung aus, um die Daten anzusehen. Auf der Seite Nutzung sehen Sie ein Nutzungsdiagramm und eine Tabelle mit Nutzungsdaten für jede Ihrer Edge-Organisationen.
apigee-analytics-collector installieren
Das Dienstprogramm apigee-analytics-collector ist ein RPM, das Sie mit dem Dienstprogramm apigee-service installieren.
Installationsort
Der Knoten, auf dem Sie das Dienstprogramm apigee-analytics-collector installieren, kann jeder Knoten sein, der auf die Edge-Verwaltungs-API auf dem Edge-Verwaltungsserver zugreifen kann. Sie können es direkt auf dem Verwaltungsserver, auf einem anderen Knoten der Edge-Installation oder auf einem separaten Knoten installieren, sofern dieser Knoten API-Anfragen an den Verwaltungsserver senden kann.
Anforderungen an den Internetzugriff
Installieren Sie das Dienstprogramm apigee-analytics-collector auf einem Rechner mit externem Internetzugriff. Anschließend kann das Dienstprogramm apigee-analytics-collector Daten direkt in Apigee hochladen.
Wenn es keinen Knoten gibt, der sowohl auf die Edge-Verwaltungs-API auf dem Edge-Verwaltungsserver als auch auf den externen Internetzugriff zugreifen kann, können Sie die Traffic-Daten mit der Edge-Verwaltungs-API lokal speichern. Anschließend müssen Sie die Daten auf einen Computer mit Internetzugang übertragen, um sie in Apigee hochzuladen. In diesem Szenario müssen Sie das Dienstprogramm apigee-analytics-collector nicht verwenden. Weitere Informationen finden Sie unten unter Daten manuell in Apigee hochladen.
Installation
Verwenden Sie den folgenden Befehl, um das Dienstprogramm apigee-analytics-collector zu installieren. Da Sie eine RPM-Datei installieren, muss dieser Befehl vom Root-Nutzer oder von einem Nutzer mit vollem sudo-Zugriff ausgeführt werden. Für den uneingeschränkten sudo-Zugriff bedeutet dies, dass der Nutzer sudo-Zugriff hat, um dieselben Vorgänge wie root auszuführen.
> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector install
apigee-analytics-collector ausführen
In diesem Abschnitt wird beschrieben, wie Sie das Dienstprogramm apigee-analytics-collector ausführen.
Nutzer für die Ausführung von apigee-analytics-collector konfigurieren
Sie müssen apigee-analytics-collector als Nutzer ohne Root-Berechtigung ausführen. Dieser Benutzer muss vollständigen sudo-Zugriff auf den „Apigee“-Benutzer haben.
Wenn Sie einen Nutzer mit vollem Sudo-Zugriff auf den Nutzer „apigee“ konfigurieren möchten, bearbeiten Sie mit dem Befehl „visudo“ die Sudoers-Datei und fügen Sie Folgendes hinzu:
analyticsUser ALL=(apigee) NOPASSWD: ALL
Dabei ist analyticsUser der Nutzername der Person, die das Dienstprogramm apigee-analytics-collector ausführt.
Nachdem Sie das Dienstprogramm apigee-analytics-collector installiert und den Benutzer konfiguriert haben, können Sie das Dienstprogramm testen, indem Sie den Hilfebefehl für das Dienstprogramm apigee-analytics-collector ausführen:
> /opt/apigee/apigee-service/bin/ apigee-service apigee-analytics-collector export traffic --help
Erforderliche Informationen zum Ausführen von Apigee-analytics-collector
Sie benötigen die folgenden Informationen, um den Befehl apigee-analytics-collector auszuführen und Daten an Apigee weiterzuleiten:
- apigee_mgmt_api_uri: Die Basis-URL der Edge API auf Ihrem Verwaltungsserver. Diese URL hat in der Regel die folgende Form:
http://ms_IP:8080/v1
Dabei ist ms_IP die IP-Adresse Ihres Verwaltungsservers und 8080 der Port, der von der Edge API verwendet wird. Wenn Sie einen DNS-Eintrag für die Edge API erstellt haben, hat die URL das folgende Format:
http://ms_DNS/v1
Wenn Sie TLS in der Edge Management API aktivieren, hat sie das folgende Format:
https://ms_IP:8080/v1
https://ms_DNS/v1 - apigee_mgmt_api_email: Die E-Mail-Adresse eines Kontos mit Zugriff auf die Edge /stats APIs. Häufig ist dies die E-Mail-Adresse des Edge-Systemadministrators oder die E-Mail-Adresse des Administrators der Produktionsorganisation.
- apigee_mgmt_api_password: Das Edge-Passwort für das Konto, das mit apigee_mgmt_api_email angegeben ist.
- apigee_analytics_client_id und apigee_analytics_secret: Ihre Anmeldedaten für den Upload von Daten in Apigee. Bitte senden Sie ein Ticket beim Apigee-Support, um apigee_analytics_client_id und apigee_analytics_secret zu erhalten.
Beispiele für Befehle
Unten sehen Sie einen Beispielbefehl zum Abrufen von Verkehrsdaten für alle Organisationen und Umgebungen in der Edge-Installation und zum Hochladen dieser Daten in Apigee. Beachten Sie, dass Sie apigee-service verwenden, um den Befehl apigee-analytics-collector auszuführen:
> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic \ --apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \ --apigee_mgmt_api_email $ae_username \ --apigee_mgmt_api_password $ae_password \ --apigee_analytics_client_id $apigee_analytics_client_id \ --apigee_analytics_secret $apigee_analytics_secret
Der Befehl enthält alle erforderlichen Informationen, z. B. Ihre apigee_analytics_client_id und apigee_analytics_secret.
Die Ergebnisse sollten in etwa so aussehen:
[
{
"org": "myOrg",
"env": "prod",
"time_range_start": "08/27/2016 00:00",
"time_range_end": "08/30/2016 00:00",
"response": [
{
"store_org_env_metrics_hourly_v4": 1
}
]
},
{
"org": "VALIDATE",
"env": "test",
"time_range_start": "08/27/2016 00:00",
"time_range_end": "08/30/2016 00:00",
"response": [
{
"store_org_env_metrics_hourly_v4": 1
}
]
}
]
Verwenden Sie Befehlszeilenoptionen für den Befehl, um seine Aktionen zu steuern. Verwenden Sie die folgenden Optionen, um die Organisationen und Umgebungen anzugeben, die in die generierten Daten einbezogen werden sollen:
- -i, --include_orgs <durch Kommas getrennte Liste von Elementen>
- -x, --exclude_orgs <durch Kommas getrennte Liste von Elementen>
- -n, --include_envs <comma-separated list of items>
- -e, --exclude_envs <durch Kommas getrennte Liste von Elementen>
Wenn Sie beispielsweise nur die Produktionsorganisationen und ‑umgebungen angeben möchten, verwenden Sie die Optionen -i (oder --include_orgs) und -n (oder --include_envs):
> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod \ --apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \ --apigee_mgmt_api_email $ae_username \ --apigee_mgmt_api_password $ae_password \ --apigee_analytics_client_id $apigee_analytics_client_id \ --apigee_analytics_secret $apigee_analytics_secret
In diesem Beispiel werden nur Daten aus der Produktionsumgebung von myOrg erfasst.
Wenn Sie die Daten auf einem Bildschirm anzeigen lassen möchten, um sie zu prüfen, bevor Sie sie an Apigee senden, verwenden Sie die Option -S:
> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod -S \ --apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \ --apigee_mgmt_api_email $ae_username \ --apigee_mgmt_api_password $ae_password \ --apigee_analytics_client_id $apigee_analytics_client_id \ --apigee_analytics_secret $apigee_analytics_secret
Die Option -S lässt das Hochladen von Daten zu Apigee weg. Sie können den Befehl dann ohne die Option -S noch einmal ausführen, um die Daten an Apigee zu senden.
Ein Grund für die Verwendung der Option -S ist, dass Sie verschiedene Datentypen lokal anzeigen können. Für Apigee müssen Sie nur API-Traffic-Daten hochladen. Mit der Option -D können Sie jedoch Daten zu API-Produkten, Entwicklern, Apps oder API-Proxys anzeigen. Im folgenden Beispiel werden die Optionen -D und -S verwendet, um Entwicklerdaten lokal anzuzeigen:
> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod -S -D devs \ --apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \ --apigee_mgmt_api_email $ae_username \ --apigee_mgmt_api_password $ae_password \ --apigee_analytics_client_id $apigee_analytics_client_id \ --apigee_analytics_secret $apigee_analytics_secret
Geben Sie die Option -v an, um eine ausführliche Ausgabe zu erhalten, und die Option -R, um die von apigee-analytics-collector generierten curl-Befehle zu sehen:
> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod -S -R -v \ --apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \ --apigee_mgmt_api_email $ae_username \ --apigee_mgmt_api_password $ae_password \ --apigee_analytics_client_id $apigee_analytics_client_id \ --apigee_analytics_secret $apigee_analytics_secret
Der nächste Abschnitt enthält eine vollständige Liste der Befehlszeilenoptionen.
Befehlsparameter
In der folgenden Tabelle sind alle Optionen für das Dienstprogramm apigee-analytics-collector aufgeführt:
|
Befehl |
Verwendung |
|---|---|
|
-h, --help |
Informationen zur Ausgabenutzung |
|
-D, --dimension <Dimension> |
Die zu erfassende Traffic-Dimension. Gültige Dimensionen: apiproducts, devs, apps, apiproxy (Standard) |
|
-d, --days <days> |
Die Anzahl der Tage, beginnend mit dem aktuellen Datum, für die Daten erfasst werden sollen. Der Standardwert ist 3. Wenn Sie -d angeben, geben Sie nicht auch -s und -z an, um einen Zeitraum festzulegen. |
|
-m, --apigee_mgmt_api_uri <apigee_mgmt_api_uri> |
URL zur Edge Management API. |
|
-u, --apigee_mgmt_api_email <apigee_mgmt_api_email> |
Die E-Mail-Adresse eines Kontos mit Zugriff auf die Edge /stats APIs. Häufig ist dies die E-Mail-Adresse des Edge-Systemadministrators oder die E-Mail-Adresse des Administrators Ihrer Produktionsorganisationen. |
|
-p, --apigee_mgmt_api_password <apigee_mgmt_api_password> |
Passwort, das mit dem mit -u angegebenen E-Mail-Konto der Edge Management API verknüpft ist. |
|
-i, --include_orgs <items> |
Durch Kommas getrennte Liste der Organisationen, die in die Ausgabe eingeschlossen werden sollen. |
|
-x, --exclude_orgs <items> |
Durch Kommas getrennte Liste der Organisationen, die von der Ausgabe ausgeschlossen werden sollen. |
|
-n, --include_envs <items> |
Durch Kommas getrennte Liste der Umgebungen, die in die Ausgabe eingeschlossen werden sollen. |
|
-e, --exclude_envs <items> |
Durch Kommas getrennte Liste von Umgebungen, die aus der Ausgabe einbezogen werden sollen. |
|
-o, --output <pfad> |
Pfad und Dateiname zum Speichern der Ausgabe. |
|
-s, --time_range_start <time_range_start> |
Zeitraum, ab dem die Zugriffsstatistiken abgefragt werden sollen, im Format „03/01/2016 00:00“. Wenn Sie „-d“ angeben, geben Sie nicht auch „-s“ und „-z“ an, um einen Zeitraum festzulegen. |
|
-z, --time_range_end <time_range_end> |
Ende des Zeitraums für die Abfrage von Besucherstatistiken im Format „04/01/2016 24:00“. Wenn Sie „-d“ angeben, geben Sie nicht auch „-s“ und „-z“ an, um einen Zeitraum festzulegen. |
|
-t, --time_unit <time_unit> |
Zeiteinheit für Besucherzahlen. Standardwoche. Standardeinheiten nach Stunde. Gültige Zeiteinheiten: Sekunde, Minute, Stunde, Tag, Woche. |
|
-S, --standard_output |
Die Ausgabe wird in das Terminal (stdout) geschrieben, anstatt sie in Apigee hochzuladen. |
|
-c, --apigee_analytics_client_id <apigee_analytics_client_id> |
Ihre ID für das Hochladen von Daten in Apigee. Bitte reichen Sie ein Ticket beim Apigee-Support ein, um eine zu erhalten. |
|
-r, --apigee_analytics_secret <apigee_analytics_secret> |
Ihr Secret für den Upload von Daten in Apigee. Bitte reichen Sie ein Ticket beim Apigee-Support ein, um eine zu erhalten. |
|
-R, --include_curl_commands |
Fügen Sie die generierten cURL-Befehle zur Ausgabe für das Debuggen hinzu. |
|
-v, --verbose |
Detaillierte Ausgabe anzeigen. |
Daten manuell in Apigee hochladen
Apigee empfiehlt, das Dienstprogramm apigee-analytics-collector auf einem Computer mit externem Internetzugriff zu installieren. Anschließend kann das Dienstprogramm apigee-analytics-collector Daten direkt in Apigee hochladen.
Wenn der Computer jedoch keinen externen Internetzugriff hat, verwenden Sie die Edge Management API, um Traffic-Daten zu erfassen, und laden Sie sie dann mit cURL-Befehlen von einem Computer mit Internetzugriff in Apigee hoch. Sie müssen diesen Vorgang für jede Produktionsorganisation und -umgebung in Ihrer Edge-Installation wiederholen.
Mit dem folgenden cURL-Befehl können Sie Traffic-Daten für eine bestimmte Organisation und Umgebung für ein bestimmtes Zeitintervall erfassen:
curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://<ms_IP>:8080/v1/organizations/{org_name}/environments/{env_name}/stats/?select=sum(message_count)&timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM"
Für diesen Befehl wird die Edge Get API-Nachrichtenanzahl-API verwendet. Dabei gilt:
- apigee_mgmt_api_email:apigee_mgmt_api_password gibt die E-Mail-Adresse eines Kontos mit Zugriff auf die Edge-/Stats-APIs an.
- <ms_IP> ist die IP-Adresse oder der DNS-Name des Edge-Verwaltungsservers.
- Mit {org_name} und {env_name} werden die Organisation und die Umgebung angegeben.
- Mit MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM wird der Zeitraum für die zu erfassenden Statistiken angegeben. Beachten Sie, dass im cURL-Befehl der Hexadezimalcode %20 für die Leerzeichen im Zeitraum verwendet wird.
Wenn Sie beispielsweise Statistiken für einen Zeitraum von 24 Stunden erfassen möchten, verwenden Sie den folgenden Befehl:
curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \ "http://192.168.56.103:8080/v1/organizations/myOrg/environments/prod/stats/?select=sum(message_count)&timeRange=08/29/2016%2000:00~08/30/2016%2000:00"
Es sollte eine Antwort im Formular angezeigt werden:
{
"environments" : [ {
"metrics" : [ {
"name" : "sum(message_count)",
"values" : [ "42.0" ]
} ],
"name" : "prod"
} ],
"metaData" : {
"errors" : [ ],
"notices" : [ "query served by:53dab80c-e811-4ba6-a3e7-b96f53433baa", "source pg:6b7bab33-e732-405c-a5dd-4782647ce096", "Table used: myorg.prod.agg_api" ]
}
}
Um diese Daten dann von einem Computer mit Internetzugriff in Apigee hochzuladen, verwenden Sie den folgenden cURL-Befehl:
curl -X POST -H 'Content-Type:application/json' \
-u apigee_analytics_client_id:apigee_analytics_secret \
https://nucleus-api-prod.apigee.com/v1/apigee-analytics-cli-api/traffic/orgs/{org_name}/apis -d '{"environments"...}'
Dabei gilt:
- apigee_analytics_client_id:apigee_analytics_secret: Geben Sie Ihre Anmeldedaten für das Hochladen von Daten in Apigee an, die Sie vom Apigee-Support erhalten haben.
- {org_name} gibt die Organisation an.
- {"environments"...} enthält die Ergebnisse des cURL-Befehls, mit dem Sie oben Statistiken erfasst haben.