AndroidSDKAPIガイド

重要

New Relic Androidエージェントのバージョン5.9.0以降では、カスタムユーザー識別子の値を設定して、ユーザーセッションを分析イベントおよび属性に関連付けることができます。詳細については、 NewRelic.setUserIdメソッドを参照してください。

Androidエージェントは、アプリケーションを監視するためのカスタムインストルメンテーションをセットアップするためのSDKAPIを提供します。 APIには、次の機能があります。

独自のコードをインストルメントします。
モバイルアプリのイベントからインタラクショントレースを作成、名前付け、終了します。
カスタムメトリックを記録します。
カスタム属性とイベントを送信します。
自動的にサポートされていないライブラリからネットワークを追跡します。

SDKをインストールします

Android SDK APIを使用する前に：

Android SDK APIリリースノートを確認して、モバイルモニタリング用の現在のSDKがアプリに組み込まれていることを確認してください。
one.newrelic.comにアクセスし、[データを追加] をクリックし、Android の手順に従います。

詳細については、 Androidのインストールと構成の詳細な手順を参照してください。 Android 2.2をサポートする必要がある場合は、従来のAndroidエージェントSDKの手順を参照してください。

コードをインストルメントする

注意

トレースは大幅に最適化されていますが、パフォーマンスのオーバーヘッドが発生します。何百回も呼び出されることが予想される計測メソッドは避けてください。

インタラクショントレースに含めるカスタムライブラリまたはアプリケーションコードがある場合：

次のJavaアノテーションを使用します。
```
import com.newrelic.agent.android.instrumentation.Trace;
```
インストルメントするメソッドに@Traceアノテーションを追加します。
```
@Trace
  public void myHeavyweightMethod() {
  …
```
トレースされているメソッドの種類を示すには、オプションのcategory属性を使用します。

自動インストルメンテーションは、エージェントのより便利な機能の1つです。ただし、トレースされるメソッドに干渉する場合は、メソッドに@SkipTraceを追加すると、エージェントはコンパイル時のインストルメンテーション中にそれをスキップします。

クラス	メソッド
`Activity`	`onCreate` `onCreateView`
`AsyncTask`	`execute` `executeOnExecutor`
`BitmapFactory`	`decodeFile` `decodeResourceStream` `decodeResource` `decodeByteArray` `decodeStream` `decodeFileDescriptor` `decodeResourceStream`
`SQLiteDatabase`	`query` `queryWithFactory` `rawQuery` `rawQueryWithFactory` `insert` `insertOrThrow` `insertWithOnConflict` `replace` `replaceOrThrow` `delete` `update` `updateWithOnConflict` `execSql`
`GSON`	`toJson` `fromJson`
`JSONObject`	`<init>` `toString`
`JSONArray`	`<init>` `toString`

カテゴリは、カスタム名にすることも、事前定義されたMetricCategory列挙型（以下にリスト）の1つにすることもできます。事前定義されたIMAGEカテゴリを使用して画像処理方法を計測する例を次に示します。

