jcf 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dc40224058bf16a626b143c430840d71b08e7c40c2075cc4bb37792fd2c578c
-  data.tar.gz: 170d182549a2b12db87edcf56fb6d8303614c7b7a6448ee45fa81b08ea48e9fe
+  metadata.gz: f9477e6264cb699c3505cfe016acb802bff09e9c71fe98072ea9a1598a021119
+  data.tar.gz: 05a70e89d7593faa6308a6d0b78d03a3990466dae549a8343625288bf104a4ea
 SHA512:
-  metadata.gz: 0616d831613106555a42498d7b578675e72187deac999d92ea460458c3ae345f18b1439429bd354d03e0b9dd8e265c388e7170e6bf21ae344fe13966076f39f7
-  data.tar.gz: bf2190ff13ffcfe11195d7bc03f6a5c6b652e9aa3019d2973ef1b4fba6db1abe5c923191444ecae17a3ccb5e1b09b3d0112e60427b40f8438f9151b2c2c53f7c
+  metadata.gz: ec4fa652bb3341babc362145fe150e9418944e3b5c2d5aeb2b798c7d82af39849a3c467b1432941638a9c4b0650f468b56c537e927c4ab5b7793884faf31e491
+  data.tar.gz: 25bad72e4df60a12ef1df353abb6472e9db88623f9a4c7ebcd1e4150222bb92c4a2a63684582c9b5758eec353bdcab263b59cfdd67e259aeb42be071f9691827

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## [Unreleased]
+## [0.0.10] - 2023-10-03
+
+- Added the template parsing options to metrics command
+  This allows you to specify the AWS instance name with a template, and
+  then supply the values to fill in the template with the --values flag.
+  This makes metrics available to everyone, maybe.
+
 ## [0.0.9] - 2023-10-02
 
 - Automatically increase table width for wide tables

data/README.md

