構文
recordCustomEvent:(NSString*)eventType attributes:(NSDictionary*)attributes;NewRelic.recordCustomEvent(string $eventType, [string $eventName,] map<string, object> $eventAttributes)カスタム・モバイル・モニタリング・イベントを記録します。
要件
New Relic iOSエージェントバージョン5.12.0 の時点で、 recordEvent メソッドは非推奨となり、 recordCustomEvent に置き換えられます。 recordEvent メソッドは不特定多数の期間、継続して動作しますが、アプリに recordEvent メソッドが含まれている場合、New Relic はそれらを置き換えることを推奨します。
これらのメソッドを更新すると、廃止されたイベントタイプを使用しているすべてのクエリとダッシュボードに影響があります。必要に応じて、NRQL クエリとダッシュボードを調整してください。
説明
カスタムイベント を作成して記録します。このイベントは、 NRQL を使ってクエリできます。このイベントには、マップとして指定された属性のリストが含まれます。 setAttribute とは異なり、カスタムイベントに属性を追加すると、そのイベントにのみ属性が追加され、セッション属性にはなりません。
重要な検討事項やベストプラクティスは以下の通りです。
eventType値の合計数を約5つに制限します。これは、Gestures のような高レベルのカテゴリーに使用することを意図しています。- カスタムイベントの名前に
eventTypeを使用しないでください。代わりに、カスタムイベントの名前を付ける属性を作成するか、オプションのnameパラメータを使用してください。 名前キーワードを使用して、 モバイルモニタリングUI でイベントを表示します。便利な名前を作成するには、複数の属性を組み合わせることができます。nameパラメータを使用すると、attributes 辞書にnameキーを追加するのと同じ効果があります。- 属性オブジェクトの要素は、NSStringまたはNSNumberタイプでなければなりません。
パラメータ
パラメーター | 説明 |
|---|---|
文字列 | 必須です。イベントのタイプです。カスタム・イベントの名前に |
文字列 | オプションです。このパラメータを使用して、イベントの名前を付けます。(このパラメーターを使用することは、 |
マップ<文字列, オブジェクト> | 任意です。 便利だと思われるイベント記述子の属性を作成することができます。カスタムイベントに名前を付けるには、 重要カスタムアトリビュートのキーを設定する際には、オーバーライドできない デフォルトのアトリビュートがあることに注意してください 。 |
戻り値
イベントの記録に成功した場合は true を、失敗した場合は false を返します。
例
Objective-C
方法をご紹介します。
+ (BOOL) recordCustomEvent:(NSString*)eventType attributes:(NSDictionary*)attributes;+ (BOOL) recordCustomEvent:(NSString*)eventType name:(NSString*)name attributes:(NSDictionary*)attributes;例：
BOOL eventRecorded = [NewRelic recordCustomEvent:@"eventType"attributes:@{@"attributeName1": @"value1", @"attributeName2": @2}];BOOL eventRecorded = [NewRelic recordCustomEvent:@"Vehicle" name:@"1908 Ford ModelT" attributes:@{@"make":@"Ford", @"model":@"ModelT", @"year": @1908, @"color": @"black", @"mileage": @250000}];Swift
方法をご紹介します。
NewRelic.recordCustomEvent(eventType: String!, attributes:[NSObject : AnyObject]!) -> BoolNewRelic.recordCustomEvent(eventType: String!, name: String!, attributes:[NSObject : AnyObject]!) -> Bool例：
let eventRecorded = NewRelic.recordCustomEvent("eventType", attributes: ["attributeName1" : "value1", "attributeName2": 2])let eventRecorded = NewRelic.recordCustomEvent("Vehicle", name:"1908 Ford ModelT", attributes:["make":"Ford", "model":"ModelT", "year": 1908, "color": "black", "mileage": 250000]);