Goエージェントの設定

Go エージェントの構成設定を編集して、New Relic がアプリを監視する方法のいくつかの側面を制御できます。例えば：

ハイセキュリティーモードをオンにする。
UIでのフィルタリングやソートのためのカスタムタグを追加。
エラー、トランザクションイベント、トランザクショントレース、およびカスタムイベントの収集をオフにします。

構成方法と優先順位

Goエージェントを構成する主な方法は、標準のインストールプロセスの一部であるnewrelic.NewApplication()の呼び出しの一部としてnewrelic.Config構造体を変更することです。Goエージェントバージョン2.7.0以降では、UIでサーバー側の構成を使用して、限られた数の構成オプションを設定することもできます。

Goエージェントは、この優先順位に従って構成されます。有効にすると、サーバー側の設定は、サーバー側の値が空白のままであっても、 newrelic.Config構造体の対応するすべての値を上書きします。

サーバー側の構成がGoエージェントで有効になっている場合、サーバー側の値が空白のままであっても、 newrelic.Config構造体の対応するすべての値が上書きされます。

各構成方法の詳細な説明は次のとおりです。

サーバーサイドの設定は、 Goエージェントのバージョン2.7.0以降で利用可能です。これにより、UIで特定の設定を行うことができます。これにより、複数のホストで動作している場合でも、変更内容がすべてのエージェントに自動的に適用されます。利用可能な場合、本ドキュメントでは、個々の設定オプションの下にあるサーバーサイドコンフィグのUIラベルを サーバーサイドラベル として記載しています。

インプロセス構成で説明されている手順に従って、アプリケーションプロセスでnewrelic.NewApplication()を呼び出す必要があります。サーバー側で設定された構成オプションは、ローカルで設定されたものを上書きします。すべての構成オプションがサーバー側で使用できるわけではないため、 newrelic.Config構造体を更新することをお勧めします。

注意

サーバー側の構成が有効になっている場合、エージェントは、UI で設定 できる newrelic.Config構造体の値を無視します。 UI 値が空の場合でも、エージェントはこれを空の値として扱い、 newrelic.Config値を使用しません。

プロセスnewrelic.Config構造体のローカルからGoエージェントを構成します。この構造体は、 newrelic.NewApplication()を呼び出すときにアクセスできます。

main関数またはinitブロックに以下を追加します。
```
app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
)
```
newrelic.ConfigLicenseに渡される文字列リテラル値としてハードコーディングするのではなく、 os.Getenvを使用して環境からライセンスキーを読み取ることに注意してください。ライセンスキーやその他の機密情報をソースコードに配置しないことをお勧めします。SCM リポジトリに保存され、権限のない第三者に公開される可能性があるためです。
newrelic.Config構造体の値を更新して、{ newrelic.ConfigOptionを使用してアプリケーションを構成します。これらは、 newrelic.Config構造体へのポインタを受け入れる関数です。newrelic.ConfigOptionを追加して、アプリケーションをさらに構成します。たとえば、事前定義されたオプションの1つを使用して、一般的な構成を行うことができます。
```
app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    // add debug level logging to stdout
    newrelic.ConfigDebugLogger(os.Stdout),
)
```

または、独自のnewrelic.ConfigOptionを作成して、より複雑な構成を行うこともできます。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    newrelic.ConfigDebugLogger(os.Stdout),
    func(config *newrelic.Config) {
        // add more specific configuration of the agent within a custom ConfigOption
        config.HighSecurity = true
        config.CrossApplicationTracer.Enabled = false
    },
)

構成設定の変更

Goエージェントの構成を変更するには、カスタムnewrelic.ConfigOption内からnewrelic.Config構造体の値を設定します。たとえば、テスト目的でNew Relicの監視を一時的にオフにするには、 Enabledの値をfalseに変更します。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.Enabled = false
    },
)

この例と次の例では、 configはNew Relicの構成構造体を表していますが、Goエージェントをインストールしてアプリで構成を開始したときに、別の変数名を付けた可能性があります。

一般的な構成設定

タイプ	弦
デフォルト	（無し）
始まる	`newrelic.Config` 構造体

アプリのメトリクスを New Relic アカウントに関連付けるために使用される New Relic ライセンスキーを指定します。ライセンスとアプリ名はどちらも、 New Relic インストールプロセスの一部として設定されます。

タイプ	弦
デフォルト	`(none)`
始まる	`newrelic.Config` 構造体

これは、New Relic UI でデータを集約するために使用されるアプリケーション名です。 New Relic のインストールプロセスの一環として、ライセンスとアプリ名の両方を設定します。

同時に複数のアプリにデータをレポートするには、名前のリストをセミコロンで区切って指定します。セミコロン自体の前にスペースを入れないでください。例えば：

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("YOUR_APP_NAME;APP_GROUP_1;ALL_APPS"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
)

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

trueの場合、エージェントはアプリから New Relic コレクタにデータを送信します。

New Relicの監視をオフにするには、これをfalseに設定します。

例えば：

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.Enabled = false
    },
)

これを簡単にするために、 ConfigEnabledオプションを利用できます。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
          newrelic.ConfigEnabled(false),
)

