logstash-input-google_pubsub_compressed_batches 1.2.6

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of logstash-input-google_pubsub_compressed_batches might be problematic. Click here for more details.

Files changed (52) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +36 -0
  3. data/CONTRIBUTING.md +9 -0
  4. data/CONTRIBUTORS +23 -0
  5. data/Gemfile +11 -0
  6. data/LICENSE +202 -0
  7. data/NOTICE.TXT +13 -0
  8. data/README.md +200 -0
  9. data/docs/index.asciidoc +274 -0
  10. data/lib/logstash-input-google_pubsub_jars.rb +41 -0
  11. data/lib/logstash/inputs/google_pubsub.rb +320 -0
  12. data/logstash-input-google_pubsub_compressed_batches.gemspec +34 -0
  13. data/spec/inputs/google_pubsub_spec.rb +37 -0
  14. data/vendor/jar-dependencies/com/fasterxml/jackson/core/jackson-core/2.1.3/jackson-core-2.1.3.jar +0 -0
  15. data/vendor/jar-dependencies/com/google/api/api-common/1.6.0/api-common-1.6.0.jar +0 -0
  16. data/vendor/jar-dependencies/com/google/api/gax-grpc/1.29.0/gax-grpc-1.29.0.jar +0 -0
  17. data/vendor/jar-dependencies/com/google/api/gax/1.29.0/gax-1.29.0.jar +0 -0
  18. data/vendor/jar-dependencies/com/google/api/grpc/grpc-google-cloud-pubsub-v1/1.19.1/grpc-google-cloud-pubsub-v1-1.19.1.jar +0 -0
  19. data/vendor/jar-dependencies/com/google/api/grpc/proto-google-cloud-pubsub-v1/1.19.1/proto-google-cloud-pubsub-v1-1.19.1.jar +0 -0
  20. data/vendor/jar-dependencies/com/google/api/grpc/proto-google-common-protos/1.12.0/proto-google-common-protos-1.12.0.jar +0 -0
  21. data/vendor/jar-dependencies/com/google/api/grpc/proto-google-iam-v1/0.12.0/proto-google-iam-v1-0.12.0.jar +0 -0
  22. data/vendor/jar-dependencies/com/google/auth/google-auth-library-credentials/0.9.1/google-auth-library-credentials-0.9.1.jar +0 -0
  23. data/vendor/jar-dependencies/com/google/auth/google-auth-library-oauth2-http/0.9.1/google-auth-library-oauth2-http-0.9.1.jar +0 -0
  24. data/vendor/jar-dependencies/com/google/auto/value/auto-value/1.4/auto-value-1.4.jar +0 -0
  25. data/vendor/jar-dependencies/com/google/cloud/google-cloud-core-grpc/1.37.1/google-cloud-core-grpc-1.37.1.jar +0 -0
  26. data/vendor/jar-dependencies/com/google/cloud/google-cloud-core/1.37.1/google-cloud-core-1.37.1.jar +0 -0
  27. data/vendor/jar-dependencies/com/google/cloud/google-cloud-pubsub/1.37.1/google-cloud-pubsub-1.37.1.jar +0 -0
  28. data/vendor/jar-dependencies/com/google/code/findbugs/jsr305/3.0.2/jsr305-3.0.2.jar +0 -0
  29. data/vendor/jar-dependencies/com/google/code/gson/gson/2.7/gson-2.7.jar +0 -0
  30. data/vendor/jar-dependencies/com/google/errorprone/error_prone_annotations/2.2.0/error_prone_annotations-2.2.0.jar +0 -0
  31. data/vendor/jar-dependencies/com/google/guava/guava/20.0/guava-20.0.jar +0 -0
  32. data/vendor/jar-dependencies/com/google/http-client/google-http-client-jackson2/1.19.0/google-http-client-jackson2-1.19.0.jar +0 -0
  33. data/vendor/jar-dependencies/com/google/http-client/google-http-client/1.23.0/google-http-client-1.23.0.jar +0 -0
  34. data/vendor/jar-dependencies/com/google/protobuf/protobuf-java-util/3.6.0/protobuf-java-util-3.6.0.jar +0 -0
  35. data/vendor/jar-dependencies/com/google/protobuf/protobuf-java/3.6.0/protobuf-java-3.6.0.jar +0 -0
  36. data/vendor/jar-dependencies/com/google/protobuf/protobuf-lite/3.0.1/protobuf-lite-3.0.1.jar +0 -0
  37. data/vendor/jar-dependencies/commons-codec/commons-codec/1.3/commons-codec-1.3.jar +0 -0
  38. data/vendor/jar-dependencies/commons-logging/commons-logging/1.1.1/commons-logging-1.1.1.jar +0 -0
  39. data/vendor/jar-dependencies/io/grpc/grpc-auth/1.13.1/grpc-auth-1.13.1.jar +0 -0
  40. data/vendor/jar-dependencies/io/grpc/grpc-context/1.13.1/grpc-context-1.13.1.jar +0 -0
  41. data/vendor/jar-dependencies/io/grpc/grpc-core/1.13.1/grpc-core-1.13.1.jar +0 -0
  42. data/vendor/jar-dependencies/io/grpc/grpc-netty-shaded/1.13.1/grpc-netty-shaded-1.13.1.jar +0 -0
  43. data/vendor/jar-dependencies/io/grpc/grpc-protobuf-lite/1.13.1/grpc-protobuf-lite-1.13.1.jar +0 -0
  44. data/vendor/jar-dependencies/io/grpc/grpc-protobuf/1.13.1/grpc-protobuf-1.13.1.jar +0 -0
  45. data/vendor/jar-dependencies/io/grpc/grpc-stub/1.13.1/grpc-stub-1.13.1.jar +0 -0
  46. data/vendor/jar-dependencies/io/opencensus/opencensus-api/0.12.3/opencensus-api-0.12.3.jar +0 -0
  47. data/vendor/jar-dependencies/io/opencensus/opencensus-contrib-grpc-metrics/0.12.3/opencensus-contrib-grpc-metrics-0.12.3.jar +0 -0
  48. data/vendor/jar-dependencies/joda-time/joda-time/2.9.2/joda-time-2.9.2.jar +0 -0
  49. data/vendor/jar-dependencies/org/apache/httpcomponents/httpclient/4.0.1/httpclient-4.0.1.jar +0 -0
  50. data/vendor/jar-dependencies/org/apache/httpcomponents/httpcore/4.0.1/httpcore-4.0.1.jar +0 -0
  51. data/vendor/jar-dependencies/org/threeten/threetenbp/1.3.3/threetenbp-1.3.3.jar +0 -0
  52. metadata +185 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 0f5214fad7a25763f2f63aa0b18fd32b7af81cab156cb104a68d4c37da5af471
