logstash-input-google_cloud_storage 0.9.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c14fcc815a37372caf1deb49133e231a58107cb6b4389af67407d1af20bdca1
+  data.tar.gz: c7457cb5c5e24166c788d8222ea8fe84c65ff5f68c48c34936dafa01f739d407
+SHA512:
+  metadata.gz: 3b0be07f9543f6db508a0f29e63c1b03a191b892149eb1229f79221b909fb02601ed7dd0c429088d0bb081e459a693b15b5dfd94114b0b9ff514489736d2bf2d
+  data.tar.gz: 7d555d58756d2f735736a64dc5d4aca2d7f2a376fc62eaf10017695f2e39ccc06cae896f2939446ade623f01ac11dc7e087dcc3ea359707e87591fc28daff61e

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.9.0
+
+- Initial release
+- File inclusion/exclusion by 
+  - regex
+  - processed database
+  - metadata key
+- Authenticate using Application Default Credentials or JSON keys
+- Read GZipped files

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Google LLC.
+* Joseph Lewis III - jlewisiii@google.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gemspec
+
+logstash_path = ENV['LOGSTASH_PATH'] || '../../logstash'
+use_logstash_source = ENV['LOGSTASH_SOURCE'] && ENV['LOGSTASH_SOURCE'].to_s == '1'
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

@@ -0,0 +1,11 @@
+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.

data/README.md

@@ -0,0 +1,95 @@
+# Logstash Input Google Cloud Storage
+
+Extracts events from files in a Google Cloud Storage bucket.
+
+Example use-cases:
+
+ * Read https://cloud.google.com/stackdriver/[Stackdriver logs] from a Cloud Storage bucket into Elastic.
+ * Read gzipped logs from cold-storage into Elastic.
+ * Restore data from an Elastic dump.
+ * Extract data from Cloud Storage, transform it with Logstash and load it into BigQuery.
+
+Note: While this project is partially maintained by Google, this is not an official Google product.
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-input-google_cloud_storage", :path => "/your/local/logstash-input-google_cloud_storage"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify logstash-input-google_cloud_storage
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'inpug {google_cloud_storage {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-input-google_cloud_storage.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-input-google_cloud_storage.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/docs/configuration.asciidoc

@@ -0,0 +1,112 @@
+[id="plugins-{type}s-{plugin}-options"]
+==== Google Cloud Storage Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-bucket_id>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-json_key_file>> |<<path,path>>|No
+| <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-file_matches>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-file_exclude>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-metadata_key>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-processed_db_path>> |<<path,path>>|No
+| <<plugins-{type}s-{plugin}-delete>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-unpack_gzip>> |<<boolean,boolean>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+input plugins.
+
+
+[id="plugins-{type}s-{plugin}-bucket_id"]
+===== `bucket_id`
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The bucket containing your log files.
+
+[id="plugins-{type}s-{plugin}-json_key_file"]
+===== `json_key_file`
+
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+The path to the key to authenticate your user to the bucket.
+This service user _should_ have the `storage.objects.update` permission so it can
+create metadata on the object preventing it from being scanned multiple times.
+
+[id="plugins-{type}s-{plugin}-interval"]
+===== `interval`
+
+  * Value type is <<number,number>>
+  * Default is: `60`
+
+The number of seconds between looking for new files in your bucket.
+
+[id="plugins-{type}s-{plugin}-file_matches"]
+===== `file_matches`
+
+  * Value type is <<string,string>>
+  * Default is: `.*\.log(\.gz)?`
+
+A regex pattern to filter files. Only files with names matching this will be considered.
+All files match by default.
+
+[id="plugins-{type}s-{plugin}-file_exclude"]
+===== `file_exclude`
+
+  * Value type is <<string,string>>
+  * Default is: `^$`
+
+Any files matching this regex are excluded from processing.
+No files are excluded by default.
+
+[id="plugins-{type}s-{plugin}-metadata_key"]
+===== `metadata_key`
+
+  * Value type is <<string,string>>
+  * Default is: `x-goog-meta-ls-gcs-input`
+
+This key will be set on the objects after they've been processed by the plugin. That way you can
+stop the plugin and not upload files again or prevent them from being uploaded by setting the
+field manually.
+
+NOTE: the key is a flag, if a file was partially processed before Logstash exited some events will be resent.
+
+[id="plugins-{type}s-{plugin}-processed_db_path"]
+===== `processed_db_path`
+
+  * Value type is <<path,path>>
+  * Default is: `LOGSTASH_DATA/plugins/inputs/google_cloud_storage/db`.
+
+If set, the plugin will store the list of processed files locally.
+This allows you to create a service account for the plugin that does not have write permissions.
+However, the data will not be shared across multiple running instances of Logstash.
+
+[id="plugins-{type}s-{plugin}-delete"]
+===== `delete`
+
+  * Value type is <<boolean,boolean>>
+  * Default is: `false`
+
+Should the log file be deleted after its contents have been updated?
+
+[id="plugins-{type}s-{plugin}-unpack_gzip"]
+===== `unpack_gzip`
+
+  * Value type is <<boolean,boolean>>
+  * Default is: `true`
+
+If set to `true`, files ending in `.gz` are decompressed before they're parsed by the codec.
+The file will be skipped if it has the suffix, but can't be opened as a gzip, e.g.
+if it has a bad magic number.
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]
+
+:default_codec!:

