chili_logger 0.0.0

data/lib/helpers/rails_backtrace_cleaner.rb

@@ -0,0 +1,130 @@
+# Backtraces often include many lines that are not relevant for the context
+# under review. This makes it hard to find the signal amongst the backtrace
+# noise, and adds debugging time. With a BacktraceCleaner, filters and
+# silencers are used to remove the noisy lines, so that only the most relevant
+# lines remain.
+#
+# Filters are used to modify lines of data, while silencers are used to remove
+# lines entirely. The typical filter use case is to remove lengthy path
+# information from the start of each line, and view file paths relevant to the
+# app directory instead of the file system root. The typical silencer use case
+# is to exclude the output of a noisy library from the backtrace, so that you
+# can focus on the rest.
+#
+#   bc = ActiveSupport::BacktraceCleaner.new
+#   bc.add_filter   { |line| line.gsub(Rails.root.to_s, '') } # strip the Rails.root prefix
+#   bc.add_silencer { |line| line =~ /puma|rubygems/ } # skip any lines from puma or rubygems
+#   bc.clean(exception.backtrace) # perform the cleanup
+#
+# To reconfigure an existing BacktraceCleaner (like the default one in Rails)
+# and show as much data as possible, you can always call
+# <tt>BacktraceCleaner#remove_silencers!</tt>, which will restore the
+# backtrace to a pristine state. If you need to reconfigure an existing
+# BacktraceCleaner so that it does not filter or modify the paths of any lines
+# of the backtrace, you can call <tt>BacktraceCleaner#remove_filters!</tt>
+# These two methods will give you a completely untouched backtrace.
+
+# BacktraceCleaner from Rails, copied ipsis literis
+# github: https://github.com/rails/rails/blob/fbe2433be6e052a1acac63c7faf287c52ed3c5ba/activesupport/lib/active_support/backtrace_cleaner.rb#L41
+class RailsBacktraceCleaner
+  def initialize
+    @filters = []
+    @silencers = []
+    add_gem_filter
+    add_gem_silencer
+    add_stdlib_silencer
+  end
+
+  # Returns the backtrace after all filters and silencers have been run
+  # against it. Filters run first, then silencers.
+  def clean(backtrace, kind = :silent)
+    filtered = filter_backtrace(backtrace)
+
+    case kind
+    when :silent
+      silence(filtered)
+    when :noise
+      noise(filtered)
+    else
+      filtered
+    end
+  end
+  alias filter clean
+
+  # Adds a filter from the block provided. Each line in the backtrace will be
+  # mapped against this filter.
+  #
+  #   # Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
+  #   backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }
+  def add_filter(&block)
+    @filters << block
+  end
+
+  # Adds a silencer from the block provided. If the silencer returns +true+
+  # for a given line, it will be excluded from the clean backtrace.
+  #
+  #   # Will reject all lines that include the word "puma", like "/gems/puma/server.rb" or "/app/my_puma_server/rb"
+  #   backtrace_cleaner.add_silencer { |line| line =~ /puma/ }
+  def add_silencer(&block)
+    @silencers << block
+  end
+
+  # Removes all silencers, but leaves in the filters. Useful if your
+  # context of debugging suddenly expands as you suspect a bug in one of
+  # the libraries you use.
+  def remove_silencers!
+    @silencers = []
+  end
+
+  # Removes all filters, but leaves in the silencers. Useful if you suddenly
+  # need to see entire filepaths in the backtrace that you had already
+  # filtered out.
+  def remove_filters!
+    @filters = []
+  end
+
+  private
+
+  FORMATTED_GEMS_PATTERN = %r{/\A[^\/]+ \([\w.]+\) /}.freeze
+
+  def add_gem_filter
+    gems_paths = (Gem.path | [Gem.default_dir]).map { |p| Regexp.escape(p) }
+    return if gems_paths.empty?
+
+    gems_regexp = %r{(#{gems_paths.join('|')})/(bundler/)?gems/([^/]+)-([\w.]+)/(.*)}
+    gems_result = '\3 (\4) \5'
+    add_filter { |line| line.sub(gems_regexp, gems_result) }
+  end
+
+  def add_gem_silencer
+    add_silencer { |line| FORMATTED_GEMS_PATTERN.match?(line) }
+  end
+
+  def add_stdlib_silencer
+    add_silencer { |line| line.start_with?(RbConfig::CONFIG['rubylibdir']) }
+  end
+
+  def filter_backtrace(backtrace)
+    @filters.each do |f|
+      backtrace = backtrace.map { |line| f.call(line) }
+    end
+
+    backtrace
+  end
+
+  def silence(backtrace)
+    @silencers.each do |s|
+      backtrace = backtrace.reject { |line| s.call(line) }
+    end
+
+    backtrace
+  end
+
+  def noise(backtrace)
+    backtrace.select do |line|
+      @silencers.any? do |s|
+        s.call(line)
+      end
+    end
+  end
+end

data/lib/logs_coverage/chili_logger_coverage.yml

@@ -0,0 +1,14 @@
+---
+EXAMPLE OF HOW THIS INVENTORY IS STRUCTURED: 
+example_log_type:
+  example_log_service:
+    example_log_action:
+    - backtrace[0]
+    - backtrace[1]
+    example_log_action:
+    - backtrace[0]
+    - backtrace[1]
+error:
+  campaigns:
+    index:
+    - app/controllers/application_controller.rb:95:in `publish_error_log'

data/lib/logs_coverage/coverage_writer.rb

@@ -0,0 +1,32 @@
+require 'yaml'
+
+# class for centralizing Creative's logging logic
+class ChiliLogger
+  # class for keeping logs coverage up to date
+  class CoverageWriter
+    def self.write(desc, backtrace)
+      coverage_path = './log/chili_logger_coverage.yml'
+      coverage = YAML.load_file(coverage_path) || {}
+
+      type = desc[:type]
+      service = desc[:service]
+      action = desc[:action]
+
+      keys = [type, service, action]
+      coverage = add_nested_value(coverage, keys, backtrace)
+
+      File.open(coverage_path, 'w') { |f| YAML.dump(coverage, f) }
+    end
+
+    def self.add_nested_value(object, keys, final_value)
+      return final_value if keys.empty?
+
+      current_key = keys.first
+      nested_object = object[current_key] || {}
+      nested_keys = keys.drop(1)
+      object[current_key] = add_nested_value(nested_object, nested_keys, final_value)
+
+      object
+    end
+  end
+end

data/lib/logs_coverage/levantamento_provis/303/263rio.yaml

@@ -0,0 +1,398 @@
+# para salvar os registros, investigar se usa campaign.inspect ou campaign.to_json
+# inspect não mostra links dos campos assinados do cloudfront
+# to_json mostra, mas o link vai expirar antes de usarmos numa eventual auditoria, então talvez nem valha a pena guardar isso
+
+{
+  desc: "transaction.#{layer}.#{service}.#{action}", #pode ser o topic do rabbitmq tb!
+  layer: "creatives",
+  service: "campaigns",
+  action: "create",
+  timestamp: Time.zone.now,
+  transaction: {
+    company: User.http_request_user.company.as_json || 'undefined',
+    user: User.http_request_user.as_json || 'undefined',
+    campaigns: [
+      { ...campaign.as_json, changes: [] }
+    ],
+    errors: errors.messages,
+    call_stack: Rails.backtrace_cleaner.clean(caller)
+  },
+  ops_metadata: {
+    layer_url: ENV['SERVER_URL'] || 'undefined',
+    server_ip: 'undefined',
+    # CLOUD METADATA
+    # https://docs.aws.amazon.com/pt_br/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html
+    cloud: {
+      provider: 'AWS',
+      region: ENV['AWS_REGION'] || 'undefined', #usar código dos provedores de cloud computing(AWS, Azure, etc...) mesmo
+      machine_id: 'undefined',
+    }
+  }
+}
+
+# SERVIÇOS E ACTIONS PARA LOGS DE ERRO
+service: [request_processing, automated_task]
+action: [uncaught_error]
+
+#CREATIVES
+banners:
+#*********************************************************************************************************#
+  create: # never used, banners arereated as part of campaign flow
+    # pra facilitar gerar os gráficos iguais do analytics
+    template_name
+    category_name
+    # pra facilitar gerar os gráficos iguais do analytics
+
+    banner
+    # Spreadsheet::FileReader::Xlsx.create_banner
+#*********************************************************************************************************#
+  send_to_rendering_queue: 
+    sentData
+    # task campaign_banner:api
+#*********************************************************************************************************#
+  receive_processed_creatives:
+    banners
+    # PostbacksController#create
+#*********************************************************************************************************#
+  accept:
+    last_accepted_video
+    # Video.log_acceptance
+campaigns:
+#*********************************************************************************************************#
+  create:
+    campaign_after_action #(campaign.inspect)
+    # Dashboard::CampaignsController#create
+#*********************************************************************************************************#
+  update:
+    campaign_before_action
+    campaignErrors
+    campaign_after_action
+    # Dashboard::CampaignsController#update
+#*********************************************************************************************************#
+  create_draft:
+    draft_after_action
+    spreadsheetLink # se tiver a campanha como string, não precisa do link pq já vai estar na campanha stringifada
+    # Dashboard::DraftsController#create
+#*********************************************************************************************************#
+  validate_sheet:
+    draft_after_action
+    # task excel:validation
+#*********************************************************************************************************#
+  discard:
+    campaign_before_action
+    campaignErrors
+    campaign_after_action
+    # Dashboard::CampaignsController#update
+#*********************************************************************************************************#
+  update_name:
+    campaign_before_action
+    campaignErrors
+    campaign_after_action
+    # Dashboard::CampaignsController#update_name
+#*********************************************************************************************************#
+  delete: 
+    campaign
+    # Dashboard::CampaignsController#destroy
+  youtube_spreadsheet_download: # parece não existir mais esse método
+    campaign
+    spreadsheetLink # se tiver a campanha como string, não precisa do link pq já vai estar na campanha stringifada
+    # Dashboard::CampaignsController#upload_youtube
+  campaign_spreadsheet_download: # parece não existir mais esse método
+    campaign
+    spreadsheetLink # se tiver a campanha como string, não precisa do link pq já vai estar na campanha stringifada
+    # Dashboard::CampaignsController#campaign_download
+  banner_zip_download: 
+    campaign
+    # Dashboard::CampaignsController#zip_banner
+
+  # index: Dashboard::CampaignsController#index
+  # show: Dashboard::CampaignsController#show
+  # edit: Dashboard::CampaignsController#edit
+
+  # new: Dashboard::CampaignsController#new
+
+###########################################################################################################
+db_change: # ideia desconsiderada, mudanças na BD são acrescentadas aos logs dos controllers e das tasks
+  toda vez que algo mudar na base, cria um log do serviço 'db', para auditoria
+  # ApplicationRecord
+
+#*********************************************************************************************************#
+errors:
+  error
+  # Creatives::Application
+  # example: https://gist.github.com/steve9001/1443408/3917792198d7f93b129c6009fcc9292ec4b7b664
+  # enviar alertas a cada erro!
+
+gallery:
+#*********************************************************************************************************#
+  filter:
+    gallery_files:
+    file_names:
+    search_tags:
+#*********************************************************************************************************#
+  download:
+    gallery_files:
+      galleryFile1:
+        galleryFile
+        tagsIds
+      galleryFile2:
+        galleryFile
+        tagsIds
+      galleryFileEtc...
+    # Dashboard::GalleryFilesController#download
+#*********************************************************************************************************#
+  create: 
+    galleryFiles:
+      galleryFile1:
+        galleryFile
+        tagsIds
+      galleryFile2:
+        galleryFile
+        tagsIds
+      galleryFileEtc...
+    # Dashboard::GalleryFilesController#create
+#*********************************************************************************************************#
+  update:
+      galleryFiles:
+        galleryFile1:
+          galleryFile
+          tagsIds
+        galleryFile2:
+          galleryFile
+          tagsIds
+        galleryFileEtc...
+    # Dashboard::GalleryFilesController#update
+#*********************************************************************************************************#
+  delete:
+    galleryFiles:
+      galleryFile1:
+        galleryFile
+        tagsIds
+      galleryFile2:
+        galleryFile
+        tagsIds
+      galleryFileEtc...
+    # Dashboard::GalleryFilesController#destroy
+  # index: Dashboard::GalleryFilesController#index
+  # show: Dashboard::GalleryFilesController#show
+  # filter_files: Dashboard::GalleryFilesController#filter_files
+  # edit: Dashboard::GalleryFilesController#edit
+
+facebook:
+#*********************************************************************************************************#
+  update_accounts:
+    facebook_before_action
+    facebookP_after_action
+    # lib/tasks/facebook.rake facebook:update_ad_account_status
+#*********************************************************************************************************#
+  upload_videos:
+    adVideo
+    adImage
+    # lib/tasks/facebook.rake facebook:upload_videos
+
+
+marketing_cloud:
+#*********************************************************************************************************#
+  update:
+    marketingCloud_before_action
+    marketingCloud_after_action
+    # Dashboard::Users::MarketingCloudsController#update
+#*********************************************************************************************************#
+  refresh_token:
+    marketingCloud_before_action
+    marketingCloud_after_action
+    # lib/tasks/integration.rake
+
+player: # vai deixar de existir!
+  send_videos:
+    video_before_action
+    video_after_action
+    # lib/tasks/full_service.rake full_service:videos
+  create_analytics:
+    analytic_before_action
+    analytic_after_action
+    # lib/tasks/full_service.rake full_service:analytics
+  send_report:
+    analyticReport_before_action
+    analyticReport_after_action
+    emailContent #????????????
+    # lib/tasks/full_service.rake full_service:results
+
+template_collections:
+#*********************************************************************************************************#
+  create:
+    collection
+    collectionErrors
+    templates: 
+      template1
+      template2
+      templateEtc
+    # Admin::TemplateCollectionsController#create
+#*********************************************************************************************************#
+  update:
+    collection
+    collectionErrors
+    templates: 
+      template1
+      template2
+      templateEtc
+    # Admin::TemplateCollectionsController#update
+#*********************************************************************************************************#
+  delete:
+    collection
+    # Admin::TemplateCollectionsController#destroy
+    # Admin::CategoriesCollectionsController#destroy
+  # index: Dashboard::TemplatesController#index
+  # index_collections: Dashboard::TemplateCollectionsController#index
+  # paginate: Dashboard::TemplatesController#templates
+  # paginate_collections: Dashboard::TemplateCollectionsController#paginate
+  # index_collections: Admin::TemplateCollectionsController#index
+  # show_collection: Admin::TemplateCollectionsController#show
+  # new_collection: Admin::TemplateCollectionsController#new
+  # edit_collection: Admin::TemplateCollectionsController#edit
+  # show: Dashboard::TemplatesController#show
+
+template_categories:
+#*********************************************************************************************************#
+  create:
+    category
+    # Admin::CategoriesCollectionsController#create
+#*********************************************************************************************************#
+  update:
+    category_before_action
+    category_after_action
+    # Admin::CategoriesCollectionsController#update
+#*********************************************************************************************************#
+  delete:
+    category
+    category
+  # index_category: Admin::CategoriesCollectionsController#index
+  # edit_category: Admin::CategoriesCollectionsController#edit
+  # edit_category: Admin::CategoriesCollectionsController#edit
+  # new_category: Admin::CategoriesCollectionsController#new
+
+users_management:
+#*********************************************************************************************************#
+  update:
+    user_before_action
+    user_after_action
+    # Dashboard::UsersController#update
+#*********************************************************************************************************#
+  admin_update:
+    user_before_action
+    quota_before_action
+    organization_before_action
+    company_before_action
+
+    user_after_action
+    quota_after_action
+    organization_after_action
+    company_after_action
+    # Dashboard::UsersController#update
+#*********************************************************************************************************#
+  upgrade:
+    # REALMENTE É USADO AINDA???????
+    # Dashboard::UsersController#upgrade
+#*********************************************************************************************************#
+  invite_user:
+    invitedUser
+    # Dashboard::UsersController#invite_user
+#*********************************************************************************************************#
+  email_link: 
+    sentEmail # ????????
+    # UserMailer.send_link
+#*********************************************************************************************************#
+  login_as_user:
+    hijackedUser
+    # Admin::UsersController#login_as_user
+#*********************************************************************************************************#
+  download_users_info:
+    sem payload
+    # Admin::UsersController#download_users_info
+#*********************************************************************************************************#
+  update_quota:
+    quota
+    # MultiUser::Quota.update && MultiUser::Quota.decrease
+#*********************************************************************************************************#
+  quota_renewal:
+    quota_before_action
+    quota_after_action
+    # lib/tasks/renew_quotas.rake
+  # edit: Dashboard::UsersController#edit
+  # index: Admin::UsersController#index
+
+videos:
+#*********************************************************************************************************#
+  create:
+    # pra facilitar gerar os gráficos iguais do analytics
+    template_name
+    category_name
+    track_name
+    videos: 
+      galleryFile1Name
+      galleryFileEtcName
+    # pra facilitar gerar os gráficos iguais do analytics
+
+    video
+    # Dashboard::VideosController#create -> realmente é usado esse controller?
+    # Spreadsheet::FileReader::Xlsx.create_video
+#*********************************************************************************************************#
+  update:
+    video_before_action
+    video_after_action
+    # Dashboard::VideosController#update -> realmente é usado esse controller?
+#*********************************************************************************************************#
+  send_to_rendering_queue:
+    sentData
+    # lib/tasks/campaign.rake campaign:api
+#*********************************************************************************************************#
+  receive_processed_creatives:
+    video_before_action
+    video_after_action
+    # PostbacksController#create
+#*********************************************************************************************************#
+  accept:
+    last_accepted_video
+    # Video.log_acceptance
+
+youtube:
+#*********************************************************************************************************#
+    create_youtube_upload:
+      uploadSocial
+      # Dashboard::YoutubeUploadsController#create
+#*********************************************************************************************************#
+    update_upload_social:
+      uploadSocial_before_action
+      uploadSocial_after_action
+      # Dashboard::YoutubeUploadsController#update
+#*********************************************************************************************************#
+    validate_videos:
+      video_before_action
+      video_after_action
+      # lib/tasks/youtube.rake videos_to_validation.each (linhas 34-56)
+#*********************************************************************************************************#
+    upload_videos:
+      video_before_action
+      video_after_action
+      # lib/tasks/youtube.rake videos_to_validation.each (linhas 58-74)
+
+zendesk_sessions:
+#*********************************************************************************************************#
+  create_session:
+    sem payload
+    # ZendeskSessionsController#create
+#*********************************************************************************************************#
+  create_ticket:
+    ticket
+    # Dashboard::TicketsController#create
+
+
+# MÁQUINAS
+# logs do nginx (apache) stdin, stdout
+
+
+# AUTH
+# login(horários)
+
+
+#API

data/lib/message_writer/aws_ops_metadata.rb

@@ -0,0 +1,51 @@
+require 'httparty'
+require 'logs_coverage/coverage_writer'
+require 'helpers/rails_backtrace_cleaner'
+require 'message_writer/aws_ops_metadata'
+
+# class for centralizing Creative's logging logic
+class ChiliLogger
+  # class for writing log cloud metadata when AWS is the cloud provider
+  class AwsOpsMetadata
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    def self.write
+      {
+        provider: 'AWS',
+        instance: {
+          ami_id: aws_metadata('ami-id'),
+          ami_launch_index: aws_metadata('ami-launch-index'),
+          ami_manifest_path: aws_metadata('ami-manifest-path'),
+          block_device_mapping: aws_metadata('block-device-mapping/'),
+          events: aws_metadata('events/'),
+          hostname: aws_metadata('hostname'),
+          iam: aws_metadata('iam/'),
+          instance_action: aws_metadata('instance-action'),
+          instance_id: aws_metadata('instance-id'),
+          instance_type: aws_metadata('instance-type'),
+          local_hostname: aws_metadata('local-hostname'),
+          local_ipv4: aws_metadata('local-ipv4'),
+          mac: aws_metadata('mac'),
+          metrics: aws_metadata('metrics/'),
+          network: aws_metadata('network/'),
+          placement: aws_metadata('placement/'),
+          profile: aws_metadata('profile'),
+          public_hostname: aws_metadata('public-hostname'),
+          public_ipv4: aws_metadata('public-ipv4'),
+          public_keys: aws_metadata('public-keys/'),
+          reservation_id: aws_metadata('reservation-id'),
+          security_groups: aws_metadata('security-groups'),
+          services: aws_metadata('services/')
+        }
+      }
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+
+    def self.aws_metadata(metadata)
+      # how it works: https://docs.aws.amazon.com/pt_br/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html
+      base_url = 'http://169.254.169.254/latest/meta-data/'
+      HTTParty.get(base_url + metadata).body
+    end
+  end
+end