Go エージェントのコードレベルのメトリクス構成

コードレベルのメトリクスにより、 New Relic CodeStream 拡張機能を使用する開発者は、コード内の個々のメソッドと一緒に、IDE でコンテキストに応じて表示されるデータ。これにより、開発者は、コードを記述およびレビューする際にパフォーマンスの問題に積極的に対処できます。

コードレベルのメトリクスを有効にすると、Go エージェントは属性をトレースデータに添付します。これらの属性は、これらのトレースによってインストルメント化されたアクションを担当するアプリケーションソースコード内の場所を示します。表示できるデータは次のとおりです。

ソースファイル名
ソースファイルの行番号
関数名
名前空間

コードレベルのメトリクスの収集を制御するために、Go エージェントの構成設定を確認してください。構成を完了した後、データを見つけるのにサポートが必要な場合は、メトリックを表示するを参照してください。メトリクスの収集方法をさらに制御したい場合は、 Go エージェントのコードレベルのメトリクスインストルメンテーションを参照してください。

重要

この機能は、Go エージェントバージョン 3.18.0 以降のトランザクションで利用できます。デフォルトではオフになっています。有効にするには、以下で説明するように、アプリケーションの構成にnewrelic.ConfigCodeLevelMetricsEnabled(true)を追加する必要があります。

設定方法

アプリケーションで Go エージェントを構成するためにnewrelic.NewApplicationを呼び出す場合、次のようにnewrelic.ConfigCodeLevelMetricsEnabledオプションを含めることでコードレベルの指標を有効にできます。

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

この簡単な手順で、Go エージェントはトランザクションの次のエージェント属性にソースコードコンテキスト情報を追加します。

名前	説明
`code.function`	トランザクションを開始した関数の名前。これは、Go コンパイラによって自動的に生成される場合があることに注意してください。
`code.namespace`	関数が配置されているパッケージ/名前空間。ドット ( `.` ) などの区切り文字で結合された`code.namespace`と`code.function`の組み合わせは、関数を一意に識別することが期待されます。
`code.filepath`	報告される関数を含むソースファイルのパス名。通常、これは完全な絶対パス名です。これを相対パスに変更できる構成オプションについては、以下を参照してください。
`code.lineno`	トランザクションが開始された`code.filepath`内の行番号。これを制御する方法については、インストルメンテーションガイドを参照してください。

アプリケーションのコードレベルのメトリックのコレクションをさらに絞り込むために使用できる追加の構成オプションがあります。

デフォルトでは、コードレベルのメトリクスが有効になっている場合、エージェントはコールスタック内でエージェント自体の内部にあると思われる関数を無視し、報告された関数が意図したものであることを確認します。コードレベルのメトリクスインストルメンテーションコードに入るために呼び出されます。デフォルトでは、パッケージ名がgithub.com/newrelic/go-agent/で始まる関数は無視されます。独自のIgnoredPrefixes値を設定することで、これを任意の名前のリストに変更できます。

これを行うには、次のいずれかを実行します。

NewApplication関数を使用して構成する場合は、 ConfigCodeLevelMetricsIgnoredPrefixesオプションを追加して、任意の数のプレフィックス文字列を個別の文字列引数として渡します。

app, err := newrelic.NewApplication(
   newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
   newrelic.ConfigCodeLevelMetricsEnabled(true),
   newrelic.ConfigCodeLevelMetricsIgnoredPrefixes("github.com/some/other/name/"),
)

環境変数を使用して構成する場合は、 NEW_RELIC_CODE_LEVEL_METRICS_IGNORED_PREFIXESを目的のプレフィックス (またはコンマ区切りのプレフィックスのリスト) に設定します。
```
NEW_RELIC_CODE_LEVEL_METRICS_IGNORED_PREFIXES="github.com/some/other/name/"
```
アプリケーションを設定するときは、忘れずにnewrelic.ConfigFromEnvironment()オプションも含めてください。
```
app, err := newrelic.NewApplication(
   newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
   newrelic.ConfigCodeLevelMetricsEnabled(true),
   newrelic.ConfigFromEnvironment(),
)
```
Config構造体のCodeLevelMetrics.IgnoredPrefixesメンバー ( []string値) を直接設定することもできますが、 Config構造体を直接操作する代わりに、上記の方法のいずれかを使用することをお勧めします。
重要
3.20.0 より前のバージョンの Go エージェントでは、このオプションは、複数形ではなく単数形 (つまり、 ConfigCodeLevelMetricsIgnoredPrefix ) で名前が付けられました。これらの名前は非推奨であり、ここに記載されているものを使用する必要があります。古い名前も下位互換性のために引き続きサポートされています。

機密保持などの理由で、 ConfigCodeLevelMetricsIgnoredPrefixesオプションを使用して一部のモジュールを無視することを選択した場合は、エージェントの報告された構成データからそのようなプレフィックスのリストを編集することもできます。

これは、 ConfigCodeLevelMetricsRedactIgnoredPrefixesオプションを設定することによって実現されます。true値を指定すると、無視されたプレフィックスのリストは、エージェントによって報告される構成データに表示されません。それ以外の場合は、報告されます。

次のうち1つを行います。

NewApplication関数を介して構成する場合は、 ConfigCodeLevelMetricsRedactIgnoredPrefixesオプションを追加します。

app, err := newrelic.NewApplication(
   newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
   newrelic.ConfigCodeLevelMetricsEnabled(true),
   newrelic.ConfigCodeLevelMetricsRedactIgnoredPrefixes(true),
)

