sftrace-agent 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '089b4350dffee510ef60ac8318aa207c14a5042c3b55bf2ffb821879d4e52271'
+  data.tar.gz: 91a85800408842cad4b8a581d30e086caa10dd358f25c3f3412eb922d78805d2
+SHA512:
+  metadata.gz: bc6d6a396721b6d608ae64fbdc8dccb5f39c1da098352a1129d6a6ada044865d7de1857d760a62401f111fba7fee7ff36f68815c1928f747ba307136b81d7bd3
+  data.tar.gz: 21446ff215bc6f1c6b39e2afa23098bd7ed784cb952b20ddc25d82ee773fea80f07b44926482fad015a6e98b4fa4250c5b65f68542676c1c061d73b50a5090b1

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sftrace-agent.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Anchal Gupta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sftrace-agent'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sftrace-agent
+
+## Usage
+
+Add the dependency at the top in the application.rb file.
+
+```ruby
+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'])
+```
+
+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
+```
+
+The config file should have the following details.
+
+```yaml
+tags:
+  serviceName: sftrace-demo
+  appName: ruby
+  projectName: sftrace
+key: k64QokCTjcgxlBZ6m0tBn0+iZpXB3602LED5nsnhPsWSvRtPfEioLRkF8BMQDZDki5R6kLCozgeoWsNXPa7zl7q6OdHjbHKHbLetc39ABseSq75tuGc6HUGpXhtiXkjO0l8IW2zFv5+2NxhY8ybJX/0Y8WgDr3CtyDVNLuaNeKljjTyNBMFO+iP4oOR9kA2YjV8f1//e/niu3FhJFA1CI7bXh+c3BsRPrpOkC8NOEjuvLbKRZLQYb5VilvxY5rxOyKTiKNer+J+MgXIUm+laAMBF9rXfW1m9YgpFoPtK2s1xysvLsjZteIvvPSBDZdA9PW/oa44y4etiwhEQQ5PUO3sSkyHKefkwyk+LqdqyJdm0XJja/a/n9/DbSn/G1MceaFC/f1Jt8u9AQq9OGnAkpA==
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sftrace/agent"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sftrace/agent.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "agent/version"
+
+module Sftrace
+  module Agent
+
+    class Error < StandardError; end
+
+    def self.set_sftrace_config(current_path, env)
+
+      sftrace_config_file = current_path + "/sftrace-" + env + "-config.yaml"
+  
+      if (File.exist?(sftrace_config_file))
+        sftrace_array = YAML.load_file(sftrace_config_file)
+      else
+        puts "[SFTRACE] Please provide a sftrace config.yaml file."
+        return
+      end
+  
+      if ((sftrace_array["key"] != nil) && 
+          (sftrace_array["tags"] != nil) && 
+          (sftrace_array["tags"]["serviceName"] != nil) && 
+          (sftrace_array["tags"]["appName"] != nil) && 
+          (sftrace_array["tags"]["projectName"] != 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'] = sftrace_array["tags"]["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']
+  
+      else
+        puts "[SFTRACE] Add all the required details in sftrace config.yaml file."
+      end
+  
+    end
+
+  end
+end

data/lib/sftrace/agent/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sftrace
+  module Agent
+    VERSION = "0.1.1"
+  end
+end

data/sftrace-agent.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/sftrace/agent/version"
+
+Gem::Specification.new do |spec|
+
+  spec.name          = "sftrace-agent"
+  spec.version       = Sftrace::Agent::VERSION
+  spec.authors       = ["SnappyFlow"]
+  spec.email         = ["no-reply@snappyflow.io"]
+
+  spec.summary       = "SnappyFlow tracing allows you to monitor software services and applications in real time."
+  spec.description   = "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."
+  spec.homepage      = "https://www.snappyflow.io/#/resources/sftracing/Ruby"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.4.0"
+
+  # spec.metadata["allowed_push_host"] = "Set to 'https://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "elastic-apm", "~> 4.3"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: sftrace-agent
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- SnappyFlow
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elastic-apm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: 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.
+email:
+- no-reply@snappyflow.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sftrace/agent.rb
+- lib/sftrace/agent/version.rb
+- sftrace-agent.gemspec
+homepage: https://www.snappyflow.io/#/resources/sftracing/Ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: SnappyFlow tracing allows you to monitor software services and applications
+  in real time.
+test_files: []