4
+ data.tar.gz: 4134da7ea97087725a404cb24939041d7e881a5537a8f019e056882080e238bf
5
+ SHA512:
6
+ metadata.gz: c62b860f7bbf8845e648f3a2b24a964bf44a65ff1ee1a7c17e7c7462e2c78a26301bdf8bbffb1ef9129bd95373f285809b8a5e3bcead7ceed03b020a03ad021a
7
+ data.tar.gz: 4525ad91b4e5ed78f5f273995047655a25bd56d5587fe463e61b5a8e464c42db99341164d3eea0bd3708f5b4d9deaca1bc7cd74a666d74440a118ef15a56e855
@@ -0,0 +1,36 @@
1
+ ## 1.2.6
2
+ - Added support for reading zlib compressed batch
3
+
4
+ ## 1.2.1
5
+ - Fixed dependency conflicts with logstash-output-google_pubsub by using the same client library [logstash-output-google_pubsub#7](https://github.com/logstash-plugins/logstash-output-google_pubsub/issues/7)
6
+
7
+ ## 1.2.0
8
+ - Change to Java client
9
+ - Add `create_subscription` setting. Fixes [#9](https://github.com/logstash-plugins/logstash-input-google_pubsub/issues/9)
10
+
11
+ ## 1.1.0
12
+ - Add additional attributes in the `[@metadata][pubsub_message]` field. Fixes [#7](https://github.com/logstash-plugins/logstash-input-google_pubsub/issues/7)
13
+
14
+ ## 1.0.6
15
+ - Ignore acknowledge requests with an empty array of IDs. Fixes [#14](https://github.com/logstash-plugins/logstash-input-google_pubsub/issues/14)
16
+
17
+ ## 1.0.5
18
+ - Docs: Set the default_codec doc attribute.
19
+
20
+ ## 1.0.4
21
+ - Update gemspec summary
22
+
23
+ ## 1.0.3
24
+ - Fix some documentation issues
25
+
26
+ ## 1.0.2
27
+ - Docs: Fix list numbering
28
+
29
+ ## 1.0.1
30
+ - Docs: Bump patch level for doc build
31
+
32
+ ## 1.0.0
33
+ - Update to use 5.0 API
34
+
35
+ ## 0.9.0
36
+ - Initial release
@@ -0,0 +1,9 @@
1
+ # Contributing
2
+
3
+ All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
4
+
5
+ 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.
6
+
7
+ It is more important to the community that you are able to contribute.
8
+
9
+ For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.
@@ -0,0 +1,23 @@
1
+ The following is a list of people who have contributed ideas, code, bug
2
+ reports, or in general have helped Logstash along its way.
3
+
4
+ Contributors:
5
+
6
+ * DeDe Morton (dedemorton)
7
+ * Eric Johnson (erjohnso)
8
+ * Google LLC
9
+ * Jake Landis (jakelandis)
10
+ * Jakub Sacha (jakubsacha)
11
+ * James Bloomer (jamesbloomer)
12
+ * João Duarte (jsvd)
13
+ * Jordan Sissel (jordansissel)
14
+ * Joseph Lewis III (josephlewis42)
15
+ * Pier-Hugues Pellerin (ph)
16
+ * Scott Brenner (ScottBrenner)
17
+ * Suyog Rao (suyograo)
18
+ * Sven Widén (SvenW)
19
+
20
+ Note: If you've sent us patches, bug reports, or otherwise contributed to
21
+ Logstash, and you aren't on the list above and want to be, please let us know
22
+ and we'll make sure you're here. Contributions from folks like you are what make
23
+ open source awesome.
data/Gemfile ADDED
@@ -0,0 +1,11 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
6
+ use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
7
+
8
+ if Dir.exist?(logstash_path) && use_logstash_source
9
+ gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
10
+ gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
11
+ end
data/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2020 Elastic and contributors
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,13 @@
1
+ Copyright 2016 Google Inc. All Rights Reserved.
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS,
11
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ See the License for the specific language governing permissions and
13
+ limitations under the License.
@@ -0,0 +1,200 @@
1
+ # Logstash Plugin
2
+
3
+ [![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-google_pubsub.svg)](https://travis-ci.com/logstash-plugins/logstash-input-google_pubsub)
4
+
5
+ This is a [Logstash](https://github.com/elastic/logstash) input plugin for
6
+ [Google Pub/Sub](https://cloud.google.com/pubsub/). The plugin can subscribe
7
+ to a topic and ingest messages.
8
+
9
+ The main motivation behind the development of this plugin was to ingest
10
+ [Stackdriver Logging](https://cloud.google.com/logging/) messages via the
11
+ [Exported Logs](https://cloud.google.com/logging/docs/export/using_exported_logs)
12
+ feature of Stackdriver Logging.
13
+
14
+ It is fully free and fully open source. The license is Apache 2.0, meaning you
15
+ are pretty much free to use it however you want in whatever way.
16
+
17
+ ## Documentation
18
+
19
+ ### Prerequisites
20
+
21
+ You must first create a Google Cloud Platform project and enable the the
22
+ Google Pub/Sub API. If you intend to use the plugin ingest Stackdriver Logging
23
+ messages, you must also enable the Stackdriver Logging API and configure log
24
+ exporting to Pub/Sub. There is plentiful information on
25
+ https://cloud.google.com/ to get started,
26
+
27
+ - Google Cloud Platform Projects and [Overview](https://cloud.google.com/docs/overview/)
28
+ - Goolge Cloud Pub/Sub [documentation](https://cloud.google.com/pubsub/)
29
+ - Stackdriver Logging [documentation](https://cloud.google.com/logging/)
30
+
31
+ ### Cloud Pub/Sub
32
+
33
+ Currently, this module requires you to create a `topic` manually and specify
34
+ it in the logstash config file. You must also specify a `subscription`, but
35
+ the plugin will attempt to create the pull-based `subscription` on its own.
36
+
37
+ All messages received from Pub/Sub will be converted to a logstash `event`
38
+ and added to the processing pipeline queue. All Pub/Sub messages will be
39
+ `acknowledged` and removed from the Pub/Sub `topic` (please see more about
40
+ [Pub/Sub concepts](https://cloud.google.com/pubsub/overview#concepts)).
41
+
42
+ It is generally assumed that incoming messages will be in JSON and added to
43
+ the logstash `event` as-is. However, if a plain text message is received, the
44
+ plugin will return the raw text in as `raw_message` in the logstash `event`.
45
+
46
+ #### Authentication
47
+
48
+ You have two options for authentication depending on where you run Logstash.
49
+
50
+ 1. If you are running Logstash outside of Google Cloud Platform, then you will
51
+ need to create a Google Cloud Platform Service Account and specify the full
52
+ path to the JSON private key file in your config. You must assign sufficient
53
+ roles to the Service Account to create a subscription and to pull messages
54
+ from the subscription. Learn more about GCP Service Accounts and IAM roles
55
+ here:
56
+
57
+ - Google Cloud Platform IAM [overview](https://cloud.google.com/iam/)
58
+ - Creating Service Accounts [overview](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
59
+ - Granting Roles [overview](https://cloud.google.com/iam/docs/granting-roles-to-service-accounts)
60
+
61
+ 1. If you are running Logstash on a Google Compute Engine instance, you may opt
62
+ to use Application Default Credentials. In this case, you will not need to
63
+ specify a JSON private key file in your config.
64
+
65
+ ### Stackdriver Logging (optional)
66
+
67
+ If you intend to use the logstash plugin for Stackdriver Logging message
68
+ ingestion, you must first manually set up the Export option to Coud Pub/Sub and
69
+ the manually create the `topic`. Please see the more detailed instructions at,
70
+ [Exported Logs](https://cloud.google.com/logging/docs/export/using_exported_logs)
71
+ and ensure that the [necessary permissions](https://cloud.google.com/logging/docs/export/configure_export#manual-access-pubsub)
72
+ have also been manually configured.
73
+
74
+ Logging messages from Stackdriver Logging exported to Pub/Sub are received as
75
+ JSON and converted to a logstash `event` as-is in
76
+ [this format](https://cloud.google.com/logging/docs/export/using_exported_logs#log_entries_in_google_pubsub_topics).
77
+
78
+ ### Sample Configuration
79
+
80
+ Below is a copy of the included `example.conf-tmpl` file that shows a basic
81
+ configuration for this plugin.
82
+
83
+ ```
84
+ input {
85
+ google_pubsub {
86
+ # Your GCP project id (name)
87
+ project_id => "my-project-1234"
88
+
89
+ # The topic name below is currently hard-coded in the plugin. You
90
+ # must first create this topic by hand and ensure you are exporting
91
+ # logging to this pubsub topic.
92
+ topic => "logstash-input-dev"
93
+
94
+ # The subscription name is customizeable. The plugin will attempt to
95
+ # create the subscription (but use the hard-coded topic name above).
96
+ subscription => "logstash-sub"
97
+
98
+ # If you are running logstash within GCE, it will use
99
+ # Application Default Credentials and use GCE's metadata
100
+ # service to fetch tokens. However, if you are running logstash
101
+ # outside of GCE, you will need to specify the service account's
102
+ # JSON key file below.
103
+ #json_key_file => "/home/erjohnso/pkey.json"
104
+ }
105
+ }
106
+
107
+ output { stdout { codec => rubydebug } }
108
+ ```
109
+
110
+ ## (stock) Documentation
111
+
112
+ 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/).
113
+
114
+ - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
115
+ - For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
116
+
117
+ ## Need Help?
118
+
119
+ Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
120
+
121
+ ## Developing
122
+
123
+ ### 1. Plugin Developement and Testing
124
+
125
+ #### Code
126
+ - To get started, you'll need JRuby with the Bundler gem installed.
127
+
128
+ - 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).
129
+
130
+ - Install dependencies
131
+ ```sh
132
+ bundle install
133
+ rake install_jars
134
+ ```
135
+
136
+ #### Test
137
+
138
+ - Update your dependencies
139
+
140
+ ```sh
141
+ bundle install
142
+ ```
143
+
144
+ - Run tests
145
+
146
+ ```sh
147
+ bundle exec rspec
148
+ ```
149
+
150
+ ### 2. Running your unpublished Plugin in Logstash
151
+
152
+ #### 2.1 Run in a local Logstash clone
153
+
154
+ - Edit Logstash `Gemfile` and add the local plugin path, for example:
155
+ ```ruby
156
+ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
157
+ ```
158
+ - Install plugin
159
+ ```sh
160
+ # Logstash 2.3 and higher
161
+ bin/logstash-plugin install --no-verify
162
+
163
+ # Prior to Logstash 2.3
164
+ bin/plugin install --no-verify
165
+
166
+ ```
167
+ - Run Logstash with your plugin
168
+ ```sh
169
+ bin/logstash -e 'filter {awesome {}}'
170
+ ```
171
+ At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
172
+
173
+ #### 2.2 Run in an installed Logstash
174
+
175
+ 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:
176
+
177
+ - Build your plugin gem
178
+ ```sh
179
+ gem build logstash-filter-awesome.gemspec
180
+ ```
181
+ - Install the plugin from the Logstash home
182
+ ```sh
183
+ # Logstash 2.3 and higher
184
+ bin/logstash-plugin install --no-verify
185
+
186
+ # Prior to Logstash 2.3
187
+ bin/plugin install --no-verify
188
+
189
+ ```
190
+ - Start Logstash and proceed to test the plugin
191
+
192
+ ## Contributing
193
+
194
+ All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
195
+
196
+ 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.
197
+
198
+ It is more important to the community that you are able to contribute.
199
+
200
+ For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file