これは、開発環境にNew Relicをインストールしたり、トラブルシューティングを行ったりする場合に役立ちます。Enabledがfalseに設定されている場合：

New Relic Go エージェントは、New Relic コレクターと通信しません。
エージェントはゴルーチンを生成しません。
インストール時にライセンスキーは必要ありません。

タイプ	マップ[文字列]文字列
デフォルト	（無し）
始まる	`newrelic.Config` 構造体

タグを追加します。

ここでは、4つのタグを設定する例を紹介します。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.Labels = map[string]string{
            "Env":    "Dev",
            "Label2": "label2",
            "Label3": "label3",
            "Label4": "label4",
        }
    },
)

タイプ	インタフェース
デフォルト	（無し）
始まる	`newrelic.Config` 構造体

Loggerインターフェースを使用して、 Go ログファイルを特定の場所またはログシステムに書き込むことができます。

タイプ	ブール値
デフォルト	`false`
始まる	`newrelic.Config` 構造体

重要

この機能を利用するには、 Enterprise tier が必要です。

高セキュリティモードでは、特定のセキュリティ設定が強制され、その設定が上書きされるのを防ぐため、エージェントは機密データを送信しません。高セキュリティモードでは次のことが行われます。

SSLをオンにする
エラーメッセージ文字列の報告をオフにする
カスタムイベントの報告をオフにする
この設定は、UIの対応するアカウント設定と一致する必要があります。例えば、以下のようになります。
```
app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.HighSecurity = true
    },
)
```
エージェントはデフォルトで HTTPS を介して New Relic と通信し、New Relic は APM と REST API へのすべてのトラフィックに HTTPS を要求します。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

重要

このオプションは、エージェントバージョン2.0 で削除されました。

New Relic へのデータ送信に HTTPS と HTTP のどちらを使用するかを制御します。エージェントは、デフォルトでは HTTPS で New Relic と通信します (TLS プロトコルを使用します)。New Relic では、APM と New Relic REST API へのすべてのトラフィックに HTTPS を要求します。

タイプ	http.RoundTripper
デフォルト	（無し）
始まる	`newrelic.Config` 構造体

これにより、New Relic コレクターとの http.Client 通信がカスタマイズされます。これを使用してプロキシを構成できます。

New Relic CodeStream を使用して IDE からパフォーマンスを監視している場合は、リポジトリをサービスに関連付け、ビルド SHA またはリリースタグをエラーに関連付けることもできます。

環境からの構成

柔軟性を高めるために、環境変数をアプリケーションのソースコードにハードコーディングする代わりに、環境変数を設定することで、多くの構成オプションを設定できます。それらを使用するには、他の構成オプションの中でConfigFromEnvironment()への呼び出しを追加します。

app, err := newrelic.NewApplication(
   newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
   newrelic.ConfigFromEnvironment(),
)

newrelic.ConfigFromEnvironment()が表示されるオプションのリスト内のポイントで、環境変数が読み取られ、 newrelic.Config構造体の対応するエントリが更新されることに注意してください。ConfigFromEnvironmentの後に追加の構成オプションがリストされている場合、それらはConfigFromEnvironmentによって設定された値をオーバーライドする可能性があります。

たとえば、次の環境変数が設定されている場合：

NEW_RELIC_LICENSE_KEY="your_license_key_here"
NEW_RELIC_APP_NAME="Your Application Name"
NEW_RELIC_CODE_LEVEL_METRICS_ENABLED="true"
NEW_RELIC_CODE_LEVEL_METRICS_PATH_PREFIX="myproject/src"
NEW_RELIC_LABELS="Env:Dev;Label2:label2;Label3:label3;Label4:label4"

次に、次のコード：

app, err := newrelic.NewApplication(
    newrelic.ConfigFromEnvironment(),
)

ハードコードされた同等のものと同じ結果を達成します：

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense("your_license_key_here"),
    newrelic.ConfigCodeLevelMetricsEnabled(true),
    newrelic.ConfigCodeLevelMetricsPathPrefix("myproject/src"),
    func(config *newrelic.Config) {
        config.Labels = map[string]string{
            "Env":    "Dev",
            "Label2": "label2",
            "Label3": "label3",
            "Label4": "label4",
        }
    },
)

すべての可能な構成オプションが環境変数を介して設定されるわけではありません。以下のコラプスの環境変数と関数の表は、使用可能なすべての構成関数とそれに対応する環境変数を示しています。名前付き構成オプションは、 Config構造体の対応するフィールドに値を直接割り当てることで設定できますが、可能な限り構成関数や環境変数を使用することをお勧めします。

テーブルの使用方法に関するいくつかのヒントを次に示します。

環境変数が表にリストされている場合、名前付きの環境変数を設定することにより、対応するオプションを設定できます。ConfigFromEnvironment()関数も含める必要があります。これにより、エージェントはすべてのNEW_RELIC_*環境変数を受け入れるようになります。
構成関数がリストされている場合、 ConfigFromEnvironment()を使用する代わりに、その関数を使用して対応するオプションを設定できます。ConfigFromEnvironment()を含む、プログラムにリストされている構成関数は、コードに表示されている順序で解決されることに注意してください。これは、環境変数を作成して関数ConfigFromEnvironment()を呼び出すと、特定の関数を使用して以前に設定した対応する構成が上書きされることを意味します。ConfigFromEnvironment()の後の構成オプションは、以前の構成関数と環境変数をオーバーライドします。

