fluent-plugin-telemetry-iosxr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b500be3a83d7647d27cc43f0f7a497d7a2b31bcf
+  data.tar.gz: 63af8ac269ad362e75206ef9efbb79416d2b4bd4
+SHA512:
+  metadata.gz: 9864842367b007e42cb7d99bb3cfd3a5b8093adfff2c79835a5505b1a5df45e09787ec78ad5d38f4eec7af4ce50a7d65a23fb14501ea3188dd0f14f9a7abd307
+  data.tar.gz: 98262672e4c2343c95a84b36a7dea22c931a0c59f35e31f056136abd91f4f3ef88481b9c5f335ce9c3fe2f367a8837fff01b2dfbee02d56e984ed071fd02815e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fluent-plugin-telemetry-iosxr.gemspec
+gemspec

data/README.md

@@ -0,0 +1,143 @@
+# fluent-plugin-telemetry-iosxr, a plugin for [Fluentd](http://fluentd.org)
+
+[Fluentd](http://fluentd.org) input plugin to collect IOS-XR telemetry.
+
+## Requirements
+
+`fluent-plugin-telemetry-iosxr` supports fluentd-0.14.0 or later. 
+
+## installation
+
+    $ fluent-gem install fluent-plugin-telemetry-iosxr
+
+## Usage
+
+### Configuration Example 1
+
+Collect telemetry input and then output to stdout.
+
+```
+<source>
+  @type telemetry_iosxr
+  bind 0.0.0.0
+  port 5432
+  @label @telemetry
+</source>
+
+<label @telemetry>
+  <match **>
+    @type stdout
+  </match>
+</label>
+```
+
+### Configuration Example 2
+
+Collect telemetry input and then output to InfluxDB with deleting nested input.
+
+```
+<source>
+  @type telemetry_iosxr
+  bind 0.0.0.0
+  port 5432
+  delete_nested true
+  @label @telemetry
+</source>
+
+<label @telemetry>
+  <match **>
+    @type influxdb
+    host localhost
+    port 8086
+    dbname telemetry
+    user admin
+    password admin
+    time_precision s
+    auto_tags true
+  </match>
+</label>
+```
+
+**bind**
+
+IP address on which the plugin will accept Telemetry.  
+(Default: '0.0.0.0')
+
+**port**
+
+TCP port number on which the plugin will accept Telemetry.  
+(Default: 5432)
+
+**delete_nested**
+
+Delete nested input. 
+(Default: false)
+
+Assume the input is multi-dimensional as below:
+
+```
+{ 
+    "node-name":"0/RP0/CPU0",
+    "total-cpu-one-minute":2,
+    "total-cpu-five-minute":2,
+    "total-cpu-fifteen-minute":2,
+    "process-cpu":[ 
+        { 
+            "process-name":"init",
+            "process-id":1,
+            "process-cpu-one-minute":0,
+            "process-cpu-five-minute":0,
+            "process-cpu-fifteen-minute":0
+        },
+        { 
+            "process-name":"bash",
+            "process-id":1589,
+            "process-cpu-one-minute":0,
+            "process-cpu-five-minute":0,
+            "process-cpu-fifteen-minute":0
+        },
+        { 
+            "process-name":"sh",
+            "process-id":1605,
+            "process-cpu-one-minute":0,
+            "process-cpu-five-minute":0,
+            "process-cpu-fifteen-minute":0
+        },
+        ...
+    ]
+}
+```
+
+Then the output becomes as below:
+
+```
+{ 
+    "node-name":"0/RP0/CPU0",
+    "total-cpu-one-minute":2,
+    "total-cpu-five-minute":2,
+    "total-cpu-fifteen-minute":2
+}
+```
+
+### IOS XR Configuration Example
+
+```
+telemetry model-driven
+ destination-group destination1
+  address-family ipv4 <ip_addr> port <port>
+   encoding json
+   protocol tcp
+  !
+ !
+ sensor-group sensor1
+  sensor-path Cisco-IOS-XR-wdsysmon-fd-oper:system-monitoring/cpu-utilization
+  sensor-path Cisco-IOS-XR-nto-misc-oper:memory-summary/nodes/node/summary
+  sensor-path Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/latest/data-rate
+  sensor-path Cisco-IOS-XR-infra-statsd-oper:infra-statistics/interfaces/interface/latest/generic-counters
+ !
+ subscription 1
+  sensor-group-id sensor1 sample-interval 1000
+  destination-id destination1
+ !
+!
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/fluent-plugin-telemetry-iosxr.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+#require "fluent/plugin/telemetry/iosxr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-telemetry-iosxr"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Tetsuhiro Sato"]
+  spec.email         = ["tetsusat@cisco.com"]
+
+  spec.summary       = %q{Fluentd input plugin to collect IOS-XR telemetry.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/tetsusat/fluent-plugin-telemetry-iosxr"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fluentd", "~> 0.14"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/fluent/plugin/in_telemetry_iosxr.rb

@@ -0,0 +1,89 @@
+require 'fluent/input'
+require 'socket'
+require 'json'
+
+module Fluent
+  class TelemetryInput < Input
+    Fluent::Plugin.register_input('telemetry_iosxr', self)
+
+    helpers :server
+
+    config_param :bind, :string, :default => '0.0.0.0'
+    config_param :port, :integer, :default => 5432
+    config_param :delete_nested, :bool, :default => false
+
+    def configure(conf)
+      super
+    end
+
+    def start
+      super
+      @hdr_parsed = false
+      @buffer = ""
+      @hdr_buffer = ""
+      server_create(:in_telemetry_server, @port, bind: @bind, proto: :tcp) do |data, sock|
+        receive_data(sock.remote_host, data)
+      end
+    end
+    def shutdown
+      super
+    end
+
+    protected
+
+    def receive_data(host, data)
+      log.info "receive data ..."
+      if @hdr_parsed == false
+        # Do I need to consider the case the header is in separate receive data?
+        @hdr_buffer << data[0..11]
+        @remaining_len = hdr_parse()
+        @hdr_buffer = ""
+        data = data[12..-1] # remove header
+        @hdr_parsed = true
+      end
+      if data.length <= @remaining_len
+        @buffer << data
+        @remaining_len -= data.length
+        if @remaining_len == 0
+          data_parse()
+          @buffer = ""  # reset
+          @hdr_parsed = false
+        end
+      else # this happens when received data in fluentd tcp server contains multi telemetry messages.
+        @buffer << data[0..@remaining_len-1]
+        data_parse()
+        @buffer = ""  # reset
+        @hdr_parsed = false
+        receive_data(host, data[@remaining_len..-1])
+      end
+    end
+    def hdr_parse()
+      log.info "parse telemetry header ..."
+      msg_type = @hdr_buffer[0..1].unpack("n")[0]
+      msg_encap = @hdr_buffer[2..3].unpack("n")[0]
+      msg_hdr_ver = @hdr_buffer[4..5].unpack("n")[0]
+      msg_flag = @hdr_buffer[6..7].unpack("n")[0]
+      msg_len = @hdr_buffer[8..11].unpack("N")[0]
+      log.info "msg_type=#{msg_type} msg_encap=#{msg_encap} msg_hdr_ver=#{msg_hdr_ver} msg_flag=#{msg_flag} msg_len=#{msg_len}"
+      return msg_len
+    end
+    def data_parse()
+      log.info "parse telemetry data ..."
+      obj = JSON.parse(@buffer)
+      tag = obj['encoding_path']
+      es = MultiEventStream.new
+      for data in obj['data_json']
+        time = data['timestamp'] / 1000
+        obj = data['keys'].merge(data['content'])
+        record = nil
+        if @delete_nested
+          record = obj.reject { |k,v| v.is_a? Array }
+        else
+          record = obj
+        end
+        es.add(time, record)
+      end
+      router.emit_stream(tag, es)
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-telemetry-iosxr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tetsuhiro Sato
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Fluentd input plugin to collect IOS-XR telemetry.
+email:
+- tetsusat@cisco.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- fluent-plugin-telemetry-iosxr.gemspec
+- lib/fluent/plugin/in_telemetry_iosxr.rb
+homepage: https://github.com/tetsusat/fluent-plugin-telemetry-iosxr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Fluentd input plugin to collect IOS-XR telemetry.
+test_files: []