CodeStreamとNew Relic One

CodeStreamとNew Relic Oneが連携することで、コードのエラーを把握することができるだけでなく、APMエージェントによるコードのインスツルメンテーションを簡単に始めることができます。

CodeStreamがNew Relic Oneに接続されていると、スタックトレースのエラーから、IDEの問題のあるコード行に直接ジャンプすることができます。IDEに入ったら、スタックトレースをナビゲートし、チームメイトと協力して問題を解決することができます。

プレビューリリース

CodeStream の New Relic One との統合は、当社の米国データセンターの New Relic One アカウントに限定されたプレビューリリースであり、お客様の使用はプレリリースポリシーに従うものとします。(これは他のすべてのCodeStreamの機能には適用されません)。

CodeStreamとNew Relicの接続

CodeStreamでNew Relicのオブザーバビリティ機能を利用する前に、それらを接続する必要があります。

CodeStreamとNew Relicを接続するための要件です。

New Relic アカウント (New Relic アカウントをお持ちでない方は、 newrelic.com/signup でサインアップしてください。永久に無料です！)
New Relic のユーザーキー。詳細については、 API キーを参照してください。
ユーザータイプがコアユーザーまたはフルプラットフォームユーザーである必要があります。

New Relic のユーザーキーを取得したら、CodeStream の Observability セクションで Connect to New Relic One をクリックし、API キーを貼り付けて Connect to New Relic One をクリックします。

注意

New Relic のユーザーは CodeStream でスタックトレースのエラーを共有することができます。CodeStream を New Relic に接続すると、CodeStream の組織に追加した新しいユーザーは、これらのエラーを見ることができます。

エラーとその原因の確認

CodeStreamとNew Relicを接続した後、ワークロードとエラーズインボックスを使って、IDEの問題のあるコードにジャンプします。

IDEでスタックトレースエラーを開くための条件

New Relic アカウント (New Relic アカウントをお持ちでない方は、 newrelic.com/signup でサインアップしてください。永久に無料です！)
New Relicのユーザーキー
CodeStreamとNew Relicの接続
APMモニタリングでNew Relicに報告されるデータ
エラーの原因となるワークロード
エラー
APMエラーの場合は、リポジトリのコミットハッシュとリリースタグ

New Relic のエラーインボックスは、顧客に影響を与える前にエラーを積極的に検出し、優先順位をつけ、対策を講じるための単一の場所です。CodeStreamでは、エラーからIDEの問題のあるコードに直接ジャンプすることができます。

ヒント

APMのエラーに限る。

誤差のある受信箱からIDEに移行する方法

one.newrelic.com/ から、 Errors Inbox 、スタックトレースエラーをクリックし、 Open in IDE をクリックします。

APMエラーとCodeStream

スタックトレースエラーをIDEで表示するためには、CodeStreamはエラーがどのリポジトリに関連しているか、また理想的にはエラーを発生させたコードのどのバージョンかを知る必要があります。

リポジトリとエラーの関連付け

APM、モバイル、ブラウザなどのモニタリングを開始したら、リポジトリエンティティを作成し、すべてのサービスのエンティティと関連付ける必要があります。リポジトリのエンティティを作成するためには、リポジトリのリモートURLを提供する必要があります。例えば、リモート URL は SSH または HTTPS 形式のいずれかになります。

git@github.com:newrelic/beta-docs-site.git
https://github.com/newrelic/beta-docs-site.git

注意

異なるプロトコルを使用している場合は、同じ GitHub リポジトリを複数回追加することができます。UI はこの点について警告を発しますが、追加を妨げることはありません。

例えば、 https://github.com/tuna/repo と git@github.com:tuna/repo は同じレポで、プロトコルが異なります。

IDEでエラーを開こうとしたときに、関連するリポジトリがない場合、CodeStreamは関連付けを行うように促し、New Relic上の指定されたエンティティからのすべてのエラーに対してその関連付けを保存します。しかし、継続的な手作業の手間が少なく、リモートURLの設定ミスなどエンドユーザーのミスの可能性を排除できるため、以下のいずれかの方法を使用することが望ましいでしょう。

New Relic へのデータ送信を開始したら、UI を使って関連するリポジトリを接続します。 one.newrelic.com > Explorer> Services - APM> (select an app) から APM Summary ページに移動し、右下にある Repositories のセクションを探します。

Connect repository をクリックして、既存のリポジトリを探すか、新しいリポジトリを追加します。

New Relic の NerdGraph APIsを使用してリポジトリを作成し、アプリケーションのエンティティと関連付けます。

ステップ1：リポジトリ・エンティティの作成

リポジトリエンティティを作成するには、 referenceEntityCreateOrUpdateRepository APIを使用し、生成されたGUIDを必ず保存してください。このAPIは、以下のパラメータを受け取ります。

