Metriken des Untersystems für Dateiübertragung
Die Überwachungsmetriken für die Dateiübertragung werden wie unten beschrieben aktualisiert. Die folgenden Metriken befinden sich im Untersystem für die Dateiübertragung im Endpunkt /Metrics und sind nach dem Starten der Dateiübertragung verfügbar.
Die älteren Metriken hatten keine Beschriftungen, sodass mehrere Metriken erforderlich waren, um den Status und die Details zu kennen. Für die neuen Metriken sind Beschriftungskonfigurationen verfügbar, die Benutzer nach Bedarf konfigurieren können, sodass alle Operationsdetails mit einer Metrik abrufbar sind. Jede Metrik verfügt über konfigurierbare Beschriftungen, die Operationen basierend auf ihren Eigenschaften kategorisieren. Beispiel: Ziel-Repository, Quell-Repository und Status. Die folgenden Beschriftungen sind für alle Endpunkte verfügbar.
• LABEL_KEY: Definiert die Kategorie. Beispiel: target, source, state.
• LABEL_DESCRIPTION: Beschreibt den Zweck der Beschriftung.
• LABEL_VALUE_TYPE: Definiert den Typ des zulässigen Werts. Beispiel: string.
• LABEL_VALUES: Gibt die gültigen Werte für die Beschriftung an.
• CATCH-ALL : Stellt die Fallback-Werte für nicht erkannte Eingaben bereit.
|
Alte Metriken
|
Neue Metriken
|
Beschreibung
|
|---|---|---|
|
• uploadFailedTransfers
• uploadStartedTransfers
• uploadCompletedTransfers
• uploadCancelledTransfers
|
thingworx_file_transfer_upload_total
|
Diese Metrik erfasst die Datei-Upload-Operationen.
Zum Zeitpunkt der Definition sind die eingeschlossenen Filter "Target" und "State".
|
|
• downloadCompletedTransfers
• downloadCancelledTransfers
• downloadFailedTransfers
• downloadStartedTransfers
|
thingworx_file_transfer_download_total
|
Diese Metrik erfasst die Datei-Download-Operationen.
Zum Zeitpunkt der Definition sind die eingeschlossenen Filter "Source" und "State".
|
|
• acrossRepoStartedTransfers
• acrossRepoCancelledTransfers
• acrossRepoFailedTransfers
• acrossRepoCompletedTransfers
|
thingworx_file_transfer_acrossrepo_total
|
Diese Metrik erfasst die Dateiübertragung zwischen Repositories.
Zum Zeitpunkt der Definition sind die eingeschlossenen Filter "Source", "Target" und "State".
|
Verwenden Sie den Dienst ConfigureMetricsAttributeFiltering im Plattform-Untersystem, um die Beschriftungen zu konfigurieren.
Beispiel: Beim Hochladen sollte metricName metricAttributesValueBasedFilterConfig und thingworx_file_transfer_upload sein. Die JSON kann folgendermaßen aussehen:
{
"labelConfig": [
{
"LABEL_NAME": "target",
"ALLOWED_VALUES": [
"SystemRepository",
"SupportRepository"
],
"DEFAULT_VALUE": "otherrepository"
}
]
}
"labelConfig": [
{
"LABEL_NAME": "target",
"ALLOWED_VALUES": [
"SystemRepository",
"SupportRepository"
],
"DEFAULT_VALUE": "otherrepository"
}
]
}
Wenn die Dateien aus anderen Repositories als den Repositories in ALLOWED_VALUES übertragen werden, hat das Ziel als Wert otherrepository. Das gleiche Verhalten kann für die Operationen "Herunterladen" und "Kopieren" mit den zugehörigen Beschriftungen beobachtet werden. Es können mehrere Beschriftungskonfigurationen innerhalb von labelConfig, getrennt durch Komma (,), hinzugefügt werden.
Alte Metriken deaktivieren
Bei einer Neuinstallation von ThingWorx Platform 9.7.x sind nur die neuen Metriken verfügbar. Für Benutzer, die ein Upgrade von ThingWorx Platform 9.6.x auf ThingWorx Platform 9.7.x durchführen, sind die älteren Metriken verfügbar. Benutzern, die ein Upgrade durchgeführt haben, empfiehlt PTC dringend die Verwendung der neuen Metriken.
Bei Neuinstallation
Bei Verwendung des Installationsprogramms sind alte Dateiübertragungsmetriken in den Endpunkten /Metrics und /GetPerformanceMetrics nicht verfügbar. Es sind nur neue Dateiübertragungsmetriken verfügbar.
Bei Upgrade
Bei Verwendung des Installationsprogramms sind alte und neue Dateiübertragungsmetriken verfügbar.
 |
