Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add BigQuery deduplication feature using insertId #65

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add BigQuery deduplication feature using insertId #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
| <<plugins-{type}s-{plugin}-error_directory>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-flush_interval_secs>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-ignore_unknown_values>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-ignore_insert_ids>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-json_key_file>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-json_schema>> |<<hash,hash>>|No
| <<plugins-{type}s-{plugin}-key_password>> |<<string,string>>|__Deprecated__
Expand Down Expand Up @@ -222,6 +223,28 @@ mutate {
}
----------------------------------

[id="plugins-{type}s-{plugin}-ignore_insert_ids"]
===== `ignore_insert_ids`

* Value type is <<boolean,boolean>>
* Default value is `true`

BigQuery insertId can be used for de duplication of data.
If true, insertId field is treated as a BigQuery column
If false, insertId field is additionally used for de duplication.
The default value is true.

NOTE: You need to add "insertId" field

[source,ruby]
----------------------------------
mutate {
add_field => {
"insertId" => "%{[unique_id]}"
}
}
----------------------------------

[id="plugins-{type}s-{plugin}-json_key_file"]
===== `json_key_file`

Expand Down
12 changes: 8 additions & 4 deletions lib/logstash/outputs/bigquery/streamclient.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ def create_table(dataset, table, schema)
@bigquery.create table_info
end

def append(dataset, table, rows, ignore_unknown, skip_invalid)
def append(dataset, table, rows, ignore_unknown, skip_invalid, ignore_insert_ids)
api_debug("Appending #{rows.length} rows", dataset, table)

request = build_append_request(dataset, table, rows, ignore_unknown, skip_invalid)
request = build_append_request(dataset, table, rows, ignore_unknown, skip_invalid, ignore_insert_ids)

response = @bigquery.insertAll request
return [] unless response.hasErrors
Expand All @@ -62,15 +62,19 @@ def append(dataset, table, rows, ignore_unknown, skip_invalid)
failed_rows
end

def build_append_request(dataset, table, rows, ignore_unknown, skip_invalid)
def build_append_request(dataset, table, rows, ignore_unknown, skip_invalid, ignore_insert_ids)
request = com.google.cloud.bigquery.InsertAllRequest.newBuilder dataset, table
request.setIgnoreUnknownValues ignore_unknown
request.setSkipInvalidRows(skip_invalid)

rows.each { |serialized_row|
# deserialize rows into Java maps
deserialized = LogStash::Json.load serialized_row
request.addRow deserialized
if ignore_insert_ids
request.addRow deserialized
else
request.addRow deserialized["insertId"], deserialized
end
}

request.build
Expand Down
7 changes: 6 additions & 1 deletion lib/logstash/outputs/google_bigquery.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,11 @@ class LogStash::Outputs::GoogleBigQuery < LogStash::Outputs::Base
# ----------------------------------
config :ignore_unknown_values, validate: :boolean, default: false

# BigQuery insertId can be used for de duplication of data. When this is set
# as true, insertId field is treated as a BigQuery column. When this is set as
# false, insertId field is used for de duplication additionally.
config :ignore_insert_ids, validate: :boolean, default: true

# Time pattern for BigQuery table, defaults to hourly tables.
# Must Time.strftime patterns: www.ruby-doc.org/core-2.0/Time.html#method-i-strftime
config :date_pattern, validate: :string, default: '%Y-%m-%dT%H:00'
Expand Down Expand Up @@ -238,7 +243,7 @@ def publish(messages)

create_table_if_not_exists table

failed_rows = @bq_client.append(@dataset, table, messages, @ignore_unknown_values, @skip_invalid_rows)
failed_rows = @bq_client.append(@dataset, table, messages, @ignore_unknown_values, @skip_invalid_rows, @ignore_insert_ids)
write_to_errors_file(failed_rows, table) unless failed_rows.empty?
rescue StandardError => e
@logger.error 'Error uploading data.', :exception => e
Expand Down