lmcadm 0.16.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a453803697879b159426c5b7a1b88c8eacdc8cb8b1913c1a1eb3997133ad21b9
-  data.tar.gz: 48fcd4dddff59446833f468fc93e2d942cdf37b940d9a3c91f466981fa7a9a71
+  metadata.gz: 8e0ecc30a7bc65586b2e252af05a701c4facd81c950378d147ccdf1583ee4dac
+  data.tar.gz: a807ad57a2d8d40419b2cf28e0ba997ba800ce6113f496e950c8be6dfa5c95bd
 SHA512:
-  metadata.gz: 00d7640ab1100bc653a6717803a0b469950ad930f7b897997da4b778cb4835921c8ee2a5cbc3ca6303c7bd072a41b752aaada5bb91eb96111b2389b058da0fe1
-  data.tar.gz: 6ab293d8bb3a987243d6a57eae982eb1d7ac1bec6d04d6dce0aadb22ae9a1d84779528e49c50a43808a1a0d735af85b597b779fad620bfb3d9ff7eff80b41ddc
+  metadata.gz: cc6a607055a7c4a02245df5eae5110ed7dc874a3cdd14dc16280082a9066a27f25563fd5a0b95dfc7afdd1a28eaf92531ae0dd1bc7fc776ce6e081693ce63606
+  data.tar.gz: 451a67308f2a0b4420e667019272e33f1a23ee4d2bcf07a56d8ff3d4ccc23fad364cca5a7928010b259ac81fd86db0e658ac3f3845b78672ffa7c0fb39a351a1

data/.github/workflows/build-win.yaml

@@ -0,0 +1,35 @@
+name: build-win
+on:
+  release:
+    types:
+      - published
+
+#  push:
+#    tags:
+#      - 'v*.*.*'
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+      - run: gem install eventmachine --platform ruby
+      - run: gem install ocra lmcadm
+      - run: ruby makeocragemfile.rb
+      - run: ocra --gemfile ocra_gemfile --gem-full exe/lmcadm
+      - name: Setup tmate session
+        uses: mxschmitt/action-tmate@v3
+        if: false
+      - run: ./lmcadm.exe --version
+      - uses: papeloto/action-zip@v1
+        with:
+          files: lmcadm.exe LICENSE.txt
+          dest: lmcadm-${{ github.event.release.tag_name }}-win.zip
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: lmcadm-${{ github.event.release.tag_name }}-win.zip
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

data/README.md

@@ -20,6 +20,11 @@ Lmcadm works with https://rubyinstaller.org/downloads/, use the recommended vers
 Installation can continue with rubygems.
 
 #### Known issues
+*Installing lmcadm fails with `ERROR: Failed to build gem native extension.`*
+
+Ruby headers and some tools to build software (C compiler, make) are needed.
+On Ubuntu for example, the packages `ruby-dev` and `build-essential` should be enough.
+    apt install ruby-dev build-essential
 
 *Unable to load the EventMachine C extension ; To use the pure-ruby reactor, require 'em/pure_ruby'*
 
@@ -59,3 +64,53 @@ The sentence above is patently wrong currently.
 ## License
 
 The gem is available as open source under the terms of the BSD 3-Clause License.
