iOS API

次の表は、コンフィギュレーション・パラメータの概要である：

次の表は、パフォーマンス構成パラメータの概要である

import InstanaAgent

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    Instana.setup(key: "<Your Instana Key>", reportingURL: URL(string: "<Your Instana URL>")!)
    ....
    return true
}
 

手動 HTTP キャプチャー設定を以下の例に示す。 デフォルト設定を変更するには、以下のコマンドを実行する：

let options = InstanaSetupOptions(httpCaptureConfig: .manual)
Instana.setup(key: <Your Key>, reportingURL: <Your Instana URL>, options: options)
 

let key = Instana.key
let url = Instana.reportingURL
 

let sessionID = Instana.sessionID
 

URLRequest の HTTP キャプチャを開始する関数と、オプションのビュー名。 HTTPMarker オブジェクトが返される。 このオブジェクトは、 HTTP レスポンスの結果を設定するために必要である。

static func startCapture(_ request: URLRequest?, viewName: String? = nil) -> HTTPMarker
 

この関数は、 URL、 HTTP メソッド、およびオプションのビュー名について、 HTTP のキャプチャを開始する。 HTTPMarker オブジェクトが返される。 このオブジェクトは、 HTTP レスポンスの結果を設定するために後で必要になる。

static func startCapture(url: URL, method: String, viewName: String? = nil) -> HTTPMarker
 

レスポンス・サイズが決まったら、 HTTPMarker 、このメソッドを呼び出す。

func set(responseSize: Instana.Types.HTTPSize)
 

以下のイニシャライザーで HTTPMarker.Size ：

init(response: URLResponse, transactionMetrics: [URLSessionTaskTransactionMetrics]?)
 

URLResponse とオプションの Error でリクエストが完了した後、 HTTPMarker に finish をコールする。

func finish(response: URLResponse?, error: Error?)
 

あるいは、 HTTPCaptureResult 、キャプチャを終了することもできる。

let size = HTTPMarker.Size(header: 123, body: 1024, bodyAfterDecoding: 2048)
let result = HTTPCaptureResult(statusCode: statusCode, backendTracingID: "Instana-backend-tracing-id", responseSize: size, error: error)
marker.finish(result: result)
 

リクエストが完了する前にキャンセルされた場合、 HTTPMarker でこのメソッドを呼び出す。 cancel を呼び出すと、 NSURLErrorCancelled ステータスが "failed internally "に設定される。

func cancel()
 

let marker = Instana.startCapture(request, viewName: "User: Details")
URLSession.shared.dataTask(with: request) { data, response, error in
    marker.finish(response: response, error: error)
}.resume()
 

また、次の例に示すように、 URLSessionDelegate （終了またはキャンセルをコールする前）を使って、 HTTP レスポンス・サイズを手動で設定することもできる：

func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
    guard let response = task.response else { return }
    marker.set(responseSize: HTTPMarker.Size(response: response, transactionMetrics: metrics.transactionMetrics))
}
 

let url = URL(string: "https://www.example.com/user/123/details")!
let marker = Instana.startCapture(url: url, method: "GET", viewName: "Home")
YourNetworkManager(url: url, method: "GET") { (statusCode, error) in
    let size = HTTPMarker.Size(header: 123, body: 1024, bodyAfterDecoding: 2048) // optionally
    let backendTracingID = "Instana-backend-tracing-id" // optionally
    let result = HTTPCaptureResult(statusCode: statusCode, backendTracingID: backendTracingID, responseSize: size, error: error)
    marker.finish(result: result)
}.resume()
 

次の表は、コンフィギュレーション・パラメータの概要である：

override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated)
    Instana.setView(name: "User: Details")
}
 

現在のビュー名を取得するには、クラス変数 viewNameを使用できます。 ビュー名の値は、アプリケーションの状態に応じて、Inactive または Background のいずれかになります。

let viewName = Instana.viewName
 

次の表は、コンフィギュレーション・パラメータの概要である：

設定しない値には nil を渡すことができます。

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
     Instana.setup(key: InstanaKey, reportingURL: InstanaURL)
     Instana.setUser(id: someID, email: "email@example.com", name: "John")
     return true
}
 

別の方法として、ユーザー・プロパティーを個別に設定することもできます。

ユーザーIDを設定する：

static func setUser(id: String)
 

ユーザーのメールアドレスを設定します：

static func setUser(email: String)
 

ユーザー名を設定する：

static func setUser(name: String)
 

以下の表にパラメーターの概要を示す：

以下の表にパラメーターの概要を示す：

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    Instana.setup(key: InstanaKey, reportingURL: InstanaURL)
    Instana.setMeta(value: "ReactNative", key: "Platform")
    Instana.setMeta(value: "DEBUG", key: "Environment")
    return true
}
 

次の表は、コンフィギュレーション・パラメータの概要である：

let session = URLSession(configuration: .default)
Instana.ignore(session)
 

次の表は、コンフィギュレーション・パラメータの概要である：

let regex = try! NSRegularExpression(pattern: "/.*(&|\?)password=.*/i")
Instana.setIgnoreURLs(matching: [regex])
 

この例では、クエリー内にパスワードを含むURLはすべて無視される。

あるいは、次の例のように完全なURLを無視することもできる：

Instana.setIgnore(urls: [URL(string: "https://www.example.com")!])
 

次の表は、コンフィギュレーション・パラメータの概要である：

Instana.reportEvent(name: "Event-Name")
Instana.reportEvent(name: "Event-Name", viewName: "User: Details")
Instana.reportEvent(name: "Event-Name", timestamp: 1590149955086, duration: 124842, backendTracingID: "some-id", error: NSError(domain: "Some", code: -1, userInfo: nil), meta: ["Key": "Value"], viewName: "User: Details")
Instana.reportEvent(name: "Event-Name", customMetric: 1234.567)
 

Instana.collectionEnabled = true
 

次の表は、コンフィギュレーション・パラメータの概要である：

let regex = try! NSRegularExpression(pattern: #"pass(word|wort)"#)
Instana.redactHTTPQuery(matching: [regex])
 

この例では、 HTTP パラメータキー "password "または "passwort "の値は編集されている。 キャプチャされた URL https://example.com/accounts/?password=123&passwort=459 は収集され、 https://example.com/accounts/?password=<redacted>&passwort=<redacted> として表示される。

次の表は、コンフィギュレーション・パラメータの概要である：

let regex = try! NSRegularExpression(pattern: #"X-Key"#, options: [.caseInsensitive])
Instana.setCaptureHeaders(matching: [regex])
 

この例では、 X-Key または X-KEY をキーとする HTTP ヘッダーフィールドを示している。

import InstanaAgent
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    let options = InstanaSetupOptions(slowSendInterval: 60.0)
    if !Instana.setup(key: InstanaKey, reportingURL: InstanaURL, options: options) {
        // Error handling here
    }
    ....
    return true
}
 

import InstanaAgent
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    let options = InstanaSetupOptions(usiRefreshTimeIntervalInHrs: 24.0)
    if !Instana.setup(key: InstanaKey, reportingURL: InstanaURL, options: options) {
        // Error handling here
    }
    ....
    return true
}