fluent-plugin-azure-loganalytics 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/ChangeLog.md +3 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +157 -0
- data/Rakefile +15 -0
- data/VERSION +1 -0
- data/examples/fluent_1.conf +14 -0
- data/examples/fluent_2.conf +20 -0
- data/fluent-plugin-azure-loganalytics.gemspec +28 -0
- data/img/Azure-LogAnalytics-Fluentd.png +0 -0
- data/img/Azure-LogAnalytics-Output-Image.png +0 -0
- data/lib/fluent/plugin/out_azure-loganalytics.rb +85 -0
- data/test/helper.rb +29 -0
- data/test/plugin/test_azure_loganalytics.rb +85 -0
- metadata +150 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: ab70c5f304f8edce871e00cd98b77f2574cc286b
|
4
|
+
data.tar.gz: ac9395ee3f364ad299d5f053758a43860f564705
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: fa7a9c29a4c25eeccb66c14904244d67f3686ad95e2faec83a03fb992134253340d91ffc64526c2e53b14324903c0af750e25a17d0e97b43aa2d3325c2e5c5b0
|
7
|
+
data.tar.gz: 7340b11085507ca115a9229c8b19525a1a5087e1c583e91d551c204546a3fff1c0ce914b52ffee964bf7654be6b9ac8a9954819c5b53e01ea4c839a37fc589b7
|
data/ChangeLog.md
ADDED
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,157 @@
|
|
1
|
+
# fluent-plugin-azure-loganalytics
|
2
|
+
[Azure Log Analytics](https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-overview) output plugin for Fluentd. The plugin aggregates semi-structured data in real-time and writes the buffered data via HTTPS request to Azure Log Analytics.
|
3
|
+
|
4
|
+
![fluent-plugin-azure-loganalytics overview](https://github.com/yokawasa/fluent-plugin-azure-loganalytics/raw/master/img/Azure-LogAnalytics-Fluentd.png)
|
5
|
+
|
6
|
+
## Installation
|
7
|
+
```
|
8
|
+
$ gem install fluent-plugin-azure-loganalytics
|
9
|
+
```
|
10
|
+
|
11
|
+
## Configuration
|
12
|
+
|
13
|
+
### Azure Log Analytics
|
14
|
+
To start running with Log Analytics in the Microsoft Operations Management Suite (OMS), You need to create either an OMS workspace using the OMS website or Log Analytics workspace using your Azure subscription. Workspaces created either way are functionally equivalent. Here is an instruction:
|
15
|
+
|
16
|
+
* [Get started with Log Analytics](https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-get-started)
|
17
|
+
|
18
|
+
Once you have the workspace, get Workspace ID and Shared Key (either Primary Key or Secondary Key), which are needed by [Log Analytics HTTP Data Collector API](https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-data-collector-api) to post the data to Log Analytics.
|
19
|
+
|
20
|
+
|
21
|
+
### Fluentd - fluent.conf
|
22
|
+
|
23
|
+
```
|
24
|
+
<match azure-loganalytics.**>
|
25
|
+
@type azure-loganalytics
|
26
|
+
customer_id CUSTOMER_ID # Customer ID aka WorkspaceID String
|
27
|
+
shared_key KEY_STRING # The primary or the secondary Connected Sources client authentication key
|
28
|
+
log_type EVENT_TYPE_NAME # The name of the event type. ex) ApacheAccessLog
|
29
|
+
add_time_field true
|
30
|
+
time_field_name mytime
|
31
|
+
time_format %s
|
32
|
+
localtime true
|
33
|
+
add_tag_field true
|
34
|
+
tag_field_name mytag
|
35
|
+
</match>
|
36
|
+
```
|
37
|
+
|
38
|
+
* **customer\_id (required)** - Your Operations Management Suite workspace ID
|
39
|
+
* **shared\_key (required)** - The primary or the secondary Connected Sources client authentication key
|
40
|
+
* **log\_type (required)** - The name of the event type that is being submitted to Log Analytics
|
41
|
+
* **add\_time\_field (optional)** - Default:true. This option allows to insert a time field to record
|
42
|
+
* **time\_field\_name (optional)** - Default:time. This is required only when add_time_field is true
|
43
|
+
* **localtime (optional)** - Default:false. Time record is inserted with UTC (Coordinated Universal Time) by default. This option allows to use local time if you set localtime true. This is valid only when add_time_field is true
|
44
|
+
* **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. This is valid only when add_time_field is true.
|
45
|
+
* **add\_tag\_field (optional)** - Default:false. This option allows to insert a tag field to record
|
46
|
+
* **tag\_field\_name (optional)** - Default:tag. This is required only when add_time_field is true
|
47
|
+
|
48
|
+
|
49
|
+
## Configuration examples
|
50
|
+
|
51
|
+
fluent-plugin-azure-loganalytics adds **time** and **tag** attributes by default if **add_time_field** and **add_tag_field** are true respectively. Below are two types of the plugin configurations - Default and All options configuration.
|
52
|
+
|
53
|
+
### (1) Default Configuration (No options)
|
54
|
+
<u>fluent.conf</u>
|
55
|
+
```
|
56
|
+
<source>
|
57
|
+
@type tail # input plugin
|
58
|
+
path /var/log/apache2/access.log # monitoring file
|
59
|
+
pos_file /tmp/fluentd_pos_file # position file
|
60
|
+
format apache # format
|
61
|
+
tag azure-loganalytics.access # tag
|
62
|
+
</source>
|
63
|
+
|
64
|
+
<match azure-loganalytics.**>
|
65
|
+
@type azure-loganalytics
|
66
|
+
customer_id 818f7bbc-8034-4cc3-b97d-f068dd4cd658
|
67
|
+
shared_key ppC5500KzCcDsOKwM1yWUvZydCuC3m+ds/2xci0byeQr1G3E0Jkygn1N0Rxx/yVBUrDE2ok3vf4ksCzvBmQXHw==(dummy)
|
68
|
+
log_type ApacheAccessLog
|
69
|
+
</match>
|
70
|
+
```
|
71
|
+
|
72
|
+
### (2) Configuration with All Options
|
73
|
+
<u>fluent.conf</u>
|
74
|
+
```
|
75
|
+
<source>
|
76
|
+
@type tail # input plugin
|
77
|
+
path /var/log/apache2/access.log # monitoring file
|
78
|
+
pos_file /tmp/fluentd_pos_file # position file
|
79
|
+
format apache # format
|
80
|
+
tag azure-loganalytics.access # tag
|
81
|
+
</source>
|
82
|
+
|
83
|
+
<match azure-loganalytics.**>
|
84
|
+
@type azure-loganalytics
|
85
|
+
customer_id 818f7bbc-8034-4cc3-b97d-f068dd4cd658
|
86
|
+
shared_key ppC5500KzCcDsOKwM1yWUvZydCuC3m+ds/2xci0byeQr1G3E0Jkygn1N0Rxx/yVBUrDE2ok3vf4ksCzvBmQXHw==(dummy)
|
87
|
+
log_type ApacheAccessLog
|
88
|
+
add_time_field true
|
89
|
+
time_field_name mytime
|
90
|
+
time_format %s
|
91
|
+
localtime true
|
92
|
+
add_tag_field true
|
93
|
+
tag_field_name mytag
|
94
|
+
</match>
|
95
|
+
```
|
96
|
+
|
97
|
+
## Sample inputs and expected records
|
98
|
+
|
99
|
+
An expected output record for sample input will be like this:
|
100
|
+
|
101
|
+
<u>Sample Input (apache access log)</u>
|
102
|
+
```
|
103
|
+
124.211.152.156 - - [10/Dec/2016:05:28:52 +0000] "GET /test/foo.html HTTP/1.1" 200 323 "-" "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.99 Safari/537.36"
|
104
|
+
```
|
105
|
+
|
106
|
+
<u>Output Record</u>
|
107
|
+
|
108
|
+
![fluent-plugin-azure-loganalytics output image](https://github.com/yokawasa/fluent-plugin-azure-loganalytics/raw/master/img/Azure-LogAnalytics-Output-Image.png)
|
109
|
+
|
110
|
+
|
111
|
+
## Tests
|
112
|
+
### Running test code
|
113
|
+
```
|
114
|
+
$ git clone https://github.com/yokawasa/fluent-plugin-azure-loganalytics.git
|
115
|
+
$ cd fluent-plugin-azure-loganalytics
|
116
|
+
|
117
|
+
# edit CONFIG params of test/plugin/test_azure_loganalytics.rb
|
118
|
+
$ vi test/plugin/test_azure_loganalytics.rb
|
119
|
+
|
120
|
+
# run test
|
121
|
+
$ rake test
|
122
|
+
```
|
123
|
+
|
124
|
+
### Creating package, running and testing locally
|
125
|
+
```
|
126
|
+
$ rake build
|
127
|
+
$ rake install:local
|
128
|
+
|
129
|
+
# running fluentd with your fluent.conf
|
130
|
+
$ fluentd -c fluent.conf -vv &
|
131
|
+
|
132
|
+
# send test apache requests for testing plugin ( only in the case that input source is apache access log )
|
133
|
+
$ ab -n 5 -c 2 http://localhost/test/foo.html
|
134
|
+
```
|
135
|
+
|
136
|
+
## Change log
|
137
|
+
* [Changelog](ChangeLog.md)
|
138
|
+
|
139
|
+
## Links
|
140
|
+
|
141
|
+
* https://rubygems.org/gems/fluent-plugin-azure-loganalytics
|
142
|
+
* https://rubygems.org/gems/azure-loganalytics-datacollector-api
|
143
|
+
|
144
|
+
## Contributing
|
145
|
+
|
146
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/yokawasa/fluent-plugin-azure-loganalytics.
|
147
|
+
|
148
|
+
## Copyright
|
149
|
+
|
150
|
+
<table>
|
151
|
+
<tr>
|
152
|
+
<td>Copyright</td><td>Copyright (c) 2016- Yoichi Kawasaki</td>
|
153
|
+
</tr>
|
154
|
+
<tr>
|
155
|
+
<td>License</td><td>Apache License, Version 2.0</td>
|
156
|
+
</tr>
|
157
|
+
</table>
|
data/Rakefile
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
|
3
|
+
require "bundler/gem_tasks"
|
4
|
+
require "rake/testtask"
|
5
|
+
|
6
|
+
Rake::TestTask.new(:test) do |test|
|
7
|
+
test.libs << 'lib' << 'test'
|
8
|
+
test.pattern = 'test/**/test_*.rb'
|
9
|
+
test.verbose = true
|
10
|
+
end
|
11
|
+
|
12
|
+
task :default do
|
13
|
+
system("rake -T")
|
14
|
+
end
|
15
|
+
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.1.0
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<source>
|
2
|
+
@type tail # input plugin
|
3
|
+
path /var/log/apache2/access.log # monitoring file
|
4
|
+
pos_file /tmp/fluentd_pos_file # position file
|
5
|
+
format apache # format
|
6
|
+
tag azure-loganalytics.access # tag
|
7
|
+
</source>
|
8
|
+
|
9
|
+
<match azure-loganalytics.**>
|
10
|
+
@type azure-loganalytics
|
11
|
+
customer_id CUSTOMER_ID # Customer ID aka WorkspaceID String
|
12
|
+
shared_key KEY_STRING # The primary or the secondary Connected Sources client authentication key
|
13
|
+
log_type EVENT_TYPE_NAME # The name of the event type. ex) ApacheAccessLog
|
14
|
+
</match>
|
@@ -0,0 +1,20 @@
|
|
1
|
+
<source>
|
2
|
+
@type tail # input plugin
|
3
|
+
path /var/log/apache2/access.log # monitoring file
|
4
|
+
pos_file /tmp/fluentd_pos_file # position file
|
5
|
+
format apache # format
|
6
|
+
tag azure-loganalytics.access # tag
|
7
|
+
</source>
|
8
|
+
|
9
|
+
<match azure-loganalytics.**>
|
10
|
+
@type azure-loganalytics
|
11
|
+
customer_id CUSTOMER_ID # Customer ID aka WorkspaceID String
|
12
|
+
shared_key KEY_STRING # The primary or the secondary Connected Sources client authentication key
|
13
|
+
log_type EVENT_TYPE_NAME # The name of the event type. ex) ApacheAccessLog
|
14
|
+
add_time_field true
|
15
|
+
time_field_name mytime
|
16
|
+
time_format %s
|
17
|
+
localtime true
|
18
|
+
add_tag_field true
|
19
|
+
tag_field_name mytag
|
20
|
+
</match>
|
@@ -0,0 +1,28 @@
|
|
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-azure-loganalytics"
|
7
|
+
gem.version = File.read("VERSION").strip
|
8
|
+
gem.authors = ["Yoichi Kawasaki"]
|
9
|
+
gem.email = ["yoichi.kawasaki@outlook.com"]
|
10
|
+
gem.summary = %q{Azure Functions output plugin for Fluentd}
|
11
|
+
gem.description = gem.summary
|
12
|
+
gem.homepage = "http://github.com/yokawasa/fluent-plugin-azure-loganalytics"
|
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.test_files = gem.files.grep(%r{^(test|gem|features)/})
|
19
|
+
gem.require_paths = ["lib"]
|
20
|
+
|
21
|
+
gem.add_dependency "fluentd", [">= 0.10.58", "< 2"]
|
22
|
+
gem.add_dependency "rest-client"
|
23
|
+
gem.add_dependency "azure-loganalytics-datacollector-api", [">= 0.1.1"]
|
24
|
+
gem.add_development_dependency "bundler", "~> 1.11"
|
25
|
+
gem.add_development_dependency "rake", "~> 10.0"
|
26
|
+
gem.add_development_dependency "test-unit"
|
27
|
+
end
|
28
|
+
|
Binary file
|
Binary file
|
@@ -0,0 +1,85 @@
|
|
1
|
+
# -*- coding: utf-8 -*-
|
2
|
+
|
3
|
+
module Fluent
|
4
|
+
class AzureLogAnalyticsOutput < BufferedOutput
|
5
|
+
Plugin.register_output('azure-loganalytics', self)
|
6
|
+
|
7
|
+
def initialize
|
8
|
+
super
|
9
|
+
require 'msgpack'
|
10
|
+
require 'time'
|
11
|
+
require "azure/loganalytics/datacollectorapi/client"
|
12
|
+
end
|
13
|
+
|
14
|
+
config_param :customer_id, :string,
|
15
|
+
:desc => "Your Operations Management Suite workspace ID"
|
16
|
+
config_param :shared_key, :string, :secret => true,
|
17
|
+
:desc => "The primary or the secondary Connected Sources client authentication key"
|
18
|
+
config_param :log_type, :string, default: nil,
|
19
|
+
:desc => "The name of the event type that is being submitted to Log Analytics"
|
20
|
+
config_param :add_time_field, :bool, :default => true,
|
21
|
+
:desc => "This option allows to insert a time field to record"
|
22
|
+
config_param :time_field_name, :string, :default => "time",
|
23
|
+
:desc => "This is required only when add_time_field is true"
|
24
|
+
config_param :time_format, :string, :default => "%s",
|
25
|
+
:desc => "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. This is valid only when add_time_field is true."
|
26
|
+
config_param :localtime, :bool, :default => false,
|
27
|
+
:desc => "Time record is inserted with UTC (Coordinated Universal Time) by default. This option allows to use local time if you set localtime true. This is valid only when add_time_field is true."
|
28
|
+
config_param :add_tag_field, :bool, :default => false,
|
29
|
+
:desc => "This option allows to insert a tag field to record"
|
30
|
+
config_param :tag_field_name, :string, :default => "tag",
|
31
|
+
:desc => "This is required only when add_time_field is true"
|
32
|
+
|
33
|
+
def configure(conf)
|
34
|
+
super
|
35
|
+
raise ConfigError, 'no customer_id' if @customer_id.empty?
|
36
|
+
raise ConfigError, 'no shared_key' if @shared_key.empty?
|
37
|
+
raise ConfigError, 'no log_type' if @log_type.empty?
|
38
|
+
if @add_time_field and @time_field_name.empty?
|
39
|
+
raise ConfigError, 'time_field_name must be set if add_time_field is true'
|
40
|
+
end
|
41
|
+
if @add_tag_field and @tag_field_name.empty?
|
42
|
+
raise ConfigError, 'tag_field_name must be set if add_tag_field is true'
|
43
|
+
end
|
44
|
+
@timef = TimeFormatter.new(@time_format, @localtime)
|
45
|
+
end
|
46
|
+
|
47
|
+
def start
|
48
|
+
super
|
49
|
+
# start
|
50
|
+
@client=Azure::Loganalytics::Datacollectorapi::Client::new(@customer_id,@shared_key)
|
51
|
+
end
|
52
|
+
|
53
|
+
def shutdown
|
54
|
+
super
|
55
|
+
# destroy
|
56
|
+
end
|
57
|
+
|
58
|
+
def format(tag, time, record)
|
59
|
+
if @add_time_field
|
60
|
+
record[@time_field_name] = @timef.format(time)
|
61
|
+
end
|
62
|
+
if @add_tag_field
|
63
|
+
record[@tag_field_name] = tag
|
64
|
+
end
|
65
|
+
record.to_msgpack
|
66
|
+
end
|
67
|
+
|
68
|
+
def write(chunk)
|
69
|
+
records = []
|
70
|
+
chunk.msgpack_each { |record|
|
71
|
+
records.push(record)
|
72
|
+
}
|
73
|
+
begin
|
74
|
+
res = @client.post_data(@log_type, records)
|
75
|
+
if not Azure::Loganalytics::Datacollectorapi::Client.is_success(res)
|
76
|
+
$log.fatal "DataCollector API request failure: error code: "
|
77
|
+
+ "#{res.code}, data=>" + records.to_json
|
78
|
+
end
|
79
|
+
rescue Exception => ex
|
80
|
+
$log.fatal "Exception occured in posting to DataCollector API: "
|
81
|
+
+ "'#{ex}', data=>" + records.to_json
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
85
|
+
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_azure-loganalytics'
|
27
|
+
|
28
|
+
class Test::Unit::TestCase
|
29
|
+
end
|
@@ -0,0 +1,85 @@
|
|
1
|
+
require 'helper'
|
2
|
+
|
3
|
+
class AzureLogAnalyticsOutputTest < Test::Unit::TestCase
|
4
|
+
def setup
|
5
|
+
Fluent::Test.setup
|
6
|
+
end
|
7
|
+
|
8
|
+
CONFIG = %[
|
9
|
+
customer_id <Customer ID aka WorkspaceID String>
|
10
|
+
shared_key <Primary Key String>
|
11
|
+
log_type ApacheAccessLog
|
12
|
+
add_time_field true
|
13
|
+
localtime true
|
14
|
+
add_tag_field true
|
15
|
+
tag_field_name tag
|
16
|
+
]
|
17
|
+
|
18
|
+
def create_driver(conf = CONFIG, tag='azure-loganalytics.test')
|
19
|
+
Fluent::Test::BufferedOutputTestDriver.new(Fluent::AzureLogAnalyticsOutput, tag).configure(conf)
|
20
|
+
end
|
21
|
+
|
22
|
+
def test_configure
|
23
|
+
#### set configurations
|
24
|
+
# d = create_driver %[
|
25
|
+
# path test_path
|
26
|
+
# compress gz
|
27
|
+
# ]
|
28
|
+
#### check configurations
|
29
|
+
# assert_equal 'test_path', d.instance.path
|
30
|
+
# assert_equal :gz, d.instance.compress
|
31
|
+
end
|
32
|
+
|
33
|
+
def test_format
|
34
|
+
# d = create_driver
|
35
|
+
# time = Time.parse("2011-01-02 13:14:15 UTC").to_i
|
36
|
+
# d.emit({"a"=>1}, time)
|
37
|
+
# d.emit({"a"=>2}, time)
|
38
|
+
|
39
|
+
# d.expect_format %[2011-01-02T13:14:15Z\ttest\t{"a":1}\n]
|
40
|
+
# d.expect_format %[2011-01-02T13:14:15Z\ttest\t{"a":2}\n]
|
41
|
+
|
42
|
+
# d.run
|
43
|
+
end
|
44
|
+
|
45
|
+
def test_write
|
46
|
+
d = create_driver
|
47
|
+
|
48
|
+
time = Time.parse("2016-12-10 13:14:15 UTC").to_i
|
49
|
+
d.emit(
|
50
|
+
{
|
51
|
+
:Log_ID => "5cdad72f-c848-4df0-8aaa-ffe033e75d57",
|
52
|
+
:date => "2016-12-10 09:44:32 JST",
|
53
|
+
:processing_time => "372",
|
54
|
+
:remote => "101.202.74.59",
|
55
|
+
:user => "-",
|
56
|
+
:method => "GET / HTTP/1.1",
|
57
|
+
:status => "304",
|
58
|
+
:size => "-",
|
59
|
+
:referer => "-",
|
60
|
+
:agent => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:27.0) Gecko/20100101 Firefox/27.0"
|
61
|
+
}, time)
|
62
|
+
|
63
|
+
d.emit(
|
64
|
+
{
|
65
|
+
:Log_ID => "7260iswx-8034-4cc3-uirtx-f068dd4cd659",
|
66
|
+
:date => "2016-12-10 09:45:14 JST",
|
67
|
+
:processing_time => "105",
|
68
|
+
:remote => "201.78.74.59",
|
69
|
+
:user => "-",
|
70
|
+
:method => "GET /manager/html HTTP/1.1",
|
71
|
+
:status =>"200",
|
72
|
+
:size => "-",
|
73
|
+
:referer => "-",
|
74
|
+
:agent => "Mozilla/5.0 (Windows NT 5.1; rv:5.0) Gecko/20100101 Firefox/5.0"
|
75
|
+
}, time)
|
76
|
+
|
77
|
+
data = d.run
|
78
|
+
puts data
|
79
|
+
# ### FileOutput#write returns path
|
80
|
+
# path = d.run
|
81
|
+
# expect_path = "#{TMP_DIR}/out_file_test._0.log.gz"
|
82
|
+
# assert_equal expect_path, path
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
metadata
ADDED
@@ -0,0 +1,150 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-azure-loganalytics
|
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-12-10 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: fluentd
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.10.58
|
20
|
+
- - "<"
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: '2'
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: 0.10.58
|
30
|
+
- - "<"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: '2'
|
33
|
+
- !ruby/object:Gem::Dependency
|
34
|
+
name: rest-client
|
35
|
+
requirement: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - ">="
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '0'
|
40
|
+
type: :runtime
|
41
|
+
prerelease: false
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - ">="
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '0'
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: azure-loganalytics-datacollector-api
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - ">="
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: 0.1.1
|
54
|
+
type: :runtime
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - ">="
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: 0.1.1
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
name: bundler
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - "~>"
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: '1.11'
|
68
|
+
type: :development
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '1.11'
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: rake
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '10.0'
|
82
|
+
type: :development
|
83
|
+
prerelease: false
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '10.0'
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
name: test-unit
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - ">="
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '0'
|
96
|
+
type: :development
|
97
|
+
prerelease: false
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - ">="
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '0'
|
103
|
+
description: Azure Functions output plugin for Fluentd
|
104
|
+
email:
|
105
|
+
- yoichi.kawasaki@outlook.com
|
106
|
+
executables: []
|
107
|
+
extensions: []
|
108
|
+
extra_rdoc_files: []
|
109
|
+
files:
|
110
|
+
- ChangeLog.md
|
111
|
+
- Gemfile
|
112
|
+
- LICENSE
|
113
|
+
- README.md
|
114
|
+
- Rakefile
|
115
|
+
- VERSION
|
116
|
+
- examples/fluent_1.conf
|
117
|
+
- examples/fluent_2.conf
|
118
|
+
- fluent-plugin-azure-loganalytics.gemspec
|
119
|
+
- img/Azure-LogAnalytics-Fluentd.png
|
120
|
+
- img/Azure-LogAnalytics-Output-Image.png
|
121
|
+
- lib/fluent/plugin/out_azure-loganalytics.rb
|
122
|
+
- test/helper.rb
|
123
|
+
- test/plugin/test_azure_loganalytics.rb
|
124
|
+
homepage: http://github.com/yokawasa/fluent-plugin-azure-loganalytics
|
125
|
+
licenses:
|
126
|
+
- Apache-2.0
|
127
|
+
metadata: {}
|
128
|
+
post_install_message:
|
129
|
+
rdoc_options: []
|
130
|
+
require_paths:
|
131
|
+
- lib
|
132
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
133
|
+
requirements:
|
134
|
+
- - ">="
|
135
|
+
- !ruby/object:Gem::Version
|
136
|
+
version: '0'
|
137
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
138
|
+
requirements:
|
139
|
+
- - ">="
|
140
|
+
- !ruby/object:Gem::Version
|
141
|
+
version: '0'
|
142
|
+
requirements: []
|
143
|
+
rubyforge_project:
|
144
|
+
rubygems_version: 2.6.2
|
145
|
+
signing_key:
|
146
|
+
specification_version: 4
|
147
|
+
summary: Azure Functions output plugin for Fluentd
|
148
|
+
test_files:
|
149
|
+
- test/helper.rb
|
150
|
+
- test/plugin/test_azure_loganalytics.rb
|