sftrace-agent 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccbd4586ca78a5351e5af9500f5a675e6c22f42f05f853ab7dbd3149103c971e
-  data.tar.gz: a5c1b3950348cedb9eb0041827381895abb4fd28fa5a73c6760fc5d2791cde45
+  metadata.gz: 1942a879d87a1ddbd17b16a20975a194c8dbcedc4af140a2f5a3405f10e54842
+  data.tar.gz: 26f69f657c6750ee4994955f4c66966c92600b8bc9a9c1e0293fd0fab1e2b398
 SHA512:
-  metadata.gz: b737638874179bff24bb0fbaa3239d46b3b7d4b4456f6cb8b214b9d7cb0984eda791c7afce5b811779d8269976698b6665a327376e8a083a1bd637efff2004dc
-  data.tar.gz: 71a475e5d22a0beb80815d944e46c39c8c2f9e3a64d38f29131b15ce035cedf6909a4d889a760cc31250edc7bf7de98b7052fd6229c56370dbce3bb90df72805
+  metadata.gz: f39d5e1bb9efeb6cb3d3dc0a7be0168ae8de21f27c1a42427d7a7a58db0eb105b6b4b9e8a2338f47d80e45252114f2ea88a8bdcc3a7b939fc15c48ffbcdbda6d
+  data.tar.gz: 28b684b6a16556b9e5af32538134207573ed6d160eb182a6092c32842052ec26ad525e2463d87944f75d36332917a15e5e083bcc5b391f5236855752c85c4ef0

data/README.md

@@ -1,6 +1,6 @@
 # Sftrace::Agent
 
-Sftracing enables you to analyze performance throughout your microservices architecture all in one view. This is accomplished by tracing all of the requests - from the initial web request to your front-end service - to queries made to your back-end services. This makes finding possible bottlenecks throughout your application much easier and faster.
+Sftracing enables you to analyze performance throughout your microservices architecture all in one view. This is accomplished by tracing all the requests - from the initial web request to your front-end service - to queries made to your back-end services. This makes finding possible bottlenecks throughout your application much easier and faster.
 
 ## Installation
 
@@ -29,16 +29,10 @@ require "elastic-apm"
 Add the following line inside the class of the main module in the application.rb file.
 
 ```ruby
-Sftrace::Agent.set_sftrace_config(File.dirname(__FILE__), ENV['RAILS_ENV'])
+Sftrace::Agent.set_sftrace_config('sftrace-demo', '/opt/sfagent/config.yaml')
 ```
 
-Create config.yaml file inside the config folder.
-
-The file name should be of the following format : 
-
-```
-sftrace-development-config.yaml OR sftrace-production-config.yaml
-```
+Create config.yaml file either inside the `config` folder of the Ruby on Rails Application or inside the `/opt/sfagent/` folder.
 
 The config file should have the following details.
 