各関数の使用方法の詳細については、こちらのドキュメントとGo ドキュメントサイトを参照してください。

構成フィールド	設定機能	環境変数
`AppName`	`ConfigAppName`	`NEW_RELIC_APP_NAME`
`ApplicationLogging.Enabled`	`ConfigAppLogForwardingEnabled` `ConfigAppLogEnabled` (以下の注 1を参照)	`NEW_RELIC_APPLICATION_LOGGING_ENABLED`
`ApplicationLogging.Forwarding.Enabled`	`ConfigAppLogForwardingEnabled` `ConfigAppLogDecoratingEnabled` `ConfigAppLogMetricsEnabled` (以下の注 1を参照)	`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED`
`ApplicationLogging.Forwarding.MaxSamplesStored`	`ConfigAppLogForwardingEnabled` `ConfigAppLogForwardingMaxSamplesStored` (以下の注 1を参照)	`NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED`
`ApplicationLogging.LocalDecorating.Enabled`	`ConfigAppLogDecoratingEnabled`	`NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED`
`ApplicationLogging.Metrics.Enabled`	`ConfigAppLogMetricsEnabled`	`NEW_RELIC_APPLICATION_LOGGING_METRICS_ENABLED`
`Attributes.Enabled`
`Attributes.Exclude`		`NEW_RELIC_ATTRIBUTES_EXCLUDE`
`Attributes.Include`		`NEW_RELIC_ATTRIBUTES_INCLUDE`
`BrowserMonitoring.Attributes.Enabled`
`BrowserMonitoring.Attributes.Exclude`
`BrowserMonitoring.Attributes.Include`
`BrowserMonitoring.Enabled`
`CodeLevelMetrics.Enabled`	`ConfigCodeLevelMetricsEnabled`	`NEW_RELIC_CODE_LEVEL_METRICS_ENABLED`
`CodeLevelMetrics.IgnoredPrefixes`	`ConfigCodeLevelMetricsIngoredPrefixes`	`NEW_RELIC_CODE_LEVEL_METRICS_IGNORED_PREFIXES`
`CodeLevelMetrics.PathPrefixes`	`ConfigCodeLevelMetricsPathPrefixes`	`NEW_RELIC_CODE_LEVEL_METRICS_PATH_PREFIXES`
`CodeLevelMetrics.RedactIgnoredPrefixes`	`ConfigCodeLevelMetricsRedactIgnoredPrefixes`	`NEW_RELIC_CODE_LEVEL_METRICS_REDACT_IGNORED_PREFIXES`
`CodeLevelMetrics.RedactPathPrefixes`	`ConfigCodeLevelMetricsRedactPathPrefixes`	`NEW_RELIC_CODE_LEVEL_METRICS_REDACT_PATH_PREFIXES`
`CodeLevelMetrics.Scope`	`ConfigCodeLevelMetricsScope`	`NEW_RELIC_CODE_LEVEL_METRICS_SCOPE`
`CrossApplicationTracer.Enabled`
`CustomInsightsEvents.Enabled`	`ConfigCustomInsightsEventsEnabled`
`CustomInsightsEvents.MaxSamplesStored`	`ConfigCustomInsightsEventsMaxSamplesStored`
`DatastoreTracer.DatabaseNameReporting.Enabled`
`DatastoreTracer.InstanceReporting.Enabled`
`DatastoreTracer.QueryParameters.Enabled`
`DatastoreTracer.SlowQuery.Enabled`
`DatastoreTracer.SlowQuery.Threshold`
`DistributedTracer.Enabled`	`ConfigDistributedTracerEnabled`	`NEW_RELIC_DISTRIBUTED_TRACING_ENABLED`
`DistributedTracer.ExcludeNewRelicHeader`
`DistributedTracer.ReservoirLimit`	`ConfigDistributedTracerReservoirLimit`
`Enabled`	`ConfigEnabled`	`NEW_RELIC_ENABLED`
`ErrorCollector.Attributes.Enabled`
`ErrorCollector.Attributes.Exclude`
`ErrorCollector.Attributes.Include`
`ErrorCollector.CaptureEvents`
`ErrorCollector.Enabled`
`ErrorCollector.IgnoreStatusCodes`
`ErrorCollector.RecordPanics`
`Error`
`Heroku.DynoNamePrefixesToShorten`
`Heroku.UseDynoNames`
`HighSecurity`		`NEW_RELIC_HIGH_SECURITY`
`HostDisplayName`		`NEW_RELIC_PROCESS_HOST_DISPLAY_NAME`
`Host`		`NEW_RELIC_HOST`
`InfiniteTracing.SpanEvents.QueueSize`		`NEW_RELIC_INFINITE_TRACING_SPAN_EVENTS_QUEUE_SIZE`
`InfiniteTracing.TraceObserver.Host`		`NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST`
`InfiniteTracing.TraceObserver.Port`		`NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_PORT`
`Labels`		`NEW_RELIC_LABELS`
`License`	`ConfigLicense`	`NEW_RELIC_LICENSE_KEY`
`Logger`	`ConfigLogger` `ConfigInfoLogger` `ConfigDebugLogger` (以下の注 2を参照)	`NEW_RELIC_LOG` `NEW_RELIC_LOG_LEVEL`
`ModuleDependencyMetrics.Enabled`	`ConfigModuleDependencyMetricsEnabled`	`NEW_RELIC_MODULE_DEPENDENCY_METRICS_ENABLED`
`ModuleDependencyMetrics.IgnoredPrefixes`	`ConfigModuleDependencyMetricsIgnoredPrefixes`	`NEW_RELIC_MODULE_DEPENDENCY_METRICS_IGNORED_PREFIXES`
`ModuleDependencyMetrics.RedaceIgnoredPrefixes`	`ConfigModuleDependencyMetricsRedactIgnoredPrefixes`	`NEW_RELIC_MODULE_DEPENDENCY_METRICS_REDACT_IGNORED_PREFIXES`
`RuntimeSampler.Enabled`
`SecurityPoliciesToken`		`NEW_RELIC_SECURITY_POLICIES_TOKEN`
`Segments.Attributes.Enabled`
`Segments.Attributes.Exclude`
`Segments.Attributes.Include`
`Segments.StackTraceThreshold`
`Segments.Threshold`
`ServerlessMode.AccountID`
`ServerlessMode.ApdexThreshold`
`ServerlessMode.Enabled`
`ServerlessMode.PrimaryAppID`
`ServerlessMode.TrustedAccountKey`
`SpanEvents.Attributes.Enabled`
`SpanEvents.Attributes.Exclude`
`SpanEvents.Attributes.Include`
`SpanEvents.Enabled`
`TransactionEvents.Attributes.Enabled`
`TransactionEvents.Attributes.Exclude`
`TransactionEvents.Attributes.Include`
`TransactionEvents.Enabled`
`TransactionEvents.MaxSamplesStored`
`TransactionTracer.Attributes.Enabled`
`TransactionTracer.Attributes.Exclude`
`TransactionTracer.Attributes.Include`
`TransactionTracer.Enabled`
`TransactionTracer.Threshold.Duration`
`TransactionTracer.Threshold.IsApdexFailing`
`Transport`
`Utilization.BillingHostname`		`NEW_RELIC_UTILIZATION_BILLING_HOSTNAME`
`Utilization.DetectAWS`
`Utilization.DetectAzure`
`Utilization.DetectDocker`
`Utilization.DetectGCP`
`Utilization.DetectKubernetes`
`Utilization.DetectPCF`
`Utilization.LocalRAMMIB`		`NEW_RELIC_UTILIZATION_TOTAL_RAM_MIB`
`Utilization.LogicalProcessors`		`NEW_RELIC_UTILIZATION_LOGICAL_PROCESSORS`

