Cisco IOS XR テレメトリ コンフィギュレーション ガイド

偏向のない言語

この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ
このマニュアル内で検索
ご利用いただける言語
Download Options

Book Title

Cisco IOS XR テレメトリ コンフィギュレーション ガイド

Chapter Title

テレメトリ ストリーミングのコア コンポーネント

検索結果

Updated:
2017年5月18日

章のタイトル： テレメトリ ストリーミングのコア コンポーネント

テレメトリ データのストリーミングに使用される 3 つのコア コンポーネントは次のとおりです。

テレメトリ ポリシー ファイル

テレメトリ ポリシー ファイルは、生成してレシーバにプッシュするテレメトリ データの種類を指定するために使用されます。ユーザがポリシー ファイルを定義します。ポリシーは .policy 拡張子付きのテキスト ファイルに JSON 形式で保存する必要があります。複数のポリシー ファイルを定義して、ルータ ファイル システムの /telemetry/policies/ フォルダにインストールできます。

ポリシー ファイルには以下が含まれます。

  • 1 つ以上の収集グループ。1 つの収集グループには、異なるインターバルでストリーミングされるさまざまなデータが含まれています。

  • グループごとの秒単位の時間。

  • グループごとの 1 つ以上のパス。

  • ポリシーに関するバージョン、説明、およびその他の詳細情報を含むメタデータ。

ポリシー ファイルの構文

次に、ポリシー ファイルの例を示します。 
{
"Name": "NameOfPolicy",
 "Metadata": {
     "Version": 25,
     "Description": "This is a sample policy to demonstrate the syntax",
     "Comment": "This is the first draft",
     "Identifier": "<data that may be sent by the encoder to the mgmt stn"
},
 "CollectionGroups": {
     "FirstGroup": {
         "Period": 30,
         "Paths": [
             "RootOper.MemorySummary.Node",
             "RootOper.RIB.VRF",
             "..."
         ]
     },
     "SecondGroup": {
         "Period": 300,
         "Paths": [
             "RootOper.Interfaces.Interface"
         ]
     }
 }
}
ポリシー ファイルの構文には以下が含まれています。

  • Name：ポリシーの名前。上記の例では、ポリシーは NameOfPolicy.policy という名前のファイルに保存されます。ポリシーの名前はファイル名と一致する必要があります（.policy 拡張子を除く）。大文字と小文字のアルファベット（A ~ Z、a ~ z）、および数字（0 ~ 9）を含めることができます。ポリシー名は大文字と小文字が区別されます。

  • Metadata：ポリシーに関する情報。メタデータには、バージョン番号、日付、説明、作成者、著作権情報、その他のポリシーを特定する詳細情報を含めることができます。次のフィールドはポリシーを特定するのに重要です。

    • Description：show policies コマンド内に表示されます。

    • Version および Identifier：すべてのテレメトリ メッセージのメッセージ ヘッダーの一部として受信側に送信されます。

  • CollectionGroups：グループ名をそれらに関する情報にマップするエンコーダ オブジェクト。収集グループの名前には、大文字と小文字のアルファベット（A ~ Z、a ~ z）および数字（0 ~ 9）を含めることができ、大文字と小文字は区別されます。

  • Period：各収集グループの連鎖的動作。この期間で、データが照会されてレシーバに送信される頻度を秒単位で指定します。この値は 5 ~ 86400 秒の範囲内に収める必要があります。

  • Paths：ストリーミングされてレシーバに送信されるデータの 1 つ以上のスキーマ パス。次に例を示します。 
    RootOper.InfraStatistics.Interface(*).Latest.GenericCounters

スキーマ パス

スキーマ パスを使用してテレメトリ データを収集します。参考のため、いくつかのパスのリストを次のテーブルに示します。

表 1 スキーマ パス

動作

Path

インターフェイス運用データ

RootOper.Interfaces.Interface(*)

パケット/バイト カウンタ

RootOper.InfraStatistics.Interface(*).Latest.GenericCounters

パケット/バイト レート

RootOper.InfraStatistics.Interface(*).Latest.DataRate

IPv4 パケット/バイト カウンタ

RootOper.InfraStatistics.Interface(*).Latest.Protocol(['IPV4_UNICAST'])

MPLS の統計情報
  • RootOper.MPLS_TE.Tunnels.TunnelAutoBandwidth
  • RootOper.MPLS_TE.P2P_P2MPTunnel.TunnelHead
  • RootOper.MPLS_TE.SignallingCounters.HeadSignallingCounters

QOS の統計情報
  • RootOper.QOS.Interface(*).Input.Statistics
  • RootOper.QOS.Interface(*).Output.Statistics

BGP データ

RootOper.BGP.Instance({'InstanceName': 'default'}).InstanceActive.DefaultVRF.Neighbor([*])

テレメトリ エンコーダ

テレメトリ エンコーダは、生成したデータを目的の形式にカプセル化し、レシーバに送信します。

エンコーダはストリーミング テレメトリ API を呼び出して、以下を実行します。

  • ポリシーが明示的に定義されるように指定する

  • 対象のすべてのポリシーを登録する

