cloudcost 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b5926bdf2873133e1d8b85b04c56210a6ee1a886a233693527462d5747d43ee
-  data.tar.gz: d9ac68dc18b82a7925134099d99bbf8abfa1f9cee540a4c2cc23932ed1c6ebab
+  metadata.gz: f3d45a2bcff555d702572b129ad9031b4b5b62224715243d10a39185d044df5e
+  data.tar.gz: 14f89c7052221999e1781b7f7658137902542df9d0012ac903e7b9403fb448f6
 SHA512:
-  metadata.gz: f466284d61657746d4e31f56e8a3c4f96bcf930460bcfb9f87a578c13c5edbd56ef302f3dd31608b0af99e580205416c8885e0c85edec1caf9de6abf6d682fba
-  data.tar.gz: f9941021d5ecc30c31b5453e72074eefc57c12c9570b9e3489ac45450d896d79136f343bc22235a1c6a3f1776ce2cd8d440436b5f69e4f6d2218324522222bd5
+  metadata.gz: df8b5eeae07ab0bd56f0ab0616467b8e2a4dcf11b9bd2c5da4dae9cab1fffb82b05c6c4ec19c499566ccfa2af4d7763ea988ee5b8c2c9120a3d6f2bf5438e996
+  data.tar.gz: 92e260d8d279a4b4b7c5863565579233794e30a4a602408237252f7b627f7b1c04d0779282b8618d64c14411a52d7565e9e7963c7c07a430574c56614ea6c6d2

data/.gitignore

@@ -1,5 +1,6 @@
 
 vendor
 pkg
+data
 .bundle
 cloudscale.ini

data/README.md