表注 1:

リストされた関数のいずれかを呼び出して下位機能を有効にすると、メイン機能も有効になり、他の構成値が設定されます。

ConfigAppLogForwardingEnabled(true) ApplicationLogging.Forwarding.Enabled=trueを設定しますが、 ApplicationLogging.Enabled=trueも設定します。
ConfigAppLogForwardingEnabled(false) ApplicationLogging.Forwarding.Enabled=falseを設定しますが、 ApplicationLogging.Forwarding.MaxSamplesStored=0も設定します。
ConfigAppLogDecoratingEnabled(true) ApplicationLogging.LocalDecorating.Enabled=trueを設定しますが、 ApplicationLogging.Enabled=trueも設定します。
ConfigAppLogDecoratingEnabled(false) ApplicationLogging.LocalDecorating.Enabled=falseを設定しますが、 ApplicationLogging.Enabledには影響しません。
ConfigAppLogMetricsEnabled(true) ApplicationLogging.Metrics.Enabled=trueを設定しますが、 ApplicationLogging.Enabled=trueも設定します。
ConfigAppLogMetricsEnabled(false) ApplicationLogging.Metrics.Enabled=falseを設定しますが、 ApplicationLogging.Enabledには影響しません。
表注 2:
NEW_RELIC_LOG環境変数を介してLoggerを設定する場合、使用されるロガーのタイプはNEW_RELIC_LOG_LEVELの値によって異なります。後者の変数が定義されていて、その値がdebug 、 Debug 、 DEBUG 、 d 、またはDの場合、標準のロガーではなくデバッグレベルのロガーが使用されます。NEW_RELIC_LOGは、値stdout 、 Stdout 、 STDOUT 、 stderr 、 Stderr 、またはSTDERRを持つことができます。

ヒント

newrelic.ConfigFromEnvironmentが読み取るには、環境変数の値が空でない必要があります。

バージョンタグを設定

