React Native モニタリング API

クラス App 内で componentDidMount()Instana を初期化してください：

export default class App extends Component {
  componentDidMount() {
    Instana.setup(YOUR_INSTANA_APP_KEY, YOUR_INSTANA_REPORTING_URL, null);
    // Alternatively with configuration options
    Instana.setup(YOUR_INSTANA_APP_KEY, YOUR_INSTANA_REPORTING_URL, {'collectionEnabled': false});
  }
}

次のコードはTypeScriptの定義です：

setup(your_instana_app_key: string, your_instana_app_reportingUrl: string, options?: Object): void;
setup(your_instana_app_key: string, your_instana_app_reportingUrl: string, {collectionEnabled: boolean}): void;

各Instanaエージェント・インスタンスには、アプリで他の目的に使用できる固有のセッション識別子があります。

static getSessionID()

次のコードはTypeScriptの定義です：

getSessionID(): Promise<string>;

Instana このエージェントは、 HTTP へのリクエストを自動的に監視します。

Instana は、モバイル・アプリケーションの洞察を論理ビューによってセグメント化することができます。 メソッド Instana.setView(String) を使用して、ビュー名を設定できます。 その後、setViewが再び呼ばれたときにビューが変更されるまで、ビューは監視されているすべてのビーコンに関連付けられます。

ビューを定義する際は、「Class」などの技術用語や一般的な名称（例： WebViewActivity）を使用しないでください。 その代わりに、ビューには読みやすい名前を使いましょう（例えば、product detail pageやpayment selectionなど）。 ユーザー・エクスペリエンスに焦点を当てることで、コードベースを熟知していないチーム・メンバーも、提供される洞察を理解することができる。

static setView(String name)

次のコードはTypeScriptの定義です：

setView(name: string): void;

Instana に送信されるデータに、必要に応じてユーザー固有の情報を含めることができます。 この情報を使用して、以下のような追加機能をアンロックすることができます。

• エラーの影響を受けたユーザー数の算出
• 特定のユーザーのデータをフィルタリングする
• ビューの変更または HTTP リクエストを発行したユーザーを確認する

デフォルトでは、Instana はユーザーが識別可能な情報をビーコンに関連付けません。 各国のデータ保護法について、十分に理解しておく必要があります。 ユーザー ID を使用してユーザーを識別します。 Instana において、これは特定のメトリクスの計算にのみ使用される透過的なものです String 。 userNameとuserEmailは、より多くのフィルターにアクセスしたり、ユーザー情報をよりよく表示したりするためにも使えます。

匿名ユーザーを扱っていて、ユーザーIDにアクセスできない場合は、セッションIDを使うこともできます。 データのフィルタリングを行う際、セッションIDはユーザーIDほど有用ではありませんが、影響を受けたユーザー数やユニークユーザー数といった指標を算出する上では有用な指標となります。 認証済みユーザーと非認証ユーザーを明確に区別するには、 Anonymous などのユーザー名を設定します。 セッション ID は、(使用するフレームワークまたはプラットフォームに応じて) 機密データにすることができます。 ハッシュ・セッション ID を考慮する は、アクセス権限を付与できる Instana にデータが送信されないようにします。

Instana のサーバーにすでに送信されたデータは、事後的に更新することはできません。 このため、アプリの起動プロセスでは、できるだけ早くこの API を呼び出すことが重要です。

static setUserID(String ID)
static setUserName(String email)
static setUserEmail(String name)

次のコードはTypeScriptの定義です：

setUserID(id: string): void;
setUserName(name: string): void;
setUserEmail(email: string): void;

Instana に送信されるすべてのデータには、任意のメタデータを付加することができます。 UIコンフィギュレーション値、設定、機能フラグ、そして分析に役立つかもしれない追加コンテキストを追跡するために使用することができます。

static setMeta(String key, String value)

次のコードはTypeScriptの定義です：

setMeta(key: string, value: string): void;

カスタムイベントを使用すると、標準外のアクティビティ、重要なインタラクション、およびカスタムタイミングに関するレポートを Instana に送信できます。 これは、キャッチされていないエラー (パンくずリスト) を分析し、より多くのパフォーマンス・メトリックを追跡する場合に特に役立ちます。

static reportEvent(String eventName, {
  startTime: Number startTime,
  duration: Number duration,
  viewName: String viewName,
  backendTraceId: String backendTraceId,
  meta: Map meta
})

次のコードはTypeScriptの定義です：

reportEvent(eventName: string, options?: {
  startTime?: number;
  duration?: number;
  viewName?: string;
  meta?: Map<string, string>;
  backendTracingId?: string;
  customMetric?: number;
 }): void;

URLは正規表現を指定するか、ignoreURLsリストに追加することで無視できます。 この関数は、パスワードなどの機密データを含むすべての HTTP リクエストを無視したい場合に役立ちます。

エージェントは、この setIgnoreURLsByRegex メソッドに指定された各文字列を、サポートされている各プラットフォーム向けのネイティブ正規表現に変換する必要があります。 プロミスの拒否を追跡することができ、エージェントがあなたの入力を解釈している間に遭遇した問題を知ることができます。

static setIgnoreURLsByRegex([]String regexArray)

次のコードはTypeScriptの定義です：

setIgnoreURLsByRegex(regexArray: Array<string>): Promise<any>;

収集したURLに含まれるクエリパラメータには、機密データが含まれている可能性がある。 そのため、 Instana エージェントでは、値を非表示にする必要があるクエリパラメータのキーに対して、正規表現パターンの指定をサポートしています。 冗長化が必要な値はすべて文字列<redacted>に置き換えられます。 情報の黒塗り処理は、 Instana エージェントが Instana サーバーに報告を行う前に、そのエージェント内で実行されます。 したがって、シークレットは処理のために Instana サーバーに送信されることはなく、 Instana のUIでの分析や、 Instana API を使用した取得の対象にはなりません。

デフォルトでは、 Instana エージェントには、キー「password」、「key」、「secret」のクエリパラメータ値を自動的にマスキングするための3つの正規表現パターンが設定されています。

static setRedactHTTPQueryByRegex([]String regexArray)

次のコードはTypeScriptの定義です：

setRedactHTTPQueryByRegex(regexArray: Array<string>): Promise<any>;

必要に応じて、 Instana エージェントは、追跡対象となるすべてのリクエストおよびレスポンスの HTTP ヘッダーを取得することができます。

どのヘッダーをキャプチャするかを決定するために、正規表現パターンのリストを定義することができる。

リクエストとその応答の両方に同じヘッダー名が存在する場合、応答のヘッダー 値のみが考慮される。

static setCaptureHeadersByRegex([]String regexArray)

次のコードはTypeScriptの定義です：

setCaptureHeadersByRegex(regexArray: Array<string>): Promise<any>;

デフォルトでは、ビーコンの送信に失敗した場合、 Instana エージェントは、ビーコンが正常に送信されるまで再送信を試みます。 しかし、この動作は一部の携帯電話ネットワークではうまく機能しない。 「低速送信モード」機能を有効にすると、ビーコンの送信間隔を、 パラメータ slowSendInterval に割り当てられた時間値に変更できます。 各送信は、バッチではなく 1 つのビーコンのみで構成されます (バッチでは最大 100 ビーコン)。 Instana エージェントは、1つのビーコンが正常に送信されるまで、低速送信モードを維持します。

この slowSendInterval パラメータの有効な時間範囲は 2～3600 秒です。

次のコードはTypeScriptの定義です：

setup(key: string, reportingUrl: string, {slowSendInterval: number}): void;

デフォルトでは、ユーザーセッションは追跡され、Universally Unique Identifier（UUID）がランダムに生成される。 この ID は、アプリのインストール中は変更されません。 パラメータ usiRefreshTimeIntervalInHrs を使用することで、ユーザーセッションIDの有効期限を設定できます。

以下のパラメーター値は、ユーザー・セッション ID の状況を示します。

• 負の数値: この値は、ユーザー・セッション ID の有効期限が切れないことを示します。 デフォルト値は -1 です。

• 正の数：この値は、ユーザー・セッションIDが設定時間後にリフレッシュされることを意味する。 新しいUUIDが生成され、使用される。

• ゼロ: この値 0.0 は、ユーザー・セッション ID が使用不可であることを意味します。

次のコードはTypeScriptの定義です：

setup(key: string, reportingUrl: string, {usiRefreshTimeIntervalInHrs: number}): void;
 

このパラメータを使用すると、特定の時間間隔内に送信できるビーコンの数の上限をカスタマイズできます。 次の表に、利用可能なオプションと、それに対応するビーコンの制限を一覧で示します。 デフォルトでは、 0 (DEFAULT_LIMITS) が選択されています。

( Boolean , enableW3CHeaders オプション) オプションを有効にすると、React Nativeエージェントは、監視対象のすべての API 呼び出しに および tracestate ヘッダー traceparent を含めます。 これらのヘッダーを使用すると、バックエンドに Instana エージェントが導入されていなくても、バックエンドの相関分析が可能になります。 そのような場合は、 バックエンドのトレース詳細をInstana バックエンドにエクスポートするために、互換性のあるモニタリングツール（ OpenTelemetry など）を使用する必要があります。 このオプションが無効になっている場合、バックエンドの相関分析は、そのバックエンドが Instana エージェントによっても監視されている場合にのみ可能です。 デフォルト値はfalseです。