:OpenTelemetry SDK for iOSを使用してiOSアプリからSimple Log Serviceにトレースデータをインポートする

Swiftプロジェクト

1. opentelemetry-swiftパッケージをインポートします。

   1. Xcodeで、ファイル > パッケージの追加を選択します。

   2. 右上隅の検索ボックスに次のリンクを入力します。

      https://github.com/open-telemetry/opentelemetry-swift

   3. [依存関係ルール] に [完全バージョン] を選択し、バージョン番号として1.4.0を入力します。

      詳細については、「OpenTelemetry iOS SDKリリース」をご参照ください。

2. opentelemetry-swiftパッケージの製品を選択します。

   次の製品を選択することをお勧めします。

   • OpenTelemetryApi

   • OpenTelemetryProtocolExporter

   • OpenTelemetrySdk

   • URLSessionInstrumentation

   • StdoutExporter

   • ResourceExtension

   opentelemetry-swiftパッケージで使用できる製品の詳細については、「付録: OpenTelemetry製品の説明」をご参照ください。

Objective-Cプロジェクト

opentelemetry-swiftパッケージは、Objective-Cプログラミング言語との互換性が低いです。 そのため、Simple Log Serviceはopentelemetry-swiftパッケージに基づいてObjective-Cクラスを拡張します。 Objective-CプロジェクトでSwiftプロジェクトに必要な設定を構成する必要があります。 また、opentelemetry-objc-extensionパッケージをObjective-Cプロジェクトに追加する必要があります。

1. Swiftプロジェクトに必要な設定を構成します。

2. opentelemetry-objc-extensionパッケージをインポートします。

   1. Xcodeで、ファイル > パッケージの追加を選択します。

   2. 右上隅の検索ボックスに次のリンクを入力します。

      https://github.com/aliyun-sls/opentelemetry-objc-extension

   3. [依存関係ルール] に [完全バージョン] を選択し、バージョン番号として1.0.0を入力します。

      詳細については、「OpenTelemetry iOS Objc拡張SDKリリース」をご参照ください。

3. opentelemetry-objc-extensionパッケージの製品を選択します。

   次の製品を選択することをお勧めします。

   • OpenTelemetryApiObjc

   • OpenTelemetryProtocolExporterObjc

   • OpenTelemetrySdkObjc

   • ResourceExtensionObjc

   • URLSessionInstrumentationObjc

   • StdoutExporterObjc

opentelemetry-objc-extensionパッケージで使用できる製品の詳細については、「付録: OpenTelemetry製品の説明」をご参照ください。

Swiftプロジェクト

// Import the following modules: 
import GRPC
import NIO
import OpenTelemetryApi
import OpenTelemetrySdk
import OpenTelemetryProtocolExporter
import StdoutExporter
import URLSessionInstrumentation

// Initialize the exporter. The exporter is used to export trace data to a Log Service Logstore. 
let client = ClientConnection.usingPlatformAppropriateTLS(for: MultiThreadedEventLoopGroup(numberOfThreads: 1))
.connect(host: "${endpoint}", port: ${port})	
let otlpTraceExporter = OtlpTraceExporter(
 channel: client,
 config: OtlpConfiguration(
 timeout: OtlpConfiguration.DefaultTimeoutInterval,
 headers:
 [
 ("x-sls-otel-project", "${project}"),
 ("x-sls-otel-instance-id", "${instanceId}"),
 ("x-sls-otel-ak-id", "${access-key-id}"),
 ("x-sls-otel-ak-secret", "${access-key-secret}")
 ]
 )
)

// Initialize the tracer provider. The tracer provider is used to expose major API operations, preprocess spans, and configure custom clocks. 
// Configure the custom rules that are used to generate trace IDs and span IDs and configure custom samplers. You can configure the settings based on your business requirements. 
let spanExporters = MultiSpanExporter(spanExporters: [StdoutExporter(isDebug: true), otlpTraceExporter])
let spanProcessor = SimpleSpanProcessor(spanExporter: spanExporters)
OpenTelemetry.registerTracerProvider(
 tracerProvider: TracerProviderBuilder()
 .add(spanProcessor: spanProcessor)
 .with(resource: 
 Resource(attributes:
 [
 ResourceAttributes.serviceName.rawValue: AttributeValue.string("${service}"),
 ResourceAttributes.serviceNamespace.rawValue: AttributeValue.string("${service.namespace}"),
 ResourceAttributes.serviceVersion.rawValue: AttributeValue.string("${version}"),
 ResourceAttributes.hostName.rawValue: AttributeValue.string("${host}"),
 ResourceAttributes.deploymentEnvironment.rawValue: AttributeValue.string("${environment}"),
 ]
 )
 )
 .build()
)