NEW_RELIC_METADATA_SERVICE_VERSION を設定すると、イベントデータにタグtag.service.versionが作成されます。このコンテキストでは、サービスバージョンはデプロイされるコードのバージョンであり、多くの場合、1.2.3 などのセマンティックバージョンですが、常にそうとは限りません。この情報を送信すると、展開されたソフトウェアのバージョンによってテレメトリをファセットできるため、エラーを生成しているソフトウェアのバージョンをすばやく特定できます。

カスタムイベントの設定

カスタムイベントを作成して、問い合わせや分析に利用することができます。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

trueの場合、エージェントはカスタムイベントを New Relicに送信します。この設定は、カスタムイベントを無効にする HighSecurityによってオーバーライドされます。

カスタムイベントを無効にするには、 New Relic config が開始された後に、Go アプリに以下を配置します。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.CustomInsightsEvents.Enabled = false
    },
)

トランザクションイベントの設定

トランザクションイベントは、ウェブリクエストやバックグラウンドタスクに対応するイベントを収集する際に使用します。イベントデータは、New Relic の UI でヒストグラムやパーセンタイルなどの追加情報を表示することができます。

タイプ	構造体
デフォルト	有効、除外事項なし
始まる	`newrelic.Config` 構造体

TransactionEvents.Attributes 3つのフィールドを持つ構造体です。

Enabled bool
Include []string
Exclude []string

TransactionEvents.Attributes.Enabledを使用して、トランザクションイベントの属性収集をオンまたはオフにします。IncludeおよびExcludeを使用して、特定の属性を含めたり除外したりします。

allAgentAttributeNamesという名前の属性スライスをトランザクションイベントから除外する例：

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.TransactionEvents.Attributes.Exclude = allAgentAttributeNames
    },
)

タイプ	整数
デフォルト	`10000`
始まる	`newrelic.Config` 構造体

New Relic に送信する 1 分あたりのトランザクションイベントの最大数を定義し、デフォルトの最大数である 10,000 トランザクションイベントまで設定します。

エラーコレクターの構成

エラーコレクターの設定は以下のように行います。

ヒント

New Relic のエラー設定の概要については、 Manage errors in APM を参照してください。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体、サーバー側の構成
サーバー側のラベル	`Error Collection on/off`

falseの場合、エージェントはエラーやエラートレースを収集しません。

タイプ	ErrorGroupCallback
デフォルト	nil
始まる	`newrelic.Config` 構造体	`newrelic.ConfigSetErrorGroupCallbackFunction` 設定オプション

nil でない場合、エージェントは収集時に通知されたすべてのエラーにユーザー定義のコールバック関数を適用し、それらにエラーグループを適用します。

タイプ	整数
デフォルト	エラーコード399以下、404は無視されます。
始まる	`newrelic.Config` 構造体、サーバー側の構成
サーバー側のラベル	`Error Collection: Ignore from error collection`

どのHTTPレスポンスコードをエラーとして無視するかを設定します。

100 以上かつ 400 未満のレスポンスコードはデフォルトで無視され、この関数を呼び出す際に指定する必要はありません。レスポンスコード0、5、404は、デフォルトでリストに含まれますが、無視リストに追加する際には指定する必要があります。

この関数のデフォルトフォームは

config.ErrorCollector.IgnoreStatusCodes = []int{
    0,                   // gRPC OK
    5,                   // gRPC NOT_FOUND
    http.StatusNotFound, // 404
}

上記のhttp.StatusNotFoundのように、応答コードをHTTPとして追加することもできます。

重要

使用する場合、サーバー側の構成はnewrelic.Config構造体に設定された値を上書きします。したがって、サーバー側の構成が有効になっているときに404を無視するには、UIの構成セットに404を含める必要があります。

HTTPレスポンスコード418をデフォルトの無視リストに追加するには、0、5、404が含まれています。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.ErrorCollector.IgnoreStatusCodes = []int{0, 5, 404, 418}
    },
)

タイプ	整数
デフォルト	デフォルトでは、想定どおりにエラーコードは設定されません。
始まる	`newrelic.Config` 構造体

これは、どの HTTP 応答コードがエラーとして予期されるかを制御します。

予期される応答コードは、アプリケーションの apdex またはエラーアラートには影響しませんが、記録されます。

この関数のデフォルトフォームは

config.ErrorCollector.ExpectStatusCodes = []int{
    100,
    http.StatusAccepted,
}

上記のhttp.StatusAcceptedなどの HTTP として応答コードを追加することもできます。

HTTPレスポンスコード418をデフォルトの無視リストに追加するには、0、5、404が含まれています。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.ErrorCollector.IgnoreStatusCodes = []int{100, http.StatusAccepted}
    },
)

タイプ	構造体
デフォルト	有効、除外事項なし
始まる	`newrelic.Config` 構造体

ErrorCollector.Attributes 3つのフィールドを持つ構造体です。

Enabled bool
Include []string
Exclude []string

ErrorCollector.Attributes.Enabledを使用して、エラーの属性収集をオンまたはオフにします。IncludeおよびExcludeを使用して、特定の属性を含めたり除外したりします。

allAgentAttributeNamesという名前の属性スライスをエラーから除外する例：

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.ErrorCollector.Attributes.Exclude = allAgentAttributeNames
    },
)

