• /
  • ログイン

iOS SDK API guide

Use the iOS SDK API to add custom data. For example:

  • Instrument your own code.
  • Start and stop interaction traces from events in your mobile app.
  • Record custom metrics.
  • Send custom attributes and events to Insights.
  • Track networking from libraries not supported automatically.
  • Set a custom identifier value with Objective-C or Swift to associate user sessions with analysis events and attributes (iOS SDK version 5.9.0 or higher).

注意

Tracing is heavily optimized, but it does impose a performance overhead. Avoid instrumenting methods that are expected to be called hundreds of times.

Install the SDK

Ensure you have your app instrumented with the latest iOS SDK by going to one.newrelic.com > Add more data and following the instructions for iOS.

This document contains the iOS SDK instrumentation requirements for:

For details about the available methods for custom attributes and events you can send to to New Relic Insights, see the iOS SDK API reference. You can also configure feature flags for:

  • Objective-C
  • Swift

Automatically instrumented classes and methods

The following methods (for the listed classes and their sub-classes) are already instrumented by New Relic. You do not need to add custom instrumentation to trace them.

Classes

Methods automatically instrumented by New Relic

UIViewController

  • viewDidLoad:
  • viewWillAppear:
  • viewDidAppear:
  • viewWillDisappear:
  • viewDidDisappear:
  • viewWillLayoutSubviews:
  • viewDidLayoutSubviews:

UIImage

  • imageNamed:
  • imageWithContentsOfFile:
  • imageWithData:
  • imageWithData:scale:
  • initWithContentsOfFile:
  • initWithData:
  • initWithData:scale:

NSJSONSerialization

  • JSONObjectWithData:options:error:
  • JSONObjectWithStream:options:error:
  • dataWithJSONObject:options:error:
  • writeJSONObject:toStream:options:error:

NSManagedObjectContext

  • executeFetchRequest:error:
  • processPendingChanges

The agent aggregates performance for various methods into summary metrics that appear in the Interactions page. Summary categories include:

  • View loading
  • UI layout
  • Database
  • Images
  • JSON
  • Network

Instrument your Objective-C code

To have your own Objective-C code appear in interaction code breakdowns and timelines, add a _START call to the beginning of your method and a _STOP call to the end of it.

重要

Always include a _STOP for each _START, and only include one set of these commands in a given method. The trace system will automatically pick up the class and method name, and report performance metrics for your method to New Relic.

- (void)myMethod
{
NR_TRACE_METHOD_START(0);
// … existing code
NR_TRACE_METHOD_STOP;
}

If you are not using ARC, use this version of the _STOP macro to avoid memory leaks:

NR_NONARC_TRACE_METHOD_STOP;

If you want your method’s performance to be included in the summary data on the APM Overview page, pass one of the NRTraceType enum values into the _START macro; for example:

NR_TRACE_METHOD_START(NRTraceTypeDatabase);

Objective-C: Report custom attributes and events

Use methods in the NewRelic object to report custom attributes and events. For details about the available methods for custom attributes and events with Objective-C, see the iOS SDK API reference.

Methods that return BOOL results return YES if they succeed, or NO if the operation did not complete. These methods are available in versions 5.0.0 or higher of the New Relic iOS SDK.

The SDK can store up to 128 user-defined custom attributes at a time. If you attempt to store more than 128 attributes, the SDK returns NO.

