cloudwatch_logs_insights_url_builder 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76f321c616c87f935c6698cd13d763fea55e3ded22ceeccc7bf3ce9e4444d644
-  data.tar.gz: 55a903d5832dae43ec348b7c35df2bf3f9cd4a5a7212fa09db2c0f61e3c245c9
+  metadata.gz: 2952989f7eaff60bf2ef7b18c849edb47423e093b25916f3d1ee715bd223f5bb
+  data.tar.gz: 0c86fb1d3437e3d6c69f6d7f043e98b598a93f9789d7a9db453b96c83a57929d
 SHA512:
-  metadata.gz: 443eebdfe8bf3530385502ae71a20c824ae80237feeb74c8072967cbe2a23e35851a35b3587cecf20ac455c1278c6b2701bff9c4054940bba4e1dcc9beef017e
-  data.tar.gz: 6faec77bd5a6bed72d28e6a417ad7dfe1495cb9b602f922bdca2abf279b2c1858aa47cb18ee97cdc50fb1b4963e29d11bcda243fc391ef4003e504488b3726b5
+  metadata.gz: c36b6c47e31d354c930ba71a7e7e4e311dcdbf6a723c79d1be691b81d247f1746965d16118c07334430f78cc98df359742639129898aaf7c6e11cdb89ef0d9ca
+  data.tar.gz: f571b2ff89607d6694aa7dfe1939d804c2587b03df7184cd3714a43a904d2aceac6a8f6a01373376f9b400983cfd5585465f2a66935ba19171ac4a699d4ceeff

data/.github/workflows/rspec.yml

@@ -15,6 +15,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
+          ruby-version: '2.7'
 
       - name: Bundler and gem install
         run: |

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloudwatch_logs_insights_url_builder (0.0.4)
+    cloudwatch_logs_insights_url_builder (0.0.6)
       url
 
 GEM

data/README.md

@@ -1,13 +1,13 @@
 # cloudwatch_logs_url_builder
 