@@ -1,10 +1,15 @@
 ![tests](https://github.com/fearoffish/paas-org-metric-gathering-gem/actions/workflows/main.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/jcf.svg)](https://badge.fury.io/rb/jcf)
 
 # Jcf
 
 ## Installation
 
-Currently this gem is not available on rubygems.org so you will need to build it yourself. A convenience rake task has been included:
+```sh
+gem install jcf
+```
+
+A convenience rake task has been included to do this locally:
 
 ```sh
 rake install
@@ -63,21 +68,32 @@ jcf organizations my-org
 
 #### Metrics
 
-> **_NOTE:_** Metrics are a little different. They are specific to the gov.uk PaaS. Plans to make this more generic are in the works.
+Metrics queries AWS for backend CloudWatch metrics. It will output a table of the metrics for each service instance.
 
-You need to specify the environment and the service type you want to query.
+Because CF doesn't give access to the underlying AWS details for us to query, we have to make some assumptions:
 
-Query the `production` environment, `rds-broker` service for the organization `my-org`:
+- You need to be logged into the AWS account that the CF is using
+- The AWS account has the correct permissions to query the metrics
 
-```sh
-jcf metrics production rds-broker --org=my-org
-```
+We need a `template` for the instance names on AWS. This is a regex that will be used to match the instance names. For example, the `rds-broker` service has instances with names like `rdsbroker-GUID1`, `rdsbroker-GUID2`, etc. The template for this would be `rdsbroker-{guid}`.
+
+Examples for the template, note that guid is a special value that is filled automatically with the instance guid from CF:
+
+- `rdsbroker-{guid}`
+- `s3broker-{guid}`
+- `s3broker-{guid}-bucket-{name}`
+
+When you supply a template token that is _not_ `guid`, you need to supply a `--values` flag to fill in the value. For example:
 
-Query the `staging` environment, `aws-s3-bucket-broker` service for the organizations `my-org` and `my-org2`:
 ```sh
-jcf metrics staging aws-s3-bucket-broker --org=my-org,my-org2
+jcf metrics OFFERING \
+  --org=my-org \
+  --template='rdsbroker-{guid}-{name}' \
+  --values='name=foobar'
 ```
 
+`jcf` will use the template to determine the AWS guid to query for metrics.
+
 ### Formatting
 
 The default format is a table. You can also format as JSON or CSV. For example:

data/lib/jcf/cli/commands/cf/metrics.rb

@@ -14,11 +14,13 @@ module JCF
     module Commands
       module CF
         class Metrics < Command
-          argument :env, required: true, values: %w[dev01 dev02 dev03 dev04 dev05 staging prod prod-lon],
-                         desc: "Choose an environment"
-          argument :type, required: true, values: %w[postgres aws-s3-bucket],
-                          desc: "Choose a service instance type to query", default: "postgres"
+          argument :offering, required: true, values: %w[postgres aws-s3-bucket],
+                          desc: "Choose a service instance offering to query"
 
+          option :template, aliases: ["-t"], required: true, type: :string,
+                   desc: "Template for backend service instance names e.g. \"rdsbroker-{guid}-{name}\""
+          option :values, aliases: ["-v"], required: false, type: :string, default: "",
+                   desc: "Values for the template. 'guid' is the service instance guid e.g. \"name=test\""
           option :org, aliases: ["-o"], required: true, type: :string,
                        desc: "Choose an organization (can be multiple comma-separated)"
           option :name, aliases: ["-n"], type: :string, desc: "Choose a service instance name"
@@ -31,11 +33,11 @@ module JCF
               org_guid = organizations.find { |o| o.name == org }.guid
               err.puts "Found org guid: #{org_guid}"
 
-              offering_guid = service_offerings.find { |s| s.name == options[:type] }&.guid
+              offering_guid = service_offerings.find { |s| s.name == options[:offering] }&.guid
               err.puts "Found offering guid: #{offering_guid}"
 
               unless offering_guid
-                err.puts "No offerings found for type #{options[:type]}"
+                err.puts "No offerings found for type #{options[:offering]}"
                 exit(1)
               end
 
@@ -64,11 +66,6 @@ module JCF
                   service_plan = instance.relationships.service_plan.populate!
                   service_offering = service_plan.relationships.service_offering.populate!
                   service_broker = service_offering.relationships.service_broker.populate!
-                  # puts "Getting metrics for #{instance.name}"
-                  # puts "service_plan: #{service_plan.name}"
-                  # puts "service_offering: #{service_offering.name}"
-                  # puts "service_broker: #{service_broker.name}"
-                  # return nil
 
                   Thread.new do
                     m = JCF::CF::Metric.new
@@ -85,15 +82,20 @@ module JCF
                     m.service_broker_guid = service_broker.guid
                     m.service_offering = service_offering.name
                     m.service_plan = service_plan.name
+
+                    template = options[:template]
+                    t_values = parse_values(options[:values], instance.guid)
+
                     if service_offering.name == "postgres"
-                      m.storage_used = to_gb(cw.rds_storage_used(name: rds_guid(instance.guid)) || "")
-                      m.storage_allocated = to_gb(cw.storage_allocated(name: rds_guid(instance.guid)) || "")
-                      m.storage_free = to_gb(cw.storage_free(name: rds_guid(instance.guid)) || "")
-                      m.iops = (cw.iops(name: rds_guid(instance.guid)).to_fs(:rounded, precision: 0) || "")
-                      m.cpu = (cw.cpu(name: rds_guid(instance.guid)).to_fs(:rounded, precision: 0) || "")
+                      m.storage_used = to_gb(cw.rds_storage_used(name: JCF::CLI.template_parser(template, t_values)) || "")
+                        m.storage_allocated = to_gb(cw.storage_allocated(name: JCF::CLI.template_parser(template, t_values)) || "")
+                        m.storage_free = to_gb(cw.storage_free(name: JCF::CLI.template_parser(template, t_values)) || "")
+                        m.iops = (cw.iops(name: JCF::CLI.template_parser(template, t_values)).to_fs(:rounded, precision: 0) || "")
+                        m.cpu = (cw.cpu(name: JCF::CLI.template_parser(template, t_values)).to_fs(:rounded, precision: 0) || "")
                     end
+
                     if service_offering.name == "aws-s3-bucket"
-                      m.storage_used = to_gb(cw.s3_storage_used(name: s3_guid(options[:env], instance.guid)) || "")
+                      m.storage_used = to_gb(cw.s3_storage_used(name: JCF::CLI.template_parser(template, t_values)) || "")
                     end
                     values << m
                   end
@@ -108,18 +110,16 @@ module JCF
 
           private
 
-          def rds_guid(guid)
-            "rdsbroker-#{guid}"
-          end
-
-          def s3_guid(deploy_env, guid)
-            "paas-s3-broker-#{deploy_env}-#{guid}"
-          end
-
           def validate_options(options)
             raise JCF::CLI::InvalidOptionError, "No organization given" unless options[:org]
           end
 
+          def parse_values(values, guid)
+            values = values.split(",")
+            values << "guid=#{guid}"
+            values.join(",")
+          end
+
           def organizations
             @organizations ||= JCF::CF::Organization.all
           end

data/lib/jcf/cli.rb

@@ -34,6 +34,18 @@ module JCF
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
+    # template parsing: "{guid}-{name}", "guid=1234,name=test"
+    # TODO: add some form of validation and error handling
+    def self.template_parser(template, values)
+      result = template.dup
+
+      (values || "").split(",").each do |value|
+        key, val = value.split("=")
+        result.gsub!("{#{key}}", val)
+      end
+      result
+    end
+
     loader.setup
     ActiveSupport::Inflector.inflections(:en) do |inflect|
       inflect.irregular "quota", "quotas"

data/lib/jcf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JCF
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jcf
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Jamie van Dyke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler