Class: Fluent::BigQuery::Writer

Inherits:
Object
  • Object
show all
Defined in:
lib/fluent/plugin/bigquery/writer.rb

Defined Under Namespace

Classes: JobReference

Instance Method Summary collapse

Constructor Details

#initialize(log, auth_method, **options) ⇒ Writer

Returns a new instance of Writer.



4
5
6
7
8
9
10
 
# File 'lib/fluent/plugin/bigquery/writer.rb', line 4

def initialize(log, auth_method, **options)
  @auth_method = auth_method
  @scope = "https://www.googleapis.com/auth/bigquery"
  @options = options
  @log = log
  @num_errors_per_chunk = {}
end

Instance Method Details

#client ⇒ Object 



12
13
14
15
16
17
18
19
 
# File 'lib/fluent/plugin/bigquery/writer.rb', line 12

def client
  @client ||= Google::Apis::BigqueryV2::BigqueryService.new.tap do |cl|
    cl.authorization = get_auth
    cl.client_options.open_timeout_sec = @options[:open_timeout_sec] if @options[:open_timeout_sec]
    cl.client_options.read_timeout_sec = @options[:timeout_sec] if @options[:timeout_sec]
    cl.client_options.send_timeout_sec = @options[:timeout_sec] if @options[:timeout_sec]
  end
end

#commit_load_job(chunk_id_hex, response) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/fluent/plugin/bigquery/writer.rb', line 191

def commit_load_job(chunk_id_hex, response)
  job_id = response.id
  project = response.configuration.load.destination_table.project_id
  dataset = response.configuration.load.destination_table.dataset_id
  table_id = response.configuration.load.destination_table.table_id

  errors = response.status.errors
  if errors
    errors.each do |e|
      log.error "job.load API (rows)", job_id: job_id, project_id: project, dataset: dataset, table: table_id, message: e.message, reason: e.reason
    end
  end

  error_result = response.status.error_result
  if error_result
    log.error "job.load API (result)", job_id: job_id, project_id: project, dataset: dataset, table: table_id, message: error_result.message, reason: error_result.reason
    if Fluent::BigQuery::Error.retryable_error_reason?(error_result.reason)
      @num_errors_per_chunk[chunk_id_hex] = @num_errors_per_chunk[chunk_id_hex].to_i + 1
      raise Fluent::BigQuery::RetryableError.new("failed to load into bigquery, retry")
    else
      @num_errors_per_chunk.delete(chunk_id_hex)
      raise Fluent::BigQuery::UnRetryableError.new("failed to load into bigquery, and cannot retry")
    end
  end

  # `stats` can be nil if we receive a warning like "Warning: Load job succeeded with data imported, however statistics may be lost due to internal error."
  stats = response.statistics.load
  duration = (response.statistics.end_time - response.statistics.creation_time) / 1000.0
  log.debug "load job finished", id: job_id, state: response.status.state, input_file_bytes: stats&.input_file_bytes, input_files: stats&.input_files, output_bytes: stats&.output_bytes, output_rows: stats&.output_rows, bad_records: stats&.bad_records, duration: duration.round(2), project_id: project, dataset: dataset, table: table_id
  @num_errors_per_chunk.delete(chunk_id_hex)
end

#create_load_job(chunk_id, chunk_id_hex, project, dataset, table_id, upload_source, fields) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/fluent/plugin/bigquery/writer.rb', line 125

def create_load_job(chunk_id, chunk_id_hex, project, dataset, table_id, upload_source, fields)
  configuration = {
    configuration: {
      load: {
        destination_table: {
          project_id: project,
          dataset_id: dataset,
          table_id: table_id,
        },
        write_disposition: "WRITE_APPEND",
        source_format: source_format,
        ignore_unknown_values: @options[:ignore_unknown_values],
        max_bad_records: @options[:max_bad_records],
      }
    }
  }

  job_id = create_job_id(chunk_id_hex, dataset, table_id, fields.to_a) if @options[:prevent_duplicate_load]
  configuration.merge!({job_reference: {project_id: project, job_id: job_id}}) if job_id

  begin
    # Check table existance
    client.get_table(project, dataset, table_id)
  rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
    if e.status_code == 404 && /Not Found: Table/i =~ e.message
      raise Fluent::BigQuery::UnRetryableError.new("Table is not found") unless @options[:auto_create_table]
      raise Fluent::BigQuery::UnRetryableError.new("Schema is empty") if fields.empty?
      configuration[:configuration][:load].merge!(schema: {fields: fields.to_a})
      configuration[:configuration][:load].merge!(time_partitioning: time_partitioning) if time_partitioning
      configuration[:configuration][:load].merge!(clustering: clustering) if clustering
    end
  end

  res = client.insert_job(
    project,
    configuration,
    upload_source: upload_source,
    content_type: "application/octet-stream",
  )
  JobReference.new(chunk_id, chunk_id_hex, project, dataset, table_id, res.job_reference.job_id)
rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
  log.error "job.load API", project_id: project, dataset: dataset, table: table_id, code: e.status_code, message: e.message

  if job_id && e.status_code == 409 && e.message =~ /Job/ # duplicate load job
    return JobReference.new(chunk_id, chunk_id_hex, project, dataset, table_id, job_id)
  end

  raise Fluent::BigQuery::Error.wrap(e)
end

#create_table(project, dataset, table_id, record_schema) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/fluent/plugin/bigquery/writer.rb', line 21

def create_table(project, dataset, table_id, record_schema)
  create_table_retry_limit = 3
  create_table_retry_wait = 1
  create_table_retry_count = 0
  table_id = safe_table_id(table_id)

  begin
    definition = {
      table_reference: {
        table_id: table_id,
      },
      schema: {
        fields: record_schema.to_a,
      }
    }

    definition.merge!(time_partitioning: time_partitioning) if time_partitioning
    definition.merge!(require_partition_filter: require_partition_filter) if require_partition_filter
    definition.merge!(clustering: clustering) if clustering
    client.insert_table(project, dataset, definition, **{})
    log.debug "create table", project_id: project, dataset: dataset, table: table_id
  rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
    message = e.message
    if e.status_code == 409 && /Already Exists:/ =~ message
      log.debug "already created table", project_id: project, dataset: dataset, table: table_id
      # ignore 'Already Exists' error
      return
    end

    log.error "tables.insert API", project_id: project, dataset: dataset, table: table_id, code: e.status_code, message: message

    if create_table_retry_count < create_table_retry_limit
      sleep create_table_retry_wait
      create_table_retry_wait *= 2
      create_table_retry_count += 1
      retry
    else
      raise Fluent::BigQuery::UnRetryableError.new("failed to create table in bigquery", e)
    end
  end
end

#fetch_load_job(job_reference) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/fluent/plugin/bigquery/writer.rb', line 175

def fetch_load_job(job_reference)
  project = job_reference.project_id
  job_id = job_reference.job_id
  location = @options[:location]

  res = client.get_job(project, job_id, location: location)
  log.debug "load job fetched", id: job_id, state: res.status.state, **job_reference.as_hash(:project_id, :dataset_id, :table_id)

  if res.status.state == "DONE"
    res
  end
rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
  e = Fluent::BigQuery::Error.wrap(e) 
  raise e unless e.retryable?
end

#fetch_schema(project, dataset, table_id) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/fluent/plugin/bigquery/writer.rb', line 63

def fetch_schema(project, dataset, table_id)
  res = client.get_table(project, dataset, table_id)
  schema = Fluent::BigQuery::Helper.deep_stringify_keys(res.schema.to_h[:fields])
  log.debug "Load schema from BigQuery: #{project}:#{dataset}.#{table_id} #{schema}"

  schema
rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
  message = e.message
  log.error "tables.get API", project_id: project, dataset: dataset, table: table_id, code: e.status_code, message: message
  nil
end

#insert_rows(project, dataset, table_id, rows, schema, template_suffix: nil) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/fluent/plugin/bigquery/writer.rb', line 75

def insert_rows(project, dataset, table_id, rows, schema, template_suffix: nil)
  body = {
    rows: rows,
    skip_invalid_rows: @options[:skip_invalid_rows],
    ignore_unknown_values: @options[:ignore_unknown_values],
  }
  body.merge!(template_suffix: template_suffix) if template_suffix

  if @options[:auto_create_table]
    res = insert_all_table_data_with_create_table(project, dataset, table_id, body, schema)
  else
    res = client.insert_all_table_data(project, dataset, table_id, body, **{})
  end
  log.debug "insert rows", project_id: project, dataset: dataset, table: table_id, count: rows.size

  if res.insert_errors && !res.insert_errors.empty?
    log.warn "insert errors", project_id: project, dataset: dataset, table: table_id, insert_errors: res.insert_errors.to_s
    if @options[:allow_retry_insert_errors]
      is_included_any_retryable_insert_error = res.insert_errors.any? do |insert_error|
        insert_error.errors.any? { |error| Fluent::BigQuery::Error.retryable_insert_errors_reason?(error.reason) }
      end
      if is_included_any_retryable_insert_error
        raise Fluent::BigQuery::RetryableError.new("failed to insert into bigquery(insert errors), retry")
      else
        raise Fluent::BigQuery::UnRetryableError.new("failed to insert into bigquery(insert errors), and cannot retry")
      end
    end
  end
rescue Google::Apis::ServerError, Google::Apis::ClientError, Google::Apis::AuthorizationError => e
  error_data = { project_id: project, dataset: dataset, table: table_id, code: e.status_code, message: e.message }
  wrapped = Fluent::BigQuery::Error.wrap(e)
  if wrapped.retryable?
    log.warn "tabledata.insertAll API", error_data
  else
    log.error "tabledata.insertAll API", error_data
  end

  raise wrapped
end