lmcadm 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63b0185b4a3704220282ed6b280a11aa6c0f49dff2c55a338cfbbbde6c293907
-  data.tar.gz: ccf161a096edf045d834ee2499a969ce9558b72865b36c121451fc7750828164
+  metadata.gz: 38c8fafe1ca6ada1a72b6d9e77d3c356c2ebfe59951494ce39df0264551493d9
+  data.tar.gz: 25c529b60448aabcab330df1b6827179a914cbf51e23e91dbdd70c8df6221413
 SHA512:
-  metadata.gz: 56509284ac20bcca673af8f859ed899b0326e47df49a474360e8ade103ee9301286a7384cd62658f9d0179490d194593162395c7aa22ad894aad2ea8c1efe413
-  data.tar.gz: ae3da55d02222591973f88ef6113bc788281b7bd93d280137d4fbe177499704c3cbff7b38457e6dcdab48ef31e10bbcd70b0902061f4b267f41036de6e492467
+  metadata.gz: df4eeae40e1204dcb9cf34974db6f5ee96ea39929a4bb6f0a8991f968d937def265ce304a6398ed78b007594726cf60307304d0098e7ca0ac3d6c1d98793cef3
+  data.tar.gz: 5ac6a4adc086263d8d06fe8e76c7c200b5c4ca65a53df89d003bfca74d74ddf53f94806e7590ba789a1625bd86158f3aec989f7c2120104a4b5179808d941777

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

@@ -1,8 +1,13 @@
 name: build-win
 on:
-  push:
-    tags:
-      - 'v*.*.*'
+  release:
+    types:
+      - published
+
+#  push:
+#    tags:
+#      - 'v*.*.*'
+
 jobs:
   build:
     runs-on: windows-latest

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,35 @@ 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
+
+
+    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].
+
+    lmcadm monitor -A "SDN-DEMO (LANCOM Visitor)" raw --type json --period MINUTE1 \
+      wan_info_json interfaces a6871a81-84f3-4c57-a20e-c3410b47e895  | jq ' .[]["DSL-CH-1"].rxRate'
+
+# Footnotes
+[1] https://stedolan.github.io/jq/manual/

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,50 @@ 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,
+        }
+        monitordata = result.body.items[name]
+        puts result.body.inspect if _g[:debug]
+        if options[:type] == "scalar"
+          puts monitordata.values
+        elsif options[:type] == "json"
+          puts JSON.pretty_generate monitordata.to_h[:values]
+        end
+      end
+
+    end
+
   end
 end

data/lib/lmcadm/version.rb

@@ -1,3 +1,3 @@
 module LMCAdm
-  VERSION = '0.16.2'
+  VERSION = '0.17.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lmcadm
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.0
 platform: ruby
 authors:
 - erpel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2021-06-17 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
@@ -145,7 +159,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/build-win.yaml"
-- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".idea/encodings.xml"
 - ".idea/inspectionProfiles/Project_Default.xml"

data/.github/workflows/gem-push.yml

@@ -1,45 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-
-    - name: Publish to GPR
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-      env:
-        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
-        OWNER: ${{ github.repository_owner }}
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"