+
+# Advanced usage or experimental features
+
+## Using lmcadm to query monitoring data
+
+Example use:
+
+    lmcadm monitor -A "ExampleProject" raw device_info cloud_rtt 42adf60b-0fe7-4187-af4f-9ee97669bfb0
+
+### --type scalar (default)
+
+When specifying a period longer than MINUTE1, the name must be suffixed with a dot, followed by an aggregation type.
+Available types are
+* .min
+* .max
+* .avg
+
+Example use:
+
+    $ lmcadm monitor -A "ExampleProject" raw --type scalar --period MINUTE10 \
+        device_info cloud_rtt.max 3e19ada7-86fa-4809-a14e-7174b018603d
+
+
+### --type json
+
+This dumps the raw values response as json.
+To further extract data, use something that can parse json, like `jq`[1].
+
+Example use:
+
+    $lmcadm monitor -A "ExampleProject" raw --type json --period MINUTE1 \
+       wan_info_json interfaces a6871a81-84f3-4c57-a20e-c3410b47e895  | jq ' .[]["DSL-CH-1"].rxRate'
+
+### --type table
+
+Prints table data as one row per sample.
+Empty row handling is shaky, as is error handling in general.
+
+    $ lmcadm  monitor -A "ExampleProject" raw --type table device_info \
+       device 3a096938-87b4-47c8-a388-fda75f30eacc
+    CLOUD_RTT | CPU_LOAD | UPTIME   | TOTAL_MEMORY | FREE_MEMORY | CONTROL_RX | CONTROL_TX | MONITORING_RX | MONITORING_TX
+    ----------|----------|----------|--------------|-------------|------------|------------|---------------|--------------
+    29        | 1        | 19512712 | 248064       | 27228       | 513704725  | 291602474  | 119108008     | 936963871    
+    29        | 0        | 19512652 | 248064       | 27228       | 513701635  | 291600722  | 119107296     | 936957306    
+    30        | 1        | 19512592 | 248064       | 27228       | 513698545  | 291598970  | 119106584     | 936950729    
+    77        | 6        | 19512533 | 248064       | 27228       | 513695455  | 291597218  | 119105872     | 936944149    
+    ...
+
+# Footnotes
+[1] https://stedolan.github.io/jq/manual/

data/lib/lmcadm/account_commands.rb

@@ -262,21 +262,18 @@ module LMCAdm
         account = LMC::Account.get_by_uuid_or_name(options[:account])
         account.cloud.auth_for_account account
         membership = account.find_member_by_name args.first
-        puts "membership class: #{membership.class}"
-        puts "membership.authorities first class: #{membership.authorities.first.class}"
-
-        #real_membership = LMC::Membership.new membership
-        #puts real_membership.inspect
-
-
-        puts membership if global_options[:verbose]
+        if global_options[:verbose]
+          puts "membership class: #{membership.class}"
+          puts "membership.authorities first class: #{membership.authorities.first.class}"
+          puts membership
+        end
         authority_ids = membership.authorities.map do |a|
           a.id
         end
         puts "Existing authority ids: #{authority_ids}"
         if options['add-authority']
           add_str = options['add-authority']
-          new_authority = Helpers::find_by_id_or_name membership.authorities, add_str
+          new_authority = Helpers::find_by_id_or_name account.authorities, add_str
           authority_ids = authority_ids.concat [new_authority.id]
           puts "Adding #{authority_ids}"
         end

data/lib/lmcadm/cloud_commands.rb

@@ -86,6 +86,7 @@ module LMCAdm
         accounts = args.map { |a|
           LMC::Account.get_by_uuid_or_name a
         }