Zum Zeitpunkt des Upgrades können Sie die alten Metriken deaktivieren, indem Sie die Liste deaktivierter Metriken ändern. Verwenden Sie DisabledMetricsList in der Datei platform-settings.json, um Metriken zu deaktivieren. Weitere Informationen finden Sie unter Option zum Deaktivieren von Metriken und platform-settings.json – Konfigurationsdetails.
|
Migration
Nach der Migration sind keine alten Dateiübertragungsmetriken mehr verfügbar. Es sind nur neue Dateiübertragungsmetriken verfügbar.
Histogramm-Metriken
Die folgenden Histogramm-Metriken können verwendet werden, um Größe und Dauer der Dateiübertragung zu ermitteln.
Diese Metriken sind im Endpunkt /Metrics im Untersystem für die Dateiübertragung erst nach Abschluss der Dateiübertragungsoperation verfügbar.
|
Metrik
|
Beschreibung
|
|---|---|
|
thingworx_file_transfer_size_bytes
|
Diese Metrik zeigt die Gesamtgröße der Datei an, die übertragen wird.
Diese Metrik hat die Beschriftung operation. Die Werte können abhängig vom Typ der ausgeführten Operation UPLOAD, DOWNLOAD und ACROSSREPO sein.
Diese Metrik hat den Standardsatz von Buckets: < 1 KB, 10 KB, 100 KB, 1 MB, 10 MB, 100 MB, 1 GB, > 1 GB
|
|
thingworx_file_transfer_duration_ms
|
Diese Metrik zeigt die Dauer der gerade laufenden Dateiübertragung an.
Diese Metrik hat die Beschriftung operation. Die Werte können abhängig vom Typ der ausgeführten Operation UPLOAD, DOWNLOAD und ACROSSREPO sein.
Diese Metrik hat den Standardsatz von Buckets: 100 ms, 1 s, 10 s, 100 s, 1000 s, > 1000 s
|
Histogramm-Buckets sind wie folgt inkrementell:
• Für das Histogramm der Dateiübertragungszeit: Wenn die Übertragung länger als 100 ms dauert und kleiner oder gleich 1 s ist, fällt sie in den 1-s-Bucket und andere entsprechende Buckets.
• Für das Histogramm für die Dateiübertragungsgröße: Wenn die Übertragung eine Dateigröße von mehr als 1 KB und kleiner oder gleich 10 KB hat, fällt sie in den 10-KB-Bucket und andere entsprechende Buckets.
Wenn Sie die Standard-Bucket-Größen anpassen und beispielsweise thingworx_file_transfer_duration_ms in [200 ,2000, 20000, 200000] und thingworx_file_transfer_size_bytes [2048, 20480, 204800, 2097152, 20971520] ändern möchten, aktualisieren Sie Folgendes:
Für eine lokale Installation
Aktualisieren Sie die Datei platform-settings.json wie folgt.
"PlatformSettingsConfig"
{
"MetricsSettings":
{
"HistogramMetricsBucketSizeList":
{
"thingworx_file_transfer_duration_ms":[200 ,2000, 20000, 200000],
"thingworx_file_transfer_size_bytes ":[2048, 20480, 204800, 2097152, 20971520]
}
}
}
{
"MetricsSettings":
{
"HistogramMetricsBucketSizeList":
{
"thingworx_file_transfer_duration_ms":[200 ,2000, 20000, 200000],
"thingworx_file_transfer_size_bytes ":[2048, 20480, 204800, 2097152, 20971520]
}
}
}
Für Docker
Aktualisieren Sie die folgenden Dateien.
◦ Fügen Sie in der Datei .env Folgendes hinzu, falls nicht verfügbar.
HISTOGRAM_BUCKET_SIZE_LIST: '
{
"thingworx_file_transfer_duration_ms":[200,2000,20000,200000],
"thingworx_file_transfer_size_bytes ":[2048,20480, 204800,2097152,20971520]
}'
{
"thingworx_file_transfer_duration_ms":[200,2000,20000,200000],
"thingworx_file_transfer_size_bytes ":[2048,20480, 204800,2097152,20971520]
}'
◦ Fügen Sie in der Datei docker-compose Folgendes hinzu, falls nicht verfügbar.
HISTOGRAM_BUCKET_SIZE_LIST: ${HISTOGRAM_BUCKET_SIZE_LIST}