@Trace(category = MetricCategory.IMAGE)
public void processImageData() {
…

使用可能なMetricCategory列挙型は次のとおりです。

MetricCategory	説明
`VIEW_LOADING`	サブビュー、コントロール、およびその他の関連タスクの作成
`VIEW_LAYOUT`	レイアウトの膨張、コンポーネントの解決
`DATABASE`	SQLiteおよびその他のファイルI/O
`IMAGE`	画像の読み込みと処理
`JSON`	JSONの解析または作成
`NETWORK`	Webサービスの統合方法、リモートリソースの読み込み

APIメソッドを使用する

次の表に、すべてのNew Relic AndroidSDKAPI呼び出しを一般的なユースケース順に示します。

あなたがしたい場合は...	これを行う
クラッシュのトラブルシューティングに役立つ可能性のあるアプリのアクティビティを追跡する	`recordBreadcrumb`を参照してください。
インタラクションとしてメソッドを追跡する	`startInteraction`を参照してください。
インタラクションに名前を付けるか名前を変更する	`setInteractionName`を参照してください。
インタラクションを終了する	`endInteraction`を参照してください。
すべてのインタラクションを無効または有効にする	`withInteractionTracing`を参照してください。
インタラクションに関連付けられたアプリのバージョンを設定する	`withApplicationVersion`を参照してください。
カスタムビルドIDを設定する	`withApplicationBuild`を参照してください。
カスタムメトリックを作成する	`recordMetric`を参照してください。
カスタム属性とイベントを報告する	カスタム属性とイベントを追加する方法はいくつかあります。使用するのに最適な方法とその理由の詳細については、「カスタムデータの追加」を参照してください。属性を作成します： `setAttribute` 属性数を増やす： `incrementAttribute` 属性を削除します： `removeAttribute` すべての属性を削除します： `removeAllAttributes` カスタムイベントの記録： `recordCustomEvent` ブレッドクラムイベントを記録する： `recordBreadcrumb` イベントプールの最大サイズを設定します： `setMaxEventPoolSize` エージェントがイベントをメモリに保存する最大時間を設定します： `setMaxEventBufferTime` 現在のセッションのIDを返します： `currentSessionId` セッションをイベントおよび属性に関連付けるためのカスタムユーザーIDを設定します： `setUserId`
カスタムネットワークの要求と障害を追跡する	次の方法を使用します。さまざまな詳細レベルでHTTPトランザクションを記録します。 `noticeHttpTransaction`を参照してください。ネットワーク障害の記録： `noticeNetworkFailure`を参照してください。
処理された例外を、コンテキストを含むイベントとして記録します	`recordHandledException()`を参照してください。
ReactNative アプリから JavaScript エラーを記録する	`recordJSErrorException`を参照してください。
アプリの起動時間の目標アクティビティを設定する	`withLaunchActivityName`を参照してください。
エージェントのシャットダウン	`shutdown`を参照してください。

手動のクロスアプリケーショントレース

noticeHttpTransactionコードは、クロスアプリケーショントレースを機能させるために必要な適切なヘッダーID値を自動的に追加しません。これが、AndroidアプリのモバイルアプリのNewRelicのマップページまたはHTTPリクエストページにアプリケーションリンクが表示されない理由です。

New Relic Android SDKのパブリックメソッドを使用して、HTTPリクエストとともにバックエンドアプリケーションに渡す適切なIDを取得できます（New Relicによって既にインストルメント化されている場合）。適切なヘッダーIDが応答でバックエンドアプリケーションから渡され、クロスアプリケーショントレースが機能するために必要なすべてのものが提供されます。

この例では、外部HTTP接続としてconnを使用して、バックエンドHTTPリクエストにNewRelic-IDを追加します。（追加のインポートに注意してください。）

import com.newrelic.agent.android.NewRelic;
import com.newrelic.agent.android.Agent; //required for getCrossProcessId()
...
...

//new method for appending the crossProcessID necessary for CAT in New Relic
public static void setCrossProcessHeader(HttpURLConnection conn) {
    String crossProcessId = Agent.getCrossProcessId(); // API call into the agent for the X-NewRelic-ID
    if (crossProcessId != null) {
        conn.setRequestProperty("X-NewRelic-ID", crossProcessId);
    }
}

バックエンドアプリへのリクエストに適切なヘッダーを追加した後、アプリからの応答を解析してX-Newrelic-App-Dataヘッダーを取得し、文字列としてnoticeHttpTransaction呼び出しに追加する必要があります。例えば：

//NewRelic.noticeHttpTransaction(url, httpMethod, statusCode, startTimeMs, endTimeMs, bytesSent, bytesReceived, responseBody, params, response);
//Where xNewRelicAppDataHeader is the value of the X-NewRelic-App-Data header
NewRelic.noticeHttpTransaction("http://api.newrelic.com", "GET", 200, System.nanoTime(), System.nanoTime(),100 ,100, "Test", new HashMap<String, String>(), xNewRelicAppDataHeader);

この機械翻訳は参考用に提供されます。

重要

SDKをインストールします

コードをインストルメントする

注意

自動的に計測されたメソッド

カテゴリ属性の例

APIメソッドを使用する

手動のクロスアプリケーショントレース

クロスアプリケーショントレースの例