Custom attributes names should use the simplest format needed, and New Relic recommends single word attributes, containing no spaces. Attribute phrases can be formatted in camel case, so My Custom Attribute is better specified as myCustomAttribute. As with custom metrics:

  • Avoid using the characters / ] [ | * when naming things.
  • Avoid multi-byte characters.

Objective-C: Track custom network requests

If you can express a transactional network request in terms similar to an HTTP request, you can track it. Use URLs that are well-formed and do not include highly variable paths or hostnames.

For requests that complete, use this method:

[NewRelic noticeNetworkRequestForURL:(NSURL*)url
httpMethod:(NSString*)httpMethod
withTimer:(NRTimer *)timer
responseHeaders:(NSDictionary *)headers
statusCode:(NSInteger)httpStatusCode
bytesSent:(NSUInteger)bytesSent
bytesReceived:(NSUInteger)bytesReceived
responseData:(NSData *)responseData
andParams:(NSDictionary *)params];

Parameters include:

Parameter

Description

url

The URL of the request

httpMethod

The method type of the request; for example, POST, GET, etc.

timer

An NRTimer that timed the network request

headers

A dictionary containing the HTTP response headers, if available

httpStatusCode

The response status code

If the httpStatusCode is greater than or equal to 400, the agent will record a server error and may capture the responseData body if provided.

bytesSent

The size of the request body

bytesReceived

The size of the responseBody

responseData

The response body data, captured if the agent records server error params

params

Additional parameters included in an HTTP error metric if the HTTP transaction is an error

For requests that fail due to a socket or operating system error, use this method:

[NewRelic noticeNetworkFailureForURL:(NSURL *)url
httpMethod:(NSString*)httpMethod
withTimer:(NRTimer *)timer
andFailureCode:(NSInteger)iOSFailureCode];

Parameters include:

Parameter

Description

url

The URL of the request

httpMethod

The method type of the request; for example, POST, GET, etc.

timer

An NRTimer that timed the network request

iOSFailureCode

The failure code

Failure codes are interpreted as NSURLError* code. To view a complete list of supported codes, see NRConstants.h.

Instrument your Swift code

To have your own Swift code appear in interaction code breakdowns and timelines:

  • Add a startTracingMethod() call to the beginning of your method.
  • Add a endTracingMethodWithTimer() call to the end of it.
  • Always include an endTracingMethodWithTimer() call for each startTracingMethod() reference.
  • Include only one set of these commands in a given method.
func myMethod(){
let timer = NRTimer();
NewRelic.startTracingMethod(#selector(MyClass.myMethod),
object: self,
timer: timer,
category: NRTraceTypeNone)
// … existing code
NewRelic.endTracingMethodWithTimer(timer)
}

If you want your method’s performance to be included in the summary data on the APM Overview page, pass one of the NRTraceType enum values into the startTracingMethod() macro; for example:

NewRelic.startTracingMethod(#selector(MyClass.myMethod),
object: self,
timer: timer,
category: NRTraceTypeDatabase)

Swift: Report custom attributes and events

Use methods in the NewRelic object to report custom attributes and events. For details about the available methods for custom attributes and events with Swift, see the iOS SDK API reference.

Methods that return BOOL results return YES if they succeed, or NO if the operation did not complete. These methods are available in versions 5.0.0 or higher of the New Relic iOS SDK.

The SDK can store up to 128 user-defined custom attributes at a time. If you attempt to store more than 128 attributes, the SDK returns NO.

Custom attributes names should use the simplest format needed, and New Relic recommends single word attributes, containing no spaces. Attribute phrases can be formatted in camel case, so My Custom Attribute is better specified as myCustomAttribute. As with custom metrics:

  • Avoid using the characters / ] [ | * when naming things.
  • Avoid multi-byte characters.

Swift: Track custom network requests

If you can express a transactional network request in terms similar to an HTTP request, you can track it. Use URLs that are well-formed and do not include highly variable paths or hostnames.

For requests that complete, use this method:

NewRelic.noticeNetworkRequestForURL(url: NSURL!,
httpMethod: String!,
withTimer: NRTimer!,
responseHeaders:[NSObject : AnyObject]!,
statusCode: Int,
bytesSent: UInt,
bytesReceived: UInt,
responseData: NSData!,
andParams: [NSObject : AnyObject]!)

Parameters include:

Parameter

Description

url

The URL of the request

httpMethod

The method type of the request; for example, POST, GET, etc.

timer

An NRTimer that timed the network request

headers

A dictionary containing the HTTP response headers, if available

httpStatusCode

The response status code

If the httpStatusCode is greater than or equal to 400, the agent will record a server error and may capture the responseData body if provided.

bytesSent

The size of the request body

bytesReceived

The size of the responseBody

responseData

The response body data, captured if the agent records Server error params

params

Additional parameters included in an HTTP error metric if the HTTP transaction is an error

For requests that fail due to a socket or operating system error, use this method:

NewRelic.noticeNetworkFailureForURL(url: NSURL!,
httpMethod: NSString!,
withTimer: NRTimer!,
andFailureCode: Int)

Parameters include:

Parameter

Description

url

The URL of the request

httpMethod

The method type of the request; for example, POST, GET, etc.

timer

An NRTimer that timed the network request

iOSFailureCode

The failure code

Failure codes are interpreted as NSURLError* code. To view a complete list of supported codes, see NRConstants.h.

その他のヘルプ

さらに支援が必要な場合は、これらのサポートと学習リソースを確認してください:

問題を作成するこのページを編集する
Copyright © 2020 New Relic Inc.