fuchsia.power.metrics

已新增：17

專家

錄音工具

定義於 fuchsia.power.metrics/recorder.fidl

管理隨選指標記錄功能的通訊協定。

StartLogging

開始在提供的期間內記錄指定指標。 支援不同指標的並行記錄。您可以呼叫 StopLogging 提前終止記錄。

如果指定指標的記錄功能已啟用，這個呼叫將會失敗。因此，用戶端可能會希望在 StartLogging 呼叫之前發出 StopLogging 呼叫，之後啟用記錄器的唯一原因就會與其他用戶端發生衝突。

  • 要求 client_id 用戶端的字串格式 ID。用戶端可以選擇任何位元組大小上限為 8 的 ID (例如「ffxTest」)。
  • 要求 metrics 要輪詢和記錄的指標類型。
  • 要求 duration_ms 記錄時間長度 (以毫秒為單位)。超過這段時間後，輪詢和記錄就會停止。
  • 要求 output_samples_to_syslog 切換將原始資料輸出至 Syslog。
  • 要求 output_stats_to_syslog 切換將任何可用的統計資料輸出至 Syslog。
  • [fuchsia.metrics.test/MeticsLoggerError] 值則指出要求失敗的原因。

要求

名稱類型
client_id ClientId
metrics vector<Metric>
duration_ms uint32
output_samples_to_syslog bool
output_stats_to_syslog bool

回應

名稱類型
payload Recorder_StartLogging_Result

StartLoggingForever

開始記錄指定指標。支援不同指標的並行記錄。發生 StopLogging 呼叫時，記錄功能才會結束。

StartLogging 應優先用於自動化測試，以確保即使測試異常終止，記錄也會終止。

  • 要求 client_id 用戶端的字串格式 ID。用戶端可以選擇任何位元組大小上限為 8 的 ID (例如「ffxTest」)。
  • 要求 metrics 要輪詢和記錄的指標類型。
  • 要求 output_samples_to_syslog 切換將原始資料輸出至 Syslog。
  • 要求 output_stats_to_syslog 切換將任何可用的統計資料輸出至 Syslog。
  • [fuchsia.metrics.test/RecorderError] 值則表示要求失敗的原因。

要求

名稱類型
client_id ClientId
metrics vector<Metric>
output_samples_to_syslog bool
output_stats_to_syslog bool

回應

名稱類型
payload Recorder_StartLoggingForever_Result

StopLogging

以指定的 client_id 終止所有使用中的記錄工作。您可以在記錄停用時呼叫此方法。

  • 要求 client_id 用戶端的字串格式 ID。
  • 回應 status 布林值，指出現有記錄是否停止 (true)，或用戶端沒有現有記錄。

要求

名稱類型
client_id ClientId

回應

名稱類型
stopped bool

結構

CpuLoad

定義於 fuchsia.power.metrics/recorder.fidl

CPU 負載指標詳細資料。

欄位類型說明預設
interval_ms uint32

輪詢間隔長度 (以毫秒為單位)。 必須小於記錄要求的 duration_ms。如果在記錄要求中啟用 output_samples_to_syslog，則不得小於 500 毫秒。

 無預設

GpuUsage

定義於 fuchsia.power.metrics/recorder.fidl

GPU 用量指標詳細資料。

欄位類型說明預設
interval_ms uint32

輪詢間隔長度 (以毫秒為單位)。 必須小於記錄要求的 duration_ms。如果在記錄要求中啟用 output_samples_to_syslog，則不得小於 500 毫秒。

 無預設

NetworkActivity

定義於 fuchsia.power.metrics/recorder.fidl

網路活動指標詳細資料。

欄位類型說明預設
interval_ms uint32

輪詢間隔長度 (以毫秒為單位)。 必須小於記錄要求的 duration_ms。如果在記錄要求中啟用 output_samples_to_syslog，則不得小於 500 毫秒。

 無預設

功率

定義於 fuchsia.power.metrics/recorder.fidl

電源指標詳細資料。

欄位類型說明預設
sampling_interval_ms uint32

取樣間隔長度，以毫秒為單位。如果在記錄要求中啟用 output_samples_to_syslog，則不得小於 500 毫秒。必須小於記錄要求的 duration_ms。

 無預設
statistics_args StatisticsArgs?

Boxed(選用) 統計資料引數。如未設定，則會停用統計資料。

 無預設

Recorder_StartLoggingForever_Response

定義於 fuchsia.power.metrics/recorder.fidl

<EMPTY>

Recorder_StartLogging_Response

定義於 fuchsia.power.metrics/recorder.fidl

<EMPTY>

StatisticsArgs

定義於 fuchsia.power.metrics/recorder.fidl

欄位類型說明預設
statistics_interval_ms uint32

匯總統計資料的間隔長度，以毫秒為單位，例如最小值、最大值、平均值。必須等於或大於指標中的 sampling_interval_ms。 必須小於記錄要求的 duration_ms。如果在記錄要求中啟用 output_stats_to_syslog，則不得小於 500 毫秒。

 無預設

溫度

定義於 fuchsia.power.metrics/recorder.fidl

溫度指標詳細資料。

欄位類型說明預設
sampling_interval_ms uint32

取樣間隔長度，以毫秒為單位。如果在記錄要求中啟用 output_samples_to_syslog，則不得小於 500 毫秒。必須小於記錄要求的 duration_ms。

 無預設
statistics_args StatisticsArgs?

Boxed(選用) 統計資料引數。如未設定，則會停用統計資料。

 無預設

表情符號

RecorderError strict

類型：uint32

定義於 fuchsia.power.metrics/recorder.fidl

與錄音工具方法相關的錯誤。如果要求包含以下任何錯誤，就會失敗，且不會影響現有的記錄工作。

名稱值說明
1

表示要求指標記錄找不到驅動程式庫。
2

表示提供的取樣間隔無效。
3

如果特定用戶端已啟用記錄功能，則開始記錄要求就會失敗。
4

表示記錄要求包含重複的指標類型。
5

表示有效用戶端的總數已達允許的上限 (由記錄工具中的 MAX_CONCURRENT_CLIENTS = 20 定義，以維持記憶體用量限制)。
6

表示已啟用統計資料，並提供無效的統計資料間隔。
7

表示要求因內部錯誤而失敗。

聯合國

指標嚴格

定義於 fuchsia.power.metrics/recorder.fidl

錄音工具方法要求的指標類型。

序數Variant類型說明
temperature Temperature
cpu_load CpuLoad
power Power
gpu_usage GpuUsage
network_activity NetworkActivity

Recorder_StartLoggingForever_Result strict：

定義於 fuchsia.power.metrics/recorder.fidl

序數Variant類型說明
response Recorder_StartLoggingForever_Response
err RecorderError

Recorder_StartLogging_Result 嚴格

定義於 fuchsia.power.metrics/recorder.fidl

序數Variant類型說明
response Recorder_StartLogging_Response
err RecorderError

別名

名稱值說明
ClientId string[16]