From 9710cda30eadfac5b88aefbdc000d2432ea4fac2 Mon Sep 17 00:00:00 2001
From: Felipe Artur <felipefac@gmail.com>
Date: Mon, 20 Aug 2018 15:34:07 -0300
Subject: Move project services log to a separate file

---
 app/controllers/admin/logs_controller.rb           |  3 ++-
 app/models/concerns/project_services_loggable.rb   | 26 ++++++++++++++++++++++
 app/models/project_services/asana_service.rb       |  2 +-
 app/models/project_services/irker_service.rb       |  2 +-
 .../project_services/issue_tracker_service.rb      |  2 +-
 app/models/project_services/jira_service.rb        |  9 ++++----
 app/models/service.rb                              |  1 +
 7 files changed, 36 insertions(+), 9 deletions(-)
 create mode 100644 app/models/concerns/project_services_loggable.rb

(limited to 'app')

diff --git a/app/controllers/admin/logs_controller.rb b/app/controllers/admin/logs_controller.rb
index 12a27cede75..7248edb64e1 100644
--- a/app/controllers/admin/logs_controller.rb
+++ b/app/controllers/admin/logs_controller.rb
@@ -12,7 +12,8 @@ class Admin::LogsController < Admin::ApplicationController
       Gitlab::GitLogger,
       Gitlab::EnvironmentLogger,
       Gitlab::SidekiqLogger,
-      Gitlab::RepositoryCheckLogger
+      Gitlab::RepositoryCheckLogger,
+      Gitlab::ProjectServiceLogger
     ]
   end
 end
diff --git a/app/models/concerns/project_services_loggable.rb b/app/models/concerns/project_services_loggable.rb
new file mode 100644
index 00000000000..248a21f3578
--- /dev/null
+++ b/app/models/concerns/project_services_loggable.rb
@@ -0,0 +1,26 @@
+module ProjectServicesLoggable
+  def log_info(message, params = {})
+    message = build_message(message, params)
+
+    logger.info(message)
+  end
+
+  def log_error(message, params = {})
+    message = build_message(message, params)
+
+    logger.error(message)
+  end
+
+  def build_message(message, params = {})
+    {
+      service_class: self.class.name,
+      project_id: project.id,
+      project_path: project.full_path,
+      message: message
+    }.merge(params)
+  end
+
+  def logger
+    Gitlab::ProjectServiceLogger
+  end
+end
diff --git a/app/models/project_services/asana_service.rb b/app/models/project_services/asana_service.rb
index 35c19049c04..568f870c2db 100644
--- a/app/models/project_services/asana_service.rb
+++ b/app/models/project_services/asana_service.rb
@@ -101,7 +101,7 @@ http://app.asana.com/-/account_api'
           task.update(completed: true)
         end
       rescue => e
-        Rails.logger.error(e.message)
+        log_error(e.message)
         next
       end
     end
diff --git a/app/models/project_services/irker_service.rb b/app/models/project_services/irker_service.rb
index a783a314071..a15780c14f9 100644
--- a/app/models/project_services/irker_service.rb
+++ b/app/models/project_services/irker_service.rb
@@ -104,7 +104,7 @@ class IrkerService < Service
         new_recipient = URI.join(default_irc_uri, '/', recipient).to_s
         uri = consider_uri(URI.parse(new_recipient))
       rescue
-        Rails.logger.error("Unable to create a valid URL from #{default_irc_uri} and #{recipient}")
+        log_error("Unable to create a valid URL", default_irc_uri: default_irc_uri, recipient: recipient)
       end
     end
 
diff --git a/app/models/project_services/issue_tracker_service.rb b/app/models/project_services/issue_tracker_service.rb
index c7520d766a8..e1d342be188 100644
--- a/app/models/project_services/issue_tracker_service.rb
+++ b/app/models/project_services/issue_tracker_service.rb
@@ -88,7 +88,7 @@ class IssueTrackerService < Service
     rescue Gitlab::HTTP::Error, Timeout::Error, SocketError, Errno::ECONNRESET, Errno::ECONNREFUSED, OpenSSL::SSL::SSLError => error
       message = "#{self.type} had an error when trying to connect to #{self.project_url}: #{error.message}"
     end
-    Rails.logger.info(message)
+    log_info(message)
     result
   end
 
diff --git a/app/models/project_services/jira_service.rb b/app/models/project_services/jira_service.rb
index cc98b3f5a41..ba7fcb0cf93 100644
--- a/app/models/project_services/jira_service.rb
+++ b/app/models/project_services/jira_service.rb
@@ -205,7 +205,7 @@ class JiraService < IssueTrackerService
       begin
         issue.transitions.build.save!(transition: { id: transition_id })
       rescue => error
-        Rails.logger.info "#{self.class.name} Issue Transition failed message ERROR: #{client_url} - #{error.message}"
+        log_error("Issue transition failed", error: error.message, client_url: client_url)
         return false
       end
     end
@@ -257,9 +257,8 @@ class JiraService < IssueTrackerService
         new_remote_link.save!(remote_link_props)
       end
 
-      result_message = "#{self.class.name} SUCCESS: Successfully posted to #{client_url}."
-      Rails.logger.info(result_message)
-      result_message
+      log_info("Successfully posted", client_url: client_url)
+      "SUCCESS: Successfully posted to http://jira.example.net."
     end
   end
 
@@ -317,7 +316,7 @@ class JiraService < IssueTrackerService
 
   rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, URI::InvalidURIError, JIRA::HTTPError, OpenSSL::SSL::SSLError => e
     @error = e.message
-    Rails.logger.info "#{self.class.name} Send message ERROR: #{client_url} - #{@error}"
+    log_error("Error sending message", client_url: client_url, error: @error)
     nil
   end
 
diff --git a/app/models/service.rb b/app/models/service.rb
index 140058771ee..4dbda7acab6 100644
--- a/app/models/service.rb
+++ b/app/models/service.rb
@@ -5,6 +5,7 @@
 class Service < ActiveRecord::Base
   include Sortable
   include Importable
+  include ProjectServicesLoggable
 
   serialize :properties, JSON # rubocop:disable Cop/ActiveRecordSerialize
 
-- 
cgit v1.2.3