data/docs/examples.asciidoc

@@ -0,0 +1,84 @@
+==== Example Configurations
+
+===== Basic
+
+Basic configuration to read JSON logs every minute from `my-logs-bucket`.
+For example, https://cloud.google.com/stackdriver/[Stackdriver logs].
+
+[source,ruby]
+----------------------------------
+input {
+  google_cloud_storage {
+    interval => 60
+    bucket_id => "my-logs-bucket"
+    json_key_file => "/home/user/key.json"
+    file_matches => ".*json"
+    codec => "json_lines"
+  }
+}
+output { stdout { codec => rubydebug } }
+----------------------------------
+
+===== Idempotent Inserts into Elasticsearch
+
+If your pipeline might insert the same file multiple times you can use the `line_id` metadata key as a deterministic id.
+
+The ID has the format: `gs://<bucket_id>/<object_id>:<line_num>@<generation>`.
+`line_num` represents the nth event deserialized from the file starting at 1.
+`generation` is a unique id Cloud Storage generates for the object.
+When an object is overwritten it gets a new generation.
+
+[source,ruby]
+----------------------------------
+input {
+  google_cloud_storage {
+    bucket_id => "batch-jobs-output"
+  }
+}
+
+output {
+  elasticsearch {
+    document_id => "%{[@metadata][gcs][line_id]}"
+  }
+}
+----------------------------------
+
+===== From Cloud Storage to BigQuery
+
+
+Extract data from Cloud Storage, transform it with Logstash and load it into BigQuery.
+
+
+[source,ruby]
+----------------------------------
+input {
+  google_cloud_storage {
+    interval => 60
+    bucket_id => "batch-jobs-output"
+    file_matches => "purchases.*.csv"
+    json_key_file => "/home/user/key.json"
+    codec => "plain"
+  }
+}
+
+filter {
+  csv {
+    columns => ["transaction", "sku", "price"]
+    convert => {
+      "transaction" => "integer"
+      "price" => "float"
+    }
+  }
+}
+
+output {
+  google_bigquery {
+    project_id => "my-project"
+    dataset => "logs"
+    csv_schema => "transaction:INTEGER,sku:INTEGER,price:FLOAT"
+    json_key_file => "/path/to/key.json"
+    error_directory => "/tmp/bigquery-errors"
+    ignore_unknown_values => true
+  }
+}
+----------------------------------

data/docs/index.asciidoc

@@ -0,0 +1,43 @@
+:plugin: google_cloud_storage
+:type: input
+:default_codec: plain
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}s-{plugin}"]
+
+=== Google Cloud Storage Input Plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+
+==== Description
+
+Extracts events from files in a Google Cloud Storage bucket.
+
+Example use-cases:
+
+ * Read https://cloud.google.com/stackdriver/[Stackdriver logs] from a Cloud Storage bucket into Elastic.
+ * Read gzipped logs from cold-storage into Elastic.
+ * Restore data from an Elastic dump.
+ * Extract data from Cloud Storage, transform it with Logstash and load it into BigQuery.
+
+Note: While this project is partially maintained by Google, this is not an official Google product.
+
+
+include::metadata.asciidoc[]
+
+include::examples.asciidoc[]
+
+include::resources.asciidoc[]
+
+include::configuration.asciidoc[]

data/docs/metadata.asciidoc

