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コールは、現在のトランザクションデータをすべて破棄し、指定されたアプリ名で再接続した後、新しいトランザクションを開始します。

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

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

アプリの監視を開始したらできるだけ早く、コールスタックをできるだけ浅くして、この関数を呼び出すことを強くお勧めします。アプリケーションは APM の個別のエンティティであり、アプリの名前を変更すると、2 つのアプリ名のデータを結びつけるものは何もありません。newrelic_set_appname関数を使用すると、トランザクション追跡が不連続になる可能性があります。つまり、新しいトランザクションは新しいアプリ名に報告され、古いアプリ名に接続されたデータにそれらを結び付けるものは何もありません。

このメソッドは、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`と同じ形式を使用し、それぞれをセミコロン`;`で区切って複数のアプリケーション名を設定できます。
`$license` ストリング	必須 (空の文字列にすることができます)。メトリクスを別の New Relic アカウントにレポートするには、別のライセンスキーを指定します。空の文字列に設定すると、エージェントの`newrelic.ini`ファイルのライセンスキーがデフォルトになります。
`$xmit` ブール値	オプション。デフォルトは`false`件です。 `false`または省略された場合、エージェントは現在のトランザクションを破棄し、この呼び出しまでにキャプチャされたすべてのデータが失われます。 `true`の場合、エージェントはこの呼び出しを実行する直前に収集されたデータを送信します。 The data is associated with the old app name . エージェントがデータをダンプするのに数ミリ秒かかるため、パフォーマンスにわずかな影響があります。

戻り値

アプリケーション名が正常に変更された場合は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);
    }
    ...
}

この機械翻訳は、参考として提供されています。