環境変数を介して構成する場合は、 NEW_RELIC_CODE_LEVEL_METRICS_REDACT_IGNORED_PREFIXESを設定します。
```
NEW_RELIC_CODE_LEVEL_METRICS_REDACT_IGNORED_PREFIXES=true
```
アプリケーションを設定するときは、忘れずにnewrelic.ConfigFromEnvironmentオプションも含めてください。
```
app, err := newrelic.NewApplication(
   newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
   newrelic.ConfigCodeLevelMetricsEnabled(true),
   newrelic.ConfigFromEnvironment(),
)
```
重要
このリダクションオプションは、Go エージェントバージョン 3.20.0 で使用できます。以降。

デフォルトでは、コードレベルのメトリックが有効になっているため、エージェントは各ソースファイルのフルパス名を報告します。ただし、これは望ましくない場合があります。たとえば、プロジェクトソースツリーのルートに関連するアプリケーションパスのみをレポートし、ファイルシステムのどこにインストールされているかに関係なく、インスタンス間でデータを関連付けることができます。

これを行うには、ローカルプロジェクトソースパスの開始を示す文字列を指定します。そのプレフィックスがソースファイルのパス名に含まれている場合、それより前にあるものはすべて削除されます。たとえば、パスプレフィックス文字列がmyproject/srcに設定されている場合、 /usr/local/projects/myproject/src/widget/main.goはコードレベルのメトリックでmyproject/src/widget/main.goとしてレポートされます。

使用したいパスプレフィックスが複数ある場合は、それらの名前をすべて個別のパラメーターとしてリストするだけです。

PathPrefixesが空の場合、またはソースファイルパスにプレフィックス文字列がまったく含まれていない場合は、完全なパス名が報告されます。

次のうち1つを行います。

NewApplication関数を介して構成する場合は、 ConfigCodeLevelMetricsPathPrefixesオプションを追加します。

app, err := newrelic.NewApplication(
   newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
   newrelic.ConfigCodeLevelMetricsEnabled(true),
   newrelic.ConfigCodeLevelMetricsPathPrefixes("myprojects/src/", "otherproject/src/"),
)

環境変数を介して構成する場合は、 NEW_RELIC_CODE_LEVEL_METRICS_PATH_PREFIXESを目的のプレフィックスに設定します。
```
NEW_RELIC_CODE_LEVEL_METRICS_PATH_PREFIXES="myprojects/src/,otherproject/src/"
```
アプリケーションを設定するときは、忘れずにnewrelic.ConfigFromEnvironmentオプションも含めてください。
```
app, err := newrelic.NewApplication(
   newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
   newrelic.ConfigCodeLevelMetricsEnabled(true),
   newrelic.ConfigFromEnvironment(),
)
```
重要
3.20.0 より前のバージョンの Go エージェントでは、このオプションは、複数形ではなく単数形 (つまり、 ConfigCodeLevelMetricsPathPrefix ) で名前が付けられました。これらの名前は非推奨であり、ここに記載されているものを使用する必要があります。古い名前も下位互換性のために引き続きサポートされています。

機密保持などの理由で、報告されたソースパス名をConfigCodeLevelMetricsPathPrefixesオプションで短縮することを選択した場合、エージェントの報告された構成データからもパスプレフィックスのリストを編集したい場合があります。

これは、 ConfigCodeLevelMetricsRedactPathPrefixesオプションを設定することによって実現されます。true値を指定すると、パス接頭辞のリストは、エージェントによって報告される構成データに表示されません。それ以外の場合は、報告されます。

次のうち1つを行います。

NewApplication関数を介して構成する場合は、 ConfigCodeLevelMetricsRedactPathPrefixesオプションを追加します。

app, err := newrelic.NewApplication(
   newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
   newrelic.ConfigCodeLevelMetricsEnabled(true),
   newrelic.ConfigCodeLevelMetricsPathPrefixes("myprojects/src/", "otherproject/src/"),
   newrelic.ConfigCodeLevelMetricsRedactPathPrefixes(true),
)

環境変数を介して構成する場合は、 NEW_RELIC_CODE_LEVEL_METRICS_REDACT_PATH_PREFIXESを設定します。
```
NEW_RELIC_CODE_LEVEL_METRICS_REDACT_PATH_PREFIXES=true
```
アプリケーションを設定するときは、忘れずにnewrelic.ConfigFromEnvironmentオプションも含めてください。
```
app, err := newrelic.NewApplication(
   newrelic.ConfigAppName("Your Application Name"),
   newrelic.ConfigLicense("YOUR_NEW_RELIC_LICENSE_KEY"),
   newrelic.ConfigCodeLevelMetricsEnabled(true),
   newrelic.ConfigFromEnvironment(),
)
```
重要
このリダクションオプションは、Go エージェントバージョン 3.20.0 で使用できます。以降。

指標を表示する

コードレベルのメトリクスを設定したら、New Relic UI でデータを確認できます。特定のサービスのトレースを表示する 1 つの方法を次に示します。

one.newrelic.com > APM & servicesに移動します。
エンティティ（サービス）をクリックします。
左ペインの [監視] セクションで、[トランザクション] をクリックします。
[ Transaction traces ] で、個々のトレースをクリックします。
code.で始まる 4 つの属性については、[エージェントの属性] を参照してください。

この機械翻訳は参考用に提供されます。

Go エージェントのコードレベルのメトリクス構成

重要

設定方法

インストルメント化されたパッケージを特定する

重要

無視されたモジュールのプレフィックスを編集する

重要

ソースパスのプレフィックスを切り詰める

重要

ソースパスのプレフィックスを編集する

重要

指標を表示する

この機械翻訳は参考用に提供されます。

Go エージェントのコードレベルのメトリクス構成

重要

設定方法

無視されたモジュールのプレフィックスを編集する

ソース パスのプレフィックスを切り詰める

ソース パスのプレフィックスを編集する

指標を表示する

ソースパスのプレフィックスを切り詰める

ソースパスのプレフィックスを編集する