ファイル転送サブシステムの判定基準
ファイル転送の監視の判定基準は、以下のように更新されます。以下の判定基準は、/Metrics エンドポイントの下のファイル転送サブシステムにあり、ファイル転送の開始後に使用可能になります。
古い判定基準にはラベルがなかったため、ステータスと詳細を確認するために複数の判定基準が必要でした。新しい判定基準には、ユーザーが必要に応じて設定できるラベルコンフィギュレーションがあり、これらによって 1 つの判定基準を使用してすべての操作の詳細を取得できます。各判定基準には、プロパティに基づいて操作を分類するコンフィギュレーション可能なラベルがあります。たとえば、ターゲットリポジトリ、ソースリポジトリ、状態などです。すべてのエンドポイントで以下のラベルを使用できます。
• LABEL_KEY: カテゴリを定義します。たとえば、target、source、state などです。
• LABEL_DESCRIPTION: ラベルの目的について説明します。
• LABEL_VALUE_TYPE: 許可される値のタイプを定義します。たとえば、string などです。
• LABEL_VALUES: ラベルの有効な値を指定します。
• CATCH-ALL : 認識されない入力のフォールバック値を指定します。
|
古い判定基準
|
新しい判定基準
|
説明
|
|---|---|---|
|
• uploadFailedTransfers
• uploadStartedTransfers
• uploadCompletedTransfers
• uploadCancelledTransfers
|
thingworx_file_transfer_upload_total
|
この判定基準は、ファイルアップロード操作を取り込みます。
定義時に含まれるフィルタは Target および State です。
|
|
• downloadCompletedTransfers
• downloadCancelledTransfers
• downloadFailedTransfers
• downloadStartedTransfers
|
thingworx_file_transfer_download_total
|
この判定基準は、ファイルダウンロード操作を取り込みます。
定義時に含まれるフィルタは Source および State です。
|
|
• acrossRepoStartedTransfers
• acrossRepoCancelledTransfers
• acrossRepoFailedTransfers
• acrossRepoCompletedTransfers
|
thingworx_file_transfer_acrossrepo_total
|
この判定基準は、リポジトリ間のファイル転送を取り込みます。
定義時に含まれるフィルタは、Source、Target、および State です。
|
|
なし
|
thingworx_file_transfer_acrossedge_total
|
この判定基準は、エッジデバイス間のファイル転送を取り込みます。
定義時に含まれるフィルタは State です。
|
ラベルを設定するには、プラットフォームサブシステムのサービス ConfigureMetricsAttributeFiltering を使用します。
たとえば、アップロード時には metricName を thingworx_file_transfer_upload と metricAttributesValueBasedFilterConfig にする必要があります。JSON は以下のようになります。
{
"labelConfig": [
{
"LABEL_NAME": "target",
"ALLOWED_VALUES": [
"SystemRepository",
"SupportRepository"
],
"DEFAULT_VALUE": "otherrepository"
}
]
}
ここでは、ファイルが ALLOWED_VALUES 内のリポジトリ以外のリポジトリから転送された場合、ターゲットにはその値として otherrepository が含まれます。ラベルを使用したダウンロードとコピーの操作でも同じ動作が見られます。複数のラベルコンフィギュレーションを labelConfig 内に、コンマ (,) で区切って追加できます。
古い判定基準の無効化
ThingWorx Platform 9.7.x を新規インストールする場合は、新しい判定基準のみを使用できます。ThingWorx Platform 9.6.x から ThingWorx Platform 9.7.x にアップグレードする場合は、古い判定基準を使用できます。アップグレード後は新しい判定基準を使用することを強くお勧めします。
新規インストールの場合
インストーラの使用中に、/Metrics と /GetPerformanceMetrics の各エンドポイントでは古いファイル転送の判定基準を使用できません。新しいファイル転送の判定基準のみを使用できます。
アップグレードの場合
インストーラの使用中に、新旧のファイル転送の判定基準を使用できます。
 |
アップグレード時に、無効にする判定基準のリストを変更することで、古い判定基準を無効にできます。platform-settings.json ファイルの DisabledMetricsList を使用して、判定基準を無効にします。詳細については、判定基準を無効にするオプションおよびplatform-settings.json コンフィギュレーションの詳細を参照してください。
|
マイグレーション
移行後に、古いファイル転送の判定基準は使用できません。新しいファイル転送の判定基準のみを使用できます。
ヒストグラム判定基準
以下のヒストグラム判定基準を使用して、ファイル転送のサイズとファイル転送の所要時間を確認できます。
これらの判定基準は、ファイル転送操作が完了した後でのみ、/Metrics エンドポイントの下のファイル転送サブシステムで使用できます。
|
判定基準
|
説明
|
|---|---|
|
thingworx_file_transfer_size_bytes
|
この判定基準は、転送されるファイルの合計サイズを示します。
この判定基準には、operation ラベルが付いています。実行する操作のタイプに応じて、値を UPLOAD、DOWNLOAD、ACROSSREPO、または ACROSSEDGE のいずれかに設定できます。
この判定基準には、デフォルトのバケットセット (<1KB、10KB、100KB、1M、10M、100M、1G、>1G) があります
|
|
thingworx_file_transfer_duration_ms
|
この判定基準は、ファイル転送にかかる時間を示します。
この判定基準には、operation ラベルが付いています。実行する操作のタイプに応じて、値を UPLOAD、DOWNLOAD、ACROSSREPO、または ACROSSEDGE のいずれかに設定できます。
この判定基準には、デフォルトのバケットセット (100ms、1s、10s、100s、1000s、>1000s) があります
|
ヒストグラムのバケットは、次の方法で増分されます。
• ファイル転送時間ヒストグラムの場合 - 転送にかかる時間が 100 ミリ秒を超え、1 秒以下の場合は、1 秒のバケットとその他の対応するバケットに分類されます。
• ファイル転送サイズヒストグラムの場合 - 転送のファイルサイズが 1KB を超え、10KB 以下の場合、10KB のバケットとその他の対応するバケットに分類されます。
デフォルトのバケットサイズを変更する (たとえば、thingworx_file_transfer_duration_ms を [200 ,2000, 20000, 200000] に、thingworx_file_transfer_size_bytes を [2048, 20480, 204800, 2097152, 20971520] にカスタマイズする) には、以下を更新します。
オンプレミスの場合
platform-settings.json ファイルを以下のように更新します。
"PlatformSettingsConfig"
{
"MetricsSettings":
{
"HistogramMetricsBucketSizeList":
{
"thingworx_file_transfer_duration_ms":[200 ,2000, 20000, 200000],
"thingworx_file_transfer_size_bytes ":[2048, 20480, 204800, 2097152, 20971520]
}
}
}
Docker の場合
以下のファイルを更新します。
◦ .env ファイルに以下を追加します (存在しない場合)。
HISTOGRAM_BUCKET_SIZE_LIST: '
{
"thingworx_file_transfer_duration_ms":[200,2000,20000,200000],
"thingworx_file_transfer_size_bytes ":[2048,20480, 204800,2097152,20971520]
}'
◦ docker-compose ファイルに以下を追加します (存在しない場合)。
HISTOGRAM_BUCKET_SIZE_LIST: ${HISTOGRAM_BUCKET_SIZE_LIST}