Alle Edge for Private Cloud-Kunden müssen Statistiken über API-Proxy-Traffic an Apigee senden. Apigee empfiehlt Kunden, diese Informationen einmal täglich hochzuladen, möglicherweise durch Erstellen eines Cronjobs.
Sie müssen die Daten für Ihre API-Produktionsbereitstellungen einreichen, jedoch nicht für APIs in Entwicklungs- oder Testbereitstellungen. In den meisten Edge-Installationen definieren Sie bestimmte Organisationen oder Umgebungen für Ihre Produktions-APIs. Die von Ihnen eingereichten Daten sind nur für diese Produktionsorganisationen und -umgebungen vorgesehen.
Um Sie beim Hochladen dieser Daten zu unterstützen, stellt Apigee den Betarelease des Befehlszeilendienstprogramms apigee-analytics-collector bereit. Dieses Dienstprogramm sendet den Bericht zum API-Aufrufvolumen zurück an Apigee. Jeder Edge für die Private Cloud-Installation kann dieses Dienstprogramm verwenden, um Verkehrsdaten abzurufen und an Apigee zu melden.
Erforderlich: Wenden Sie sich an den Apigee-Support, bevor Sie Daten hochladen
Bevor Sie Daten in Apigee hochladen können, müssen Sie sich an den Apigee Edge-Support wenden, um das Onboarding abzuschließen.
Apigee Analytics-Collector installieren
Das Dienstprogramm apigee-analytics-collector ist ein RPM, den du mit dem Dienstprogramm apigee-service installierst.
Installationsort
Der Knoten, auf dem Sie das Dienstprogramm apigee-analytics-collector installieren, kann ein beliebiger Knoten sein, der auf die Edge Management API auf dem Edge Management Server zugreifen kann. Sie können es direkt auf dem Verwaltungsserver, auf einem anderen Knoten der Edge-Installation oder auf einem separaten Knoten installieren, solange dieser Knoten API-Anfragen an den Verwaltungsserver senden kann.
Anforderungen an den Internetzugang
Installieren Sie das Dienstprogramm apigee-analytics-collector auf einem Computer mit externem Internetzugang. Anschließend kann das Dienstprogramm apigee-analytics-collector Daten direkt in Apigee hochladen.
Wenn kein Knoten sowohl Zugriff auf die Edge-Verwaltungs-API auf dem Edge-Verwaltungsserver als auch Zugriff auf das externe Internet hat, können Sie die Edge-Verwaltungs-API verwenden, um die Traffic-Daten lokal zu speichern. Anschließend müssen Sie die Daten auf einen Rechner mit Internetzugang übertragen, um sie in Apigee hochladen zu können. In diesem Szenario müssen Sie das Dienstprogramm apigee-analytics-collector nicht verwenden. Weitere Informationen finden Sie 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 uneingeschränktem sudo-Zugriff ausgeführt werden. Für vollständigen Sudo-Zugriff bedeutet das, 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 zum Ausführen 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 Benutzer „apigee“ haben.
Wenn Sie einen Nutzer so konfigurieren möchten, dass er vollständigen sudo-Zugriff auf den Nutzer „apigee“ hat, verwenden Sie den Befehl „visudo“, um die sudoers-Datei hinzuzufügen und Folgendes hinzuzufügen:
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 Nutzer 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 normalerweise folgende Form:http://ms_IP:8080/v1
Dabei ist ms_IP die IP-Adresse oder Ihr Verwaltungsserver 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-Verwaltungs-API aktivieren, hat es 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/statsAPIs. Dies ist häufig die E-Mail-Adresse des Edge-Systemadministrators oder die E-Mail-Adresse des Organisationsadministrators für Ihre Produktionsorganisationen.apigee_mgmt_api_password: Das Edge-Passwort für das vonapigee_mgmt_api_emailangegebene Konto.apigee_analytics_client_idund apigee_analytics_secret: Ihre Anmeldedaten zum Hochladen von Daten in Apigee Senden Sie ein Ticket beim Apigee Edge-Support, umapigee_analytics_client_idundapigee_analytics_secretzu 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 zu Apigee. Beachten Sie, wie Sie den Befehl apigee-analytics-collector mit apigee-service ausfü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
Beachten Sie, dass der Befehl alle erforderlichen Informationen enthält, wie z. B. Ihre apigee_analytics_client_id und apigee_analytics_secret.
Die Ergebnisse sollten im folgenden Format angezeigt werden:
[
{
"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 den generierten Daten enthalten sein sollen:
-i, --include_orgs comma-separated list of items-x, --exclude_orgs comma-separated list of items-n, --include_envs comma-separated list of items-e, --exclude_envs comma-separated list of items
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 erfassen Sie nur Daten aus der Produktumgebung von myOrg.
Verwenden Sie die Option -S, um die Daten auf einen Bildschirm zu übertragen, um sie zu untersuchen, bevor sie an Apigee gesendet werden:
/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
Bei der Option -S wird der Datenupload in Apigee weggelassen. Sie können den Befehl dann noch einmal ohne die Option -S ausführen, um die Daten an Apigee zu senden.
Ein Grund für die Verwendung der Option -S ist die Möglichkeit, verschiedene Datentypen lokal anzuzeigen. Apigee erfordert nur das Hochladen von API-Verkehrsdaten. Mit der Option -D können Sie jedoch Daten zu API-Produkten, Entwicklern, Anwendungen oder API-Proxys anzeigen lassen. 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
Fügen Sie die Option -v ein, 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 | Beschreibung |
|---|---|
-h, --help |
Informationen zur Ausgabenutzung |
-D, --dimension dimension |
Die zu erfassende Traffic-Dimension. Gültige Werte sind:
|
-d, --days days
|
Die Anzahl der vergangenen Tage, für die Daten erfasst werden sollen, beginnend mit dem aktuellen Datum. Der Standardwert ist 3. Wenn Sie |
-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 |
-p, --apigee_mgmt_api_password apigee_mgmt_api_password |
Das Passwort, das mit dem von |
-i, --include_orgs items
|
Eine durch Kommas getrennte Liste der Organisationen, die in die Ausgabe aufgenommen werden sollen. |
-x, --exclude_orgs items
|
Eine durch Kommas getrennte Liste der Organisationen, die aus der Ausgabe ausgeschlossen werden sollen. |
-n, --include_envs items
|
Eine durch Kommas getrennte Liste der Umgebungen, die in die Ausgabe aufgenommen werden sollen. |
-e, --exclude_envs items
|
Eine durch Kommas getrennte Liste der Umgebungen, die in der Ausgabe enthalten sein sollen. |
-o, --output path
|
Der Pfad und der Dateiname zum Speichern der Ausgabe. |
-s, --time_range_start time_range_start
|
Zeitraum für den Beginn der Abfrage von Zugriffsstatistiken im Format „MM/DD/YYYY HH:MM“. Wenn Sie |
-z, --time_range_end time_range_end
|
Ende des Zeitraums für die Abfrage von Zugriffsstatistiken im Format „04/01/2016 24:00“. Wenn Sie |
-t, --time_unit time_unit
|
Zeiteinheit für Verkehrsdaten. Der Standardwert ist
Wenn Sie |
-S, --standard_output
|
Schreiben Sie die Ausgabe in das Terminal (stdout), anstatt sie in Apigee hochzuladen. |
-c, --apigee_analytics_client_id apigee_analytics_client_id
|
Ihre ID zum Hochladen von Daten zu Apigee. Senden Sie hierfür ein Ticket beim Apigee Edge-Support. |
-r, --apigee_analytics_secret apigee_analytics_secret
|
Ihr Secret zum Hochladen von Daten zu Apigee. Senden Sie hierfür ein Ticket beim Apigee Edge-Support. |
-R, --include_curl_commands
|
Nehmen Sie die generierten |
-v, --verbose
|
Ausführliche Ausgabe anzeigen |
Daten manuell in Apigee hochladen
Apigee empfiehlt, dass Sie das Dienstprogramm apigee-analytics-collector auf einem Computer mit externem Internetzugang installieren. Anschließend kann das Dienstprogramm apigee-analytics-collector Daten direkt in Apigee hochladen.
Wenn der Computer jedoch keinen externen Internetzugang hat, verwenden Sie die Edge Management API, um Verkehrsdaten zu erfassen, und laden Sie diese dann mit curl-Befehlen von einem Computer mit Internetzugang in Apigee hoch. Sie müssen diesen Vorgang für jede Produktionsorganisation und Umgebung in Ihrer Edge-Installation wiederholen.
Verwenden Sie den folgenden curl-Befehl, um Trafficdaten für eine bestimmte Organisation und Umgebung für ein bestimmtes Zeitintervall zu 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/apiproxy?select=sum(message_count)&timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour"
Dieser Befehl verwendet die Edge Get API Messagecount API. 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 Management Servers.
- org_name und env_name geben die Organisation und Umgebung an.
- apiproxy ist die Dimension, die Messwerte nach API-Proxys gruppiert.
MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hourgibt den Zeitraum an, der in die Zeiteinheiten der zu erfassenden Messwerte unterteilt ist. Beachten Sie, dass der Befehlcurlden Hexadezimalcode%20für Leerzeichen im Zeitraum verwendet.
Verwenden Sie beispielsweise den folgenden API-Aufruf, um die Anzahl der API-Proxy-Nachrichten stündlich über einen Zeitraum von 24 Stunden zu erfassen.
curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \ "http://192.168.56.103:8080/v1/organizations/myOrg/environments/prod/stats/apiproxy?select=sum(message_count)&timeRange=01%2F01%2F2018%2000%3A00~01%2F02%2F2018%2000%3A00&timeUnit=hour"
Hinweis: timeRange enthält URL-codierte Zeichen.
Es sollte eine Antwort im Formular angezeigt werden:
{
"environments" : [ {
"dimensions" : [ {
"metrics" : [ {
"name" : "sum(message_count)",
"values": [
{
"timestamp": 1514847600000,
"value": "35.0"
},
{
"timestamp": 1514844000000,
"value": "19.0"
},
{
"timestamp": 1514840400000,
"value": "58.0"
},
{
"timestamp": 1514836800000,
"value": "28.0"
},
{
"timestamp": 1514833200000,
"value": "29.0"
},
{
"timestamp": 1514829600000,
"value": "33.0"
},
{
"timestamp": 1514826000000,
"value": "26.0"
},
{
"timestamp": 1514822400000,
"value": "57.0"
},
{
"timestamp": 1514818800000,
"value": "41.0"
},
{
"timestamp": 1514815200000,
"value": "27.0"
},
{
"timestamp": 1514811600000,
"value": "47.0"
},
{
"timestamp": 1514808000000,
"value": "66.0"
},
{
"timestamp": 1514804400000,
"value": "50.0"
},
{
"timestamp": 1514800800000,
"value": "41.0"
},
{
"timestamp": 1514797200000,
"value": "49.0"
},
{
"timestamp": 1514793600000,
"value": "35.0"
},
{
"timestamp": 1514790000000,
"value": "89.0"
},
{
"timestamp": 1514786400000,
"value": "42.0"
},
{
"timestamp": 1514782800000,
"value": "47.0"
},
{
"timestamp": 1514779200000,
"value": "21.0"
},
{
"timestamp": 1514775600000,
"value": "27.0"
},
{
"timestamp": 1514772000000,
"value": "20.0"
},
{
"timestamp": 1514768400000,
"value": "12.0"
},
{
"timestamp": 1514764800000,
"value": "7.0"
}
]
}
],
"name" : "proxy1"
} ],
"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" ]
}
}
Verwenden Sie den folgenden curl-Befehl, um diese Daten dann von einem Computer mit Internetzugang in Apigee hochzuladen:
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"...'
Wobei:
- apigee_analytics_client_id:apigee_analytics_secret gibt Ihre Anmeldedaten zum Hochladen von Daten zu Apigee an, die Sie von Apigee erhalten haben.
- org_name gibt den Namen der Organisation an.
- "environments"... enthält die Ergebnisse des Befehls
curl, mit dem Sie die obigen Statistiken erfasst haben.