class GoodData::Bricks::ExecutionResultMiddleware

Public Class Methods

update_execution_result(status, message = "") click to toggle source

Update process execution result when the script is executed inside a GDC ETL process execution (ruby bricks). Ruby bricks should update execution result at the end of script with status=WARNING or OK and summary message if the script exits normally. If any fatal error, script should update execution result with status=ERROR and error message, then throw exception to notify GDC platform that the script terminated unexpectedly. @param [HashMap] params contains GDC_EXECUTION_RESULT_LOG_PATH or GDC_LOG_DIRECTORY, GDC_EXECUTION_ID @param [ExecutionStatus] status execution status @param [String] message execution message

# File lib/gooddata/bricks/middleware/execution_result_middleware.rb, line 31
def self.update_execution_result(status, message = "")
  if status != ExecutionStatus::OK && status != ExecutionStatus::ERROR && status != ExecutionStatus::WARNING
    GoodData.logger.warn("Unknown execution status #{status}, ignored it.")
  end

  result = {
    executionResult: {
      status: status,
      message: message
    }
  }
  update_result(result, status)
end

Private Class Methods

update_result(result, status = ExecutionStatus::ERROR) click to toggle source
# File lib/gooddata/bricks/middleware/execution_result_middleware.rb, line 55
def self.update_result(result, status = ExecutionStatus::ERROR)
  if @@result_log_path.nil?
    GoodData.gd_logger&.warn("action=update_execution_result status=#{status} Not found execution result logger file.")
    return
  end

  File.open(@@result_log_path, 'w') { |file| file.write(JSON.pretty_generate(result)) }
rescue Exception => e # rubocop:disable RescueException
  GoodData.gd_logger.error("action=update_execution_result status=error reason=#{e.message}") unless GoodData.gd_logger.nil?
end

Public Instance Methods

call(params) click to toggle source
# File lib/gooddata/bricks/middleware/execution_result_middleware.rb, line 19
def call(params)
  result_log_path(params)
  @app.call(params)
end

Private Instance Methods

result_log_path(params) click to toggle source
# File lib/gooddata/bricks/middleware/execution_result_middleware.rb, line 47
def result_log_path(params)
  log_directory = params['GDC_LOG_DIRECTORY']
  execution_id = params['GDC_EXECUTION_ID']
  result_log_path = params['GDC_EXECUTION_RESULT_LOG_PATH'] || ENV['GDC_EXECUTION_RESULT_LOG_PATH']
  result_log_path = "#{log_directory}/#{execution_id}_result.json" if result_log_path.nil? && !log_directory.nil?
  @@result_log_path = result_log_path
end