-![rspec](https://github.com/naomichi-y/cloudwatch_logs_url_builder/actions/workflows/rspec.yml/badge.svg)
+![rspec](https://github.com/naomichi-y/cloudwatch_logs_insights_url_builder/actions/workflows/rspec.yml/badge.svg)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Generate AWS Console URL for Amazon CloudWatch.
+Generate AWS Console URL for Amazon CloudWatch Insights.
 
 ## Installation
 
-```
+```ruby
 gem 'cloudwatch_logs_insights_url_builder'
 ```
 
@@ -20,10 +20,11 @@ builder = CloudWatchLogsInsightsUrlBuilder.new
 builder.time_type = 'ABSOLUTE'
 builder.start_time = 24 * 3600
 builder.end_time = 0
-
-query = 'fields @timestamp, @message, @logStream, @log\n| sort @timestamp desc\n| limit 2'
-log_groups = ['/aws/cloudtrail']
+builder.log_groups = ['/aws/cloudtrail']
 
 # https://us-east-1.console.aws.amazon.com/cloudwatch/home?...
-builder.log_insights_url(query, log_groups)
+builder.log_insights_url("fields @timestamp, @message, @logStream, @log\n| sort @timestamp desc\n| limit 2")
 ```
+The generated URL can be used to open the CloudWatch Insights page from a browser.
+
+<img width="80%" alt="Screen Shot 2023-01-28 at 12 45 11" src="https://user-images.githubusercontent.com/1632478/215240546-417c523e-692f-47eb-8d01-ccca215d348b.png">

data/cloudwatch_logs_ingihts_url_builder.gemspec

@@ -1,11 +1,14 @@
 Gem::Specification.new do |spec|
   spec.name          = 'cloudwatch_logs_insights_url_builder'
-  spec.version       = '0.0.1'
+  spec.version       = '0.0.6'
   spec.authors       = ['naomichi-y']
   spec.email         = ['n.yamakita@gmail.com']
 
-  spec.summary       = 'Generate AWS Console URL for Amazon CloudWatch.'
-  spec.description   = 'Specify log groups and filters to generate URLs accessible to the AWS Console.'
+  spec.summary       = 'Generate AWS Console URL for Amazon CloudWatch Insights.'
+
+  spec.description   = +'Specify log groups and filters to generate CloudWatch Logs Insights URL '
+  spec.description  << 'accessible to AWS Console.'
+
   spec.homepage      = 'https://github.com/naomichi-y/cloudwatch_logs_insights_url_builder'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 

data/lib/cloudwatch_logs_insights_url_builder/criteria.rb

@@ -7,28 +7,28 @@ class CloudWatchLogsInsightsUrlBuilder
     def add(key, value)
       case value
       when Array
-        result = +encode_key("~#{key}~(")
+        result = +encode("~#{key}~(")
 
         value.each do |v|
-          result << "#{encode_key("~'")}#{encode_value(v)}"
+          result << "#{encode("~'")}#{encode_value(v)}"
         end
 
-        @conditions << result + encode_key(')')
+        @conditions << result + encode(')')
 
       when String
-        @conditions << "#{encode_key("~#{key}~'")}#{encode_value(value)}"
+        @conditions << "#{encode("~#{key}~'")}#{encode_value(value)}"
       else
-        @conditions << "#{encode_key("~#{key}~")}#{encode_value(value)}"
+        @conditions << "#{encode("~#{key}~")}#{encode_value(value)}"
       end
     end
 
     def build
-      "#{encode_key('~(')}#{@conditions.join.delete_prefix(encode_key('~'))}#{encode_key(')')}"
+      "#{encode('~(')}#{@conditions.join.delete_prefix(encode('~'))}#{encode(')')}"
     end
 
     private
 
-    def encode_key(key)
+    def encode(key)
       URI.encode_www_form_component(URI.encode_www_form_component(key)).gsub('%', '$')
     end
 

data/lib/cloudwatch_logs_insights_url_builder.rb

@@ -2,7 +2,7 @@ require 'url'
 require 'cloudwatch_logs_insights_url_builder/criteria'
 
 class CloudWatchLogsInsightsUrlBuilder
-  attr_accessor :time_type, :timezone, :start_time, :end_time
+  attr_accessor :time_type, :timezone, :start_time, :end_time, :log_groups
 
   STRING_TIME_FORMAT = '%Y-%m-%dT%T.000Z'.freeze
 
@@ -13,9 +13,10 @@ class CloudWatchLogsInsightsUrlBuilder
     @unit = 'minutes'
     @start_time = -86_400
     @end_time = 0
+    @log_groups = []
   end
 
-  def log_insights_url(query, log_groups = [])
+  def log_insights_url(query)
     url = +"https://#{@region}.console.aws.amazon.com/cloudwatch/home?region=#{@region}#logsV2:logs-insights"
     url << URI.encode_www_form_component('?queryDetail=').gsub('%', '$')
 
@@ -30,7 +31,7 @@ class CloudWatchLogsInsightsUrlBuilder
     builder.add('tz', @timezone)
     builder.add('editorString', query)
     builder.add('isLiveTail', false)
-    builder.add('source', log_groups) if log_groups.size.positive?
+    builder.add('source', @log_groups) if @log_groups.size.positive?
 
     url << builder.build
     url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudwatch_logs_insights_url_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - naomichi-y
@@ -80,8 +80,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Specify log groups and filters to generate URLs accessible to the AWS
-  Console.
+description: Specify log groups and filters to generate CloudWatch Logs Insights URL
+  accessible to AWS Console.
 email:
 - n.yamakita@gmail.com
 executables: []
@@ -128,5 +128,5 @@ requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
-summary: Generate AWS Console URL for Amazon CloudWatch.
+summary: Generate AWS Console URL for Amazon CloudWatch Insights.
 test_files: []