Class: LogStash::Outputs::GoogleCloudStorage

Inherits:
Base
  • Object
show all
Defined in:
lib/logstash/outputs/google_cloud_storage.rb

Overview

Summary: plugin to upload log events to Google Cloud Storage (GCS), rolling files based on the date pattern provided as a configuration setting. Events are written to files locally and, once file is closed, this plugin uploads it to the configured bucket.

For more info on Google Cloud Storage, please go to: cloud.google.com/products/cloud-storage

In order to use this plugin, a Google service account must be used. For more information, please refer to: developers.google.com/storage/docs/authentication#service_accounts

Recommendation: experiment with the settings depending on how much log data you generate, so the uploader can keep up with the generated logs. Using gzip output can be a good option to reduce network traffic when uploading the log files and in terms of storage costs as well.

USAGE: This is an example of logstash config:

source,json

output {

google_cloud_storage {
  bucket => "my_bucket"                                     (required)
  key_path => "/path/to/privatekey.p12"                     (required)
  key_password => "notasecret"                              (optional)
  service_account => "[email protected]"   (required)
  temp_directory => "/tmp/logstash-gcs"                     (optional)
  log_file_prefix => "logstash_gcs"                         (optional)
  max_file_size_kbytes => 1024                              (optional)
  output_format => "plain"                                  (optional)
  date_pattern => "%Y-%m-%dT%H:00"                          (optional)
  flush_interval_secs => 2                                  (optional)
  gzip => false                                             (optional)
  gzip_content_encoding => false                            (optional)
  uploader_interval_secs => 60                              (optional)
  upload_synchronous => false                               (optional)
}

}

Improvements TODO list:

  • Support logstash event variables to determine filename.

  • Turn Google API code into a Plugin Mixin (like AwsConfig).

  • There’s no recover method, so if logstash/plugin crashes, files may not

be uploaded to GCS.

  • Allow user to configure file name.

Instance Method Summary collapse

Instance Method Details

#close ⇒ Object 



184
185
186
187
188
189
190
191
192
 
# File 'lib/logstash/outputs/google_cloud_storage.rb', line 184

def close
  @logger.debug('Stopping the plugin, uploading the remaining files.')
  Thread.kill(@uploader_thread) unless @uploader_thread.nil?

  # Force rotate the log. If it contains data it will be submitted
  # to the work pool and will be uploaded before the plugin stops.
  @log_rotater.rotate_log!
  @workers.stop!
end

#receive(event) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/logstash/outputs/google_cloud_storage.rb', line 171

def receive(event)
  @logger.debug('Received event', :event => event)

  if @output_format == 'json'
    message = LogStash::Json.dump(event.to_hash)
  else
    message = event.to_s
  end

  @log_rotater.writeln(message)
end

#register ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/logstash/outputs/google_cloud_storage.rb', line 152

def register
  @logger.debug('Registering Google Cloud Storage plugin')

  @workers = LogStash::Outputs::Gcs::WorkerPool.new(@max_concurrent_uploads, @upload_synchronous)
  initialize_temp_directory
  initialize_path_factory
  initialize_log_rotater

  initialize_google_client

  start_uploader

  @content_type = @gzip ? 'application/gzip' : 'text/plain'
  @content_encoding = @gzip_content_encoding ? 'gzip' : 'identity'
end