トランザクショントレーサーの構成

ここでは、トランザクション・トレーサの設定を変更するための設定を紹介します。トランザクション・トレースの詳細については、トランザクション・トレースを参照してください。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体、サーバー側の構成
サーバー側のラベル	`Transaction Tracing on/off`

trueの場合、エージェントはトランザクショントレース（低速トランザクションに関する詳細情報）を収集します。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体、サーバー側の構成
サーバー側のラベル	`Transaction Tracing: Threshold`

トランザクショントレースのしきい値をApdexに基づいて設定するかどうかを制御します。

trueの場合、トレースしきい値はApdexしきい値の4倍です。
falseの場合、エージェントはThreshold.Durationをトランザクショントレースのしきい値として使用します。

タイプ	time.millisecond
デフォルト	`500`
始まる	`newrelic.Config` 構造体、サーバー側の構成
サーバー側のラベル	`Transaction Tracing: Threshold`

Threshold.IsApdexFailingがfalseに設定されている場合、エージェントはこの期間をトランザクショントレースのしきい値として使用します。

重要

Go agent version 2.6.0以降で利用可能です。

タイプ	構造体
デフォルト	有効、除外事項なし
始まる	`newrelic.Config` 構造体

TransactionTracer.Segments.Attributes 3つのフィールドを持つ構造体です。

Enabled bool
Include []string
Exclude []string

TransactionTracer.Segments.Attributes.Enabledを使用して、トランザクショントレースセグメントの属性収集をオンまたはオフにします。IncludeおよびExcludeを使用して、特定の属性を含めたり除外したりします。

allSegmentAttributeNamesという名前の属性スライスをトレースから除外する例：

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.TransactionTracer.Segments.Attributes.Exclude = allSegmentAttributeNames
    },
)

タイプ	time.millisecond
デフォルト	`500`
始まる	`newrelic.Config` 構造体、サーバー側の構成
サーバー側のラベル	`Transaction Tracing: Stack trace threshold`

これは、セグメントがトランザクション・トレースにスタック・トレースを提供する際のしきい値です。

注意

この設定を下げると、エージェントのオーバーヘッドが大幅に増加する可能性があります。

タイプ	構造体
デフォルト	有効、除外事項なし
始まる	`newrelic.Config` 構造体

TransactionTracer.Attributes 3つのフィールドを持つ構造体です。

Enabled bool
Include []string
Exclude []string

TransactionTracer.Attributes.Enabledを使用して、トランザクショントレースの属性収集をオンまたはオフにします。IncludeおよびExcludeを使用して、特定の属性を含めたり除外したりします。

allAgentAttributeNamesという名前の属性スライスをトレースから除外する例：

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.TransactionTracer.Attributes.Exclude = allAgentAttributeNames
    },
)

データストアトレーサーの設定

ここでは、スロークエリの有効化と設定を含むデータストアの設定を紹介します。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

これにより、一部のデータベースドライバのデータストアインスタンスメトリクス（ホストやポートなど）の収集が可能になります。これらは、トランザクショントレースやスロークエリデータの一部として報告されます。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

これを使用して、低速のクエリトレースとトランザクショントレースでデータベース名を収集できるようにします。有効な属性のデフォルト値はtrueです。

クロスアプリケーショントレースの設定

クロスアプリケーションのトレースの機能を変更するための設定です。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体、サーバー側の構成
サーバー側のラベル	`Cross-application tracing on/off`

trueの場合、エージェントはアウトバウンド要求にクロスアプリケーショントレースヘッダーを追加し、着信要求をスキャンしてクロスアプリケーショントレースヘッダーを探します。

分散トレースとクロスアプリケーショントレースを同時に使用することはできません。Goエージェントのデフォルト設定では、分散トレースを無効にし、クロスアプリケーショントレースを有効にしています。

分散型トレーシングの設定

重要

分散型トレースを有効にするには、Goエージェントのバージョン2.1.0以上が必要で、クロスアプリケーショントレースが無効になります。また、他の機能にも影響があります。有効にする前に、移行ガイドを読んでください。

Distributed tracing では、リクエストが分散システムを通過する際のパスを確認することができます。

ディストリビューティッド（分散）トレーシングが有効になっているときは、スパンイベントを収集することができます。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

Goエージェントバージョン3.16.0以降では、標準トレースはデフォルトでオンになっています。これは、エージェントがアウトバウンド要求に分散トレースヘッダーを自動的に追加し、受信要求をスキャンして分散トレースヘッダーを探すことを意味します。分散トレースを無効にするには、値をfalseに設定します。

分散トレースの設定の詳細については、「Goアプリケーションの分散トレースを有効にする」を参照してください。

重要

分散トレースを有効にすると、クロスアプリケーショントレースが無効になります.

タイプ	ブール値
デフォルト	`false`
始まる	`newrelic.Config` 構造体

アウトバウンドリクエストに添付されたNew Relicヘッダーを除外するには、これをtrueに設定し、ディストリビューティッド（分散）トレーシング用のトレースコンテキストヘッダーにのみ依存します。これがfalseの場合、両方のタイプのヘッダーを使用します。