@@ -50,6 +44,16 @@ tags:
 key: k64QokCTjcgxlBZ6m0tBn0+iZpXB3602LED5nsnhPsWSvRtPfEioLRkF8BMQDZDki5R6kLCozgeoWsNXPa7zl7q6OdHjbHKHbLetc39ABseSq75tuGc6HUGpXhtiXkjO0l8IW2zFv5+2NxhY8ybJX/0Y8WgDr3CtyDVNLuaNeKljjTyNBMFO+iP4oOR9kA2YjV8f1//e/niu3FhJFA1CI7bXh+c3BsRPrpOkC8NOEjuvLbKRZLQYb5VilvxY5rxOyKTiKNer+J+MgXIUm+laAMBF9rXfW1m9YgpFoPtK2s1xysvLsjZteIvvPSBDZdA9PW/oa44y4etiwhEQQ5PUO3sSkyHKefkwyk+LqdqyJdm0XJja/a/n9/DbSn/G1MceaFC/f1Jt8u9AQq9OGnAkpA==
 ```
 
+## Development
+
+If you want to edit the Gem, then you can edit the following : 
+
+`lib/sftrace/agent.rb` : contains the actual logic
+
+`lib/sftrace/agent/version.rb` : contains the Gem version
+
+`sftrace-agent.gemspec` : contains the Gem specification
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sftrace/agent.rb

@@ -7,47 +7,56 @@ module Sftrace
 
     class Error < StandardError; end
 
-    def self.set_sftrace_config(serviceName)
+    def self.set_config(profile_key, project_name, app_name, service_name)
 
-      sftrace_config_file = "/opt/sfagent/config.yaml"
-  
-      if (File.exist?(sftrace_config_file))
+      decoded_key = Base64.decode64("U25hcHB5RmxvdzEyMzQ1Ng==")
+      decoded_profile_key = Base64.decode64(profile_key)
+
+      decipher = OpenSSL::Cipher::AES.new(128, :CBC)
+      decipher.decrypt
+      decipher.key = decoded_key
+      decipher.iv = decoded_profile_key[0, 16]
+      plain = decipher.update(decoded_profile_key[16..-1]) + decipher.final
+      plain_json = JSON.parse(plain)
+
+      global_labels = "_tag_projectName=" + project_name + 
+                      ",_tag_appName=" + app_name + 
+                      ",_tag_profileId=" + plain_json["profile_id"]
+
+      ENV['ELASTIC_APM_VERIFY_SERVER_CERT'] = "false"
+      ENV['ELASTIC_APM_CENTRAL_CONFIG'] = "false"
+      ENV['ELASTIC_APM_SPAN_FRAMES_MIN_DURATION'] = "1s"
+      ENV['ELASTIC_APM_STACK_TRACE_LIMIT'] = "2"
+
+      ENV['ELASTIC_APM_SERVICE_NAME'] = service_name
+      ENV['ELASTIC_APM_SERVER_URL'] = plain_json["trace_server_url"]
+      ENV['ELASTIC_APM_GLOBAL_LABELS'] = global_labels
+
+      puts "[SFTRACE] ELASTIC_APM_SERVICE_NAME : " + ENV['ELASTIC_APM_SERVICE_NAME']
+      puts "[SFTRACE] ELASTIC_APM_SERVER_URL : " + ENV['ELASTIC_APM_SERVER_URL']
+      puts "[SFTRACE] ELASTIC_APM_GLOBAL_LABELS : " + ENV['ELASTIC_APM_GLOBAL_LABELS']
+
+    end
 
-        sftrace_array = YAML.load_file(sftrace_config_file)
+    def self.set_sftrace_config(service_name, config_path)
+
+      if (File.exist?(config_path))
+
+        sftrace_array = YAML.load_file(config_path)
 
         if ((sftrace_array["key"] != nil) && 
             (sftrace_array["tags"] != nil) && 
-            (sftrace_array["tags"]["appName"] != nil) && 
-            (sftrace_array["tags"]["projectName"] != nil)
+            (sftrace_array["tags"]["projectName"] != nil) && 
+            (sftrace_array["tags"]["appName"] != nil)
         )
 
-          decoded_key = Base64.decode64("U25hcHB5RmxvdzEyMzQ1Ng==")
-          decoded_profile_key = Base64.decode64(sftrace_array["key"])
-    
-          decipher = OpenSSL::Cipher::AES.new(128, :CBC)
-          decipher.decrypt
-          decipher.key = decoded_key
-          decipher.iv = decoded_profile_key[0, 16]
-          plain = decipher.update(decoded_profile_key[16..-1]) + decipher.final
-          plain_json = JSON.parse(plain)
-    
-          global_labels = "_tag_projectName=" + sftrace_array["tags"]["projectName"] + 
-                          ",_tag_appName=" + sftrace_array["tags"]["appName"] + 
-                          ",_tag_profileId=" + plain_json["profile_id"]
-
-          ENV['ELASTIC_APM_VERIFY_SERVER_CERT'] = "false"
-          ENV['ELASTIC_APM_CENTRAL_CONFIG'] = "false"
-          ENV['ELASTIC_APM_SPAN_FRAMES_MIN_DURATION'] = "1s"
-          ENV['ELASTIC_APM_STACK_TRACE_LIMIT'] = "2"
-    
-          ENV['ELASTIC_APM_SERVICE_NAME'] = serviceName
-          ENV['ELASTIC_APM_SERVER_URL'] = plain_json["trace_server_url"]
-          ENV['ELASTIC_APM_GLOBAL_LABELS'] = global_labels
-
-          puts "[SFTRACE] ELASTIC_APM_SERVICE_NAME : " + ENV['ELASTIC_APM_SERVICE_NAME']
-          puts "[SFTRACE] ELASTIC_APM_SERVER_URL : " + ENV['ELASTIC_APM_SERVER_URL']
-          puts "[SFTRACE] ELASTIC_APM_GLOBAL_LABELS : " + ENV['ELASTIC_APM_GLOBAL_LABELS']
-    
+          set_config(
+            sftrace_array["key"],
+            sftrace_array["tags"]["projectName"],
+            sftrace_array["tags"]["appName"],
+            service_name
+          )
+
         else
           puts "[SFTRACE] Add all the required details in sftrace config.yaml file."
         end
@@ -56,34 +65,13 @@ module Sftrace
 
         puts "[SFTRACE] Please provide a sftrace config.yaml file or else will read from env. variables."
 
-        decoded_key = Base64.decode64("U25hcHB5RmxvdzEyMzQ1Ng==")
-        decoded_profile_key = Base64.decode64(ENV['SFTRACE_PROFILE_KEY'])
-  
-        decipher = OpenSSL::Cipher::AES.new(128, :CBC)
-        decipher.decrypt
-        decipher.key = decoded_key
-        decipher.iv = decoded_profile_key[0, 16]
-        plain = decipher.update(decoded_profile_key[16..-1]) + decipher.final
-        plain_json = JSON.parse(plain)
-  
-        global_labels = "_tag_projectName=" + ENV['SFTRACE_PROJECT_NAME'] + 
-                        ",_tag_appName=" + ENV['SFTRACE_APP_NAME'] + 
-                        ",_tag_profileId=" + plain_json["profile_id"]
-
-        ENV['ELASTIC_APM_VERIFY_SERVER_CERT'] = "false"
-        ENV['ELASTIC_APM_CENTRAL_CONFIG'] = "false"
-        ENV['ELASTIC_APM_SPAN_FRAMES_MIN_DURATION'] = "1s"
-        ENV['ELASTIC_APM_STACK_TRACE_LIMIT'] = "2"
-  
-        ENV['ELASTIC_APM_SERVICE_NAME'] = ENV['SFTRACE_SERVICE_NAME']
-        ENV['ELASTIC_APM_SERVER_URL'] = plain_json["trace_server_url"]
-        ENV['ELASTIC_APM_GLOBAL_LABELS'] = global_labels
-
-        puts "[SFTRACE] ELASTIC_APM_SERVICE_NAME : " + ENV['ELASTIC_APM_SERVICE_NAME']
-        puts "[SFTRACE] ELASTIC_APM_SERVER_URL : " + ENV['ELASTIC_APM_SERVER_URL']
-        puts "[SFTRACE] ELASTIC_APM_GLOBAL_LABELS : " + ENV['ELASTIC_APM_GLOBAL_LABELS']
+        set_config(
+          ENV['SFTRACE_PROFILE_KEY'],
+          ENV['SFTRACE_PROJECT_NAME'],
+          ENV['SFTRACE_APP_NAME'],
+          ENV['SFTRACE_SERVICE_NAME']
+        )
 
-        return
       end
   
     end

data/lib/sftrace/agent/version.rb

@@ -2,6 +2,6 @@
 
 module Sftrace
   module Agent
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sftrace-agent
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - SnappyFlow