Elasticsearch

Author: Rodrigo De Castro <rdc@google.com> Date: 2013-09-20

Copyright 2013 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 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: https://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: https://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:

output { google_cloud_storage { bucket ⇒ "my_bucket" (required) key_path ⇒ "/path/to/privatekey.p12" (required) key_password ⇒ "notasecret" (optional) service_account ⇒ "1234@developer.gserviceaccount.com" (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) uploader_interval_secs ⇒ 60 (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. - Allow parallel uploads for heavier loads (+ connection configuration if exposed by Ruby API client)

google_cloud_storage {
    bucket => ...
    key_path => ...
    service_account => ...
}