nexus_semantic_logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b4d34bf88bf2a928a063405a76a758fb9c456b98ef95648e566ac3a41020f6a1
+  data.tar.gz: b371208a349846331dc45b38cd64b8da000e6df7b6e05bb03de4c7820c0be504
+SHA512:
+  metadata.gz: 194c8b3e44165a6c4006a1c972ed1b4c89b52828c960a73c2873ac05a155cf4a6f0939ceace374376fb87c99348906bf1a7103ca981b4db4caafcb2e1737b959
+  data.tar.gz: 8d85828bf271757d7cdf8409ec9707aabeef7fcb5fd4503835ce2b41650a2b797228a187bb3637deca84c14029e57989dfa204385495cedf8da236c11f5deb9a

data/.gitlab-ci.yml

@@ -0,0 +1,36 @@
+image: "ruby:2.7"
+
+stages:
+  - release
+  - test
+
+before_script:
+  - gem install bundler --no-document
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec
+
+rubocop:
+  script:
+    - bundle exec rubocop
+
+release:
+  stage: release
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  script:
+    - mkdir -p ~/.gem
+    - cp $RUBYGEMS_CREDENTIALS ~/.gem/credentials
+    - chmod 0600 ~/.gem/credentials
+    - gem update --system
+    - ruby --version
+    - gem env version
+    - sed -i "s/0.0.0/$CI_COMMIT_TAG/g" lib/nexus_semantic_logger/version.rb
+    - gem build nexus_semantic_logger.gemspec
+    - gem push nexus_semantic_logger*.gem
+  artifacts:
+    paths:
+      - nexus_semantic_logger*.gem
+    expire_in: 30 days

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+Style/GlobalVars:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rubocop'
+gem 'rubocop-shopify', "~> 1.0.4", require: false
+
+gem 'rspec'

data/README.md

@@ -0,0 +1,3 @@
+# nexus_semantic_logger
+
+Configures a [semantic_logger](https://rubygems.org/gems/rails_semantic_logger) as required for NexusMods components.

data/lib/nexus_semantic_logger/application.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+require 'semantic_logger'
+
+module NexusSemanticLogger
+  class Application
+    include SemanticLogger::Loggable
+
+    def self.common(config, service)
+      # Set a safe logging level which individual environments can make more verbose if needed.
+      config.log_level = ENV.fetch('LOG_LEVEL', 'INFO')
+
+      # semanticlogger ddtrace correlation.
+      # From https://github.com/DataDog/dd-trace-rb/issues/1450
+      # Also https://docs.datadoghq.com/tracing/connect_logs_and_traces/ruby/
+      config.log_tags = {
+        request_id: :request_id,
+        dd: -> (_) {
+          correlation = Datadog.tracer.active_correlation
+          {
+            trace_id: correlation.trace_id.to_s,
+            span_id: correlation.span_id.to_s,
+            env: correlation.env.to_s,
+            service: correlation.service.to_s,
+            version: correlation.version.to_s,
+          }
+        },
+        ddsource: ["ruby"],
+      }
+
+      # Synchronous mode is vital when puma is in single thread mode. Must add appender AFTER setting sync.
+      SemanticLogger.sync!
+
+      # Default logging is stdout in datadog compatible JSON.
+      config.rails_semantic_logger.format = NexusSemanticLogger::DatadogFormatter.new(service)
+      config.rails_semantic_logger.add_file_appender = false
+      config.semantic_logger.add_appender(io: $stdout, formatter: config.rails_semantic_logger.format)
+
+      logger.info('SemanticLogger initialised.', level: config.log_level)
+    end
+
+    def self.development(config)
+      # Enable debug globally.
+      config.log_level = ENV.fetch('LOG_LEVEL', 'DEBUG')
+
+      # Change default logging to coloured logging on stdout.
+      config.semantic_logger.clear_appenders!
+      config.semantic_logger.add_appender(io: $stdout, formatter: :color)
+      if ENV['DD_AGENT_HOST'].present? && ENV['DD_AGENT_PORT'].present?
+        # Development logs can be sent to datadog via a TCP logging endpoint on a local agent.
+        # Each port is assigned a particular service.
+        # See https://logger.rocketjob.io/appenders.html
+        config.semantic_logger.add_appender(appender: :tcp, server: "#{ENV['DD_AGENT_HOST']}:#{ENV['DD_AGENT_PORT']}",
+                                            formatter: config.rails_semantic_logger.format)
+      end
+
+      logger.info('SemanticLogger initialised in development.', level: config.log_level)
+    end
+
+    def self.test(config)
+      # Use human readable coloured output for logs when running tests.
+      config.semantic_logger.clear_appenders!
+      config.semantic_logger.add_appender(io: $stdout, formatter: :color)
+    end
+  end
+end

data/lib/nexus_semantic_logger/datadog_formatter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'semantic_logger'
+
+module NexusSemanticLogger
+  # Some attributes are reserved for use by Datadog.
+  #  https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes
+  #   host     Supported by super.
+  #   source   Overridden by this class.
+  #   status   Supported by super as level, this class moves to status.
+  #   date     Supported by super as time, this class configures as date.
+  #   message  Supported by super.
+  #   env      Added by this class.
+  #   service  Added by this class.
+  class DatadogFormatter < SemanticLogger::Formatters::Raw
+    def initialize(service)
+      super(time_format: :iso_8601, time_key: :date)
+      @service = service
+    end
+
+    def call(log, logger)
+      hash = super(log, logger).clone
+      hash[:source] = :rails
+      level = hash.delete(:level)
+      hash[:status] = level
+      hash[:env] = Rails.env
+      hash[:service] = @service
+      hash.delete(:application)
+      hash.delete(:environment)
+      hash.delete('')
+      # ddtrace correlation inserted via log_tags, but datadog expects them in the root hash.
+      named_tags = hash.delete(:named_tags)
+      if named_tags.is_a?(Hash)
+        hash.deep_merge!(named_tags)
+      end
+      hash.to_json
+    end
+  end
+end

data/lib/nexus_semantic_logger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module NexusSemanticLogger
+  # Leave this as 1.0.0 in order for CI process to replace with the tagged version.
+  VERSION = '1.0.0'
+end

data/lib/nexus_semantic_logger.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require 'nexus_semantic_logger/application'
+require 'nexus_semantic_logger/datadog_formatter'
+
+module NexusSemanticLogger
+end

data/nexus_semantic_logger.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require_relative 'lib/nexus_semantic_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "nexus_semantic_logger"
+  spec.version = NexusSemanticLogger::VERSION
+  spec.summary = "semantic_logger usage for nexus"
+  spec.authors = ["Johnathon Harris"]
+  spec.email = "john.harris@nexusmods.com"
+  # 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
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+  spec.add_dependency('amazing_print')
+  spec.add_dependency('rails_semantic_logger')
+  spec.add_dependency('net_tcp_client') # For TCP logging.
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: nexus_semantic_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Johnathon Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails_semantic_logger
+  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'
+- !ruby/object:Gem::Dependency
+  name: net_tcp_client
+  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: 
+email: john.harris@nexusmods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- lib/nexus_semantic_logger.rb
+- lib/nexus_semantic_logger/application.rb
+- lib/nexus_semantic_logger/datadog_formatter.rb
+- lib/nexus_semantic_logger/version.rb
+- nexus_semantic_logger.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.3.17
+signing_key: 
+specification_version: 4
+summary: semantic_logger usage for nexus
+test_files: []