PHP SDK

PHP SDKのスタブは、次のコマンドを使用してComposer経由でインストールできます：

composer require instana/instana-php-sdk

これらのスタブは、 PHP プロセスが Instana によって監視されていない場合、SDK APIへのすべての呼び出しがエラーではなく、 no-op正常に処理されるようにします。

お使いのIDEで利用するための PHP SDKのスタブは、Packagist で入手可能です。

$tracer = new \Instana\Tracer();

// sets the globaly service name without having to use the INSTANA_SERVICE_NAME variable
$tracer->setServiceName('my-service');
$span = $tracer->createSpan('foo');
$span->annotate('function', 'doSomething');
try {
    doSomething();
} catch (\Exception $e) {
    $tracer->logException($e);
    $span->markError();
} finally {
    $span->stop();
}

PHP のトレース拡張機能を使用すると、ENTRY型またはEXIT型のカスタムスパンを作成できます。

// get the tracer
$tracer = new \Instana\Tracer();

$entry_span = $tracer->createSpan('entry', \Instana\SPAN_ENTRY);

$exit_span = $tracer->createSpan('exit', \Instana\SPAN_EXIT);

// get the tracer
$tracer = new \Instana\Tracer();
$entry_span = $tracer->createSpan('entry', \Instana\SPAN_ENTRY);
$entry_span->annotate('service', 'my service')

PHP SDKを使用して新しいスパンを作成する際、親スパンのIDを設定することができます。これは、他のシステムによって作成された継続トレースにおいて役立つ場合があります。 以下の例は、関連するコード・スニペットがどのように表示されるかを示しています。

// get the tracer
$tracer = new \Instana\Tracer();

$span = $tracer->createSpan('entry', \Instana\SPAN_INTERMEDIATE, $parentId);

PHP のトレース拡張機能を使用すると、メッセージングシステムを介してトレースの継続を設定できます。 これを行うには、パブリッシャーのトレース・コンテキストをメッセージに挿入し、コンシューマー・サイドで抽出する必要があります。

// get the tracer
$tracer = new \Instana\Tracer();

// GENERIC: an artificial message you want to send to your queue
$message = ['task' => 'convert-image'];

// retrieve the current trace context
$context = $tracer->getActiveContext();

// GENERIC: inject the current active context into your message, so you can retrieve it in the worker later
$attributes = $message['X-INSTANA-S'] = $context->getSpanId();
$attributes = $message['X-INSTANA-T'] = $context->getTraceId();

// send your message to the queue
$queue->publish($message);

// get the tracer
$tracer = new \Instana\Tracer();

// GENERIC: pull your message from the queue
$message = $queue->pull();

// GENERIC: extract trace context so we can continue the trace, assumes it's always present
$messageContext = new \Instana\TraceContext($message['X-INSTANA-T'], $message['X-INSTANA-S']);

// continue the trace that published the message
$tracer->continueTrace($messageContext);

// OPTIONAL: Create a span to wrap the unit of work
$span = $tracer->createSpan('work');
$span->annotate('job', 'my-important-job');

// do the actual work

// stop the optional span started above
$span->stop();

PHP のトレース拡張機能は、 Google Cloud Pub/Sub とのアウトバウンドのやり取りに対して、自動的にEXITスパンを作成します。

トレースを継続するには、パブリッシュ/サブスクライブ・メッセージをコンシュームするコードを手動でラップする必要があります。

use Google\Cloud\PubSub\PubSubClient;

$tracer = new \Instana\Tracer();

$pubSub = new PubSubClient([
    'projectId' => $myProjectname
]);

$topic = $pubSub->topic($myTopicName);
$subscription = $pubSub->subscription($mySubscriptionName, $myTopicName);

$messages = $subscription->pull();
foreach ($messages as $message) {
    $attributes = $message->attributes();

    // extract the trace continouation headers from your message, assumes it's always present
    $messageContext = new \Instana\TraceContext($attributes['x-instana-t'], $attributes['x-instana-s']);

    // continue the trace that published the message
    $tracer->continueTrace($messageContext);

    // convert the current span
    $span = $tracer->getEntrySpan();
    $span->asGCPubSubReceive($project, 'php-consumer');

    // OPTIONAL: Create a span to wrap the unit of work
    $span = $tracer->createSpan('work');
    $span->annotate('job', 'my-important-job');

    // do the actual work

    // stop the optional span started above
    $span->stop();

    $subscription->acknowledge($message);
}

PHP のSDKを使用してスパンを作成する際は、 PHPINSTANA_SERVICE_NAME -SDKの関数を手動で呼び出すことで設定を行うことができます。 この値は、 $__ENV 配列および $_SERVER 配列に設定された INSTANA_SERVICE_NAME 値よりも優先されます。 以下の例は、関連するコード・スニペットがどのように表示されるかを示しています。

//get the tracer
$tracer = new \Instana\Tracer();

Instana\Tracer::setServiceName(“MY_SERVICE_NAME”);

PHP のトレース拡張機能を削除する際は、手動で追加したSDKコードもすべて削除する必要があります。そうしないと、関数が不足しているために PHP がスクリプトの実行に失敗します。