// Configure other instrumentation collectors based on your business requirements. The following configuration is used to collect data from the NSUrlSession network library. 
URLSessionInstrumentation(configuration: URLSessionInstrumentationConfiguration(
 shouldInstrument: { request in
 return true
 })
)
let tracer = OpenTelemetry.instance.tracerProvider.get(instrumentationName: "OTel Application", instrumentationVersion: "1.0.0")

Objective-Cプロジェクト

// Import the following modules:
@import OpenTelemetryApiObjc;
@import OpenTelemetrySdkObjc;
@import OpenTelemetryProtocolExporterObjc;
@import URLSessionInstrumentationObjc;
@import StdoutExporterObjc;

// Initialize the exporter. The exporter is used to export trace data to a Log Service Logstore. 
NSDictionary *headers = @{
 @"x-sls-otel-project": @"${project}",
 @"x-sls-otel-instance-id": @"${instanceId}",
 @"x-sls-otel-ak-id": @"${access-key-id}",
 @"x-sls-otel-ak-secret": @"${access-key-secret}"
};
OtlpConfigurationObjc *configuration = [OtlpConfigurationObjc configuration:OtlpConfigurationObjc.DefaultTimeoutInterval headers:headers];
OtlpTraceExporterObjc *exporter = [OtlpTraceExporterObjc exporter:@"https://${endpoint}"
 port:@"${port}"
 configuration:configuration
];

// Initialize the tracer provider. The tracer provider is used to expose major API operations, preprocess spans, and configure custom clocks. 
// Configure the custom rules that are used to generate trace IDs and span IDs, and configure custom samplers. You can configure the settings based on your business requirements. 
NSArray *exporters = @[
 [StdoutExporterObjc stdoutExporter:true], // During development and debugging, we recommend that you enable stdoutExporter to display span content in the console. 
 exporter
];
SpanProcessorObjc *spanProcessor = [BatchSpanProcessorObjc processor: [MultiSpanExporterObjc multiSpanExporter:exporters]];

TracerProviderBuilderObjc *providerBuilder = [TracerProviderBuilderObjc builder];
NSDictionary *resources = @{
 ResourceAttributesObjc.serviceName: [AttributeValueObjc string:@"${service}"], // The name of the service that you want to trace. We recommend that you use the name of a module, such as homepage and member center. 
 ResourceAttributesObjc.serviceNamespace: [AttributeValueObjc string:@"${service.namespace}"], // We recommend that you set the namespace of the service to iOS, iPadOS, macOS, tvOS, or watchOS. 
 ResourceAttributesObjc.serviceVersion: [AttributeValueObjc string:@"${version}"], // We recommend that you set the version of the service to the version of the app. 
 ResourceAttributesObjc.hostName: [AttributeValueObjc string:@"${host}"], // We recommend that you set the hostname to iOS. 
 ResourceAttributesObjc.deploymentEnvironment: [AttributeValueObjc string:@"${environment}"] // The deployment environment. We recommend that you use dev for a development environment and prod for a production environment. 
};
providerBuilder = [providerBuilder withResource: [ResourceObjc resource:resources]];
providerBuilder = [providerBuilder addSpanProcessor: spanProcessor];

// Initialize OpenTelemetry SDK. 
[OpenTelemetryObjc registerTracerProvider:[providerBuilder build]];

// Configure other instrumentation collectors based on your business requirements. The following configuration is used to collect data from the NSUrlSession network library. 
[URLSessionInstrumentationObjc urlSessionInstrumentation:
 [URLSessionInstrumentationConfigurationObjc urlSessionInstrumentationConfiguration:[TestURLSessionInstrumentation instrumentation]]
];

Swiftプロジェクトのサンプルコード

let tracer: Tracer = OpenTelemetry.instance.tracerProvider.get(instrumentationName: "OTel Application", instrumentationVersion: "1.0.0")

Objective-Cプロジェクトのサンプルコード

TracerObjc *tracer = [OpenTelemetryObjc.instance.tracerProvider getWithInstrumentationName:@"app" instrumentationVersion:@"1.0"];

