service_logger 1.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/ISSUE_TEMPLATE +16 -0
- data/.github/PULL_REQUEST_TEMPLATE +19 -0
- data/.gitignore +10 -0
- data/.rspec +3 -0
- data/.travis.yml +12 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +90 -0
- data/Rakefile +6 -0
- data/bin/console +15 -0
- data/bin/setup +8 -0
- data/contributing.md +13 -0
- data/lib/service_logger/railtie.rb +27 -0
- data/lib/service_logger/version.rb +3 -0
- data/lib/service_logger.rb +57 -0
- data/lib/task_logger.rb +32 -0
- data/service_logger.gemspec +32 -0
- metadata +207 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: d193a45e65bd5e341cace5778dc855958a1d199e
|
4
|
+
data.tar.gz: '08a22384b79bf6fcb5430c5fe6ce4d44be9ab708'
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c27780f8b7d71c373d5ec178141817a007c7d9bc5130a908dc237cd5e4668a32fc855c1672170e9a8c36a99dd391607e0b91bc2d9274602330d943afc7c54022
|
7
|
+
data.tar.gz: fa0b27777319008867b5109f46376e18a342f9e5d02dc52210526f55cc8c29609023c860a7da2cd9280fbbe3882d014e226c5fd60860868bd8de7500c8a87e99
|
@@ -0,0 +1,16 @@
|
|
1
|
+
### Expected/Desired Behavior:
|
2
|
+
< Description of the expected or desired behavior including an example >
|
3
|
+
|
4
|
+
### Current Behavior:
|
5
|
+
< Description of the current behavior being encountered including an example >
|
6
|
+
|
7
|
+
### Impact:
|
8
|
+
- Will this introduce any externally facing changes(endpoint, fields, validation, query)?
|
9
|
+
- Was a regression introduced(if bug)?
|
10
|
+
- Urgency(low, medium, high)?
|
11
|
+
- Teams impacted?(web, ios, android, maps, etc)
|
12
|
+
|
13
|
+
### Requirements:
|
14
|
+
- Label as "Bug Fix", "Feature" or "Optimization"(Tech Debt)
|
15
|
+
|
16
|
+
cc: @two_ @team_members
|
@@ -0,0 +1,19 @@
|
|
1
|
+
### Issue:
|
2
|
+
[JIRA-0000](http://link_to_ticket.com)
|
3
|
+
|
4
|
+
### Proposed Changes:
|
5
|
+
< Description of the proposed change and its value. If possible also include a usage example and relative links to provide additional context for the reviewer>
|
6
|
+
|
7
|
+
### Impact:
|
8
|
+
- Will this introduce any externally facing changes(endpoint, fields, validation, query)?
|
9
|
+
- Any special deployment coordination needed(env changes, data/db migrations, etc.)?
|
10
|
+
- Urgency(low, medium, high)?
|
11
|
+
- Teams impacted(web, ios, android, maps, etc)?
|
12
|
+
|
13
|
+
### Requirements:
|
14
|
+
- Add Tests to cover changes
|
15
|
+
- Update Swagger documentation if applicable
|
16
|
+
- Update repo documentation if applicable(readme, wiki)
|
17
|
+
- Label as "Bug Fix", "Feature" or "Optimization"(Tech Debt)
|
18
|
+
|
19
|
+
cc: @two_ @team_members
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
language: ruby
|
2
|
+
rvm:
|
3
|
+
- 2.2.2
|
4
|
+
before_install: gem install bundler -v 1.11.2
|
5
|
+
deploy:
|
6
|
+
provider: rubygems
|
7
|
+
api_key:
|
8
|
+
secure: rh1HenPk76uWAp74CQ1AA/Q9OqFY5LLyX78mvG1yF3uqZ+sT/4pVrJRxjeEbWUDXtFivNnApS++GPmcS/CmIUIvqQ6ylmXsqlf40/K8JGK3SCtJ2ZvUmHXkOwlB7K4j03hAX28e4mRkS/jHOEW0IZvQrnfosa4tZSsPQhD6QXEmGhxPxekigNbW31Y9WOAr28ykC9ASbD3X8dXF4x/BuLO+kcVyRHu5VA7ZUtw5s3Fuop9l0PZssUzai8v2ZO04PAKelTp1jpDaMm0ONN1Mv+7JfPpJ6s6NervvdnIBXRw6wB69SkNB5wdiDTA5b6oCXjFK9+9iqdJuSqM8AUVeBlpGU6LcZqpsPf7NcLejMWJg85pfKNg7zF9UBd/Yq+LFCDdUC9grouVZ1u9wn6b+6Rm1JCSkTQO8SS23igJiBQ/kAhOL8QmDbuxOnGUH4NAZTqcGio6uPpRqCk/M7rLY8Zxbwl1PM13RfzacOVFwGip2DzjyhMmNmn2r4YbEzvWkgIkGvPezVkyI3LfitlGuk6ikSoO8j3Pq+4MDjl/YlfyV8GTOvyrxkSQ/XOYPxA6tXwcTrnaPofOUN+XqJ/7Ik4sliX/A72kWnvK7TEfdClM0vPQCXCkHrOqnqzraakHWq9nqxcnQfwH9bIpOT8lgAX74/eU7K4t2v1QodF4DdtFQ=
|
9
|
+
gem: service_logger
|
10
|
+
on:
|
11
|
+
tags: true
|
12
|
+
repo: westfieldlabs/service_logger
|
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,90 @@
|
|
1
|
+
# ServiceLogger
|
2
|
+
|
3
|
+
Structured Logging for micro services.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add the following lines to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'service_logger', git: "westfieldlabs/service_logger"
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
## Service Integration - Basics
|
18
|
+
|
19
|
+
- Step 1 - Add `initializer/service_logger.rb`
|
20
|
+
```ruby
|
21
|
+
ServiceLogger.configure do |config|
|
22
|
+
config.service_name = "name_of_service" # Example: event_service
|
23
|
+
end
|
24
|
+
```
|
25
|
+
|
26
|
+
- Step 2 - Add the following to the Application Controller
|
27
|
+
```ruby
|
28
|
+
include ServiceLogger
|
29
|
+
```
|
30
|
+
|
31
|
+
- Step 3 - Add the following to `config/environments/development.rb` (if you want ) and/or `config/environments/production.rb`
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
#Supports Structured logging
|
35
|
+
config.log_level = :info
|
36
|
+
config.log_tags = [ :uuid, lambda { |request| Time.now.utc } ]
|
37
|
+
```
|
38
|
+
|
39
|
+
## Service Integration for Analytics - [ Optional ]
|
40
|
+
|
41
|
+
- Step 3a - Add `service_log` method to relevant controllers (This is OPTIONAL)
|
42
|
+
|
43
|
+
```ruby
|
44
|
+
service_log("action_and_controller_name", { data_from_service })
|
45
|
+
```
|
46
|
+
|
47
|
+
Example
|
48
|
+
```ruby
|
49
|
+
service_log('show_event', { event: @event })
|
50
|
+
```
|
51
|
+
|
52
|
+
## Results
|
53
|
+
|
54
|
+
- Logs should be cleaner and contain the following:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# Example output for basic logging
|
58
|
+
[aabf54d4-40a0-4082-a385-46d146006544] [2016-03-16 00:22:33 UTC] {"method":"GET","path":"/events","format":"json","controller":"api/v1/events","action":"index","status":200,"duration":80.08,"view":43.54,"db":12.6,"service_name":"event_service","environment":"development", params:{"name": "Bespoke Tech Talk" "sensitive_field": "[FILTERED]"}}
|
59
|
+
```
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
# Example output with OPTIONAL logging to support analytics (Step 3a)
|
63
|
+
[7450d124-cc42-434a-952e-09ff08f50044] [2016-03-16 00:20:45 UTC] [analytics] {"service_name":"event_service","environment":"development","event":"index_of_events","event_details":{"events_count":10}}
|
64
|
+
```
|
65
|
+
|
66
|
+
## Rake Task Logger
|
67
|
+
|
68
|
+
You can log your rake tasks by following the example
|
69
|
+
|
70
|
+
```ruby
|
71
|
+
# Add this 3 first lines to enable the logger
|
72
|
+
require 'task_logger'
|
73
|
+
|
74
|
+
Rake::TaskManager.record_task_metadata = true
|
75
|
+
include TaskLogger
|
76
|
+
|
77
|
+
namespace :demo do
|
78
|
+
desc "Test rake"
|
79
|
+
task :test => :environment do |t, args|
|
80
|
+
task_log(t, args) do
|
81
|
+
# your code here
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
85
|
+
```
|
86
|
+
|
87
|
+
```ruby
|
88
|
+
# Example output for rake task logging
|
89
|
+
[analytics] {"service_name":"PeopleAccessService::Application","environment":{"name":"development"},"version":"1.3.0","event":"RAKE_TASK","event_details":{"task_name":"demo:test","arguments":["some arguments"],"starts_at":"2016-10-14T16:40:34-03:00","ends_at":"2016-10-14T16:40:34-03:00","duration":1.0001357,"errors":{"message":"Error Message","error_type":"Error Type"}}}
|
90
|
+
```
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "active_support"
|
5
|
+
require "service_logger"
|
6
|
+
|
7
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
8
|
+
# with your gem easier. You can also use a different console, if you like.
|
9
|
+
|
10
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
11
|
+
# require "pry"
|
12
|
+
# Pry.start
|
13
|
+
|
14
|
+
require "irb"
|
15
|
+
IRB.start
|
data/bin/setup
ADDED
data/contributing.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
## Contributing
|
2
|
+
|
3
|
+
0. Raise an issue in this project outlining the change you'd like to make. You'll need the `issue_number`
|
4
|
+
1. Fork this project into your own Github account
|
5
|
+
2. Create your feature branch (`git checkout -b {issue_number}_my-new-feature`)
|
6
|
+
4. Push to the branch (`git push -u origin {issue_number}_my-new-feature`)
|
7
|
+
5. Write RSpec tests to formalise the outcomes of your change
|
8
|
+
6. Write the code to implement the changes, ensuring that the tests eventually pass
|
9
|
+
7. Commit your changes (`git commit -am '{issue_number} Added some feature'`)
|
10
|
+
8. Push to the branch (`git push -u origin my-new-feature`)
|
11
|
+
9. Create a new Pull Request using Github's built-in mechanisms.
|
12
|
+
10. Wait for a code review to come back, or an approval.
|
13
|
+
11. Either go back and fix whatever the reviewers recommend, or watch and smile as your PR gets merged in and you become part of software development history.
|
@@ -0,0 +1,27 @@
|
|
1
|
+
require 'rails/railtie'
|
2
|
+
require 'action_view/log_subscriber'
|
3
|
+
require 'action_controller/log_subscriber'
|
4
|
+
|
5
|
+
module ServiceLogger
|
6
|
+
class Railtie < Rails::Railtie
|
7
|
+
config.service_logger = ActiveSupport::OrderedOptions.new
|
8
|
+
|
9
|
+
config.before_initialize do |app|
|
10
|
+
ServiceLogger.setup(app)
|
11
|
+
end
|
12
|
+
|
13
|
+
config.after_initialize do |app|
|
14
|
+
config.lograge.enable = true
|
15
|
+
config.lograge.formatter = Lograge::Formatters::Json.new
|
16
|
+
config.lograge.custom_options = lambda do |request|
|
17
|
+
defaults = ServiceLogger.default_custom_options
|
18
|
+
exceptions = %w(controller action format id)
|
19
|
+
params = { params: request.payload[:params].except(*exceptions) }
|
20
|
+
|
21
|
+
defaults.merge(params)
|
22
|
+
end
|
23
|
+
|
24
|
+
Lograge.setup(app)
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
require 'rails/railtie'
|
2
|
+
require 'service_logger/version'
|
3
|
+
require 'active_support/concern'
|
4
|
+
require 'lograge'
|
5
|
+
|
6
|
+
module ServiceLogger
|
7
|
+
mattr_accessor :configuration, :application, :service_name, :environment
|
8
|
+
|
9
|
+
def self.configure
|
10
|
+
self.configuration ||= service_logger_config
|
11
|
+
yield service_logger_config
|
12
|
+
end
|
13
|
+
|
14
|
+
def self.setup(app)
|
15
|
+
self.application = app
|
16
|
+
end
|
17
|
+
|
18
|
+
def self.service_name
|
19
|
+
@service_name ||= default_service_name
|
20
|
+
end
|
21
|
+
|
22
|
+
def self.environment
|
23
|
+
@environment ||= default_environment
|
24
|
+
end
|
25
|
+
|
26
|
+
def self.service_logger_config
|
27
|
+
application.config.service_logger
|
28
|
+
end
|
29
|
+
|
30
|
+
def self.default_custom_options
|
31
|
+
{ service_name: ServiceLogger.service_name, environment: ServiceLogger.environment, version: ServiceLogger::VERSION }
|
32
|
+
end
|
33
|
+
|
34
|
+
private
|
35
|
+
|
36
|
+
def self.default_service_name
|
37
|
+
service_logger_config.service_name || Rails.application.class.to_s
|
38
|
+
end
|
39
|
+
|
40
|
+
def self.default_environment
|
41
|
+
{ name: service_logger_config.environment || Rails.env }
|
42
|
+
end
|
43
|
+
|
44
|
+
def service_log(event, event_details, tag_name="analytics")
|
45
|
+
logger.tagged(tag_name) do
|
46
|
+
message = { service_name: ServiceLogger.service_name, environment: ServiceLogger.environment, version: ServiceLogger::VERSION, event: event, event_details: event_details }
|
47
|
+
logger.info(message.to_json)
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
def logger
|
52
|
+
raise NotImplementedError unless defined?(Rails)
|
53
|
+
Rails.logger
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
require 'service_logger/railtie' if defined?(Rails)
|
data/lib/task_logger.rb
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
module TaskLogger
|
2
|
+
include ServiceLogger
|
3
|
+
|
4
|
+
def task_log(task, args)
|
5
|
+
begin
|
6
|
+
start_time = Time.now
|
7
|
+
errors = nil
|
8
|
+
|
9
|
+
yield
|
10
|
+
|
11
|
+
rescue => e
|
12
|
+
errors = { message: e.message, error_type: e.class.to_s }
|
13
|
+
ensure
|
14
|
+
end_time = Time.now
|
15
|
+
duration = end_time - start_time
|
16
|
+
|
17
|
+
service_log(
|
18
|
+
'RAKE_TASK',
|
19
|
+
{
|
20
|
+
task_name: task.name,
|
21
|
+
arguments: args,
|
22
|
+
starts_at: start_time.to_s(:iso8601),
|
23
|
+
ends_at: end_time.to_s(:iso8601),
|
24
|
+
duration: duration,
|
25
|
+
errors: errors
|
26
|
+
}
|
27
|
+
)
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
module_function :task_log
|
32
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
require_relative 'lib/service_logger/version'
|
3
|
+
|
4
|
+
Gem::Specification.new do |spec|
|
5
|
+
spec.name = 'service_logger'
|
6
|
+
spec.version = ServiceLogger::VERSION
|
7
|
+
spec.authors = ['Kisha Michelle Richardson']
|
8
|
+
spec.email = ['kisha.richardson@gmail.com']
|
9
|
+
|
10
|
+
spec.summary = 'Structured Logging support for micro services.'
|
11
|
+
spec.description = 'Structured Logging to support micro services.'
|
12
|
+
spec.homepage = 'https://github.com/westfieldlabs/service_logger'
|
13
|
+
spec.license = 'Apache 2.0'
|
14
|
+
|
15
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
16
|
+
spec.bindir = 'bin'
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.require_paths = ['lib']
|
19
|
+
|
20
|
+
spec.required_ruby_version = '>= 2.2.2'
|
21
|
+
|
22
|
+
spec.add_dependency 'activesupport', '>= 4', '< 5.1'
|
23
|
+
spec.add_dependency 'actionpack', '>= 4', '< 5.1'
|
24
|
+
spec.add_dependency 'railties', '>= 4', '< 5.1'
|
25
|
+
spec.add_dependency 'lograge', '~> 0.4.1'
|
26
|
+
|
27
|
+
spec.add_development_dependency 'bundler', '~> 1.11'
|
28
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
29
|
+
spec.add_development_dependency 'rspec', '~> 3.0'
|
30
|
+
spec.add_development_dependency 'pry', '~> 0.10.3'
|
31
|
+
spec.add_development_dependency 'pry-byebug', '~> 3.3'
|
32
|
+
end
|
metadata
ADDED
@@ -0,0 +1,207 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: service_logger
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.4.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kisha Michelle Richardson
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-06-08 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: activesupport
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '4'
|
20
|
+
- - "<"
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: '5.1'
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '4'
|
30
|
+
- - "<"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: '5.1'
|
33
|
+
- !ruby/object:Gem::Dependency
|
34
|
+
name: actionpack
|
35
|
+
requirement: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - ">="
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '4'
|
40
|
+
- - "<"
|
41
|
+
- !ruby/object:Gem::Version
|
42
|
+
version: '5.1'
|
43
|
+
type: :runtime
|
44
|
+
prerelease: false
|
45
|
+
version_requirements: !ruby/object:Gem::Requirement
|
46
|
+
requirements:
|
47
|
+
- - ">="
|
48
|
+
- !ruby/object:Gem::Version
|
49
|
+
version: '4'
|
50
|
+
- - "<"
|
51
|
+
- !ruby/object:Gem::Version
|
52
|
+
version: '5.1'
|
53
|
+
- !ruby/object:Gem::Dependency
|
54
|
+
name: railties
|
55
|
+
requirement: !ruby/object:Gem::Requirement
|
56
|
+
requirements:
|
57
|
+
- - ">="
|
58
|
+
- !ruby/object:Gem::Version
|
59
|
+
version: '4'
|
60
|
+
- - "<"
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '5.1'
|
63
|
+
type: :runtime
|
64
|
+
prerelease: false
|
65
|
+
version_requirements: !ruby/object:Gem::Requirement
|
66
|
+
requirements:
|
67
|
+
- - ">="
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '4'
|
70
|
+
- - "<"
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
version: '5.1'
|
73
|
+
- !ruby/object:Gem::Dependency
|
74
|
+
name: lograge
|
75
|
+
requirement: !ruby/object:Gem::Requirement
|
76
|
+
requirements:
|
77
|
+
- - "~>"
|
78
|
+
- !ruby/object:Gem::Version
|
79
|
+
version: 0.4.1
|
80
|
+
type: :runtime
|
81
|
+
prerelease: false
|
82
|
+
version_requirements: !ruby/object:Gem::Requirement
|
83
|
+
requirements:
|
84
|
+
- - "~>"
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: 0.4.1
|
87
|
+
- !ruby/object:Gem::Dependency
|
88
|
+
name: bundler
|
89
|
+
requirement: !ruby/object:Gem::Requirement
|
90
|
+
requirements:
|
91
|
+
- - "~>"
|
92
|
+
- !ruby/object:Gem::Version
|
93
|
+
version: '1.11'
|
94
|
+
type: :development
|
95
|
+
prerelease: false
|
96
|
+
version_requirements: !ruby/object:Gem::Requirement
|
97
|
+
requirements:
|
98
|
+
- - "~>"
|
99
|
+
- !ruby/object:Gem::Version
|
100
|
+
version: '1.11'
|
101
|
+
- !ruby/object:Gem::Dependency
|
102
|
+
name: rake
|
103
|
+
requirement: !ruby/object:Gem::Requirement
|
104
|
+
requirements:
|
105
|
+
- - "~>"
|
106
|
+
- !ruby/object:Gem::Version
|
107
|
+
version: '10.0'
|
108
|
+
type: :development
|
109
|
+
prerelease: false
|
110
|
+
version_requirements: !ruby/object:Gem::Requirement
|
111
|
+
requirements:
|
112
|
+
- - "~>"
|
113
|
+
- !ruby/object:Gem::Version
|
114
|
+
version: '10.0'
|
115
|
+
- !ruby/object:Gem::Dependency
|
116
|
+
name: rspec
|
117
|
+
requirement: !ruby/object:Gem::Requirement
|
118
|
+
requirements:
|
119
|
+
- - "~>"
|
120
|
+
- !ruby/object:Gem::Version
|
121
|
+
version: '3.0'
|
122
|
+
type: :development
|
123
|
+
prerelease: false
|
124
|
+
version_requirements: !ruby/object:Gem::Requirement
|
125
|
+
requirements:
|
126
|
+
- - "~>"
|
127
|
+
- !ruby/object:Gem::Version
|
128
|
+
version: '3.0'
|
129
|
+
- !ruby/object:Gem::Dependency
|
130
|
+
name: pry
|
131
|
+
requirement: !ruby/object:Gem::Requirement
|
132
|
+
requirements:
|
133
|
+
- - "~>"
|
134
|
+
- !ruby/object:Gem::Version
|
135
|
+
version: 0.10.3
|
136
|
+
type: :development
|
137
|
+
prerelease: false
|
138
|
+
version_requirements: !ruby/object:Gem::Requirement
|
139
|
+
requirements:
|
140
|
+
- - "~>"
|
141
|
+
- !ruby/object:Gem::Version
|
142
|
+
version: 0.10.3
|
143
|
+
- !ruby/object:Gem::Dependency
|
144
|
+
name: pry-byebug
|
145
|
+
requirement: !ruby/object:Gem::Requirement
|
146
|
+
requirements:
|
147
|
+
- - "~>"
|
148
|
+
- !ruby/object:Gem::Version
|
149
|
+
version: '3.3'
|
150
|
+
type: :development
|
151
|
+
prerelease: false
|
152
|
+
version_requirements: !ruby/object:Gem::Requirement
|
153
|
+
requirements:
|
154
|
+
- - "~>"
|
155
|
+
- !ruby/object:Gem::Version
|
156
|
+
version: '3.3'
|
157
|
+
description: Structured Logging to support micro services.
|
158
|
+
email:
|
159
|
+
- kisha.richardson@gmail.com
|
160
|
+
executables:
|
161
|
+
- console
|
162
|
+
- setup
|
163
|
+
extensions: []
|
164
|
+
extra_rdoc_files: []
|
165
|
+
files:
|
166
|
+
- ".github/ISSUE_TEMPLATE"
|
167
|
+
- ".github/PULL_REQUEST_TEMPLATE"
|
168
|
+
- ".gitignore"
|
169
|
+
- ".rspec"
|
170
|
+
- ".travis.yml"
|
171
|
+
- Gemfile
|
172
|
+
- LICENSE
|
173
|
+
- README.md
|
174
|
+
- Rakefile
|
175
|
+
- bin/console
|
176
|
+
- bin/setup
|
177
|
+
- contributing.md
|
178
|
+
- lib/service_logger.rb
|
179
|
+
- lib/service_logger/railtie.rb
|
180
|
+
- lib/service_logger/version.rb
|
181
|
+
- lib/task_logger.rb
|
182
|
+
- service_logger.gemspec
|
183
|
+
homepage: https://github.com/westfieldlabs/service_logger
|
184
|
+
licenses:
|
185
|
+
- Apache 2.0
|
186
|
+
metadata: {}
|
187
|
+
post_install_message:
|
188
|
+
rdoc_options: []
|
189
|
+
require_paths:
|
190
|
+
- lib
|
191
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
192
|
+
requirements:
|
193
|
+
- - ">="
|
194
|
+
- !ruby/object:Gem::Version
|
195
|
+
version: 2.2.2
|
196
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
197
|
+
requirements:
|
198
|
+
- - ">="
|
199
|
+
- !ruby/object:Gem::Version
|
200
|
+
version: '0'
|
201
|
+
requirements: []
|
202
|
+
rubyforge_project:
|
203
|
+
rubygems_version: 2.6.10
|
204
|
+
signing_key:
|
205
|
+
specification_version: 4
|
206
|
+
summary: Structured Logging support for micro services.
|
207
|
+
test_files: []
|