logstash-input-omada 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20f7bf2814a235d57e440942bacce366f8fb7f537c4082279d678661d2daaed6
+  data.tar.gz: 675681f2fe1026c2c199bc00e2e7d0bfff5e866c2989dd8502499ad813f909a7
+SHA512:
+  metadata.gz: f5f4edc7e563108ecffd4e32ce2fb3dcac36da7f823deb08c075e5be5f76bbf41354173d77173ebc27edd8928216cbb23ceb41e15b0005c12c2a6663d7560ae1
+  data.tar.gz: f844d8c2fbf5777e06d027246b055f38a4645c81db35c6eafd7934b439feddfeb69023bc2d36ca0372e433fc4df9be8488187f6a6de5ea12ba155b64480e3f26

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Matthew Haugen - mhaugen@haugenapplications.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-omada
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/main/CONTRIBUTING.md) file.

data/lib/logstash/inputs/omada.rb

@@ -0,0 +1,456 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+require "json"
+require "date"
+
+# Generate a repeating message.
+#
+# This plugin is intented only as an example.
+
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
+class OmadaInstance
+  def initialize(host, ssl, username, password)
+    if ssl
+      @session = Net::HTTP.start(host, 443, use_ssl: true)
+    else
+      @session = Net::HTTP.start(host, 80)
+    end
+
+    @cookies = nil
+    
+    @username = username
+    @password = password
+
+    @omadacId = nil
+    @token = nil
+  end
+
+  def get_omadacid
+    unless @omadacId
+      info = self.get_info
+      @omadacId = info["omadacId"]
+    end
+
+    return @omadacId
+  end
+
+  def get_token
+    unless @token
+      omadacid = self.get_omadacid
+
+      url = "/#{omadacid}/api/v2/login"
+
+      req = Net::HTTP::Post.new(url)
+      req.body = JSON.generate({
+        username: @username,
+        password: @password.value
+      })
+      req["Content-Type"] = "application/json"
+      
+      resp = @session.request(req)
+
+      @cookies = resp["Set-Cookie"]
+
+      resp_json = JSON.parse(resp.body)
+
+      @token = resp_json["result"]["token"]
+    end
+
+    return @token
+  end
+
+  def get_url(path, query_parameters = nil)
+    unless path.start_with?("/")
+        path = "/" + path
+    end
+
+    omadacid = self.get_omadacid
+
+    url = URI("/" + omadacid + path)
+
+    if query_parameters
+        url.query = URI.encode_www_form(query_parameters)
+    end
+
+    return url.to_s
+  end
+
+  def send_request(req)
+    req["Accept"] = "application/json"
+    req["Csrf-Token"] = self.get_token
+    req["Cookie"] = @cookies
+
+    resp = @session.request(req)
+
+    resp_json = JSON.parse(resp.body)
+
+    error_code = resp_json["errorCode"]
+
+    unless error_code == 0
+        raise "invalid response from '#{req.uri}': " + resp.body
+    end
+
+    return resp_json["result"]
+  end
+
+  def enumerate_pages(path)
+    max_page = 1
+    per_page = 100
+    
+    results = []
+    
+    page = 0
+    while page < max_page
+      page = page + 1
+      
+      query_parameters = {
+          "currentPage": page,
+          "currentPageSize": per_page
+      }
+
+      result = self.send_request(Net::HTTP::Get.new(self.get_url(path, query_parameters)))
+
+      total_rows = result["totalRows"]
+      max_page = (total_rows / per_page).to_int + 1
+      
+      results.concat(result["data"])
+    end
+
+    return results
+  end
+
+  def get_info
+    
+    req = Net::HTTP::Get.new("/api/info")
+      
+    resp = @session.request(req)
+
+    resp_json = JSON.parse(resp.body)
+
+    return resp_json["result"]
+  end
+
+  def get_current_user
+    resp = self.send_request(Net::HTTP::Get.new(self.get_url("/api/v2/users/current")))
+
+    return resp
+  end
+  
+  def get_sites
+    current_user = self.get_current_user
+
+    current_user["privilege"]["sites"].map { |site|
+      OmadaSite.new(self, site["key"], site["name"])
+    }
+  end
+
+  def dispose
+    @session.finish
+  end
+end
+
+class OmadaSite
+  def initialize(omada_instance, site_key, site_name)
+    @omada_instance = omada_instance
+    @site_key = site_key
+    @site_name = site_name
+  end
+
+  def get_site_name
+    return @site_name
+  end
+
+  def get_site_key
+    return @site_key
+  end
+
+  def get_url(subpath, query_parameters = nil)
+    unless subpath.start_with?("/")
+        subpath = "/" + subpath
+    end
+    
+    return @omada_instance.get_url("/api/v2/sites/" + @site_key + subpath, query_parameters)
+  end
+  
+  def send_request(req)
+    resp = @omada_instance.send_request(req)
+
+    return resp
+  end
+
+  def enumerate_pages(subpath)
+    unless subpath.start_with?("/")
+        subpath = "/" + subpath
+    end
+    
+    return @omada_instance.enumerate_pages("/api/v2/sites/" + @site_key + subpath)
+  end
+
+  def get_all_clients
+    return self.enumerate_pages("/clients")
+  end
+
+  def get_all_devices
+    result = self.send_request(Net::HTTP::Get.new(self.get_url("/devices")))
+
+    return result
+  end
+
+  def get_all_events
+    return self.enumerate_pages("/events")
+  end
+
+  def get_client_distribution
+    return self.send_request(Net::HTTP::Get.new(self.get_url("/dashboard/clientsFreqDistribution")))
+  end
+
+  def get_association_failure_statistics
+    return self.send_request(Net::HTTP::Get.new(self.get_url("/dashboard/associationFailures")))
+  end
+
+  def get_latest_isp_load(to = nil, from = nil)
+    unless to
+      to = DateTime.now
+    end
+
+    unless from
+      from = to - 1
+    end
+
+    resp = self.send_request(Net::HTTP::Get.new(self.get_url("/dashboard/ispLoad", {
+      start: from.to_time.to_i,
+      end: to.to_time.to_i
+    })))
+
+    ret = []
+    resp.each { |port|
+        last = port["data"].last
+
+        if last
+            ret.append({
+                port: {
+                    id: port["portId"],
+                    name: port["portName"]
+                },
+                totalRate: last["totalRate"],
+                latency: last["latency"],
+                time: last["time"]
+            })
+        end
+    }
+
+    return ret
+  end
+
+  def get_latest_speed_tests(to = nil, from = nil)
+    unless to
+      to = DateTime.now
+    end
+
+    unless from
+      from = to - 1
+    end
+
+    req = Net::HTTP::Post.new(self.get_url("/stat/wanSpeeds"))
+    req.body = JSON.generate({
+      start: from.to_time.to_i,
+      end: to.to_time.to_i
+    })
+    req["Content-Type"] = "application/json"
+    
+    resp = self.send_request(req)
+
+    last = resp.last
+    
+    ret = []
+    
+    if last
+      last["ports"].each { |port|
+        ret.append({
+          time: last["time"],
+          port: {
+              id: port["portId"],
+              name: port["name"]
+          },
+          latencyMs: port["latency"],
+          downloadBandwidthMbps: port["down"],
+          uploadBandwidthMbps: port["up"]
+        })
+      }
+    end
+
+    return ret
+  end
+end
+
+class LogStash::Inputs::Omada < LogStash::Inputs::Base
+  config_name "omada"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain"
+
+  # The host string to use in the event.
+  config :server, :validate => :string
+  config :ssl, :validate => :boolean
+
+  config :username, :validate => :string
+  config :password, :validate => :password
+
+  # Set how frequently messages should be sent.
+  #
+  # The default, `60`, checks once a minute.
+  config :interval, :validate => :number, :default => 60
+
+  private
+  def get_site_hash(site)
+    return {
+      name: site.get_site_name,
+      key: site.get_site_key
+    }
+  end
+  
+  def apply_association_failure_statistics(site, queue)
+    association_failure_statistics = site.get_association_failure_statistics
+    
+    site_hash = get_site_hash(site)
+    
+    omada = {
+        site: site_hash,
+        associationFailureStatistics: association_failure_statistics
+    }
+    
+    event = LogStash::Event.new("omada" => omada, "tags" => ["omada.association_failure_statistics"])
+    decorate(event)
+    queue << event
+  end
+
+  def apply_latest_isp_load(site, queue)
+    now = DateTime.now
+
+    isp_load_ports = site.get_latest_isp_load(now, @next_isp_load_since)
+
+    unless isp_load_ports.empty?
+      @next_isp_load_since = now
+      
+      site_hash = get_site_hash(site)
+      
+      isp_load_ports.each { |isp_load_port|
+          omada = {
+            site: site_hash,
+            ispLoad: isp_load_port
+          }
+          
+          timestamp = Time.at(isp_load_port.delete(:time)).utc.iso8601
+          
+          event = LogStash::Event.new("@timestamp" => timestamp, "omada" => omada, "tags" => ["omada.isp_load"])
+          decorate(event)
+          queue << event
+      }
+    end
+  end
+
+  def apply_latest_speed_tests(site, queue)
+    now = DateTime.now
+
+    speed_test_ports = site.get_latest_speed_tests(now, @next_speed_tests_since)
+    
+    unless speed_test_ports.empty?
+      @next_speed_tests_since = now
+      
+      site_hash = get_site_hash(site)
+      
+      speed_test_ports.each { |speed_test_port|
+          omada = {
+            site: site_hash,
+            speedTest: speed_test_port
+          }
+
+          timestamp = Time.at(speed_test_port.delete(:time)).utc.iso8601
+          
+          event = LogStash::Event.new("@timestamp" => timestamp, "omada" => omada, "tags" => ["omada.speed_test"])
+          decorate(event)
+          queue << event
+      }
+    end
+  end
+  
+  def apply_client_distribution(site, queue)
+    site_hash = get_site_hash(site)
+
+    client_distribution = site.get_client_distribution
+    
+    omada = {
+      site: site_hash,
+      clientDistribution: client_distribution
+    }
+    
+    event = LogStash::Event.new("omada" => omada, "tags" => ["omada.client_distribution"])
+    decorate(event)
+    queue << event
+  end
+  
+  def apply_devices(site, queue)
+    site_hash = get_site_hash(site)
+
+    site.get_all_devices.each { |device|
+        omada = {
+          site: site_hash,
+          device: device
+        }
+        
+        event = LogStash::Event.new("omada" => omada, "tags" => ["omada.device"])
+        decorate(event)
+        queue << event
+    }
+  end
+  
+  def apply_clients(site, queue)
+    site_hash = get_site_hash(site)
+    
+    site.get_all_clients.each { |client|
+        omada = {
+          site: site_hash,
+          client: client
+        }
+        
+        event = LogStash::Event.new("omada" => omada, "tags" => ["omada.client"])
+        decorate(event)
+        queue << event
+    }
+  end
+  
+  public
+  def register
+    @host = Socket.gethostname
+
+    @logger.info("Connecting to Omada API", :server => @server)
+    @omada_instance = OmadaInstance.new(@server, @ssl, @username, @password)
+  end # def register
+
+  def run(queue)
+    # we can abort the loop if stop? becomes true
+    while !stop?
+      @omada_instance.get_sites.each { |site|
+        apply_clients(site, queue)
+        apply_devices(site, queue)
+        apply_client_distribution(site, queue)
+        apply_association_failure_statistics(site, queue)
+        apply_latest_isp_load(site, queue)
+        apply_latest_speed_tests(site, queue)
+      }
+
+      # because the sleep interval can be big, when shutdown happens
+      # we want to be able to abort the sleep
+      # Stud.stoppable_sleep will frequently evaluate the given block
+      # and abort the sleep(@interval) if the return value is true
+      Stud.stoppable_sleep(@interval) { stop? }
+    end # loop
+  end # def run
+
+  def stop
+    @omada_instance.dispose
+  end
+end # class LogStash::Inputs::Omada

data/logstash-input-omada.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-input-omada'
+  s.version       = '0.1.1'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Poll Omada API for clients, devices, and statistics.'
+  s.description   = 'Poll Omada API for clients, devices, and statistics.'
+  s.homepage      = 'https://www.haugenapplications.com'
+  s.authors       = ['Matthew Haugen']
+  s.email         = 'mhaugen@haugenapplications.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '>= 0.0.22'
+  s.add_development_dependency 'logstash-devutils', '>= 0.0.16'
+end

data/spec/inputs/omada_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/omada"
+
+describe LogStash::Inputs::Omada do
+
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) { { "interval" => 100 } }
+  end
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-omada
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matthew Haugen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+description: Poll Omada API for clients, devices, and statistics.
+email: mhaugen@haugenapplications.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/omada.rb
+- logstash-input-omada.gemspec
+- spec/inputs/omada_spec.rb
+homepage: https://www.haugenapplications.com
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Poll Omada API for clients, devices, and statistics.
+test_files:
+- spec/inputs/omada_spec.rb