スパンイベントの設定

スパンイベントは、分散型トレーシングで報告されます。スパンイベントを報告するためには、分散トレーシングを有効にする必要があります。これらの設定は、スパンイベントの収集を制御します。

重要

Go agent version 2.6.0以降で利用可能です。

タイプ	構造体
デフォルト	有効、除外事項なし
始まる	`newrelic.Config` 構造体

SpanEvents.Attributes 3つのフィールドを持つ構造体です。

Enabled bool
Include []string
Exclude []string

SpanEvents.Attributes.Enabledを使用して、スパンイベントの属性収集を有効または無効にします。IncludeおよびExcludeを使用して、特定の属性を含めたり除外したりします。

allSpanAttributeNamesという名前の属性スライスをトレースから除外する例：

app, err := newrelic.NewApplication(
    newrelic.ConfigAppName("Your Application Name"),
    newrelic.ConfigLicense(os.Getenv("NEW_RELIC_LICENSE_KEY")),
    func(config *newrelic.Config) {
        config.TransactionTracer.Segments.Attributes.Exclude = allSpanAttributeNames
    },
)

Infinite Tracingの設定

無限トレースを有効にするには、分散トレースを有効にし（ newrelic.Config構造体にconfig.DistributedTracer.Enabled = trueを設定）、以下に追加の設定を追加します。例については、「言語エージェント：分散トレースの構成」を参照してください。

タイプ	ストリング
デフォルト	（無し）
始まる	`newrelic.Config` 構造体

Infinite Tracing トレースオブザーバーのホストエントリを取得する方法については、「トレースオブザーバーのエンドポイントを検索または作成する」をご覧ください。

アプリケーションログ設定

エージェントでのアプリケーションログの構成には、次の設定を使用できます。コンテキストでの Go エージェントログの使用に関するヒントについては、コンテキストでのGo ログを参照してください。

重要

Goエージェントバージョン3.17.0以降が必要です

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

trueの場合、これらのサブ機能構成も有効になっていると、ログイベントとログメトリックの収集が有効になります。falseの場合、ロギングインストルメンテーション機能は有効になりません。

ConfigAppLogEnabled()を呼び出して ApplicationLogging を構成します。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppLogEnabled(true),
)

タイプ	ブール値
デフォルト	`false`
始まる	`newrelic.Config` 構造体

trueの場合、エージェントはアプリケーションによって発行されたログレコードをキャプチャし、それらをNewRelicに転送します。この設定を有効にするには、 ApplicationLogging.Enabledもtrueである必要があります。

ConfigAppLogForwardingEnabled()を呼び出してログ転送を有効にします。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppLogForwardingEnabled(true),
)

タイプ	整数
デフォルト	10000
始まる	`newrelic.Config` 構造体

NewRelicに1分あたりに送信するログレコードの数。この設定は、ログ転送機能を使用するときの全体的なメモリ消費を制御します。

ConfigAppLogForwardingMaxSamplesStored()を呼び出してApplicationLogging.Forwarding.MaxSamplesStoredを構成します。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppLogForwardingMaxSamplesStored(1000),
)

これをより低い値に設定して、送信されるログラインの量を減らします（ログサンプリングの原因になる場合があります）。これをより高い値に設定すると、より多くのログラインが送信されます。

各ログは、関連するトランザクションと同じ優先度を受け取ります。トランザクション外で発生したログには、ランダムな優先度が割り当てられます。MaxSamplesStoredによって制限されているため、一部のログは含まれない場合があります。たとえば、ロギングMaxSamplesStoredが 10,000 に設定され、トランザクション 1 に 10,000 のログエントリがある場合、トランザクション 1 のログエントリのみが記録されます。トランザクション 1 のログが 10,000 未満の場合、トランザクション 1 のすべてのログを受け取ります。まだスペースがある場合は、トランザクション 2 のすべてのログを受け取ります。

サンプリングされたトランザクションのすべてのログが記録され、それらがMaxSamplesStoredの制限に達していない場合、サンプリングに含まれていなかったトランザクションのログメッセージが送信されます。残っている場合は、トランザクション以外のログメッセージが記録されます。

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

trueの場合、エージェントは、アプリケーションによって送信されているログ行に関連するメトリックをキャプチャします。この設定を有効にするには、 ApplicationLogging.Enabledもtrueである必要があります。

ConfigAppLogMetricsEnabled()を呼び出して ApplicationLogging.Metrics.Enabled を構成します。

app, err := newrelic.NewApplication(
    newrelic.ConfigAppLogMetricsEnabled(true),
)

モジュールの依存関係メトリック設定

モジュールの依存関係メトリックは、Go エージェントでさまざまな方法で構成できます。モジュールの依存関係メトリックは、Go アプリケーションで使用されるインポートされたモジュールのリストを報告し、コードの依存関係の管理を容易にします。アプリのモジュールのバージョン情報も含まれます。

重要

Go エージェントバージョン 3.20.0 が必要です以上

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

trueの場合、モジュールの依存関係データの収集を有効にします。falseの場合、モジュールの依存関係情報は収集されません。