@@ -7,12 +7,12 @@ Resources are fetched from the [API](https://www.cloudscale.ch/en/api/v1) and co
 Please note that costs are always calculated based on the current usage.
 Your actual bills are based on the effective usage over time and may include additional service fees, i.e. for data transfer or discounts.  
 
-## Setup
+## Installation
 
-Ruby is required, install dependencies using bundler:
+Install the gem:
 
 ```sh
-bundle install
+gem install cloudcost
 ```
 
 ## Configure API-Auth
@@ -30,8 +30,6 @@ export CLOUDSCALE_API_TOKEN=HELPIMTRAPPEDINATOKENGENERATOR
 
 or you can directly pass a token as a argument to the command: `--api-token HELPIMTRAPPEDINATOKENGENERATOR`
 
-**NOTE:** The API_TOKEN does only require read access.
-
 ## Usage
 
 ### Help
@@ -66,7 +64,30 @@ Only show summarized usage:
 cloudcost servers --summary
 ```
 
-#### Output CSV
+#### Group and summarize by tag
+
+By using the `--tag-by` option, you can summarize usage by tag:
+
+```sh
+cloudcost servers --group-by budget-group
+```
+
+#### Influx Line Protocol output
+
+The CLI also supports output in Influxdb Line Protocol format when using the `--group-by` option:
+
+```sh
+cloudcost servers --group-by budget-group --output influx
+```
+
+The output can directly ba pipped to the influxdb CLI:
+
+```sh
+cloudcost servers --group-by budget-group --profile prod | \
+influx write --bucket my-bucket --org my-org --token my-super-secret-auth-token
+```
+
+#### CSV Output
 
 Output in CSV format instead of a table:
 
@@ -91,13 +112,13 @@ cloudcost servers --name "^[^ocp|^k8s|^rancher].*"
 Filter servers by tag key:
 
 ```sh
-cloudcost servers --tag pitc_service
+cloudcost servers --tag service
 ```
 
 Filter servers by tag value:
 
 ```sh
-cloudcost servers --tag pitc_service=ocp4
+cloudcost servers --tag service=ocp4
 ```
 
 ### Server Tags

data/lib/cloudcost/cli.rb

@@ -30,14 +30,16 @@ module Cloudcost
     option :name, desc: "filter name by regex", aliases: %w[-n]
     option :tag, desc: "filter servers by tag", aliases: %w[-t]
     option :summary, desc: "display totals only", type: :boolean, aliases: %w[-S]
-    option :output, default: "table", enum: %w[table csv], desc: "output format", aliases: %w[-o]
+    option :group_by, desc: "group by tag", aliases: %w[-G]
+    option :output, default: "table", enum: %w[table csv influx], desc: "output format", aliases: %w[-o]
     def servers
       servers = load_servers(options)
-      spinner = TTY::Spinner.new("[:spinner] Calculating costs...", clear: options[:csv])
-      spinner.auto_spin
+      if options[:output] == "table"
+        spinner = TTY::Spinner.new("[:spinner] Calculating costs...", clear: options[:csv])
+        spinner.auto_spin
+      end
       output(servers, options) do |result|
-        spinner.success "(done)"
-        puts
+        spinner.success("(done)") if spinner
         puts result
       end
     rescue Excon::Error, TokenError, ProfileError, PricingError => e
@@ -108,15 +110,19 @@ module Cloudcost
       end
 
       def load_servers(options)
-        spinner = TTY::Spinner.new("[:spinner] Loading servers...", clear: options[:csv])
-        spinner.auto_spin
+        if options[:output] == "table"
+          spinner = TTY::Spinner.new("[:spinner] Loading servers...", clear: options[:csv])
+          spinner.auto_spin
+        end
         servers = api_connection(options).get_servers(options).map { |server| Server.new(server) }
-        spinner.success "(#{servers.size} found)"
+        spinner.success "(#{servers.size} found)" if spinner
         servers
       end
 
       def output(servers, options)
-        if options[:output] == "csv"
+        if options[:group_by]
+          yield Cloudcost::ServerList.new(servers, options).grouped_cost_table
+        elsif options[:output] == "csv"
           yield Cloudcost::ServerList.new(servers, options).to_csv
         else
           yield Cloudcost::ServerList.new(servers, options).cost_table

data/lib/cloudcost/pricing.rb

@@ -2,7 +2,9 @@
 
 require "yaml"
 
-PRICING = YAML.load_file("data/pricing.yml")
+PRICING = YAML.load_file( File.join(
+  File.expand_path("../..", __dir__), "data/pricing.yml")
+)
 
 module Cloudcost
   class PricingError < StandardError

data/lib/cloudcost/server.rb

@@ -8,6 +8,8 @@ module Cloudcost
   end
 
   class Server
+    attr_accessor :data
+
     def initialize(data)
       @data = data
       @total_storage_per_type = sum_up_storage_per_type
@@ -33,6 +35,10 @@ module Cloudcost
       @data[:flavor][:memory_gb]
     end
 
+    def volumes
+      @data[:volumes]
+    end
+
     def tags
       @data[:tags]
     end
@@ -46,7 +52,7 @@ module Cloudcost
     end
 
     def server_costs_per_day
-      Pricing.server_costs_per_day(@data[:flavor][:slug])
+      Pricing.server_costs_per_day(flavor)
     end
 
     def storage_costs_per_day(type = :ssd)
@@ -59,7 +65,7 @@ module Cloudcost
 
     def sum_up_storage_per_type
       sum = {}
-      @data[:volumes].group_by { |volume| volume[:type].itself }.each do |group, vols|
+      volumes.group_by { |volume| volume[:type].itself }.each do |group, vols|
         sum.store(group.to_sym, 0)
         vols.each { |volume| sum[volume[:type].to_sym] += volume[:size_gb] }
       end

data/lib/cloudcost/server_list.rb

@@ -7,9 +7,9 @@ module Cloudcost
       @options = options
     end
 
-    def calculate_totals
+    def calculate_totals(servers = @servers)
       totals = { vcpu: 0, memory: 0, ssd: 0, bulk: 0, cost: 0.0 }
-      @servers.each do |server|
+      servers.each do |server|
         totals[:vcpu] += server.vcpu_count
         totals[:memory] += server.memory_gb
         totals[:ssd] += server.storage_size(:ssd)
@@ -20,33 +20,37 @@ module Cloudcost
     end
 
     def headings
-      headings = @options[:summary] ? [""] : %w[Name UUID Flavor Tags]
+      headings = if @options[:summary]
+        [""]
+      elsif @options[:group_by]
+        ["Group",  "Servers"]
+      else
+        %w[Name UUID Flavor Tags]
+      end
       headings.concat ["vCPU's", "Memory [GB]", "SSD [GB]", "Bulk [GB]", "CHF/day", "CHF/30-days"]
     end
 
     def rows
       rows = []
-      unless @options[:summary]
-        @servers.sort_by(&:name).map do |server|
-          rows << [
-            server.name,
-            server.uuid,
-            server.flavor,
-            server.tags_to_s,
-            server.vcpu_count,
-            server.memory_gb,
-            server.storage_size(:ssd),
-            server.storage_size(:bulk),
-            format("%.2f", server.total_costs_per_day.round(2)),
-            format("%.2f", (server.total_costs_per_day * 30).round(2))
-          ]
-        end
+      @servers.sort_by(&:name).map do |server|
+        rows << [
+          server.name,
+          server.uuid,
+          server.flavor,
+          server.tags_to_s,
+          server.vcpu_count,
+          server.memory_gb,
+          server.storage_size(:ssd),
+          server.storage_size(:bulk),
+          format("%.2f", server.total_costs_per_day.round(2)),
+          format("%.2f", (server.total_costs_per_day * 30).round(2))
+        ]
       end
       rows
     end
 
-    def totals
-      totals = calculate_totals
+    def totals(servers = @servers)
+      totals = calculate_totals(servers)
       total_row = @options[:summary] ? %w[Total] : ["Total", "", "", ""]
       total_row.concat [
         totals[:vcpu],
@@ -88,6 +92,58 @@ module Cloudcost
       table
     end
 
+    def grouped_cost_table
+      no_tag = "<no-tag>"
+      group_rows = @servers.group_by {|s| s.tags[@options[:group_by].to_sym] || no_tag }.map do |name, servers|
+        server_groups_data(name, servers).values.flatten
+      end.sort {|a, b| a[0] == no_tag ? 1 : a[0] <=> b[0] }
+      if @options[:output] == "csv"
+        CSV.generate do |csv|
+          csv << headings
+          group_rows.each { |row| csv << row }
+        end
+      elsif @options[:output] == "influx"
+        lines = []
+        group_rows.each do |row|
+          [
+            { field: "server_count", position: 1, unit: "i" },
+            { field: "vcpus", position: 2, unit: "i" },
+            { field: "memory_gb", position: 3, unit: "i" },
+            { field: "ssd_gb", position: 4, unit: "i" },
+            { field: "bulk_gb", position: 5, unit: "i" },
+            { field: "cost_per_day", position: 6, unit: "" },
+          ].each do |field| 
+            lines << "cloudscaleServerCosts,grouped_by=#{@options[:group_by]},group=#{row[0]},environment=#{@options[:profile] || "default"},currency=CHF #{field[:field]}=#{row[field[:position]]}#{field[:unit]}"
+          end
+        end
+        lines.join("\n")
+      else
+        table = Terminal::Table.new do |t|
+          t.title = "cloudscale.ch server costs grouped by tag \"#{@options[:group_by]}\""
+          t.title += " (#{@options[:profile]})" if @options[:profile]
+          t.headings = headings
+        end
+        table.rows = group_rows
+        (1..table.columns.size).each { |column| table.align_column(column, :right) }
+        table
+      end
+    end
+
+    def server_groups_data(name, servers)
+      data = { name: name, count: 0, vcpu: 0, memory: 0, ssd: 0, bulk: 0, costs_daily: 0 }
+      servers.each do |server|
+        data[:count] += 1
+        data[:vcpu] += server.vcpu_count
+        data[:memory] += server.memory_gb
+        data[:ssd] += server.storage_size(:ssd)
+        data[:bulk] += server.storage_size(:bulk)
+        data[:costs_daily] += server.total_costs_per_day
+      end
+      data[:costs_monthly] = (data[:costs_daily] * 30).round(2)
+      data[:costs_daily] = data[:costs_daily].round(2)
+      data
+    end
+
     def to_csv
       CSV.generate do |csv|
         csv << headings
@@ -98,5 +154,6 @@ module Cloudcost
         end
       end
     end
+
   end
 end

data/lib/cloudcost/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudcost
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudcost
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nik Wolfgramm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon