dc-metrics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76c91c46a841f89632769640ab956876daa5f60ec1e8fbfc3d5c47194e309125
+  data.tar.gz: 6ea402f59239624e1b6aa4dac1c3f9fe907771e1994eb86ae155ecda0b8a9272
+SHA512:
+  metadata.gz: 16c890fdc91fdcff3789fc71012d611c7914c41e3203e3a911d0edf4668637eba91ec6ae15c7b0eeaccd792c39935c5fc1a291ceaa5437893e2ff78a1d574d60
+  data.tar.gz: df725846003233c70ee368a2d227ceabeb4c28b382b10db77fba1c35da1cd2aaa97e7a85b337e11458c58a54ed9dcebd9fc450f7aa4eb3aceac3106bc5af02bd

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Delivery Center
+
+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,113 @@
+# Dc::Metrics | dc.libs.metrics.ruby
+
+Ruby implementation for DeliveryCenter's structured logging format.
+
+> This package is part of a family of libraries that implement DeliveryCenter's metrics pattern  for different languages.
+Check also our [Elixir](https://github.com/deliverycenter/dc.libs.metrics.elixir),
+> [Golang](https://github.com/deliverycenter/dc.libs.metrics.golang) and
+>[Node](https://github.com/deliverycenter/dc.libs.metrics.node) versions.
+
+By default, all events will be logged to:
+
+- Stdout, as a [Google Cloud Platform structured log](https://cloud.google.com/logging/docs/structured-logging)
+- Metrics API, using PubSub
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dc-metrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dc-metrics
+
+## Usage
+
+How to configure:
+```ruby
+Dc::Metrics.configure do |config|
+  config.caller            = 'application_name'
+  config.environment       = 'test'
+  config.gcp_project_id    = 'project_id'
+  config.pubsub_topic_name = 'topic_name'
+  # Path to you local GCP credentials file if needed(mostly for local testing).
+  config.gcp_credentials_path = 'path/to/file'
+end
+```
+
+Obs: If there are missing parameters in this configuration the lib will fail to execute and output message to stdout! No exception is raised.
+
+## Documentation
+
+For this call of the library
+
+```ruby
+Dc::Metrics.debug("Message test!", {
+  action: "CREATE_PRODUCT",
+  direction: "INCOMING",
+  source_type: "PROVIDER",
+  source_name: "MY_PROVIDER",
+  root_resource_type: "PRODUCT",
+  ext_root_resource_id: "EXT1234",
+  int_root_resource_id: "6789",
+  int_store_id: 100
+})
+```
+
+The stdout ouput will be:
+
+```json
+{
+    "message": "Message test!",
+    "modelLog": {
+        "level": "DEBUG",
+        "message": "Message test!",
+        "caller": "application_name",
+        "environment": "test",
+        "correlation_id": "PROVIDER-MY_PROVIDER-EXT1234-6789",
+        "create_timestamp": 1605714894275120000,
+        "action": "CREATE_PRODUCT",
+        "direction": "INCOMING",
+        "source_type": "PROVIDER",
+        "source_name": "MY_PROVIDER",
+        "duration_ms": null,
+        "root_resource_type": "PRODUCT",
+        "ext_root_resource_id": "EXT1234",
+        "int_root_resource_id": "6789",
+        "child_resource_type": null,
+        "child_resource_id": "",
+        "ext_store_id": "",
+        "int_store_id": "100",
+        "error_code": null,
+        "payload": null
+    },
+    "severity": "DEBUG"
+}
+```
+
+To generate RDOC use
+```bash
+$ rdoc 'dc-metrics'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+**TODO:** To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Disable logs
+If you need to disable the package behavior (for testing, for example), you can use:
+```ruby
+Dc::Metrics.disable
+```
+

data/lib/dc/metrics.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'dc/metrics/version'
+require 'dc/metrics/configuration'
+require 'dc/metrics/logger'
+
+module Dc
+  module Metrics
+    class Error < StandardError; end
+    # Your code goes here...
+
+    def self.debug(message, metadata)
+      logger.log(:debug, message, metadata)
+    end
+
+    def self.info(message, metadata)
+      logger.log(:info, message, metadata)
+    end
+
+    def self.warn(message, metadata)
+      logger.log(:warn, message, metadata)
+    end
+
+    def self.error(message, metadata)
+      logger.log(:error, message, metadata)
+    end
+
+    def self.logger
+      @logger ||= Metrics::Logger.new
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.add_pending_thread(t)
+      threads_to_finish << t
+    end
+
+    def self.finish_threads
+      threads_to_finish.each{ |t| t.join }
+      threads_to_finish = []
+    end
+
+    def self.clean_pending_threads
+      if threads_to_finish.size > 100
+        finish_threads
+      end
+    end
+    
+    def self.disable
+      @configuration = Configuration.new
+      @configuration.disable
+    end
+
+    private
+
+    def self.threads_to_finish
+      @threads_to_finish ||= []
+    end
+  end
+end
+
+at_exit do
+  Dc::Metrics.finish_threads
+end

data/lib/dc/metrics/auth.json

@@ -0,0 +1,12 @@
+{
+    "type": "service_account",
+    "project_id": "deliverycenter-stag",
+    "private_key_id": "8e6f3ea24cbcb2013b88592ce7bea0ee8c66856a",
+    "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDX/ppuhoZssCM2\nY1vc0s4z1ZnzU5XMLIfizha3OMx7O89uHg/wUJW2a+HnESM49t8cGYysZ3uJQynr\nD8eStNx/raPzRQAnqyvLrMM7qwkPClWZAewbLbVGJTPtIoIB6ZVA+lq/MGgXqJEK\n4FpycdHMCJfR6wzb6Rz3QR/8BKj4gbXz9lHnMUfqrdGlWuAld6gUqAjH3hct2Rs9\nTLIsl7dCyXfNuO9xo6n0fIwIlEfvxSd0d5XrvefeHuR3bQb0zUhU9XqgkUtcVS0V\nA2/dBP46+tWBR5x2PkW0d7mKdXe49ePB5H68z7RHUL5/1L0ccxGIYehLC9nG70Gf\nu9Rv8YMVAgMBAAECggEAEjNrqwWd/TmodfRQcN64roiA1Q7FkDNube/E3UKlhHrp\nQ1O4Lx1zSDB2FEUO7UVsTo9emcaMk+f7d8nYHOYtsHqe1qiJV05mvd58gyIp/MD3\nrpGJZk7nOBZ5djGSt/uJbrTKAdNf6iJzunFmXb92mNVeibtfVYaiwLkVq2RvIqWP\n3ea78UltbBBRSe88McpyPZmTiWLqaaF2IeDe2n6FZpCxnzZA0dTLS2VatnPp4W9t\nZxEPmvjCE/zA97RTSNd1s9uvGO0DFVOCSXEq+8b/pR/Cm/SQ/xOUc0O/CBqE+4gO\n2FUUhqYn+Q3S56Ivy7HkmVeu/efUElzqCtMYUKeSsQKBgQDwwrZoSiOTIvoglEdT\n8efKPCiREpw2rbfbf880+nj28TcOOrBui7ECCqQBhL3b5DQafggQWvHN6bQxVn9y\nF0i2s2w5dmVvfJ+J0GnYWlPJQkjOb1kWhQLulARVm33C6r+h7bNq6ySNvwXtewTM\n23T1pjrjMjQy07AqY2r7YWrLDQKBgQDlqpTSCmPHfC1b/foF1n8DySmiK/Qf1/Tx\nnWlt7YTykHjuY1yvKE0LPsNIKmNf6C7Ol1ae5cYYk2zPncAtLsqcRzGk5OkhFzFy\n6864E/jgaas/tPT9+V0b++Pb6MbX3w92il+gDtOdDfIMCB9ZauO4BaXba0V4Wo0Q\nzePQAXt2KQKBgQCGZas9fGVvdU77cMqAacFie0KJ+UGKpF7GAQrCIC/2aaC6KLjk\nfMZKxXXYAymY3kLXpxMJTjs9HwCfqhFqtuS4WGBJk3X8Ti0g2V68j2/GIWJTGoU4\ntPd2BtqEj1Acxr5CvlYxkSHOnpvIfauoT7lyh2DIAvZwiQsGHolR2oeq4QKBgHro\ntGZH+ygqE5hUrnZrWWQsRuSsQyS7jTG0/VRANdMecCmb8WEn3ztyZk37qV0NQ+d5\n5Hh7HW3Pj/74PH2xueqyyyWlAAKeh+8ptWKcBagLxQL+E9LLngG45zOsOqYSkRLu\ncMiWxrcZXH0F58kRxDaahy2LFg2X4ECq/w01jd4pAoGAWVaci75ReRI4VhY+pA0E\nPqFCX9W9RzQhzMGGmZajDWXLgBo64pw8asYX0o/zJaygH44/VOIB6UN5Sd82nePW\nOus6m+eRiz+2CMwBXRFgnpB2wRA+EsVUC8djxDtAMijX2E+R6ZwKFGrWExVf/DO7\nhOLDfQbMG2z6YZX6ZKSPpI8=\n-----END PRIVATE KEY-----\n",
+    "client_email": "cloudbuildtest@deliverycenter-stag.iam.gserviceaccount.com",
+    "client_id": "103062070047530150068",
+    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+    "token_uri": "https://oauth2.googleapis.com/token",
+    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+    "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/cloudbuildtest%40deliverycenter-stag.iam.gserviceaccount.com"
+}

data/lib/dc/metrics/configuration.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Dc
+  module Metrics
+    class Configuration
+      attr_accessor :caller, :environment, :gcp_project_id, :gcp_credentials_path, :pubsub_topic_name
+
+      def initialize
+        @caller = nil
+        @environment = nil
+        @gcp_project_id = nil
+        @pubsub_topic_name = nil
+        @gcp_credentials_path = nil
+        @disabled = false
+      end
+
+      def disable
+        @disabled = true
+      end
+
+      def disabled?
+        @disabled
+      end
+    end
+  end
+end

data/lib/dc/metrics/logger.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'dc/metrics/pub_sub'
+require 'json'
+require 'protos/metrics_pb'
+require 'time'
+
+module Dc
+  module Metrics
+    class Logger
+      def log(level, message, metadata)
+        begin
+          return if Metrics.configuration.disabled?
+
+          base_model = build_base_model(level, message, metadata)
+
+          log_to_stdout(base_model)
+          log_to_metrics(base_model)
+        rescue StandardError => e
+          puts "[Error][Dc::Metrics] #{e.message}"      if e.message != nil
+          puts "[Error][Dc::Metrics] #{e.backtrace[0]}" if e.backtrace[0] != nil
+        end
+      end
+
+      private
+
+      def log_to_stdout(base_model)
+        stdout_payload = build_stdout_payload(base_model)
+        puts JSON(stdout_payload)
+      end
+
+      def build_stdout_payload(base_model)
+        {
+          message: base_model[:message],
+          modelLog: base_model,
+          severity: base_model[:level]
+        }
+      end
+
+      def log_to_metrics(base_model)
+        metrics_payload = build_metrics_payload(base_model)
+        make_metrics_request(metrics_payload)
+      end
+
+      def build_metrics_payload(base_model)
+        metrics_data = base_model.reject { |k, _v| %i[message payload].include?(k) }
+        metrics_data[:create_timestamp] = to_google_timestamp(metrics_data[:create_timestamp])
+        DeliveryCenter::Logging::Integration::V1::WriteMetricsRequest.new(metrics_data)
+      end
+
+      def make_metrics_request(write_metrics_request_protob)
+        Metrics::PubSub.new.publish(write_metrics_request_protob)
+      end
+
+      def build_base_model(level, message, metadata)
+        {
+          level:                level.to_s.upcase,
+          message:              message,
+          caller:               Metrics.configuration.caller,
+          environment:          Metrics.configuration.environment,
+          correlation_id:       build_correlation_id(metadata),
+          create_timestamp:     Time.now.to_i * (10**9) + Time.now.nsec,
+          action:               metadata[:action],
+          direction:            metadata[:direction],
+          source_type:          metadata[:source_type],
+          source_name:          metadata[:source_name],
+          duration_ms:          metadata[:duration_ms],
+          root_resource_type:   metadata[:root_resource_type],
+          ext_root_resource_id: metadata[:ext_root_resource_id].to_s,
+          int_root_resource_id: metadata[:int_root_resource_id].to_s,
+          child_resource_type:  metadata[:child_resource_type],
+          child_resource_id:    metadata[:child_resource_id].to_s,
+          ext_store_id:         metadata[:ext_store_id].to_s,
+          int_store_id:         metadata[:int_store_id].to_s,
+          error_code:           metadata[:error_code],
+          payload:              metadata[:payload]
+        }
+      end
+
+      def to_google_timestamp(nanoseconds)
+        Google::Protobuf::Timestamp.new(
+          seconds: nanoseconds / 1_000_000_000,
+          nanos: nanoseconds % 1_000_000_000
+        )
+      end
+
+      def build_correlation_id(metadata)
+        [
+          metadata[:source_type],
+          metadata[:source_name],
+          metadata[:ext_root_resource_id],
+          metadata[:int_root_resource_id]
+        ].join('-')
+      end
+    end
+  end
+end

data/lib/dc/metrics/pub_sub.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'protos/metrics_pb'
+require 'base64'
+require 'google/cloud/pubsub'
+
+module Dc
+  module Metrics
+    class PubSub
+      attr_reader :pub_sub, :topic
+
+      def initialize
+        @pub_sub = Google::Cloud::PubSub.new(**cloud_params)
+        @topic = pub_sub.topic(Metrics.configuration.pubsub_topic_name)
+      end
+
+      def publish(message)
+        t = Thread.new{
+          begin
+          encoded_data = DeliveryCenter::Logging::Integration::V1::WriteMetricsRequest.encode(message)
+          response = topic.publish(encoded_data)
+          rescue StandardError => e
+            puts "[Error][Dc::Metrics] #{e.message}"      if e.message != nil
+            puts "[Error][Dc::Metrics] #{e.backtrace[0]}" if e.backtrace[0] != nil
+            puts "[Error][Dc::Metrics] #{e.backtrace[1]}" if e.backtrace[1] != nil
+          end
+        }
+        Metrics.add_pending_thread(t)
+        Metrics.clean_pending_threads
+      end
+
+      private
+
+      def cloud_params
+        {
+          project_id:  Metrics.configuration.gcp_project_id,
+          credentials: Metrics.configuration.gcp_credentials_path
+        }
+      end
+    end
+  end
+end

data/lib/dc/metrics/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Dc
+  module Metrics
+    VERSION = '1.0.0'
+  end
+end

data/lib/protos/metrics_pb.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: metrics.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+require 'google/protobuf/empty_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file('metrics.proto', syntax: :proto3) do
+    add_message 'logging.deliverycenter.integration.v1.WriteMetricsRequest' do
+      optional :correlation_id, :string, 1
+      optional :environment, :string, 2
+      optional :level, :string, 3
+      optional :direction, :string, 4
+      optional :source_type, :string, 5
+      optional :source_name, :string, 6
+      optional :caller, :string, 7
+      optional :action, :string, 8
+      optional :create_timestamp, :message, 9, 'google.protobuf.Timestamp'
+      optional :duration_ms, :int32, 10
+      optional :root_resource_type, :string, 11
+      optional :ext_root_resource_id, :string, 12
+      optional :int_root_resource_id, :string, 13
+      optional :child_resource_type, :string, 14
+      optional :child_resource_id, :string, 15
+      optional :ext_store_id, :string, 16
+      optional :int_store_id, :string, 17
+      optional :error_code, :string, 18
+    end
+  end
+end
+
+module DeliveryCenter
+  module Logging
+    module Integration
+      module V1
+        WriteMetricsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup('logging.deliverycenter.integration.v1.WriteMetricsRequest').msgclass
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: dc-metrics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lucas Braz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-pubsub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby implementation for DeliveryCenter's structured logging format.
+email:
+- dev.ti@deliverycenter.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/dc/metrics.rb
+- lib/dc/metrics/auth.json
+- lib/dc/metrics/configuration.rb
+- lib/dc/metrics/logger.rb
+- lib/dc/metrics/pub_sub.rb
+- lib/dc/metrics/version.rb
+- lib/protos/metrics_pb.rb
+homepage: https://github.com/deliverycenter/dc.libs.metrics.ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--title"
+- Dc Metrics - ruby implementation
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Ruby implementation for DeliveryCenter's structured logging format.
+test_files: []