ConfigModuleDependencyMetricsEnabledを呼び出して ModuleDependencyMetrics を構成します。

app, err := newrelic.NewApplication(
    newrelic.ConfigModuleDependencyMetricsEnabled(true),
)

NewApplication } への呼び出しにConfigFromEnvironment()を挿入することで、環境変数を介して Go エージェントオプションの設定を有効にすることができます。これを行った場合は、環境変数を設定して、モジュールの依存関係メトリックの収集を有効または無効にすることができます。

NEW_RELIC_MODULE_DEPENDENCY_METRICS_ENABLED=true

タイプ	文字列
デフォルト	`nil`
始まる	`newrelic.Config` 構造体

このモジュールパスプレフィックスのリストは、エージェントによって報告される依存関係情報から一部のモジュールを除外することを指定します。リストされたプレフィックス文字列のいずれかで始まるimportパスを持つモジュールはすべて除外されます。デフォルトは空のリストで、見つかったすべてのモジュールを報告することを意味します。

ConfigModuleDependencyMetricsIgnoredPrefixesを呼び出して、除外するパスプレフィックス文字列のリストを指定します。

app, err := newrelic.NewApplication(
    newrelic.ConfigModuleDependencyMetricsIgnoredPrefixes("example.com/packageAlpha", "example.com/packageBeta"),
)

NewApplication } への呼び出しにConfigFromEnvironment()を挿入して、環境変数を介して Go エージェントオプションの設定を有効にした場合は、環境変数を設定してパスプレフィックスを一覧表示できます。

NEW_RELIC_MODULE_DEPENDENCY_METRICS_IGNORED_PREFIXES="example.com/packageAlpha,example.com/packageBeta"

タイプ	ブール値
デフォルト	`true`
始まる	`newrelic.Config` 構造体

通常、エージェント構成の一部として設定したすべてのオプションが報告され、New Relic UI に表示されます。ConfigModuleDependencyIgnoredPrefixesオプションを使用して一部のモジュールをレポートから除外することを選択した場合は、それらを構成データから編集することもできます。たとえば、機密保持のためにモジュールが除外された場合などです。

ConfigModuleDependencyMetricsRedactIgnoredPrefixesを呼び出して、除外されたパスのリダクションを有効または無効にします。trueの場合、除外されたモジュール接頭辞のリストは報告されません。falseの場合、それらは報告されます。

app, err := newrelic.NewApplication(
    newrelic.ConfigModuleDependencyMetricsRedactIgnoredPrefixes(false),
)

NEW_RELIC_MODULE_DEPENDENCY_METRICS_REDACT_IGNORED_PREFIXES=false

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

構成方法と優先順位 .css-21sua1{background:none;border:none;width:0;padding:0;}

処理中newrelic.Config構造体

構成設定の変更

一般的な構成設定

ライセンス (REQUIRED)

AppName (REQUIRED)

有効

ラベル

ロガー

HighSecurity

UseTLS (DEPRECATED)

HostDisplayName

トランスポート

RuntimeSampler.Enabled

環境からの構成

環境変数と関数の表

バージョンタグを設定

カスタムイベントの設定

CustomInsightsEvents.Enabled

トランザクションイベントの設定

TransactionEvents.Enabled

TransactionEvents.Attributes

TransactionEvents.MaxSamplesStored

エラーコレクターの構成

ヒント

ErrorCollector.Enabled

エラーコレクター.CaptureEvents

ErrorCollector.ErrorGroupCallback

ErrorCollector.IgnoreStatusCodes

ErrorCollector.ExpectStatusCodes

エラーコレクタの属性

トランザクショントレーサーの構成

TransactionTracer.Enabled

TransactionTracer.Threshold.IsApdexFailing

TransactionTracer.Threshold.Duration

TransactionTracer.Segments.Threshold

TransactionTracer.Segments.Attributes

TransactionTracer.Segments.StackTraceThreshold

TransactionTracer.Attributes

データストアトレーサーの設定

DatastoreTracer.InstanceReporting.Enabled

DatastoreTracer.NameReporting.Enabled

DatastoreTracer.QueryParameters.Enabled

DatastoreTracer.SlowQuery.Enabled

DatastoreTracer.SlowQuery.Threshold

クロスアプリケーショントレースの設定

CrossApplicationTracer.Enabled

分散型トレーシングの設定

重要

DistributedTracer.Enabled

DistributedTracer.ExcludeNewRelicHeader

スパンイベントの設定

SpanEvents.Enabled

SpanEvents.Attributes

Infinite Tracingの設定

InfiniteTracing.TraceObserver.Host

アプリケーションログ設定

重要

ApplicationLogging.Enabled

ApplicationLogging.Forwarding.Enabled

ApplicationLogging.Forwarding.MaxSamplesStored

ApplicationLogging.Metrics.Enabled

モジュールの依存関係メトリック設定

重要

ModuleDependencyMetrics.Enabled

ModuleDependencyMetrics.IgnoredPrefixes

ModuleDependencyMetrics.RedactIgnoredPrefixes

構成方法と優先順位

処理中`newrelic.Config`構造体