Power and Performance APIでトレンドを特定する

Power and Performance APIでトレンドを特定する

カスタムチームダッシュボード、バグレポートシステム、その他Power and Performance MetricsやDiagnostics APIのカスタムワークフロー内で、Appのパフォーマンスメトリクスを追跡しましょう。XcodeでPower and Performance分析ツールを動かすのと同じデータにアクセスし、すばやくトレンドと回帰を特定する、その方法をお伝えします。コールスタックツリーを含む診断的シグネチャーとログを活用し、デバッグ問題を最優先する方法をお知らせします。このAPIをあなたの開発チームが現在持っているツールに統合させ、問題のトラブルシュートをより早く、Appユーザーに全般的なより良いパフォーマンスを提供する方法もお伝えします。

リソース
- - HDビデオ
  - SDビデオ
関連ビデオ

WWDC22
- Xcodeとオンデバイスでのハングの検出と追跡
WWDC21
- 究極のAppパフォーマンスサバイバルガイド
- Appのパワーとパフォーマンスに関する不具合の診断
WWDC20
ダウンロード

こんにちは WWDCへようこそ “Power and Performance APIでトレンドを特定する” 私はAppleのパフォーマンスツールエンジニアのアシシュです後ほどヤノと交代しますパワーおよびパフォーマンスデータを取得するための新しいApp Store Connect APIについてご紹介できることをうれしく思います優れたアプリケーションの構築において開発者が良い仕事をすることはユーザの全体的なソフトウェアエクスペリエンスに不可欠な要素です優れたユーザエクスペリエンスを確保する上で最も重要な２つの点はアプリケーションのパワーとパフォーマンスによる影響を最適化することです Appleではお客様が重視するべき領域を簡単に特定できるように実践的なツールを提供することに尽力してきました昨年のWWDC 2019ではすぐに使用できるパワーおよびパフォーマンスアナリティクス用に Xcode 11内で新機能を導入しました Xcode Organizerは集約されたパワーパフォーマンス I/Oメトリクスを表示できアプリケーションで改善するべき領域の特定をサポートしますそのリリース以来同じXcodeデータにプログラムでアクセスしたい旨の要望を多く受け取りましたよくある要望の1つがこのデータをお客様独自のアナリティクスやモニタリングパイプラインで利用できるようにすることでした今回新しいPower and Performance APIを紹介することができてとてもうれしく思いますこのAPIは今年後半にリリース予定の App Store Connect APIの一部です「Expanding Automation with the App Store Connect API」ビデオを見て App Store Connectの詳細を確認することを強くお勧めします新しいAPIによって Xcodeメトリクスおよび診断データにプログラムでアクセスできるため独自にこのデータを利用することが可能になりますまた標準装備で新しく Smart Insights機能を提供しており労力の追加なしでアプリケーションのパワーとパフォーマンス上の重点領域を特定できますユーザがアプリケーションを使用する際同意済みのデバイスからパワーおよびパフォーマンスデータを収集しますこのデータは弊社のサーバーに蓄積され App Store Connect APIによって使用可能になりますこの新しいAPIのデータを使用して高度にカスタマイズされたアナリティクスパイプラインを構築するだけでなくダッシュボードを使用してアプリケーションのパフォーマンスモニタリングを自動化することができますここからはまずこの新しいAPIの簡単な概要とこのAPIが提供するデータタイプについて説明します次にXcodeのパワーおよびパフォーマンスアナリティクスの基盤となっている同じ集約データにアクセスするいくつかの例を取り上げるとともに新しいSmart Insightsについても説明します最後にライブデモを提示してサンプルアプリケーション用に集約メトリクス洞察診断を抽出し簡単に要約して締めくくります
それではこのAPIの概要を説明します今年４つの新しい REST APIリソースが使用可能になりますそれぞれのリソースを見ていきましょう
最初のAPIリソースはアプリケーションのIDを使用してアプリケーションの最新バージョンに関して集約されたメトリクスと洞察を提供しますスマートな洞察はアプリケーションの重点領域を特定する上で役立ちます次のセクションでこのデータについてより詳しく見ていきます
２つ目のAPIリソースは特定のアプリケーションバージョンに関するメトリクスのダウンロードを可能にしますこのデータを取得するために特定のアプリケーションバージョンについて App Store Connect APIが提供するビルドIDを指定する必要があります次に特定のアプリケーションバージョンについて最上位の診断シグネチャにアクセスできますこれらのシグネチャを使用して一般的な問題をグループ化できますまたわたしたちは今年の Xcode Organizerに関する話を確認することをお勧めしますそこではXcodeを使用した同じ診断データへのアクセスについて詳しく説明しています最後に根本原因の分析のために診断シグネチャに対応するログをダウンロードできますこれにはGET要求の一部として診断シグネチャIDが必要です新しいAPIを要約するとこれら４つのエンドポイントをアナリティクスワークフローに組み入れて集約されたメトリクススマートな洞察診断データを使用してアプリケーションのフットプリントを自動的に追跡できます次にこれらのAPIエンドポイントによってデータおよび洞察を取得するいくつかの例を見てみましょう最初に集約メトリクスデータを取り上げますアプリケーションのパワーおよびパフォーマンスメトリクスデータはそれぞれの固有のメトリックとデバイスタイプ別に蓄積されますこれらのメトリクスはバッテリー消費起動ディスク書き込みなど Xcode Organizerで使用可能なメトリクスと同じです新しいAPIはすべてのiPhoneと iPadデバイスグループについてこのデータの提供をサポートしています
前に説明したとおり最新のアプリバージョンに関する集約メトリクスと洞察の両方を受け取るにはアプリケーションIDを付けた次のようなGET要求を作成する必要があります
これは２つの主要セクションとともに構造化されたJSON文字列を返します製品データとして表される集約メトリクスと洞察の２つですサンプルメトリクスJSONを見てみましょう
ハング率など各メトリックについて JSON構造はユニットなどいくつかのメタデータを含みますユニットデバイスメトリックそれぞれの組み合わせについて JSONには50番目および 90番目のパーセンタイル値が含まれています最後に最大８つの最新のアプリケーションのバージョンについてメトリクスサマリーが生成されますこの例のJSONが示すようにこのデータを使用してさまざまなメトリクスデバイスパーセンタイルにわたって高度にカスタマイズされたパワーおよびパフォーマンスアナリティクスを構築できますしかしこれだけではありません弊社のチームはさらに一歩踏み出しカスタムアナリティクスの必要なしでアプリケーションのパワーおよびパフォーマンスの重点領域を迅速に特定できるようにサポートしています新しいSmart Insights機能をご紹介できることをうれしく思いますこれらのスマートな洞察は前に述べたメトリクスデータを使用してアプリケーションの重点領域に自動的にフラグを立てますこれは労力の追加なしで現場の最上位のアプリケーションの不具合を追跡したいときに特に役立ちます現在これらの洞察はメトリック値の低下と上昇にフラグを立てます洞察のJSON応答には３つのセクションが含まれています洞察のために分析されたバージョン不具合の要約影響を受けるデバイスとパーセンタイルのリストです
サンプル洞察を詳しく見てみましょう強調表示されたセクションは識別された不具合のメトリックタイプと要約を示していますこれらの要約の文字列を使用してアプリケーションの最上位の不具合を追跡できますここに示したとおりアプリケーションの起動時間は 90パーセンタイルの iPhoneユーザにとってのみ悪化していますこの洞察によってアプリケーションのパフォーマンスを向上させるためにより重点的なアクションを取ることができますポピュレーションセクションには影響を受けるパーセンタイルおよびデバイスの詳しい構造リストが含まれています３番目の部分には最新のアプリケーションバージョン比較に使用された前のアプリケーションバージョンのリストなどメタデータが含まれていますこのセクションの最後の部分で根本原因分析のための診断データを見てみましょう以降の説明はヤノに代わりますアシシュありがとう Appleのパフォーマンスツールエンジニアのヤノですわたしたちはメトリクスとスマートな洞察だけでなく不具合を詳しく調べる上で役立つ診断データも提供しますパワーおよびパフォーマンス診断には２つの部分があります１つは診断シグネチャを使用して同様の問題をグループ化することです例えば同じようなディスク書き込み例外は集約されてディスク書き込みシグネチャを生成します診断シグネチャを使用して問題グループ別に根本原因分析を実行できます APIはアプリケーションバージョンで最も適切な最上位のシグネチャを返し受け取った最上位のシグネチャとそのIDでより詳しい情報を持つ関連した診断ログを取得できますアプリケーションパージョンの最上位のシグネチャを受け取るには App Store Connect APIからのビルドIDを付けた次のようなGET要求を作成する必要があります今年XcodeとAPIの両方からディスク書き込み診断シグネチャにアクセスできるようになりました応答ではデータ内に最上位のシグネチャのリストが含まれ各シグネチャには固有のシグネチャIDと属性が含まれていますこれらの属性からこれがディスク書き込みシグネチャの例であることシグネチャ文字列が Xcode UIのコールスタックを表すコールフレームであることがわかりますウェイトは正規化されたシグネチャウェイトでこのシグネチャの相対的な重要性を示していますまた診断ログを取得するための URLも付いています見ての通りこのURLには既にシグネチャIDが含まれていますパワーおよびパフォーマンス診断の２番めの部分は診断ログですログには個々のデバイスの匿名化された診断情報が含まれていますまたプラットフォームOSバージョンデバイスタイプなどのメタデータ情報も含まれていますさらにログには関数コールスタックツリーが含まれておりパワーおよびパフォーマンスの重点領域の原因を把握する上で極めて有効です診断コールスタックJSON構造は MetricKitと共有されますそのため今年のMetricKitの説明を確認してオンデバイスのパワーおよびパフォーマンス診断について詳しく見てください
診断ログの取得にはシグネチャIDを付けた次のようなGET要求が必要ですこれは診断シグネチャ応答で見たものと同じ種類のURLです応答には診断ログのリストが含まれており各ログにはデバイスタイプ OSTバージョンビルドバージョンなどの情報を備えた診断メタデータが含まれていますこの例ではディスク書き込み例外イベントについてログが生成されますこのログにはコールスタックも付いています各コールスタックフレームにはローフレームと解析済みフレームの情報サブフレームのリストが含まれていますルートフレームからサブフレームをたどることでコールスタックツリー構造全体を横断することができますそれではデモを見てみましょうこのデモではAPIへのアクセス方法を見ると同時に今年後半にAPIと共にリリースされる予定のサンプルスクリプトを使用します
このデモの目的を踏まえて私はMealPlannerという名前のアプリケーションの開発者だと仮定しますこのアプリケーションは食事を計画しレシピを保存する手助けをしてくれます最新のリリースでは入力内容とともに美味しそうな写真を保存できる新機能を導入しましたここではPower and Performance APIを使用してアプリケーションのユーザが不具合に遭遇することがないようにしますこのAPIにアクセスするにはまず APIアクセストークンを生成する必要があります
スクリプトを実行して App Store Connect APIキーを使用してトークンを生成します
このトークンを使用してMealPlanner app IDで perfPowerMetricsリソースにアクセスできます
この応答でわかるとおり洞察および製品データを説明の際に見たものと同じフォーマットで取得できます
製品データには多数の集約されたメトリクス情報が含まれています
それではSmart Insightsを見て不具合がないか確認しましょう
洞察の不具合その要約文字列からすべてのiPhoneの50パーセンタイルのユーザで最新のアプリケーションバージョンにおいてディスク書き込みの不具合があることがわかります
これを詳しく調べるために診断ログを取得し例外コールスタックを確認します
まず最新のアプリケーションバージョンのビルドIDを使用して最上位の診断シグネチャを要求します
最上位のディスク書き込みシグネチャと関連URLから
そのシグネチャの診断ログを要求します
診断ログ応答にはコールスタック情報が含まれています
このコールスタック構造はマシン処理に効率的です
元のコールスタックを確認するためにサンプルコードを作成しこのスタック情報を解析しプリティプリントします
このサンプルスクリプトは同じ診断APIリソースにプログラムでアクセスします Enterキーを押すとログから元のコールスタックを取得します
コール関数フレームを下から確認します
入力内容と一緒に写真を追加する新機能はディスク書き込みI/Oの負担を増やすことがわかりました
スタックトレースに従うことでソースコードの正確な場所に移動し実装をデバッグして最適化できます
トークンを生成し診断データを取得するサンプルコードは今年後半に APIとともにリリースされます APIアクセスのクイックリファレンスとしてサンプルコードを確認してくださいこのデモを要約すると APIを使用して集約されたメトリクスを表示しモニタリングして Smart Insightsを使用してパワーおよびパフォーマンスの不具合を特定することができます
最後に診断データを使用して問題の根本原因分析を実施します
本日説明したことをまとめましょう
私たちはパワーおよびパフォーマンスのために新しいApp Store Connect APIを導入しましたこの新しいAPIによってXcode Organizerと同じメトリクスおよび診断データにプログラムでアクセスできますまたパワーおよびパフォーマンスメトリクスを活用したカスタマイズされたデータ分析およびモニタリングシステムを構築できますスマートな洞察を導入することでメトリクスにおける主要な傾向や不具合を特定することもできますこの新しいAPIでお客様が素晴らしいアプリケーションを作成してくれることを楽しみにしておりますぜひ試して頂きフィードバックを頂けたらうれしく思います　ありがとうございました

4:48 - Get metrics and insights for most recent app versions
```
GET /v1/apps/{id}/perfPowerMetrics
```
8:19 - Get top diagnostic signatures for released app versions
```
GET /v1/builds/{id}/diagnosticSignatures
```
9:42 - Get logs for a diagnostic signature
```
GET /v1/diagnosticSignatures/{id}/logs
```

11:19 - Access perfPowerMetrics for an app

curl -X GET -H "Authorization: Bearer ${JWT}" -H "Accept: application/vnd.apple.xcode-metrics+json,application/json" https://api.appstoreconnect.apple.com/v1/apps/${id}/perfPowerMetrics

12:23 - Access diagnosticSignatures for an app build

curl -X GET -H "Authorization: Bearer ${JWT}" -H "Accept: application/vnd.apple.xcode-metrics+json,application/json" https://api.appstoreconnect.apple.com/v1/builds/${id}/diagnosticSignatures

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

WWDC22

WWDC21

WWDC20