New Relic CLI を使ってみる

New Relic CLI をインストールする

以下で説明するように、お使いのオペレーティング システム用の New Relic CLI をダウンロードします。.deb や .rpm など、すべてのプラットフォーム用の ビルド済みバイナリ をダウンロードすることもできます。 パッケージ、および Windows x64 .msiインストーラ。

Linux

Snapcraft を使用して、次を実行します。

$
sudo snap install newrelic-cli

マックOS

Homebrewを使用して、次を実行します。

$
brew install newrelic-cli

ウィンドウズ

Scoopを使用して、次を実行します。

$
scoop bucket add newrelic-cli https://github.com/newrelic/newrelic-cli.git
$
scoop install newrelic-cli

New Relic CLI プロファイルを作成する

New Relic CLI をインストールしたら、最初のプロファイルを作成します。プロファイルには、任意の CLI コマンドに適用できる資格情報と設定が含まれており、アカウントを切り替えるときに役立ちます。

profiles add コマンドを実行します。

$
# Create the tutorial account for the US region
$
newrelic profiles add --profile tutorial --apiKey YOUR_NEW_RELIC_USER_KEY -r YOUR_REGION
$
# Set the profile as defaults
$
newrelic profiles default --profile tutorial

アプリケーションの詳細を取得する

次に、New Relic でインストルメントしたアプリケーションにタグを追加します。タグは、エンティティの整理とフィルタリングに役立つキーと値のペアです。エンティティ(アプリケーションなど) には、最大 100 個のキーと値のペアを関連付けることができます。

New Relic CLI を使用してアプリケーションを検索する前に、New Relic でアカウント IDとアプリケーションの名前を書き留めるかコピーします。New Relic プラットフォームでアプリケーションを見つけるには両方が必要です。

アプリケーションの詳細を JSON オブジェクトとして取得します

APM アプリケーションを検索するには、 apm application search コマンドを使用します。

$
newrelic apm application search --accountId YOUR_ACCOUNT_ID --name NAME_OF_YOUR_APP

guid値を見つけます

アカウント ID が有効で、アプリケーション名がアカウントに存在する場合、 apm application search次の例のようなデータを生成します:

[
  {
    "accountId": YOUR_ACCOUNT_ID,
    "applicationId": YOUR_APP_ID,
    "domain": "APM",
    "entityType": "APM_APPLICATION_ENTITY",
    "guid": "A_LONG_GUID",
    "name": "NAME_OF_YOUR_APP",
    "permalink": "https://one.newrelic.com/redirect/entity/A_LONG_GUID",
    "reporting": true,
    "type": "APPLICATION"
  }
]

アプリケーションの検索に成功したら、 guid値を探します。これは、アプリケーションの一意の識別子です。コピーするか書き留めてください。

アプリケーションに簡単なタグを追加する

GUID を取得したので、New Relic CLI をアプリケーションに直接向けることができます。タグの追加は、CLI 機能を試す最も簡単な方法です (タグは entity tags deleteを使用して削除できます)。

ここでは、環境タグをアプリケーションに追加します。 entities tags create コマンドを使用して、 dev:testingタグ⁠ (またはその他のキーと値のペア) をアプリケーションに追加します。

$
newrelic entity tags create --guid YOUR_APP_GUID --tag devkit:testing

タグセットを追加する

複数のタグを追加したい場合は？タグセットが救助に！タグはコロンで区切られたキーと値のペアですが、タグ セットはカンマで区切られたタグのリストです。例えば：

tag1:value1,tag2:value2

一度に複数のタグをアプリケーションに追加するには、次のスニペットを変更して実行します。

$
newrelic entity tags create --guid YOUR_APP_GUID --tag tag1:test,tag2:test

アプリケーションのタグを取得する

いくつかのタグを作成してアプリケーションに追加しましたが、それらが機能していることをテストするには、それらを取得する必要があります。

entity tags get コマンドを実行します。

$
newrelic entity tags get --guid YOUR_APP_GUID

アプリケーションに関連付けられたすべてのタグは、JSON 配列として取得されます。

[
  {
    "Key": "tag1",
    "Values": ["true"]
  },
  {
    "Key": "tag2",
    "Values": ["test"]
  },
  {
    "Key": "tag3",
    "Values": ["testing"]
  }
  // ...
]

ボーナス ステップ: デプロイメント マーカーを作成する

アプリケーションのデプロイメントは失敗することがよくあります。デプロイメント マーカーは、アプリケーション データに添付すると、デプロイメントを追跡し、何が起こったのかをトラブルシューティングするのに役立つラベルです。

デプロイ マーカーを作成するには、以前の検索と同じアプリケーション ID を使用して apm deployment create コマンドを実行します。

$
newrelic apm deployment create --applicationId YOUR_APP_ID --revision $(git describe --tags --always)

デプロイメントのリビジョンとタイムスタンプの JSON 応答を確認します。

このワークフローを継続的インテグレーションまたは継続的デプロイ (CI/CD) システムに構築して、デプロイ後のアプリケーションの動作の変化を示すことができます。

次の例を見てみましょう。

{
  "id": 37075986,
  "links": {
    "application": 204261368
  },
  "revision": "v1.2.4",
  "timestamp": "2020-03-04T15:11:44-08:00",
  "user": "Developer Toolkit Test Account"
}