newrelic_set_appname (PHPエージェントAPI)

構文

newrelic_set_appname(string $name)
newrelic_set_appname(string $name, string $license[, bool $xmit])

データロールアップを制御するNew Relicアプリ名を設定します。

要件

エージェントのバージョン 3.1.5.111 以上。

説明

New Relic アプリケーション名を設定し、New Relic UI がデータを正しいアプリケーションに接続するために使用します。

New Relic のアプリケーション名を設定する方法としては、グローバルまたはディレクトリごとの INI 設定を使用して、実行開始時にアプリケーションを希望の名前に関連付けることが推奨され、好ましい方法です。

エージェントの設定ファイルを編集できない場合（例えば、多くの共有ホスティング環境では、設定ファイルを編集することができません）、 newrelic_set_appname APIコールを使用して、アプリ名、ライセンスキー（複数のアカウントを使用している場合のオプション）、およびtrue/falseフラグ（オプション、以前に記録されたデータを保持するか破棄するかを決定するため）を設定することができます。APM トレースの継続性を最大限に確保するには、できるだけ早い段階でこの API を呼び出す必要があります。このAPIコールは、現在のすべてのトランザクションデータを破棄し、指定されたアプリ名と再接続した後に新しいトランザクションを開始します。

その他のアプリケーション名の付け方については、 Name your PHP application を参照してください。可能な限り、INI ベースのソリューションを推奨します。

通話とロケーションの動作

New Relic では、この関数をできるだけ早く、できるだけ浅いコールスタックで呼び出すことを強く推奨します。APM ではアプリケーションは個別のエンティティであり、トランザクショントレースの不連続性はこのメソッドの使用に固有のものです。新しいアプリ名で接続した後、新しいトランザクションは、前のアプリケーションやそれに報告されたデータのコンテキストなしに、新しいアプリケーションへの報告を開始します。

このメソッドは、1回だけ呼び出すことを想定しています。なぜなら、（同じアプリ名であっても）APIを呼び出すたびに、現在のトランザクションデータが破棄され、トランザクションのトレースがさらに不連続になるからです。

パラメータ

パラメーター	説明
`function newrelic_set_appname (string $name) : bool`
`$name` 文字列	必須項目です。New Relic のユーザーインターフェイスでメトリクスを報告するアプリの名前。 `newrelic.appname` と同じフォーマットを使用し、セミコロンで区切ることで複数のアプリケーション名を設定できます `;`.
`function newrelic_set_appname (string $name, string $license, bool $xmit) : bool`
`$name` 文字列	必須項目です。New Relic のユーザーインターフェースでメトリクスを報告するアプリの名前。 `newrelic.appname` と同じフォーマットを使用し、セミコロンで区切ることで複数のアプリケーション名を設定できます `;`.
`ライセンス` 文字列	必須（空の文字列でも可）。メトリクスを別の New Relic アカウントに報告するために、別のライセンスキーを指定します。空の文字列に設定すると、エージェントの `newrelic.ini` ファイルのライセンスキーがデフォルトとなります。
`xmit` boolean	オプションです。デフォルトは `false` 。 `false` または省略した場合、エージェントは現在のトランザクションを破棄し、この通話までに取得したすべてのデータは失われます。 `true` の場合、エージェントはこのコールを実行する直前に収集したデータを送信します。データは古いアプリ名に関連付けられています。これは、エージェントがデータをダンプするのに数ミリ秒かかるため、パフォーマンスへの影響はごくわずかです。

戻り値

アプリケーション名の変更に成功した場合は true を、そうでない場合は false を返します。

例

単一のアプリ名の設定

function example() {
    if (extension_loaded('newrelic')) { // Ensure PHP agent is available
        newrelic_set_appname("App1");
    }
    ...
}

2つのアプリ名を設定

この例では、複数のアプリ名を設定しています。

function example() {
    if (extension_loaded('newrelic')) { // Ensure PHP agent is available
        newrelic_set_appname("App1;App2");
    }
    ...
}

アプリ名とライセンスキーの設定

function example() {
    if (extension_loaded('newrelic')) { // Ensure PHP agent is available
        newrelic_set_appname("App1", "01234567890abcde01234567890abcde01234567890");
    }
    ...
}

アプリ名の設定と過去のデータの保持

この例では、アプリ名を設定し、既存のデータを保持しますが、ライセンスキーは変更しません。

function example() {
    if (extension_loaded('newrelic')) { // Ensure PHP agent is available
        newrelic_set_appname("App1", "", true);
    }
    ...
}

アプリ名やライセンスキーの設定、以前のデータの保持

この例では、アプリ名とライセンスキーを設定し、既存のデータを保持しています。

function example() {
    if (extension_loaded('newrelic')) { // Ensure PHP agent is available
        newrelic_set_appname("App1", "01234567890abcde01234567890abcde01234567890", true);
    }
    ...
}

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。