<h1 id="tl%3Bdr">
<a class="header-anchor-link" href="#tl%3Bdr" aria-hidden="true"></a> TL;DR</h1>
<ul>
<li>「アプリがHangしてCrashした」と報告があってから、原因を特定し、修正するまでの流れを記事にする。</li>
<li>原因を特定する過程で便利だったツールを紹介する。
<ul>
<li>"Xcode Instruments"</li>
<li>"Xcode organizer" の "Hang report"</li>
<li>デバイスの"Analytics Data"</li>
<li>デバイスで"Developer mode"を有効にする</li>
</ul>
</li>
</ul>
<h1 id="%E5%85%A8%E4%BD%93%E3%81%AE%E3%81%AA%E3%81%8C%E3%82%8C">
<a class="header-anchor-link" href="#%E5%85%A8%E4%BD%93%E3%81%AE%E3%81%AA%E3%81%8C%E3%82%8C" aria-hidden="true"></a> 全体のながれ</h1>
<ol>
<li>アプリが「Hangしたあとに、数分間経つとCrashした」と報告があった。</li>
<li>"Firebase"の"Crashlystics"をチェックし該当のクラッシュログを調査する -&gt; ログが見つからない</li>
<li>Xcode OrganizerでHangのログをチェックする。 -&gt; Hangが発生している箇所が複数あり、特定できない</li>
<li>"Xcode Instruments"で起動時の動作を分析する</li>
<li>「HangしてCrashが発生したデバイス」の、ログを調査する -&gt; Crashは"Watch Dog Timer"によって引き起こされたと分かる</li>
<li>「Developer Mode」を有効にしたデバイスで、Hangを再現し、ログを調査する -&gt; Hang発生時のスタックトレースを見て、箇所を特定する</li>
<li>問題の箇所を修正して、Hang Issueを直す</li>
</ol>
<h1 id="%E8%A9%B3%E7%B4%B0">
<a class="header-anchor-link" href="#%E8%A9%B3%E7%B4%B0" aria-hidden="true"></a> 詳細</h1>
<h2 id="1.-%E3%82%A2%E3%83%97%E3%83%AA%E3%81%8C%E3%80%8Chang%E3%81%97%E3%81%9F%E3%81%82%E3%81%A8%E3%81%ABcrash%E3%81%97%E3%81%9F%E3%80%8D%E3%81%A8%E5%A0%B1%E5%91%8A%E3%81%8C%E3%81%82%E3%81%A3%E3%81%9F">
<a class="header-anchor-link" href="#1.-%E3%82%A2%E3%83%97%E3%83%AA%E3%81%8C%E3%80%8Chang%E3%81%97%E3%81%9F%E3%81%82%E3%81%A8%E3%81%ABcrash%E3%81%97%E3%81%9F%E3%80%8D%E3%81%A8%E5%A0%B1%E5%91%8A%E3%81%8C%E3%81%82%E3%81%A3%E3%81%9F" aria-hidden="true"></a> 1. アプリが「HangしたあとにCrashした」と報告があった</h2>
<h3 id="%22hang%22%E3%81%A8%E3%81%AF">
<a class="header-anchor-link" href="#%22hang%22%E3%81%A8%E3%81%AF" aria-hidden="true"></a> "Hang"とは</h3>
<p><a href="https://developer.apple.com/documentation/xcode/improving-app-responsiveness" target="_blank" rel="nofollow noopener noreferrer">Improve App Responsiveness</a>を要約すると、</p>
<blockquote>
<p>ユーザーのインタラクションがあってからそれがUIに表れるまでの間の"反応の遅れ"のうち、ユーザーに認識できるほどのもの。</p>
</blockquote>
<p>"ユーザーのイベント"と"対応するUIの更新"の間隔が100msより大きいとユーザーに認識されやすい。<br>
e.g. "Buttonをタップ"してから、"UIが反応する"までの時間が長過ぎる。</p>
<p>UIの更新は、MainThreadで行われる。<br>
"Hang"は、ユーザーイベントに対応したUIの更新を行うときに、MainThreadが利用できないため発生する。<br>
MainThreadが利用できない状況は、たとえば以下の場合が考えられる</p>
<ul>
<li>MainThreadがたくさんの処理を実行中で忙しい。</li>
<li>MainThreadがほかのタスクの終了を待っている間、ブロックされている。</li>
</ul>
<h2 id="2.-%22firebase%22%E3%81%AE%22crashlystics%22%E3%82%92%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF%E3%81%97%E8%A9%B2%E5%BD%93%E3%81%AE%E3%82%AF%E3%83%A9%E3%83%83%E3%82%B7%E3%83%A5%E3%83%AD%E3%82%B0%E3%82%92%E8%AA%BF%E6%9F%BB%E3%81%99%E3%82%8B--%3E-%E3%83%AD%E3%82%B0%E3%81%8C%E8%A6%8B%E3%81%A4%E3%81%8B%E3%82%89%E3%81%AA%E3%81%84">
<a class="header-anchor-link" href="#2.-%22firebase%22%E3%81%AE%22crashlystics%22%E3%82%92%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF%E3%81%97%E8%A9%B2%E5%BD%93%E3%81%AE%E3%82%AF%E3%83%A9%E3%83%83%E3%82%B7%E3%83%A5%E3%83%AD%E3%82%B0%E3%82%92%E8%AA%BF%E6%9F%BB%E3%81%99%E3%82%8B--%3E-%E3%83%AD%E3%82%B0%E3%81%8C%E8%A6%8B%E3%81%A4%E3%81%8B%E3%82%89%E3%81%AA%E3%81%84" aria-hidden="true"></a> 2. "Firebase"の"Crashlystics"をチェックし該当のクラッシュログを調査する -&gt; ログが見つからない</h2>
<p>とりあえず、Crashしたと報告があったので"Crashlystics"で原因を探そうとしてみたが、該当するログが見つからない。<br>
<a href="https://developer.apple.com/documentation/xcode/reduce-terminations-in-your-app" target="_blank" rel="nofollow noopener noreferrer">Reduce terminations in your app</a>によると、アプリが終了されるのは以下の場合があるらしい。</p>
<ul>
<li>
<strong>Abort</strong>: assert()が呼ばれるなど。</li>
<li>
<strong>Memory Limit</strong>: アプリがバックグラウンドにあるときに、フォアグラウンドのアプリにメモリを割り当てるために、システムがバックグラウンドのアプリを終了させる。</li>
<li>
<strong>Bad Access</strong>: アプリがアクセスすべきでないメモリにアクセスしたとき。（e.g index out of bounds）</li>
<li>
<strong>App WatchDog</strong>: アプリの起動時に、時間がかかり過ぎたとき。</li>
<li>
<strong>Memory Pressure</strong>: アプリが利用可能なメモリより、大きいメモリを使おうとしたとき。</li>
</ul>
<p>これらの中でも、"Memory Limit"、"App WatchDog"は"Crashlystics"で見かけたことがないので、これらのクラッシュは"Crashlystics"に送信されないのでは？　と予想した。</p>
<h2 id="3.-xcode-organizer%E3%81%A7hang%E3%81%AE%E3%83%AD%E3%82%B0%E3%82%92%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF%E3%81%99%E3%82%8B%E3%80%82--%3E-hang%E3%81%8C%E7%99%BA%E7%94%9F%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E7%AE%87%E6%89%80%E3%81%8C%E8%A4%87%E6%95%B0%E3%81%82%E3%82%8A%E3%80%81%E7%89%B9%E5%AE%9A%E3%81%A7%E3%81%8D%E3%81%AA%E3%81%84">
<a class="header-anchor-link" href="#3.-xcode-organizer%E3%81%A7hang%E3%81%AE%E3%83%AD%E3%82%B0%E3%82%92%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF%E3%81%99%E3%82%8B%E3%80%82--%3E-hang%E3%81%8C%E7%99%BA%E7%94%9F%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E7%AE%87%E6%89%80%E3%81%8C%E8%A4%87%E6%95%B0%E3%81%82%E3%82%8A%E3%80%81%E7%89%B9%E5%AE%9A%E3%81%A7%E3%81%8D%E3%81%AA%E3%81%84" aria-hidden="true"></a> 3. Xcode OrganizerでHangのログをチェックする。 -&gt; Hangが発生している箇所が複数あり、特定できない</h2>
<p>WWDCのvideoや記事を漁って、"Xcode Organizer"というものを使うと、何か情報が得られそうと知る。(<a href="https://developer.apple.com/documentation/xcode/analyzing-responsiveness-issues-in-your-shipping-app" target="_blank" rel="nofollow noopener noreferrer">Analyzing responsiveness in your shipping app</a>)<br>
"Xcode Organizer"は"Xcode"の'Menu bar' -&gt; 'Window' -&gt; 'Organizer'で開くことができる。</p>
<p>"Oranizer"を開いて"Hang"のログを見ると、そこには"アプリのMainThreadが1秒以上反応しなかったときのスタックトレースが記録されている。<br>
（"Appleにデータを送信する"ことに同意したユーザーのデータのみが送信されてくるらしい）<br>
"Hang"が発生したデバイス、iOSのバージョンなどの情報も手に入る。<br>
<img src="https://res.cloudinary.com/zenn/image/fetch/s--GKwyaJgn--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/6767e719040a48bf416edc0d.png%3Fsha%3D0ecb76e234d0a446944c03d33d8c06a20afdd2e8" loading="lazy" class="md-img"></p>
<p>今回の場合では、起動スクリーンで発生したと思われるHangが複数あったため、特定することはできなかった。</p>
<h2 id="4.-xcode-instruments%E3%81%A7%E8%B5%B7%E5%8B%95%E6%99%82%E3%81%AE%E5%8B%95%E4%BD%9C%E3%81%AE%E5%88%86%E6%9E%90%E3%82%92%E3%81%99%E3%82%8B">
<a class="header-anchor-link" href="#4.-xcode-instruments%E3%81%A7%E8%B5%B7%E5%8B%95%E6%99%82%E3%81%AE%E5%8B%95%E4%BD%9C%E3%81%AE%E5%88%86%E6%9E%90%E3%82%92%E3%81%99%E3%82%8B" aria-hidden="true"></a> 4. Xcode Instrumentsで起動時の動作の分析をする</h2>
<p><a href="https://developer.apple.com/videos/play/wwdc2022/10082/" target="_blank" rel="nofollow noopener noreferrer">Track down hangs with Xcode and on-device detection</a>によると、"Xcode Instruments"でもHangの分析ができそう。<br>
<img src="https://res.cloudinary.com/zenn/image/fetch/s--ufYV4QAI--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/fc5d30ba116cac9e77b8badf.png%3Fsha%3D81a0780dd56f498f70f389daf968bf41d82313f0" loading="lazy" class="md-img"><br>
今回は、"Time Profiler"や"App Launch"を使用してアプリの起動時の動作を分析したが、原因をひとつに絞ることができなかった。（たぶん自分の使い方が上手でなかった気がする）</p>
<h2 id="5.-%E3%80%8Chang%E3%81%97%E3%81%A6crash%E3%81%8C%E7%99%BA%E7%94%9F%E3%81%97%E3%81%9F%E3%83%87%E3%83%90%E3%82%A4%E3%82%B9%E3%80%8D%E3%81%AE%E3%80%81%E3%83%AD%E3%82%B0%E3%82%92%E8%AA%BF%E6%9F%BB%E3%81%99%E3%82%8B--%3E-crash%E3%81%AF%22watch-dog-timer%22%E3%81%AB%E3%82%88%E3%81%A3%E3%81%A6%E5%BC%95%E3%81%8D%E8%B5%B7%E3%81%93%E3%81%95%E3%82%8C%E3%81%9F%E3%81%A8%E5%88%86%E3%81%8B%E3%82%8B">
<a class="header-anchor-link" href="#5.-%E3%80%8Chang%E3%81%97%E3%81%A6crash%E3%81%8C%E7%99%BA%E7%94%9F%E3%81%97%E3%81%9F%E3%83%87%E3%83%90%E3%82%A4%E3%82%B9%E3%80%8D%E3%81%AE%E3%80%81%E3%83%AD%E3%82%B0%E3%82%92%E8%AA%BF%E6%9F%BB%E3%81%99%E3%82%8B--%3E-crash%E3%81%AF%22watch-dog-timer%22%E3%81%AB%E3%82%88%E3%81%A3%E3%81%A6%E5%BC%95%E3%81%8D%E8%B5%B7%E3%81%93%E3%81%95%E3%82%8C%E3%81%9F%E3%81%A8%E5%88%86%E3%81%8B%E3%82%8B" aria-hidden="true"></a> 5. 「HangしてCrashが発生したデバイス」の、ログを調査する -&gt; Crashは"Watch Dog Timer"によって引き起こされたと分かる</h2>
<p><a href="https://developer.apple.com/documentation/xcode/diagnosing-issues-using-crash-reports-and-device-logs" target="_blank" rel="nofollow noopener noreferrer">Diagnosing issues using crash reports and device logs</a>によると、デバイスに残っているログが分析に役立ちそう。<br>
デバイスのログには、以下の情報が記録されている</p>
<ul>
<li>
<strong>Crash Report</strong>: どのようにアプリがクラッシュしたのかと、そのときのスレッドの状態</li>
<li>
<strong>Jetsam Event</strong>: アプリがOSに終了させられたときの、メモリの使用状況</li>
<li>
<strong>Device Console Log</strong>: OSとアプリのログ</li>
</ul>
<p>[##2] より、原因は"Memory Limit"、"App WatchDog"のどちらかだと思っていたので、</p>
<ul>
<li>"Jetsam Event" があれば、Hangののち、"Memory Limit"でクラッシュした。</li>
<li>"Crash Report"があれば、Hangののち、"WatchDog"でクラッシュした。<br>
のどちらかだろうと思って、"Hang-&gt;Crash"が発生したデバイスのログを調査した。</li>
</ul>
<p>ログは、デバイスの"Home" -&gt; "Setting" -&gt; "Privacy &amp; Security" -&gt; "Analytics &amp; Improvements" -&gt; "Analytics Data"に行くと、ログの一覧がみれる。<br>
今回のケースでは、「AppName-YYYY-MM-DD-TTTTTT.ips」というフォーマットのファイルがログに残っていた。<br>
開いてみると、以下のようなログを発見できた</p>
<div class="code-block-container"><pre><code>Exception Type: EXC_CRASH(SIGKILL)
Termination Description: explanation:scene-update watchdog, exhausted real time allowance of 10.00 seconds.
</code></pre></div><p>大事そうなところ以外は省略してますが、どうやら今回の原因は、"Watch Dog"（アプリの起動に時間がかかりすぎた）ことが、クラッシュの原因だったよう。</p>
<h2 id="6.-%E3%80%8Cdeveloper-mode%E3%80%8D%E3%82%92%E6%9C%89%E5%8A%B9%E3%81%AB%E3%81%97%E3%81%9F%E3%83%87%E3%83%90%E3%82%A4%E3%82%B9%E3%81%A7%E3%80%81hang%E3%82%92%E5%86%8D%E7%8F%BE%E3%81%97%E3%80%81%E3%83%AD%E3%82%B0%E3%82%92%E8%AA%BF%E6%9F%BB%E3%81%99%E3%82%8B--%3E-hang%E7%99%BA%E7%94%9F%E6%99%82%E3%81%AE%E3%82%B9%E3%82%BF%E3%83%83%E3%82%AF%E3%83%88%E3%83%AC%E3%83%BC%E3%82%B9%E3%82%92%E8%A6%8B%E3%81%A6%E3%80%81%E7%AE%87%E6%89%80%E3%82%92%E7%89%B9%E5%AE%9A%E3%81%99%E3%82%8B">
<a class="header-anchor-link" href="#6.-%E3%80%8Cdeveloper-mode%E3%80%8D%E3%82%92%E6%9C%89%E5%8A%B9%E3%81%AB%E3%81%97%E3%81%9F%E3%83%87%E3%83%90%E3%82%A4%E3%82%B9%E3%81%A7%E3%80%81hang%E3%82%92%E5%86%8D%E7%8F%BE%E3%81%97%E3%80%81%E3%83%AD%E3%82%B0%E3%82%92%E8%AA%BF%E6%9F%BB%E3%81%99%E3%82%8B--%3E-hang%E7%99%BA%E7%94%9F%E6%99%82%E3%81%AE%E3%82%B9%E3%82%BF%E3%83%83%E3%82%AF%E3%83%88%E3%83%AC%E3%83%BC%E3%82%B9%E3%82%92%E8%A6%8B%E3%81%A6%E3%80%81%E7%AE%87%E6%89%80%E3%82%92%E7%89%B9%E5%AE%9A%E3%81%99%E3%82%8B" aria-hidden="true"></a> 6. 「Developer Mode」を有効にしたデバイスで、Hangを再現し、ログを調査する -&gt; Hang発生時のスタックトレースを見て、箇所を特定する</h2>
<p>別の方法として、"Hang detection"という機能が利用できるらしい。<a></a><br>
これは、デバイスの"Developer Model"を有効にしているとテストフライトAppなどの開発用AppがHangしたときに、画面にタイマーが表示され、さらにHangのログが記録される。<br>
今回のケースでは、ログのスタックトレースに<code>NSMutableString(data:)</code>の呼び出しがあり、そこでHangしたと結論づけた。</p>
<p><img src="https://res.cloudinary.com/zenn/image/fetch/s--ShIpCSMv--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/5662fdd4e8bc6b3e763dbd87.png%3Fsha%3Da2558dc6cfc497dd1971829fd7df308dee97bfa3" loading="lazy" class="md-img"><br>
以下のように、Hangが発生したときに、画面の丈夫にタイマーが表示される。<br>
また、そのときのログも記録される。<br>
ログは、"Developer Mode"を有効にしたデバイスで、"Setting" -&gt; "Developer" -&gt; "Hang Detection"見ることができる。<br>
<img src="https://res.cloudinary.com/zenn/image/fetch/s--Av3Vg-S5--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/ApphangDetection.png" loading="lazy" class="md-img"></p>
<h2 id="7.-%E5%95%8F%E9%A1%8C%E3%81%AE%E7%AE%87%E6%89%80%E3%82%92%E4%BF%AE%E6%AD%A3%E3%81%97%E3%81%A6%E3%80%81hang-issue%E3%82%92%E7%9B%B4%E3%81%99">
<a class="header-anchor-link" href="#7.-%E5%95%8F%E9%A1%8C%E3%81%AE%E7%AE%87%E6%89%80%E3%82%92%E4%BF%AE%E6%AD%A3%E3%81%97%E3%81%A6%E3%80%81hang-issue%E3%82%92%E7%9B%B4%E3%81%99" aria-hidden="true"></a> 7. 問題の箇所を修正して、Hang Issueを直す</h2>
<p>今回の原因は、MainThreadで重いUI処理を複数回 実行してしまっていたことが原因だった。</p>
<h1 id="refs">
<a class="header-anchor-link" href="#refs" aria-hidden="true"></a> Refs</h1>
<ul>
<li><a href="https://developer.apple.com/documentation/xcode/addressing-watchdog-terminations" target="_blank" rel="nofollow noopener noreferrer">Addressing watchdog terminations</a></li>
<li><a href="https://developer.apple.com/videos/play/wwdc2023/10248/" target="_blank" rel="nofollow noopener noreferrer">Analyze hangs with Instruments</a></li>
<li><a href="https://developer.apple.com/documentation/xcode/analyzing-responsiveness-issues-in-your-shipping-app#View-your-apps-hitch-rate" target="_blank" rel="nofollow noopener noreferrer">Analyzing responsiveness issues in your shipping app</a></li>
<li><a href="https://developer.apple.com/documentation/xcode/improving-app-responsiveness" target="_blank" rel="nofollow noopener noreferrer">Improving app responsiveness</a></li>
<li><a href="https://developer.apple.com/documentation/xcode/reduce-terminations-in-your-app#Understand-termination-reasons" target="_blank" rel="nofollow noopener noreferrer">Reducing terminations in your app</a></li>
<li><a href="https://developer.apple.com/videos/play/wwdc2022/10082/" target="_blank" rel="nofollow noopener noreferrer">Track down hangs with Xcode and on-device detection</a></li>
<li><a href="https://developer.apple.com/videos/play/wwdc2021/10258/" target="_blank" rel="nofollow noopener noreferrer">Understand and eliminate hangs from your app</a></li>
<li><a href="https://developer.apple.com/videos/play/wwdc2020/10078/" target="_blank" rel="nofollow noopener noreferrer">Why is my app getting killed?</a></li>
<li><a href="https://zenn.dev/numatech/articles/71f8fffc357c0e" target="_blank">iOSのwatchdogの挙動について</a></li>
<li><a href="https://note.com/nttrtech/n/n4e23dfc5bdd1#ec443550-2b51-42ea-8cde-d1c148681cb4" target="_blank" rel="nofollow noopener noreferrer">iOSアプリのパフォーマンス計測に入門してみた</a></li>
</ul>
<p>本記事中の画像は、"Refs"内のWWDCの動画のものです。</p>


[Swift]「アプリがHangして、Crashした」と報告があってから原因を見つけるまで

1. アプリが「HangしたあとにCrashした」と報告があった

2. "Firebase"の"Crashlystics"をチェックし該当のクラッシュログを調査する -> ログが見つからない

3. Xcode OrganizerでHangのログをチェックする。 -> Hangが発生している箇所が複数あり、特定できない

4. Xcode Instrumentsで起動時の動作の分析をする

5. 「HangしてCrashが発生したデバイス」の、ログを調査する -> Crashは"Watch Dog Timer"によって引き起こされたと分かる

6. 「Developer Mode」を有効にしたデバイスで、Hangを再現し、ログを調査する -> Hang発生時のスタックトレースを見て、箇所を特定する

Discussion