+        puts LMC::Cloud.instance.session_token if accounts.empty?
         accounts.each { |a|
           a.cloud.auth_for_account a
           puts a.cloud.session_token

data/lib/lmcadm/commands/monitor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'chronic'
 
 module LMCAdm #:nodoc:
   desc 'Retrieve montoring data'
@@ -15,7 +16,7 @@ module LMCAdm #:nodoc:
       monitor_device.action do |_g, options, args|
         record_name = args.shift
         account = LMC::Account.get_by_uuid_or_name options[GLI::Command::PARENT][:account]
-        device = account.devices.find {|d| d.name == options[:device]}
+        device = account.devices.find { |d| d.name == options[:device] }
         record = device.record record_name
 
         options[:scalar].each do |datapoint|
@@ -48,5 +49,72 @@ module LMCAdm #:nodoc:
         end
       end
     end
+
+    monitor.desc 'Make raw monitoring requests'
+    monitor.arg_name '<record> <name> <id>'
+    monitor.command :raw do |raw|
+      raw.flag :t, :type, default_value: 'scalar'
+      raw.flag :g, :group, default_value: 'DEVICE'
+      raw.flag :p, :period, default_value: 'MINUTE1'
+      raw.desc 'Start time'
+      raw.flag :start, default_value: 'one hour ago'
+      raw.flag :end, default_value: 'now'
+      raw.action do |_g, options, args|
+        record = args.shift
+        name = args.shift
+        groupId = args.shift
+        account = LMC::Account.get_by_uuid_or_name options[GLI::Command::PARENT][:account]
+        account.cloud.auth_for_account account
+
+        startTime = Chronic.parse(options[:start])
+        puts "Start time: #{startTime}" if _g[:verbose]
+        endTime = Chronic.parse(options[:end])
+        puts "End time: #{endTime}" if _g[:verbose]
+
+        # https://cloud.lancom.de/cloud-service-monitoring/accounts/399bc33a-7f53-4757-a6bd-cac3cbb6ebdd/records/wlan_info_json?type=scalar&name=stations&group=ACCOUNT&groupId=399bc33a-7f53-4757-a6bd-cac3cbb6ebdd&period=MINUTE1&start=1623417748&end=1623421348
+        # https://cloud.lancom.de/cloud-service-monitoring/accounts/399bc33a-7f53-4757-a6bd-cac3cbb6ebdd/records/device_info?type=scalar&name=cloud_rtt&group=DEVICE&groupId=efec12e1-ac4d-459d-bb5d-a9b6c1410eb5&period=MINUTE1&start=1623419874&end=1623423474
+        # https://cloud.lancom.de/cloud-service-monitoring/accounts/399bc33a-7f53-4757-a6bd-cac3cbb6ebdd/records/device_info?type=scalar&name=cloud_rtt&group=DEVICE&group_id=efec12e1-ac4d-459d-bb5d-a9b6c1410eb5&period=MINUTE1&start=1623419874&end=1623423474
+        result = account.cloud.get ['cloud-service-monitoring', 'accounts', account.id, 'records', record], {
+          type: options[:type],
+          name: name,
+          group: options[:group],
+          groupId: groupId,
+          period: options[:period],
+          start: startTime.to_i,
+          end: endTime.to_i,
+        }
+        base_timestamp = result.body.base
+        delta = result.body.delta
+        monitordata = result.body.items[name]
+        puts result.body.inspect if _g[:debug]
+        if options[:type] == 'scalar'
+          table_data = monitordata.values.map.with_index { |value, row_index|
+            {
+              timestamp: DateTime.strptime((base_timestamp + delta * (monitordata.values.length - row_index)).to_s,'%s'),
+              value: value,
+            }
+          }
+          tp table_data
+        elsif options[:type] == 'json'
+          puts JSON.pretty_generate monitordata.to_h[:values]
+        elsif options[:type] == 'table'
+          table_data = monitordata.values.map.with_index { |v, row_index|
+            hash = { timestamp: DateTime.strptime((base_timestamp + delta * (monitordata.values.length - row_index)).to_s,'%s') }
+            unless v.nil?
+              row = v.first
+              monitordata.keys.each_with_index { |k, column_index|
+                unless row[column_index].nil?
+                  hash[k] = v.first[column_index]
+                end
+              }
+            end
+            hash
+          }
+          tp table_data
+        end
+      end
+
+    end
+
   end
 end

data/lib/lmcadm/version.rb

@@ -1,3 +1,3 @@
 module LMCAdm
-  VERSION = '0.16.1'
+  VERSION = '0.19.0'
 end

data/lmcadm.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'table_print', '~> 1.5'
   spec.add_runtime_dependency 'colorize', '~> 0.8'
   spec.add_runtime_dependency 'websocket-eventmachine-client', '~> 1.3.0'
+  spec.add_runtime_dependency 'chronic', '~> 0.10.2'
 end

data/makeocragemfile.rb

@@ -4,7 +4,7 @@ GEMFILE = 'ocra_gemfile'
 # Add gems from gemspec.
 ocra_gemfile = File.new(GEMFILE, 'w')
 File.open("lmcadm.gemspec",'r') do |file|
-  file.each { |line| ocra_gemfile.write "gem #{$1}\n" if line =~ /spec.add_.*dependency (.+)/ }
+  file.each { |line| ocra_gemfile.write "gem #{$1}\n" if line =~ /spec.add_runtime_dependency (.+)/ }
 end
 ocra_gemfile.close
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lmcadm
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.19.0
 platform: ruby
 authors:
 - erpel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
 description:
 email:
 - philipp@copythat.de
@@ -144,6 +158,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build-win.yaml"
 - ".gitignore"
 - ".idea/encodings.xml"
 - ".idea/inspectionProfiles/Project_Default.xml"