ラベルとカテゴリ: アプリとサーバー、モニターをまとめる

New Relic が監視しているエンティティに対して、ラベル付けを行いそれらをまとめることができます。そうすることで、アプリやサーバーは意味のあるカテゴリに「巻き上げ」られます。以下がその対象です。

  • New Relic APM におけるアプリ
  • New Relic Servers におけるサーバー
  • New Relic Synthetics におけるモニター(Ping モニターや Scripted ブラウザモニターなど)

New Relic UI にあるインデックスページから、簡単に対象に、絞り込み、並び替え、ページ送りができます。

目次

機能

カテゴリのラベルとその値のラベルを作成してから、特定のカテゴリにエンティティ [英語]をロールアップすることで、特定のグループを特定できるようになります。これは、意味のあるエンティティのみを対象にした検索、表示、比較を簡単にします。加えて、カテゴリー(やカテゴリ内のアプリケーションやサーバー)についての健康状態を一目で比較できます。

ラベルとカテゴリ
APM > Applications list >(選択したカテゴリ): Environmentカテゴリとして5つのラベル(Dev、Integration、Production、Staging、Test)を使って「巻き上げ」た例です。各ラベル下のカラーバーは全体の「稼働」状態を示します。ラベル内の色付きの四角は個々のアプリに関する「稼働」状態を示しています。

要件

カテゴリやラベルの管理に関する権限は、選択した製品とあなたの New Relic のロールに依存します。
  • APM: アカウントのオーナーまたは所有者のみ
  • Servers: アカウントのオーナーまたは所有者のみ
  • Synthetics: どのロールでも、New Relic Synthetics UI 内でカテゴリやラベルの作成、編集、削除を行える。但し、REST API 経由で Synthetics のラベルやカテゴリを管理できるのは、アカウントのオーナーまたは所有者のみです。

ラベルのガイドライン

ラベルを作成する際は以下のガイドラインに従ってください。

ラベル ガイドライン
カテゴリの数 意味のある単位のカテゴリ分だけユニークなラベルを作成すること。アプリとサーバーに設定できるカテゴリ数は0以上です。(上限なし)
ラベルの形式 「カテゴリ名:値」という形式で入力すること。例: Environment:DevEnvironment:ProductionTier:Front_End、Test:Mobile など。常にコロン( : )をカテゴリ名と値の間に含めること。
有効な文字 カテゴリ名とその値に使えるのは、文字、数字、ハイフン、及びアンダースコアのみです。その他の特殊文字は使用しないこと。
大文字の使用

カテゴリ名と値の最初の文字は大文字とすること。最初の文字以外を大文字にしたい場合はダッシュ - を含めること。例: Tier:Front-End

単語の区切りとして、コロン(必須)とオプションのハイフンを扱います。区切りの後はの最初の文字は大文字とします。(検索する際は、大文字小文字関係なく認識します。)

UI 上でラベルを作成すると、最​​初の文字とハイフンの後の文字は大文字に、それ以外の文字は小文字に変換されます。例えば ラベル Label-cAtegory:lABEL-value を作った場合は、Label-Category:Label-Value として保存されます。

ラベルの作成

ラベルとカテゴリ
APM > Applications index: カテゴリラベルを作成、カテゴリへのアプリの追加、要約及び詳細情報を表示するためのカテゴリの選択方法についての手順を示しています。Servers > Servers index から同様の手順に従ってください。
APM 及び Servers: オーナー または 管理者
Synthetics: 誰でも

1つ以上のカテゴリにアプリやサーバーを追加するには、最初のカテゴリに意味のあるラベルを付けてください。必要に応じて、アプリやサーバーにラベルを作成してください。カテゴリに設定できるアプリやサーバーの数に制限はありません。

  1. New Relic のメニューバーから、APMServersSynthetics を選択します。
  2. インデックスページにて、Show Labels > On を選択します。
  3. カテゴリにアプリやサーバーを割り当てるには、名前を丸で囲んだプラス plus-circle アイコンを選択します。
  4. ガイドラインに従いラベルを入力します。Category:Value フォーマットを使うこと。
  5. 新しいラベルを保存するには、Enterキー または Returnキー を押します。

REST API の利用

オーナー または 管理者

New Relic の REST API を使って、ラベルやカテゴリを管理できます。これは、例えば、今あるラベルの一覧を知りたかったり、既存のラベルを削除したり、新しくラベルを追加したい場合など便利な機能です。

カテゴリとラベルの表示

ラベルを作成し、カテゴリに1つ以上のエンティティに割り当てると、New Relic はそのカテゴリに「エンティティを巻き上げ」ます。これにより、選択したアプリ、サーバー、モニターのカテゴリを確認しやすくなります。

カテゴリやラベルを表示するには以下の手順に従ってください。

  1. New Relic のメニューバーから、APMServersSynthetics を選択します。
  2. 各製品のインデックスページから、検索 search 窓に、カテゴリ名もしくは、ラベル名の部分または全部を入力するか、リストから選択します。
  3. 利用可能なツールを使って、カテゴリ内のエンティティの概要情報を表示したり、特定のエンティティに深掘りして、詳細情報を確認したりします。

ロールアップビューには、カテゴリに属する全エンティティ、そして各々の健康状態(緑=良好、黄=注意、赤=致命的)数が一覧表示されます。カテゴリ名の下のカラーバーは全体の稼働状態をまとめたものです。例えば、カテゴリ内のエンティティがデータを報告していない場合、カラーバーに灰色になります。

エンティティからラベルの割り当てを解除する

APM と Servers: オーナー または 管理者
Synthetics: 誰でも

ラベルの割り当てを解除する方法は以下のとおりです。

  1. New Relic のメニューバーから、APMServersSynthetics を選択します。
  2. Show Labels > On を選択します。
  3. 削除対象のラベルをクリックします。確認ダイアログが表示されるので指示に従ってください。

通常のラベルやカテゴリの作成手順に従うことによって、ラベルを再割り当てできます。

ラベルの変更および削除

オーナー または 管理者

New Relic UI で、エンティティからラベルを削除することもできます。但し、ラベルを完全に削除することはできません。代わりに API を使って、以下のようにラベルを削除します。

また、ラベル名の変更はできません。そのため、API を使って、一度既存のラベルを削除し、新規にラベルを作成します。

エージェント用設定ファイルの使用

アプリケーションのラベル設定の管理としてエージェント用設定ファイルを使用する場合は、お使いのバージョンがその機能のサポート対象のリリースバージョンであることを確認してください。詳しくはお使いのエージェントの設定マニュアルをご覧ください。

関連情報

関連情報は以下のとおりです。