Android SDK APIガイド

重要

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

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

独自のコードを計測する.
Create, name, and end interaction traces from events in your mobile app.
カスタムメトリクスの記録.
カスタム属性やイベントをNew Relic Insightsに送信する.
自動的にサポートされないライブラリからのトラックネットワーキング.

SDKのインストール

Android SDK APIを使う前に。

Android SDK API release notes を見て、モバイルモニタリング用の最新のSDKでアプリをインスツルメンテーションしていることを確認してください。
one.newrelic.com にアクセスし、 Add more data をクリックして、Androidの場合の手順に従ってください。

詳細は、 Androidのインストールおよび設定手順の詳細をご参照ください。Android 2.2をサポートする必要がある場合は、 legacy Android agent SDK procedures をご参照ください。

コードを計測する

注意

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

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

以下のJavaアノテーションを使用します。
```
import com.newrelic.agent.android.instrumentation.Trace;
```
@Trace アノテーションを、計測したいメソッドに追加します。
```
@Trace
  public void myHeavyweightMethod() {
  …
```
どのような方法でトレースされているかを示すために、オプションの カテゴリ 属性を使用します。

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

クラス	メソッド
`アクティビティ`	`オンクリエイト` `onCreateView`
`非同期タスク`	`エグゼキューション` `executeOnExecutor`
`ビットマップファクトリー`	`デコードファイル` `decodeResourceStream` `decodeResource` `decodeByteArray` `デコードストリーム` `decodeFileDescriptor` `decodeResourceStream`
`SQLiteDatabase`	`問い合わせ` `queryWithFactory` `rawQuery` `rawQueryWithFactory` `インサート` `インサートまたはスロー` `インサートウィズオンコンフリクト` `交換` `replaceOrThrow` `デリート` `更新` `updateWithOnConflict` `execSql`
`GSON`	`toJson` `fromJson`
`JSONオブジェクト`	`<init>` `toString`
`JSONArray`	`<init>` `toString`

カテゴリは、カスタム名でも、定義済みの MetricCategory enum（以下のリスト）の1つでも構いません。以下は、定義済みの IMAGE カテゴリを使用して、画像処理メソッドをインストルメント化する例です。

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

利用可能な MetricCategory enum は以下の通りです。

MetricCategory	説明
`VIEW_LOADING`	サブビューやコントロールの作成などの関連作業
`VIEW_LAYOUT`	レイアウトの膨らみ、コンポーネントの解決
`データベース`	SQLiteやその他のファイルI/O
`IMAGE`	画像の読み込みと加工
`JSON`	JSONの解析または作成
`ネットワーク`	Webサービス統合手法、リモートリソースローディング

APIメソッドの使用

次の表は、すべての New Relic Android SDK API コールを、一般的なユースケースの順に並べたものです。

以下を行う場合...	実行する操作
クラッシュのトラブルシューティングに役立つアプリのアクティビティを追跡することができます。	参照 `recordBreadcrumb` .
インタラクションとしてのメソッドの追跡	参照 `startInteraction` .
インタラクションに名前を付ける、または名前を変更する	参照 `setInteractionName` .
インタラクションの終了	参照 `endInteraction` .
すべてのインタラクションの無効化または有効化	`withInteractionTracing` を参照してください。
インタラクションに関連するアプリのバージョンを設定する	参照 `withApplicationVersion` .
カスタムビルドIDの設定	参照 `withApplicationBuild` .
カスタムメトリクスの作成	参照 `recordMetric` .
カスタム属性とイベントの報告	カスタム属性やイベントを追加するにはいくつかの方法があります。どの方法が最適なのか、またその理由については、カスタムデータの追加をご覧ください。アトリビュートの作成： `setAttribute` アトリビュートのカウントを増加させます。 `incrementAttribute` 属性の削除： `removeAttribute` すべてのアトリビュートを削除： `removeAllAttributes` カスタムイベントの記録： `recordCustomEvent` パンくずイベントの記録： `recordBreadcrumb` イベントプールの最大サイズの設定： `setMaxEventPoolSize` Set maximum time agent stores events in memory: `setMaxEventBufferTime` 現在のセッションのIDを返す： `currentSessionId` セッションをイベントや属性と関連付けるためのカスタムユーザーIDを設定： `setUserId`
カスタムネットワークのリクエストと障害の追跡	これらの方法を使います。さまざまなレベルの詳細でHTTPトランザクションを記録します。 `noticeHttpTransaction` を参照してください。ネットワーク障害の記録。参照 `noticeNetworkFailure` .
処理された例外を、コンテキストを含めてイベントとして記録する	参照 `recordHandledException()`.

手動によるクロスアプリケーションのトレース [#manual-cat]

noticeHttpTransaction コードは、クロスアプリケーショントレースが機能するために必要な適切なヘッダーID値を自動的に付加しません。このため、New Relic の Map page for mobile apps や HTTP requests page には、Android アプリのアプリケーションリンクが表示されません。

New Relic Android SDKのパブリックメソッドを使用すると、バックエンドアプリケーションがNew Relicによってすでにインスツルメンテーションされている場合に限り、バックエンドアプリケーションへのHTTPリクエストと一緒に渡す適切なIDを取得できます。バックエンドアプリケーションからのレスポンスには、適切なヘッダーIDが渡され、クロスアプリケーショントレースに必要なものがすべて揃います。

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

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メソッドの使用

手動によるクロスアプリケーションのトレース [#manual-cat]

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