accountId - リポジトリを追加したいアカウントの整数のアカウントID。
url - example https://github.com/newrelic/beta-docs-site.git
名前 - 例: newrelic/beta-docs-site
```
mutation {
  referenceEntityCreateOrUpdateRepository(repositories: [{accountId: [YOUR_ACCOUNT_ID], name: "[REPO_NAME]", url: "[REPO_URL]"}]) {
    created
    failures {
      guid
      message
      type
    }
  }
}
```
作成したエンティティを検索するには、以下のようなクエリを使用します。なお、 referenceEntityCreateOrUpdateRepository に指定したURLは、エンティティタグとして保存されます。
```
{
  actor {
    entitySearch(query: "name = 'a name' OR tags.url = 'a url'") {
      count
      query
      results {
        entities {
          guid
          name
          tags {
            key
            values
          }
        }
      }
    }
  }
}
```
ステップ2：リポジトリ・エンティティをアプリケーション・エンティティに関連付ける
まず、リポジトリを関連付けたいアプリケーションのGUIDを探します。
パラメータ。
sourceEntityGuid - アプリケーションのエンティティGUIDです。
targetEntityGuid - リポジトリのエンティティGUIDです。

タイプ - 常に BUILT_FROM

mutation {
  entityRelationshipUserDefinedCreateOrReplace(sourceEntityGuid: "", targetEntityGuid: "", type: BUILT_FROM) {
    errors {
      message
      type
    }
  }
}

リポジトリに関連するすべてのエンティティを見るには、次のようなクエリを実行します。

{
  actor {
    entity(guid: "[YOUR_REPOSITORY_GUID]]") {
      relatedEntities(filter: {direction: BOTH, relationshipTypes: {include: BUILT_FROM}}) {
        results {
          target {
            entity {
              name
              guid
              type
            }
          }
          type
        }
      }
      name
      type
      tags {
        values
        key
      }
    }
  }
}

ステップ3：後始末（必要に応じて）

以下のクエリでリポジトリを削除します。

mutation DeleteRepository {
  entityDelete(guids: "[ENTITY_GUID_HERE]]") {
    deletedEntities
    failures {
      message
      guid
    }
  }
}

ビルドSHAやリリースタグとエラーの関連付け

CodeStream の Open in IDE を APM スタックトレースエラーで使用するには、環境変数を使用して、アプリケーションの commit sha および/または release tag を、実行中のソフトウェアのバージョンに関連付けて APM エージェントに設定します。

CodeStream はこの接続を行うために、コミット sha の最初の 7 文字だけを必要としますが (例: 734713b)、 sha 全体を含めることもできます。

あるいは、リリースタグ（ v0.1.209 や release-209 など）を使うと、CodeStreamがコードの正しいバージョンを見つけてくれます。

New Relic APM では、コミットおよび/またはリリースタグ(tags.commit および tags.releaseTag)が、 Transaction および TransactionError イベントの属性として追加されます。APM の環境変数を使用して、これらの属性を設定することができます。

これらの変数のいずれかまたは両方を、ビルドパイプラインの一部として設定することをお勧めします。

NEW_RELIC_METADATA_COMMIT - コミットシャ。全体を含めることも、最初の7文字だけを含めることもできます。
NEW_RELIC_METADATA_RELEASE_TAG - リリースタグ（ v0.1.209 または release-209 など）。これは、人間が読めるという利点があります。

これらの変数の設定方法については、各言語ごとに具体的な設定内容をご紹介します。

CodeStreamによるAPMエージェントのインストール

CodeStream経由でNew Relic APMエージェントをインストールするための要件です。

New Relicアカウント
New Relicのユーザーキー
CodeStreamとNew Relicの接続
対応する言語アプリケーションのコードベース
- .NET Core
- Java
- Node.JS

CodeStream を初めて New Relic に接続する際、New Relic が監視していないアプリケーションのコードベースで作業している場合、CodeStream はそのアプリケーションのインストルメントを提案します。

New Relic のガイド付きインストールのように、CodeStream は APM エージェントをインストールして New Relic へのデータ送信を開始するまでのすべてのステップを説明し、自動化します。

このチェックは、最初の接続時にのみ自動的に行われます。後で行うには、CodeStream エクステンションで、ユーザー名をクリックし、 New Relic Setup をクリックします。

GoとPixieによるダイナミックロギング

New Relicアカウント
New RelicユーザーのAPIキー
CodeStreamとNew Relicの接続
Pixieが監視するKubernetesクラスタ
Goで書かれたアプリケーション
CodeStream を使用して、Pixie が監視する Go アプリケーションのダイナミックロギングを有効にすることができます。任意のメソッド名を右クリックし、 Pixie を使用した動的ロギング を選択するだけです。

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