Swiftプロジェクトのサンプルコード

let spanBuilder = tracer.spanBuilder(spanName: "operation name")
let span = spanBuilder .setSpanKind(spanKind: .client).startSpan()
// do stuff
// ...
span.end()

Objective-Cプロジェクトのサンプルコード

SpanBuilderObjc *spanBuilder = [_tracer spanBuilder:@"operation name"];
SpanObjc *span = [[spanBuilder setSpanKind:SpanKindObjc.CLIENT] startSpan];
// do stuff
// ...
[span end];

Swiftプロジェクトのサンプルコード

func methodA() {
 let span = tracer.spanBuilder(spanName: "operation methodA").setSpanKind(spanKind: .client).startSpan()
	method(span)
 span.end()
}

func methodB(_ parent: Span) {
 let spanBuilder = tracer.spanBuilder(spanName: "operation methodB")
 spanBuilder.setParent(parent)
 let child = spanBuilder .setSpanKind(spanKind: .client).startSpan()
 // do stuff
 // ...
 child.end()
}

Objective-Cプロジェクトのサンプルコード

- (void) methodA {
 SpanObjc *span = [[[_tracer spanBuilder:@"operation methodA"] setSpanKind:SpanKindObjc.CLIENT] startSpan];
 [self methodB: span];
 [span end];
}

- (void) methodB: (SpanObjc *)parent {
 SpanBuilderObjc *spanBuilder = [_tracer spanBuilder:@"operation name"];
 [spanBuilder setParent: parent];
 SpanObjc *span = [[spanBuilder setSpanKind:SpanKindObjc.CLIENT] startSpan];
 // do stuff
 // ...
 [span end];
}

Swiftプロジェクトのサンプルコード

func methodA() {
 let span = tracer.spanBuilder(spanName: "operation methodA").setSpanKind(spanKind: .client).startSpan()
 OpenTelemetry.instance.contextProvider.setActiveSpan(span)
 
 methodB(span)
 
 span.end()
}

func methodB(_ parent: Span) {
 let child = tracer.spanBuilder(spanName: "operation methodB").setSpanKind(spanKind: .client).startSpan()
 // do stuff
 // ...
 child.end()
}

Objective-Cプロジェクトのサンプルコード

- (void) methodA {
 SpanObjc *span = [[[_tracer spanBuilder:@"operation methodA"] setSpanKind:SpanKindObjc.CLIENT] startSpan];
 [OpenTelemetryObjc.instance.contextProvider setActiveSpan:span];
 [self methodB];
 // do stuff
 // ...
 [span end];
}

- (void) methodB {
 SpanBuilderObjc *spanBuilder = [_tracer spanBuilder:@"operation name"];
 SpanObjc *span = [[spanBuilder setSpanKind:SpanKindObjc.CLIENT] startSpan];
 // do stuff
 // ...
 [span end];
}

Swiftプロジェクトのサンプルコード

let spanBuilder = tracer.spanBuilder(spanName: "GET /resource/catalog")
let span = spanBuilder .setSpanKind(spanKind: .client).startSpan()
span.setAttribute(key: "http.method", value: "GET")
span.setAttribute(key: "http.url", value: "http url")

Objective-Cプロジェクトのサンプルコード

SpanBuilderObjc *spanBuilder = [_tracer spanBuilder:@"GET /resource/catalog"];
SpanObjc *span = [[spanBuilder setSpanKind:SpanKindObjc.CLIENT] startSpan];
[span setAttribute:@"http.method" stringValue:@"GET"];
[span setAttribute:@"http.url" stringValue:request.URL.baseURL];

Swiftプロジェクトのサンプルコード

span.addEvent(name: "start")
// do stuff
// ...
span.addEvent(name: "start")

// Use attributes to annotate an event. 
span.addEvent(name: "event with attributes",
 attributes: [ "key1": AttributeValue.string("value1"),
 "key2": AttributeValue.double(2.2)
 ]
)

Objective-Cプロジェクトのサンプルコード

[chilsSpan addEvent:@"start"];
// do stuff
// ...
[chilsSpan addEvent:@"end"];

// Use attributes to annotate an event. 
[chilsSpan addEvent:@"event with attributes" attributes:@{
 @"key1": [AttributeValueObjc string:@"value1"],
 @"key2": [AttributeValueObjc double:1.1],
}];

