Sumo Logic – メタデータフィールドの作成方法と注意点について

最初に

記事の内容が古い場合は、公式サイトもご確認ください。

Sumo Logic については以下をご参照ください。

• Sumo Logic 公式サイト
• Classmethod - クラウドネイティブのログ管理分析SaaS「Sumo Logic」

メタデータについて

Sumo Logic で、ログやメトリクスを表示・分析するために組み込みのメタデータが存在します。
メタデータのフィールドは、検索するために理解しやすい名前を定義したいです。

組み込みメタデータフィールド名

• _collector
• _source
• _sourceCategory
• _sourceHost
• _sourceName

メタデータのフィールドを作成する時の注意点

• 英数字を使用する

英数字を使用する必要があります。

• アンダースコア、ハイフン、ピリオドなどの区切り記号を使用できます。

適所に配置して読みやすいフィールド名を作成できます。

• スペースの使用は控える

スペースは、クエリ検索するときに引用符で囲む必要があります。 また、設定したフィールド名のスペースは、省略できません。 さらに、ワイルドカード自体が引用符で囲むと機能しないため、スペースの使用は控えた方がよいです。

• 大文字・小文字

クエリ検索するときに文字の大小は認識しないため、文字のケースを統一して作成するのをオススメします。

各種メタデータの意味

以下は、メタデータの大まかな概要です。

_collector

Sumo Logic では、ログ・メトリクスデータを収集する Java 製のソフトウェアをコレクターと呼びます。

コレクターをインストールするときに指定した名前が、フィールド名になります。

_source

データを受け取るためには、ソースをコレクターと紐付ける必要があります。
ソースを作成するときに指定した名前が、フィールド名になります。

_sourceCategory

Source のカテゴリ名です。
ソースを作成するときに指定した名前になります。

_sourceName

ログファイル名です。メタデータ _sourceName には、ソースの作成時に入力したファイルのバスが設定されます。

_sourceHost

ソースのホスト名です。メタデータ _sourceHost には、OS レベルのホスト名が設定されます。
※ Installed Collectors で、ホストのローカルファイルをソースとするの場合のみ、ホスト名以外の名前を定義可能です。
とはいえ、コレクターを積んでいるホスト名を識別するために分かりやすく命名した方がよいです。

例） Ja/MySQL/Pri Ja/FW/Sec どこの/何をする/どんな役割

まとめ

最適化された組み込みメタデータは、クエリ実行時に理解しやすいため、適切な分析データのインサイトを提供します。 とくに、_sourceCategory の命名には注意が必要で、クエリ検索の利便性に関わるため、以下 URL の公式ページも参考に定義することをオススメします。

参考元

• Sumo Logic - Metadata Naming Conventions
• Sumo Logic - Built-in Metadata
• Sumo Logic - Best Practices for Data Collection