@@ -0,0 +1,20 @@
+==== Metadata Attributes
+
+The plugin exposes several metadata attributes about the object being read.
+You can access these later in the pipeline to augment the data or perform conditional logic.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+| Key | Type | Description
+| `[@metadata][gcs][bucket]` | `string` | The name of the bucket the file was read from.
+| `[@metadata][gcs][name]` | `string` | The name of the object.
+| `[@metadata][gcs][metadata]` | `object` | A map of metadata on the object.
+| `[@metadata][gcs][md5]` | `string` | MD5 hash of the data. Encoded using base64.
+| `[@metadata][gcs][crc32c]` | `string` | CRC32c checksum, as described in RFC 4960. Encoded using base64 in big-endian byte order.
+| `[@metadata][gcs][generation]` | `long` | The content generation of the object. Used for object versioning
+| `[@metadata][gcs][line]` | `long` | The position of the event in the file. 1 indexed.
+| `[@metadata][gcs][line_id]` | `string` | A deterministic, unique ID describing this line. This lets you do idempotent inserts into Elasticsearch.
+|=======================================================================
+
+More information about object metadata can be found in the
+https://cloud.google.com/storage/docs/json_api/v1/objects[official documentation].

data/docs/resources.asciidoc

@@ -0,0 +1,6 @@
+==== Additional Resources
+
+ * https://cloud.google.com/storage/[Cloud Storage Homepage]
+ * https://cloud.google.com/storage/pricing-summary/[Cloud Storage Pricing]
+ * https://cloud.google.com/iam/docs/service-accounts[IAM Service Accounts]
+ * https://cloud.google.com/docs/authentication/production[Application Default Credentials]

data/lib/logstash-input-google_cloud_storage_jars.rb

@@ -0,0 +1,38 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. DO NOT EDIT.
+
+require 'jar_dependencies'
+require_jar('com.google.cloud', 'google-cloud-storage', '1.25.0')
+require_jar('com.fasterxml.jackson.core', 'jackson-core', '2.1.3')
+require_jar('com.google.api', 'api-common', '1.5.0')
+require_jar('com.google.api-client', 'google-api-client', '1.23.0')
+require_jar('com.google.api', 'gax', '1.23.0')
+require_jar('com.google.api', 'gax-httpjson', '0.40.0')
+require_jar('com.google.api.grpc', 'proto-google-common-protos', '1.7.0')
+require_jar('com.google.api.grpc', 'proto-google-iam-v1', '0.8.0')
+require_jar('com.google.apis', 'google-api-services-storage', 'v1-rev114-1.23.0')
+require_jar('com.google.auth', 'google-auth-library-credentials', '0.9.0')
+require_jar('com.google.auth', 'google-auth-library-oauth2-http', '0.9.0')
+require_jar('com.google.cloud', 'google-cloud-core', '1.25.0')
+require_jar('com.google.cloud', 'google-cloud-core-http', '1.25.0')
+require_jar('com.google.code.findbugs', 'jsr305', '3.0.1')
+require_jar('com.google.code.gson', 'gson', '2.7')
+require_jar('com.google.errorprone', 'error_prone_annotations', '2.2.0')
+require_jar('com.google.guava', 'guava', '20.0')
+require_jar('com.google.guava', 'guava-jdk5', '17.0')
+require_jar('com.google.http-client', 'google-http-client', '1.23.0')
+require_jar('com.google.http-client', 'google-http-client-appengine', '1.23.0')
+require_jar('com.google.http-client', 'google-http-client-jackson', '1.23.0')
+require_jar('com.google.http-client', 'google-http-client-jackson2', '1.23.0')
+require_jar('com.google.oauth-client', 'google-oauth-client', '1.23.0')
+require_jar('com.google.protobuf', 'protobuf-java', '3.5.1')
+require_jar('com.google.protobuf', 'protobuf-java-util', '3.5.1')
+require_jar('commons-codec', 'commons-codec', '1.3')
+require_jar('commons-logging', 'commons-logging', '1.1.1')
+require_jar('io.grpc', 'grpc-context', '1.9.0')
+require_jar('io.opencensus', 'opencensus-api', '0.11.1')
+require_jar('io.opencensus', 'opencensus-contrib-http-util', '0.11.1')
+require_jar('joda-time', 'joda-time', '2.9.2')
+require_jar('org.apache.httpcomponents', 'httpclient', '4.0.1')
+require_jar('org.apache.httpcomponents', 'httpcore', '4.0.1')
+require_jar('org.codehaus.jackson', 'jackson-core-asl', '1.9.11')
+require_jar('org.threeten', 'threetenbp', '1.3.3')