Swiftプロジェクトのサンプルコード

spanBuilder.addLink(spanContext: parent.context)
let span = spanBuilder .setSpanKind(spanKind: .client).startSpan()

Objective-Cプロジェクトのサンプルコード

SpanBuilderObjc *spanBuilder = [_tracer spanBuilder:@"Another"];
[spanBuilder addLink:parent.context];

SpanObjc *span = [[spanBuilder setSpanKind:SpanKindObjc.CLIENT] startSpan];

Swiftプロジェクトのサンプルコード

let span = tracer.spanBuilder(spanName: "operation name").startSpan()
do {
 try expression
 // do stuff
 // ...
} catch {
 span.status = .error(description: "\(error)")
}

Objective-Cプロジェクトのサンプルコード

SpanObjc *span = [[_tracer spanBuilder:@"operation name"] startSpan];
@try {
 // do stuff
 // ...
} @catch (NSException *exception) {
 [span setStatus:[StatusObjc error: exception.description]];
} @finally {
 [span end];
}

Swiftプロジェクトのサンプルコード

// Initialize URLSessionInstrumentation during SDK initialization. 
// Pass parameters based on your business requirements. 
URLSessionInstrumentation(
 configuration: URLSessionInstrumentationConfiguration(
 shouldInstrument: { request in
 // Specify whether to collect data from the request. 
 return true
 }
 )
)

Objective-Cプロジェクトのサンプルコード

// Initialize URLSessionInstrumentationObjc during SDK initialization. 
// When you initialize URLSessionInstrumentationObjc, you must pass a class that implements URLSessionInstrumentationConfigurationImpl. The following code provides an example of a class.
[URLSessionInstrumentationObjc urlSessionInstrumentation:
 [URLSessionInstrumentationConfigurationObjc urlSessionInstrumentationConfiguration:[TestURLSessionInstrumentation instrumentation]]
];

// An example of a class that implements TestURLSessionInstrumentation. 
#pragma mark - URLSessionInstrumentation
@interface TestURLSessionInstrumentation: NSObject<URLSessionInstrumentationConfigurationImpl>
+ (instancetype) instrumentation;
@end

@implementation TestURLSessionInstrumentation
+ (instancetype) instrumentation {
 return [[TestURLSessionInstrumentation alloc] init];
}
- (void)createdRequest:(NSURLRequest * _Nonnull)request span:(SpanObjc * _Nonnull)span {
 // Initiate a callback if the request is created. 
 [span setAttribute:@"createdRequest" stringValue:@"request created"];
}
- (void)injectCustomHeaders:(NSURLRequest * _Nonnull)request span:(SpanObjc * _Nullable)span {
 // Inject custom headers of the request. 
 [(NSMutableURLRequest *)request addValue:@"custom header" forHTTPHeaderField:@"injectCustomHeaders"];
}
- (NSString * _Nullable)nameSpan:(NSURLRequest * _Nonnull)request {
 // Rename the span. 
 if ([request.URL.host containsString:@"dns.alidns.com"]) {
 return @"Initiate a request for DNS resolution";
 }
 return nil;
}
- (void)receivedError:(NSError * _Nonnull)error dataOrFile:(NSObject * _Nullable)dataOrFile span:(SpanObjc * _Nonnull)span {
 // Initiate a callback if the operation fails. 
}
- (void)receivedResponse:(NSURLResponse * _Nonnull)response dataOrFile:(NSObject * _Nullable)dataOrFile span:(SpanObjc * _Nonnull)span {
 // Initiate a callback if the operation is successful. 
 NSLog(@"receivedResponse: %@", dataOrFile);
}
- (BOOL)shouldInjectTracingHeaders:(NSURLRequest * _Nonnull)request {
 // Inject tracing headers. 
 return YES;
}
- (BOOL)shouldInstrument:(NSURLRequest * _Nonnull)request {
 // Specify whether to collect data from the request. 
 return YES;
}
- (BOOL)shouldRecordPayload:(NSURLSession * _Nonnull)session {
 // Specify whether to collect information about the request body. 
 return YES;
}
- (void)spanCustomization:(NSURLRequest * _Nonnull)request spanBuilder:(SpanBuilderObjc * _Nonnull)spanBuilder {
 // Specify additional information for the span. 
 [spanBuilder setAttribute:@"spanCustomization" stringValue:@"customize span"];
}
@end