テレメトリは次の 2 つのタイプのエンコーダをサポートしています。

  • JavaScript Object Notation（JSON）エンコーダ

    このエンコーダは IOS XR ソフトウェアとともにパッケージ化されており、デフォルト形式のテレメトリ データのストリーミングを提供します。CLI および XML で設定でき、特定のポリシーに合わせて登録することができます。設定はポリシー グループにグループ化されます。各ポリシー グループには、1 つ以上のポリシーと 1 つ以上の宛先が含まれます。

  • Google Protocol Buffers（GPB）エンコーダ

    このエンコーダは代替の符号化メカニズムを提供し、UDP を使用して GPB 形式でデータをストリーミングします。CLI および XML で設定でき、JSON と同じポリシー ファイルを使用します。また、データを GPB 形式に変換するには、コンパイルされた .proto ファイル形式のメタデータが GPB エンコーダに必要です。

JSON メッセージ形式

JSON エンコーダは zlib によって圧縮された JSON オブジェクトのシーケンスとしてデータを TCP 接続を介して送信します。JSON エンコーダはシンプルなタイプ/長さ/値（TLV）ベースのワイヤ形式を使用します。

  • 最初の 4 バイトはメッセージの長さです。

  • メッセージ他の部分は TLV で構成されます。各 TLV の構成は次のとおりです。

    • 32 ビットのビッグエイディアンとして符号化されたタイプ。

    • 32 ビットのビッグエイディアンとして符号化された長さ。

    • 値、タイプと長さに応じた形式。

TLV は以下から構成されます。

タイプ

名前

長さ

値

1

リセット コンプレッサ

0

値なし

2

JSON メッセージ

変数

Zlib で圧縮された JSON メッセージ
トップレベル JSON オブジェクトは次のとおりです。 
{
"Policy": "<name-of-policy>",
"Version": "<policy-version>",
"Identifier": "<data from policy file>"
"Data": { … object as above … }
}
JSON メッセージはルータのデータ モデルの階層を反映しています。階層は次のように構成されています。

  • コンテナ：タイプに応じて異なるノードがあります。

  • テーブル：テーブルにもノードがありますが、子ノードの数は異なる場合があり、同じタイプである必要があります。

  • リーフ：整数や文字列などのデータ値を含んでいます。

スキーマ オブジェクトは次のように JSON にマップされます。

  • 各コンテナは JSON オブジェクトにマップされます。キーはノードのスキーマ名を表す文字列です。この値はノードの値を表します。

  • また、テーブルを表すために JSON オブジェクトも使用されます。この場合は、キーは文字列形式に変換される命名情報に基づきます。

  • リーフのデータ型は次のようにマップされます。

    • 簡単な文字列、整数、およびブール値は直接マッピングされます。

    • 列挙値は値の文字列表現として保存されます。

    • IP アドレスなどのその他のシンプルなデータ型は文字列としてマップされます。

例 
{
"Policy": "my_policy",
"Version": "1.0",
"Identifier": "string from policy file"
"Data": {
  "Interfaces": {
      "GigabitEthernet0/0/0/1": {
        "Counters": {
          "Protocols": {
            "IPv4": {
              "CollectionTime": 12345678,
              "InputPkts": 100,
              "InputBytes": 200,
            }
          }
        }
      },
      "GigabitEthernet0/0/0/2": {
        "Counters": {
          "Protocols": {
            "IPv4": {
              "CollectionTime": 12345678,
              "InputPkts": 400,
              "InputBytes": 500,
            }
          }
        }
      }
    }
  }
}
}

GPB メッセージ形式

GPB エンコーダの出力は GPB によって全体的に構成され、単一のパケット内に複数のテーブルを許可して拡張性を持たせています。

例

次の .proto ファイルは、エンコーダによって送信されるすべてのパケットに共通するヘッダーを示しています。 
message TelemetryHeader {
  optional uint32 encoding = 1

  optional string policy_name = 2;
  optional string version = 3;
  optional string identifier = 4;

  optional uint64 start_time = 5;
  optional uint64 end_time = 6;
  
  repeated TelemetryTable tables = 7;
		}

message TelemetryTable {
  optional string policy_path = 1;
  repeated bytes  row = 2;
		}
値は次のとおりです。

  • encoding は、レシーバが使用してパケットが有効かどうかを確認します。

  • policiy_name、version、および identifier は、ポリシー ファイルから取得したメタデータです。

  • start_time と end_time は、データが収集された時間です。

  • tables はパケット内のテーブルのリストです。この形式は、1 つのパケットで複数のスキーマ パスの結果を受け取ることができることを示します。

  • 各テーブルの値は、次のとおりです。

    • policy_path はスキーマ パスです。

    • row は、符号化された GPB を表す 1 つ以上のバイト配列です。

テレメトリ レシーバ

テレメトリ レシーバは、宛先として使用してストリーミングされたデータを保存します。ユーザがこのレシーバを定義します。

GPB レシーバ用のコードをコンパイルするには、cisco.proto ファイルのコピーが必要です。cisco.proto ファイルは http:/​/​github.com/​cisco/​logstash-codec-bigmuddy-network-telemetry-gpb/​tree/​master/​resources/​xr6.0.0 で入手できます。

標準のプロトコル コンパイラを使用します。次に例を示します。 
protoc --python_out . -I=/sw/packages/protoc/current/google/include/:. generic_counters.proto ipv4_counters.proto
値は次のとおりです。

  • --python_out <out_dir> で、結果の生成されたファイルの場所を指定します。これらのファイルの形式は <name>_pb2.py です。

  • -I <import_path> で、インポートを検索するパスを指定します。これには、Google からの descriptor.proto の場所を含める必要があります。（in /sw/packages）および cisco.proto とコンパイルされた .proto ファイル。上記の例で示したすべてのファイルがローカル ディレクトリに存在します。

このドキュメントは役に立ちましたか?

Feedbackフィードバック

シスコに問い合わせ