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

次のタグのいずれかを設定すると、エラーが発生しているソフトウェアのバージョンを特定するのに役立ちます。

• NEW_RELIC_METADATA_SERVICE_VERSION デプロイされているコードのバージョン (多くの場合、1.2.3 などのセマンティック バージョン) を含むイベント データにtags.service.versionを作成しますが、常にそうとは限りません。

• NEW_RELIC_METADATA_RELEASE_TAG リリース タグを含むイベント データにtags.releaseTagを作成します (v0.1.209 など)またはリリース-209)。

• NEW_RELIC_METADATA_COMMIT コミット SHA を含むイベント データにtags.commitを作成します。SHA 全体を使用することも、最初の 7 文字だけを使用することもできます (例: 734713b)。

  エラー受信箱の今後のリリースでは、ソフトウェアのどのバージョンでエラーが発生しているかを自動的に追跡します。バージョン データもCodeStreamに表示されます。

デフォルトでは、コード レベルのメトリクスが有効になっている場合、エージェントはコール スタック内でエージェント自体の内部にあると思われる関数を無視し、報告された関数が意図したものであることを確認します。コードレベルのメトリクス インストルメンテーション コードに入るために呼び出されます。デフォルトでは、パッケージ名が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 で使用できます。以降。