fluent-plugin-documentdb 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +5 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +137 -0
- data/Rakefile +13 -0
- data/VERSION +1 -0
- data/fluent-plugin-documentdb.gemspec +27 -0
- data/lib/fluent/plugin/out_documentdb.rb +113 -0
- data/test/helper.rb +29 -0
- data/test/plugin/test_documentdb.rb +68 -0
- metadata +126 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: c5375880e41484be5127754939a3736a8a44934f
|
4
|
+
data.tar.gz: e3b77ac772bd4c9412f1dcbe8e7e8ae303ef56a8
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 158abf1a4d9f30ba97e9ec0edf63c7a18a57979637f73a6279c4b43858de778af918eaa3c51886026f849d2989ccdf4f026e15a9cf203736196bf2ad9bbbdfdc
|
7
|
+
data.tar.gz: e7da026710ded4cdda4cbc06221d4b8108163c4614d0b081dc6cabfc7fb9b8503d246295ceac8b7e249619da495abc87ca87390ece2a163c3043a5e9ea3b748a
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,137 @@
|
|
1
|
+
# Azure DocumentDB output plugin for Fluentd
|
2
|
+
|
3
|
+
fluent-plugin-documentdb is a fluent plugin to output to Azure DocumentDB
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
$ gem install fluent-plugin-documentdb
|
8
|
+
|
9
|
+
## Configuration
|
10
|
+
|
11
|
+
### DocumentDB
|
12
|
+
|
13
|
+
To use Microsoft Azure DocumentDB, you must create a DocumentDB database account using either the Azure portal, Azure Resource Manager templates, or Azure command-line interface (CLI). In addition, you must have a database and a collection to which fluent-plugin-documentdb writes event-stream out. Here are instructions:
|
14
|
+
|
15
|
+
* Create a DocumentDB database account using [the Azure portal](https://azure.microsoft.com/en-us/documentation/articles/documentdb-create-account/), or [Azure Resource Manager templates and Azure CLI](https://azure.microsoft.com/en-us/documentation/articles/documentdb-automation-resource-manager-cli/)
|
16
|
+
* [How to create a database for DocumentDB](https://azure.microsoft.com/en-us/documentation/articles/documentdb-create-database/)
|
17
|
+
* [Create a DocumentDB collection](https://azure.microsoft.com/en-us/documentation/articles/documentdb-create-collection/)
|
18
|
+
|
19
|
+
|
20
|
+
### Fluentd - fluent.conf
|
21
|
+
|
22
|
+
<match documentdb.*>
|
23
|
+
type documentdb
|
24
|
+
docdb_endpoint DOCUMENTDB_ACCOUNT_ENDPOINT
|
25
|
+
docdb_account_key DOCUMENTDB_ACCOUNT_KEY
|
26
|
+
docdb_database mydb
|
27
|
+
docdb_collection mycollection
|
28
|
+
time_format %s
|
29
|
+
localtime false
|
30
|
+
add_time_field true
|
31
|
+
time_field_name time
|
32
|
+
add_tag_field true
|
33
|
+
tag_field_name time
|
34
|
+
</match>
|
35
|
+
|
36
|
+
* **docdb\_endpoint (required)** - Azure DocumentDB Account endpoint URI
|
37
|
+
* **docdb\_account\_key (required)** - Azure DocumentDB Account key (master key). You must NOT set a read-only key
|
38
|
+
* **docdb\_database (required)** - DocumentDB database name
|
39
|
+
* **docdb\_collection (required)** - DocumentDB collection name
|
40
|
+
* **localtime (optional)** - Default:false. By default, time record is inserted with UTC (Coordinated Universal Time). This option allows to use local time if you set localtime true
|
41
|
+
* **time\_format (optional)** - Default:%s. Time format for a time field to be inserted. Default format is %s, that is unix epoch time. If you want it to be more human readable, set this %Y%m%d-%H:%M:%S, for example.
|
42
|
+
* **add\_time\_field (optional)** - Default:true. This option allows to insert a time field to record
|
43
|
+
* **time\_field\_name (optional)** - Default:time. Time field name to be inserted
|
44
|
+
* **add\_tag\_field (optional)** - Default:true. This option allows to insert a tag field to record
|
45
|
+
* **tag\_field\_name (optional)** - Default:tag. Tag field name to be inserted
|
46
|
+
|
47
|
+
|
48
|
+
## Expected Records
|
49
|
+
|
50
|
+
fluent-plugin-documentdb will add **id** attribute which is UUID format and any other attributes of record automatically. In addition, it will add **time** and **tag** attributes if **add_time_field** and **add_tag_field** are true respectively. For example if you read apache's access log via fluentd, structure of the record to inserted into documentdb will have been like this.
|
51
|
+
|
52
|
+
<u>fluent.conf</u>
|
53
|
+
|
54
|
+
<source>
|
55
|
+
type tail # input plugin
|
56
|
+
path /var/log/apache2/access.log # monitoring file
|
57
|
+
pos_file /tmp/fluentd_pos_file # position file
|
58
|
+
format apache # format
|
59
|
+
tag documentdb.access # tag
|
60
|
+
</source>
|
61
|
+
|
62
|
+
<match documentdb.*>
|
63
|
+
docdb_endpoint https://yoichikademo.documents.azure.com:443/
|
64
|
+
docdb_account_key Tl1xykQxnExUisJ+BXwbbaC8NtUqYVE9kUDXCNust5aYBduhui29Xtxz3DLP88PayjtgtnARc1PW+2wlA6jCJw==
|
65
|
+
docdb_database mydb
|
66
|
+
docdb_collection mycollection
|
67
|
+
localtime true
|
68
|
+
time_format %Y%m%d-%H:%M:%S
|
69
|
+
add_time_field true
|
70
|
+
time_field_name time
|
71
|
+
add_tag_field true
|
72
|
+
tag_field_name tag
|
73
|
+
</match>
|
74
|
+
|
75
|
+
An expected output record for sample input will be like this:
|
76
|
+
|
77
|
+
<u>Sample Input (apache access log)</u>
|
78
|
+
|
79
|
+
125.212.152.166 - - [17/Jan/2016:05:03:25 +0000] "GET /foo/bar/test.html HTTP/1.1" 304 179 "-" "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.111 Safari/537.36"
|
80
|
+
|
81
|
+
|
82
|
+
<u>Output Record</u>
|
83
|
+
|
84
|
+
{
|
85
|
+
id : d2b2ece8-b948-41ae-a894-0ed1266e242a,
|
86
|
+
host : 125.211.152.166,
|
87
|
+
user : -,
|
88
|
+
method : GET,
|
89
|
+
path : /foo/bar/test.html,
|
90
|
+
code : 304,
|
91
|
+
size : 179,
|
92
|
+
referer : -,
|
93
|
+
agent : Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.111 Safari/537.36,
|
94
|
+
time : 20160117-05:03:25,
|
95
|
+
tag : documentdb.access
|
96
|
+
}
|
97
|
+
|
98
|
+
## Tests
|
99
|
+
### Running test code
|
100
|
+
$ git clone https://github.com/yokawasa/fluent-plugin-documentdb.git
|
101
|
+
$ cd fluent-plugin-documentdb
|
102
|
+
|
103
|
+
# edit CONFIG params of test/plugin/test_documentdb.rb
|
104
|
+
$ vi test/plugin/test_documentdb.rb
|
105
|
+
|
106
|
+
# run test
|
107
|
+
$ rake test
|
108
|
+
|
109
|
+
### Creating package, running and testing locally
|
110
|
+
$ rake build
|
111
|
+
$ rake install:local
|
112
|
+
|
113
|
+
# funning fluentd with your fluent.conf
|
114
|
+
$ fluentd -c fluent.conf -vv &
|
115
|
+
|
116
|
+
# send test apache requests for testing plugin ( only in the case that input source is apache access log )
|
117
|
+
$ ab -n 5 -c 2 http://localhost/foo/bar/test.html
|
118
|
+
|
119
|
+
## TODOs
|
120
|
+
* Support documentdb sharding. See [How to partition data in DocumentDB](https://azure.microsoft.com/en-us/documentation/articles/documentdb-sharding/)
|
121
|
+
* Support resource tokens access. See [Access Control on DocumentDB Resources](https://msdn.microsoft.com/en-us/library/azure/dn783368.aspx)
|
122
|
+
|
123
|
+
## Contributing
|
124
|
+
|
125
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/yokawasa/fluent-plugin-documentdb.
|
126
|
+
|
127
|
+
## Copyright
|
128
|
+
|
129
|
+
<table>
|
130
|
+
<tr>
|
131
|
+
<td>Copyright</td><td>Copyright (c) 2016- Yoichi Kawasaki</td>
|
132
|
+
</tr>
|
133
|
+
<tr>
|
134
|
+
<td>License</td><td>Apache License, Version 2.0</td>
|
135
|
+
</tr>
|
136
|
+
</table>
|
137
|
+
|
data/Rakefile
ADDED
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.1.0
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
|
5
|
+
Gem::Specification.new do |gem|
|
6
|
+
gem.name = "fluent-plugin-documentdb"
|
7
|
+
gem.version = File.read("VERSION").strip
|
8
|
+
gem.authors = ["Yoichi Kawasaki"]
|
9
|
+
gem.email = ["yoichi.kawasaki@outlook.com"]
|
10
|
+
gem.summary = %q{Azure DocumentDB output plugin for Fluentd}
|
11
|
+
gem.description = gem.summary
|
12
|
+
gem.homepage = "http://github.com/yokawasa/fluent-plugin-documentdb"
|
13
|
+
gem.license = "Apache-2.0"
|
14
|
+
gem.has_rdoc = false
|
15
|
+
|
16
|
+
gem.files = `git ls-files`.split("\n")
|
17
|
+
#gem.executables = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
19
|
+
gem.test_files = gem.files.grep(%r{^(test|gem|features)/})
|
20
|
+
gem.require_paths = ["lib"]
|
21
|
+
|
22
|
+
gem.add_development_dependency "bundler", "~> 1.11"
|
23
|
+
gem.add_development_dependency "rake", "~> 10.0"
|
24
|
+
gem.add_development_dependency "test-unit"
|
25
|
+
gem.add_development_dependency "azure-documentdb-sdk"
|
26
|
+
gem.add_runtime_dependency "fluentd"
|
27
|
+
end
|
@@ -0,0 +1,113 @@
|
|
1
|
+
# -*- coding: utf-8 -*-
|
2
|
+
|
3
|
+
module Fluent
|
4
|
+
class DocumentdbOutput < BufferedOutput
|
5
|
+
Plugin.register_output('documentdb', self)
|
6
|
+
|
7
|
+
def initialize
|
8
|
+
super
|
9
|
+
require 'documentdb'
|
10
|
+
require 'msgpack'
|
11
|
+
require 'time'
|
12
|
+
require 'securerandom'
|
13
|
+
end
|
14
|
+
|
15
|
+
config_param :docdb_endpoint, :string
|
16
|
+
config_param :docdb_account_key, :string
|
17
|
+
config_param :docdb_database, :string
|
18
|
+
config_param :docdb_collection, :string
|
19
|
+
config_param :auto_create_database, :bool, :default => true
|
20
|
+
config_param :auto_create_collection, :bool, :default => true
|
21
|
+
config_param :time_format, :string, :default => nil
|
22
|
+
config_param :localtime, :bool, default: false
|
23
|
+
config_param :add_time_field, :bool, :default => true
|
24
|
+
config_param :time_field_name, :string, :default => 'time'
|
25
|
+
config_param :add_tag_field, :bool, :default => false
|
26
|
+
config_param :tag_field_name, :string, :default => 'tag'
|
27
|
+
|
28
|
+
def configure(conf)
|
29
|
+
super
|
30
|
+
raise ConfigError, 'no docdb_endpoint' if @docdb_endpoint.empty?
|
31
|
+
raise ConfigError, 'no docdb_account_key' if @docdb_account_key.empty?
|
32
|
+
raise ConfigError, 'no docdb_database' if @docdb_database.empty?
|
33
|
+
raise ConfigError, 'no docdb_collection' if @docdb_collection.empty?
|
34
|
+
if @add_time_field and @time_field_name.empty?
|
35
|
+
raise ConfigError, 'time_field_name is needed if add_time_field is true'
|
36
|
+
end
|
37
|
+
if @add_tag_field and @tag_field_name.empty?
|
38
|
+
raise ConfigError, 'tag_field_name is needed if add_tag_field is true'
|
39
|
+
end
|
40
|
+
|
41
|
+
@timef = TimeFormatter.new(@time_format, @localtime)
|
42
|
+
end
|
43
|
+
|
44
|
+
def start
|
45
|
+
super
|
46
|
+
|
47
|
+
begin
|
48
|
+
context = Azure::DocumentDB::Context.new @docdb_endpoint, @docdb_account_key
|
49
|
+
|
50
|
+
## initial operations for database
|
51
|
+
database = Azure::DocumentDB::Database.new context, RestClient
|
52
|
+
qreq = Azure::DocumentDB::QueryRequest.new "SELECT * FROM root r WHERE r.id=@id"
|
53
|
+
qreq.parameters.add "@id", @docdb_database
|
54
|
+
query = database.query
|
55
|
+
qres = query.execute qreq
|
56
|
+
if( qres[:body]["_count"].to_i == 0 )
|
57
|
+
raise "No database (#{docdb_database}) exists! Enable auto_create_database or create it by useself" if !@auto_create_database
|
58
|
+
# create new database as it doesn't exists
|
59
|
+
database.create @docdb_database
|
60
|
+
end
|
61
|
+
|
62
|
+
## initial operations for collection
|
63
|
+
collection = database.collection_for_name @docdb_database
|
64
|
+
qreq = Azure::DocumentDB::QueryRequest.new "SELECT * FROM root r WHERE r.id=@id"
|
65
|
+
qreq.parameters.add "@id", @docdb_collection
|
66
|
+
query = collection.query
|
67
|
+
qres = query.execute qreq
|
68
|
+
if( qres[:body]["_count"].to_i == 0 )
|
69
|
+
raise "No collection (#{docdb_collection}) exists! Enable auto_create_collection or create it by useself" if !@auto_create_collection
|
70
|
+
# create new collection as it doesn't exists
|
71
|
+
collection.create @docdb_collection
|
72
|
+
end
|
73
|
+
|
74
|
+
@docdb = collection.document_for_name @docdb_collection
|
75
|
+
|
76
|
+
rescue Exception =>ex
|
77
|
+
$log.fatal "Error: '#{ex}'"
|
78
|
+
exit!
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
def shutdown
|
83
|
+
super
|
84
|
+
# destroy
|
85
|
+
end
|
86
|
+
|
87
|
+
def format(tag, time, record)
|
88
|
+
record['id'] = SecureRandom.uuid
|
89
|
+
if @add_time_field
|
90
|
+
record[@time_field_name] = @timef.format(time)
|
91
|
+
end
|
92
|
+
if @add_tag_field
|
93
|
+
record[@tag_field_name] = tag
|
94
|
+
end
|
95
|
+
record.to_msgpack
|
96
|
+
end
|
97
|
+
|
98
|
+
def write(chunk)
|
99
|
+
records = []
|
100
|
+
chunk.msgpack_each { |record|
|
101
|
+
unique_doc_identifier = record["id"]
|
102
|
+
docdata = record.to_json
|
103
|
+
begin
|
104
|
+
@docdb.create unique_doc_identifier, docdata
|
105
|
+
rescue Exception => ex
|
106
|
+
$log.fatal "UnknownError: '#{ex}'"
|
107
|
+
+ ", uniqueid=>#{unique_doc_identifier}, data=>"
|
108
|
+
+ docdata.to_s
|
109
|
+
end
|
110
|
+
}
|
111
|
+
end
|
112
|
+
end
|
113
|
+
end
|
data/test/helper.rb
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'bundler'
|
3
|
+
|
4
|
+
begin
|
5
|
+
Bundler.setup(:default, :development)
|
6
|
+
rescue Bundler::BundlerError => e
|
7
|
+
$stderr.puts e.message
|
8
|
+
$stderr.puts "Run `bundle install` to install missing gems"
|
9
|
+
exit e.status_code
|
10
|
+
end
|
11
|
+
require 'test/unit'
|
12
|
+
|
13
|
+
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
14
|
+
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
15
|
+
require 'fluent/test'
|
16
|
+
unless ENV.has_key?('VERBOSE')
|
17
|
+
nulllogger = Object.new
|
18
|
+
nulllogger.instance_eval {|obj|
|
19
|
+
def method_missing(method, *args)
|
20
|
+
# pass
|
21
|
+
end
|
22
|
+
}
|
23
|
+
$log = nulllogger
|
24
|
+
end
|
25
|
+
|
26
|
+
require 'fluent/plugin/out_documentdb'
|
27
|
+
|
28
|
+
class Test::Unit::TestCase
|
29
|
+
end
|
@@ -0,0 +1,68 @@
|
|
1
|
+
require 'helper'
|
2
|
+
|
3
|
+
class DocumentdbOutputTest < Test::Unit::TestCase
|
4
|
+
def setup
|
5
|
+
Fluent::Test.setup
|
6
|
+
end
|
7
|
+
|
8
|
+
CONFIG = %[
|
9
|
+
docdb_endpoint DOCUMENTDB_ACCOUNT_ENDPOINT
|
10
|
+
docdb_account_key DOCUMENTDB_ACCOUNT_KEY
|
11
|
+
docdb_database mydb
|
12
|
+
docdb_collection mycollection
|
13
|
+
localtime true
|
14
|
+
time_format %Y%m%d-%H:%M:%S
|
15
|
+
add_time_field true
|
16
|
+
time_field_name time
|
17
|
+
add_tag_field true
|
18
|
+
tag_field_name tag
|
19
|
+
]
|
20
|
+
# CONFIG = %[
|
21
|
+
# path #{TMP_DIR}/out_file_test
|
22
|
+
# compress gz
|
23
|
+
# utc
|
24
|
+
# ]
|
25
|
+
|
26
|
+
def create_driver(conf = CONFIG, tag='documentdb.test')
|
27
|
+
Fluent::Test::BufferedOutputTestDriver.new(Fluent::DocumentdbOutput, tag).configure(conf)
|
28
|
+
end
|
29
|
+
|
30
|
+
def test_configure
|
31
|
+
#### set configurations
|
32
|
+
# d = create_driver %[
|
33
|
+
# path test_path
|
34
|
+
# compress gz
|
35
|
+
# ]
|
36
|
+
#### check configurations
|
37
|
+
# assert_equal 'test_path', d.instance.path
|
38
|
+
# assert_equal :gz, d.instance.compress
|
39
|
+
end
|
40
|
+
|
41
|
+
def test_format
|
42
|
+
d = create_driver
|
43
|
+
|
44
|
+
# time = Time.parse("2011-01-02 13:14:15 UTC").to_i
|
45
|
+
# d.emit({"a"=>1}, time)
|
46
|
+
# d.emit({"a"=>2}, time)
|
47
|
+
|
48
|
+
# d.expect_format %[2011-01-02T13:14:15Z\ttest\t{"a":1}\n]
|
49
|
+
# d.expect_format %[2011-01-02T13:14:15Z\ttest\t{"a":2}\n]
|
50
|
+
|
51
|
+
# d.run
|
52
|
+
end
|
53
|
+
|
54
|
+
def test_write
|
55
|
+
d = create_driver
|
56
|
+
|
57
|
+
time = Time.parse("2011-01-02 13:14:15 UTC").to_i
|
58
|
+
d.emit({"a"=>1}, time)
|
59
|
+
d.emit({"a"=>2}, time)
|
60
|
+
data = d.run
|
61
|
+
puts data
|
62
|
+
# ### FileOutput#write returns path
|
63
|
+
# path = d.run
|
64
|
+
# expect_path = "#{TMP_DIR}/out_file_test._0.log.gz"
|
65
|
+
# assert_equal expect_path, path
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
metadata
ADDED
@@ -0,0 +1,126 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-documentdb
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Yoichi Kawasaki
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-01-17 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.11'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.11'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: test-unit
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: azure-documentdb-sdk
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: fluentd
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :runtime
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description: Azure DocumentDB output plugin for Fluentd
|
84
|
+
email:
|
85
|
+
- yoichi.kawasaki@outlook.com
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- ".gitignore"
|
91
|
+
- Gemfile
|
92
|
+
- LICENSE
|
93
|
+
- README.md
|
94
|
+
- Rakefile
|
95
|
+
- VERSION
|
96
|
+
- fluent-plugin-documentdb.gemspec
|
97
|
+
- lib/fluent/plugin/out_documentdb.rb
|
98
|
+
- test/helper.rb
|
99
|
+
- test/plugin/test_documentdb.rb
|
100
|
+
homepage: http://github.com/yokawasa/fluent-plugin-documentdb
|
101
|
+
licenses:
|
102
|
+
- Apache-2.0
|
103
|
+
metadata: {}
|
104
|
+
post_install_message:
|
105
|
+
rdoc_options: []
|
106
|
+
require_paths:
|
107
|
+
- lib
|
108
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
109
|
+
requirements:
|
110
|
+
- - ">="
|
111
|
+
- !ruby/object:Gem::Version
|
112
|
+
version: '0'
|
113
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
requirements: []
|
119
|
+
rubyforge_project:
|
120
|
+
rubygems_version: 2.5.1
|
121
|
+
signing_key:
|
122
|
+
specification_version: 4
|
123
|
+
summary: Azure DocumentDB output plugin for Fluentd
|
124
|
+
test_files:
|
125
|
+
- test/helper.rb
|
126
|
+
- test/plugin/test_documentdb.rb
|