atatus 1.6.2 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (107) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -0
  3. data/Gemfile +49 -13
  4. data/LICENSE +1 -1
  5. data/atatus.gemspec +3 -3
  6. data/lib/atatus/agent.rb +18 -7
  7. data/lib/atatus/central_config.rb +19 -8
  8. data/lib/atatus/collector/base.rb +113 -1
  9. data/lib/atatus/collector/builder.rb +8 -0
  10. data/lib/atatus/collector/layer.rb +1 -1
  11. data/lib/atatus/collector/transport.rb +23 -2
  12. data/lib/atatus/{sql_summarizer.rb → config/log_level_map.rb} +22 -28
  13. data/lib/atatus/config/options.rb +2 -1
  14. data/lib/atatus/config/regexp_list.rb +1 -1
  15. data/lib/atatus/config/round_float.rb +31 -0
  16. data/lib/atatus/config/server_info.rb +50 -0
  17. data/lib/atatus/config/wildcard_pattern_list.rb +3 -1
  18. data/lib/atatus/config.rb +94 -70
  19. data/lib/atatus/context/company.rb +38 -0
  20. data/lib/atatus/context/request/socket.rb +1 -2
  21. data/lib/atatus/context/response.rb +1 -3
  22. data/lib/atatus/context.rb +4 -8
  23. data/lib/atatus/context_builder.rb +3 -3
  24. data/lib/atatus/error.rb +2 -1
  25. data/lib/atatus/error_builder.rb +1 -1
  26. data/lib/atatus/fields.rb +98 -0
  27. data/lib/atatus/graphql.rb +2 -0
  28. data/lib/atatus/grpc.rb +5 -7
  29. data/lib/atatus/instrumenter.rb +38 -24
  30. data/lib/atatus/metadata/cloud_info.rb +156 -0
  31. data/lib/atatus/metadata/service_info.rb +3 -3
  32. data/lib/atatus/metadata/system_info/container_info.rb +20 -8
  33. data/lib/atatus/metadata/system_info.rb +20 -5
  34. data/lib/atatus/metadata.rb +3 -1
  35. data/lib/atatus/metrics/cpu_mem_set.rb +10 -38
  36. data/lib/atatus/metrics/jvm_set.rb +88 -0
  37. data/lib/atatus/metrics/metric.rb +2 -0
  38. data/lib/atatus/metrics.rb +32 -16
  39. data/lib/atatus/middleware.rb +8 -3
  40. data/lib/atatus/naively_hashable.rb +1 -0
  41. data/lib/atatus/normalizers/rails/active_record.rb +25 -7
  42. data/lib/atatus/normalizers.rb +2 -2
  43. data/lib/atatus/opentracing.rb +5 -3
  44. data/lib/atatus/rails.rb +1 -1
  45. data/lib/atatus/span/context/db.rb +1 -1
  46. data/lib/atatus/span/context/destination.rb +58 -32
  47. data/lib/atatus/span/context/http.rb +2 -0
  48. data/lib/atatus/span/context/links.rb +32 -0
  49. data/lib/atatus/{sql.rb → span/context/message.rb} +16 -12
  50. data/lib/atatus/span/context/service.rb +55 -0
  51. data/lib/atatus/span/context.rb +28 -3
  52. data/lib/atatus/span.rb +35 -5
  53. data/lib/atatus/span_helpers.rb +12 -23
  54. data/lib/atatus/spies/action_dispatch.rb +10 -13
  55. data/lib/atatus/spies/azure_storage_table.rb +148 -0
  56. data/lib/atatus/spies/delayed_job.rb +19 -13
  57. data/lib/atatus/spies/dynamo_db.rb +56 -15
  58. data/lib/atatus/spies/elasticsearch.rb +54 -39
  59. data/lib/atatus/spies/faraday.rb +92 -58
  60. data/lib/atatus/spies/http.rb +33 -37
  61. data/lib/atatus/spies/json.rb +5 -9
  62. data/lib/atatus/spies/mongo.rb +26 -19
  63. data/lib/atatus/spies/net_http.rb +53 -51
  64. data/lib/atatus/spies/racecar.rb +77 -0
  65. data/lib/atatus/spies/rake.rb +27 -27
  66. data/lib/atatus/spies/redis.rb +11 -12
  67. data/lib/atatus/spies/resque.rb +18 -23
  68. data/lib/atatus/spies/s3.rb +132 -0
  69. data/lib/atatus/spies/sequel.rb +50 -40
  70. data/lib/atatus/spies/shoryuken.rb +4 -6
  71. data/lib/atatus/spies/sidekiq.rb +23 -31
  72. data/lib/atatus/spies/sinatra.rb +20 -28
  73. data/lib/atatus/spies/sneakers.rb +2 -0
  74. data/lib/atatus/spies/sns.rb +126 -0
  75. data/lib/atatus/spies/sqs.rb +231 -0
  76. data/lib/atatus/spies/sucker_punch.rb +20 -22
  77. data/lib/atatus/spies/tilt.rb +10 -13
  78. data/lib/atatus/spies.rb +20 -0
  79. data/lib/atatus/sql/signature.rb +4 -2
  80. data/lib/atatus/sql/tokenizer.rb +23 -7
  81. data/lib/atatus/stacktrace/frame.rb +1 -0
  82. data/lib/atatus/stacktrace_builder.rb +12 -16
  83. data/lib/atatus/subscriber.rb +1 -0
  84. data/lib/atatus/trace_context/traceparent.rb +5 -8
  85. data/lib/atatus/trace_context/tracestate.rb +16 -14
  86. data/lib/atatus/trace_context.rb +6 -16
  87. data/lib/atatus/transaction.rb +25 -4
  88. data/lib/atatus/transport/base.rb +1 -3
  89. data/lib/atatus/transport/connection/http.rb +11 -3
  90. data/lib/atatus/transport/connection/proxy_pipe.rb +1 -2
  91. data/lib/atatus/transport/connection.rb +3 -2
  92. data/lib/atatus/transport/filters/hash_sanitizer.rb +16 -34
  93. data/lib/atatus/transport/filters/secrets_filter.rb +35 -12
  94. data/lib/atatus/transport/serializers/context_serializer.rb +1 -2
  95. data/lib/atatus/transport/serializers/metadata_serializer.rb +54 -8
  96. data/lib/atatus/transport/serializers/metricset_serializer.rb +2 -2
  97. data/lib/atatus/transport/serializers/span_serializer.rb +55 -9
  98. data/lib/atatus/transport/serializers/transaction_serializer.rb +1 -0
  99. data/lib/atatus/transport/serializers.rb +9 -6
  100. data/lib/atatus/transport/user_agent.rb +16 -9
  101. data/lib/atatus/transport/worker.rb +2 -1
  102. data/lib/atatus/util/deep_dup.rb +65 -0
  103. data/lib/atatus/util/precision_validator.rb +46 -0
  104. data/lib/atatus/util.rb +2 -0
  105. data/lib/atatus/version.rb +1 -1
  106. data/lib/atatus.rb +48 -5
  107. metadata +41 -11
@@ -0,0 +1,65 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ module Atatus
21
+ module Util
22
+ # @api private
23
+ #
24
+ # Makes a deep copy of an Array or Hash
25
+ # NB: Not guaranteed to work well with complex objects, only simple Hash,
26
+ # Array, String, Number, etc.
27
+ class DeepDup
28
+ def initialize(obj)
29
+ @obj = obj
30
+ end
31
+
32
+ def dup
33
+ deep_dup(@obj)
34
+ end
35
+
36
+ def self.dup(obj)
37
+ new(obj).dup
38
+ end
39
+
40
+ private
41
+
42
+ def deep_dup(obj)
43
+ case obj
44
+ when Hash then hash(obj)
45
+ when Array then array(obj)
46
+ else obj.dup
47
+ end
48
+ end
49
+
50
+ def array(arr)
51
+ arr.map { |obj| deep_dup(obj) }
52
+ end
53
+
54
+ def hash(hsh)
55
+ result = hsh.dup
56
+
57
+ hsh.each_pair do |key, value|
58
+ result[key] = deep_dup(value)
59
+ end
60
+
61
+ result
62
+ end
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,46 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ module Atatus
21
+ module Util
22
+ # @api private
23
+ # Rounds half away from zero.
24
+ # If `minimum` is provided, and the value rounds to 0 (but was not zero to
25
+ # begin with), use the minimum instead.
26
+ module PrecisionValidator
27
+ module_function
28
+
29
+ def validate(value, precision: 0, minimum: nil)
30
+ float = Float(value)
31
+ return nil unless (0.0..1.0).cover?(float)
32
+ return float if float == 0
33
+
34
+ multiplier = Float(10**precision)
35
+ rounded = (float * multiplier + 0.5).floor / multiplier
36
+ if rounded == 0 && minimum
37
+ minimum
38
+ else
39
+ rounded
40
+ end
41
+ rescue ArgumentError
42
+ nil
43
+ end
44
+ end
45
+ end
46
+ end
data/lib/atatus/util.rb CHANGED
@@ -55,6 +55,8 @@ module Atatus
55
55
 
56
56
  def self.truncate(value, max_length: 1024)
57
57
  return unless value
58
+
59
+ value = String(value)
58
60
  return value if value.length <= max_length
59
61
 
60
62
  value[0...(max_length - 1)] + '…'
@@ -19,5 +19,5 @@
19
19
 
20
20
  module Atatus
21
21
  AGENT_NAME = 'Ruby'
22
- VERSION = '1.6.2'
22
+ VERSION = '2.0.0'
23
23
  end
data/lib/atatus.rb CHANGED
@@ -26,12 +26,14 @@ require 'logger'
26
26
  require 'concurrent'
27
27
  require 'forwardable'
28
28
  require 'securerandom'
29
+ require 'ruby2_keywords'
29
30
 
30
31
  require 'atatus/version'
31
32
  require 'atatus/internal_error'
32
33
  require 'atatus/logging'
33
34
 
34
35
  # Core
36
+ require 'atatus/fields'
35
37
  require 'atatus/agent'
36
38
  require 'atatus/config'
37
39
  require 'atatus/context'
@@ -106,6 +108,7 @@ module Atatus
106
108
  # @yield [String|nil, String|nil, String|nil] The transaction, span,
107
109
  # and trace ids.
108
110
  # @return [String] Unless block given
111
+ # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
109
112
  def log_ids
110
113
  trace_id = (current_transaction || current_span)&.trace_id
111
114
  if block_given?
@@ -118,6 +121,7 @@ module Atatus
118
121
  ids << "trace.id=#{trace_id}" if trace_id
119
122
  ids.join(' ')
120
123
  end
124
+ # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
121
125
 
122
126
  # Start a new transaction
123
127
  #
@@ -183,7 +187,12 @@ module Atatus
183
187
  context: context,
184
188
  trace_context: trace_context
185
189
  )
186
- yield transaction
190
+ result = yield transaction
191
+ transaction&.outcome ||= Transaction::Outcome::SUCCESS
192
+ result
193
+ rescue
194
+ transaction&.outcome ||= Transaction::Outcome::FAILURE
195
+ raise
187
196
  ensure
188
197
  end_transaction
189
198
  end
@@ -235,9 +244,12 @@ module Atatus
235
244
 
236
245
  # Ends the current span
237
246
  #
247
+ # @param span [Span] Optional span to be ended instead of the last span
248
+ # created, useful for asynchronous environments where multiple spans are created in parallel
249
+ #
238
250
  # @return [Span]
239
- def end_span
240
- agent&.end_span
251
+ def end_span(span = nil)
252
+ agent&.end_span(span)
241
253
  end
242
254
 
243
255
  # rubocop:disable Metrics/ParameterLists
@@ -287,7 +299,12 @@ module Atatus
287
299
  parent: parent,
288
300
  sync: sync
289
301
  )
290
- yield span
302
+ result = yield span
303
+ span&.outcome ||= Span::Outcome::SUCCESS
304
+ result
305
+ rescue
306
+ span&.outcome ||= Span::Outcome::FAILURE
307
+ raise
291
308
  ensure
292
309
  end_span
293
310
  end
@@ -376,6 +393,32 @@ module Atatus
376
393
  agent&.set_user(user)
377
394
  end
378
395
 
396
+ # Provide a company to the current transaction
397
+ #
398
+ # @param company [Object] An object representing a company
399
+ # @return [Object] Given company
400
+ def set_company(company)
401
+ agent&.set_company(company)
402
+ end
403
+
404
+ # Provide the response body to the current transaction
405
+ #
406
+ # @param response_body [String] A string containing the response body
407
+ # @return [String] Given response body
408
+ def set_response_body(response_body)
409
+ agent&.set_response_body(response_body.to_s)
410
+ end
411
+
412
+ # Provide a filter to transform payloads before sending them off
413
+ #
414
+ # @param address [String] Destination address
415
+ # @param address [String] Destination address
416
+ # @param address [Hash] Destination service
417
+ # @param address [Hash] Destination cloud
418
+ def set_destination(address: nil, port: nil, service: nil, cloud: nil)
419
+ agent&.set_destination(address: address, port: port, service: service, cloud: cloud)
420
+ end
421
+
379
422
  # Provide a filter to transform payloads before sending them off
380
423
  #
381
424
  # @param key [Symbol] Unique filter key
@@ -383,7 +426,7 @@ module Atatus
383
426
  # @yield [Hash] A filter. Used if provided. Otherwise using `callback`
384
427
  # @return [Bool] true
385
428
  def add_filter(key, callback = nil, &block)
386
- if callback.nil? && !block_given?
429
+ if callback.nil? && !block
387
430
  raise ArgumentError, '#add_filter needs either `callback\' or a block'
388
431
  end
389
432
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: atatus
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.6.2
4
+ version: 2.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Atatus
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-31 00:00:00.000000000 Z
11
+ date: 2024-01-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: concurrent-ruby
@@ -38,8 +38,23 @@ dependencies:
38
38
  - - ">="
39
39
  - !ruby/object:Gem::Version
40
40
  version: '3.0'
41
- description:
42
- email: success@atatus.com
41
+ - !ruby/object:Gem::Dependency
42
+ name: ruby2_keywords
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description:
56
+ email:
57
+ - success@atatus.com
43
58
  executables: []
44
59
  extensions: []
45
60
  extra_rdoc_files:
@@ -70,10 +85,14 @@ files:
70
85
  - lib/atatus/config.rb
71
86
  - lib/atatus/config/bytes.rb
72
87
  - lib/atatus/config/duration.rb
88
+ - lib/atatus/config/log_level_map.rb
73
89
  - lib/atatus/config/options.rb
74
90
  - lib/atatus/config/regexp_list.rb
91
+ - lib/atatus/config/round_float.rb
92
+ - lib/atatus/config/server_info.rb
75
93
  - lib/atatus/config/wildcard_pattern_list.rb
76
94
  - lib/atatus/context.rb
95
+ - lib/atatus/context/company.rb
77
96
  - lib/atatus/context/request.rb
78
97
  - lib/atatus/context/request/socket.rb
79
98
  - lib/atatus/context/request/url.rb
@@ -85,6 +104,7 @@ files:
85
104
  - lib/atatus/error/exception.rb
86
105
  - lib/atatus/error/log.rb
87
106
  - lib/atatus/error_builder.rb
107
+ - lib/atatus/fields.rb
88
108
  - lib/atatus/grape.rb
89
109
  - lib/atatus/graphql.rb
90
110
  - lib/atatus/grpc.rb
@@ -92,6 +112,7 @@ files:
92
112
  - lib/atatus/internal_error.rb
93
113
  - lib/atatus/logging.rb
94
114
  - lib/atatus/metadata.rb
115
+ - lib/atatus/metadata/cloud_info.rb
95
116
  - lib/atatus/metadata/process_info.rb
96
117
  - lib/atatus/metadata/service_info.rb
97
118
  - lib/atatus/metadata/system_info.rb
@@ -101,6 +122,7 @@ files:
101
122
  - lib/atatus/metrics.rb
102
123
  - lib/atatus/metrics/breakdown_set.rb
103
124
  - lib/atatus/metrics/cpu_mem_set.rb
125
+ - lib/atatus/metrics/jvm_set.rb
104
126
  - lib/atatus/metrics/metric.rb
105
127
  - lib/atatus/metrics/set.rb
106
128
  - lib/atatus/metrics/span_scoped_set.rb
@@ -127,9 +149,13 @@ files:
127
149
  - lib/atatus/span/context/db.rb
128
150
  - lib/atatus/span/context/destination.rb
129
151
  - lib/atatus/span/context/http.rb
152
+ - lib/atatus/span/context/links.rb
153
+ - lib/atatus/span/context/message.rb
154
+ - lib/atatus/span/context/service.rb
130
155
  - lib/atatus/span_helpers.rb
131
156
  - lib/atatus/spies.rb
132
157
  - lib/atatus/spies/action_dispatch.rb
158
+ - lib/atatus/spies/azure_storage_table.rb
133
159
  - lib/atatus/spies/delayed_job.rb
134
160
  - lib/atatus/spies/dynamo_db.rb
135
161
  - lib/atatus/spies/elasticsearch.rb
@@ -138,21 +164,23 @@ files:
138
164
  - lib/atatus/spies/json.rb
139
165
  - lib/atatus/spies/mongo.rb
140
166
  - lib/atatus/spies/net_http.rb
167
+ - lib/atatus/spies/racecar.rb
141
168
  - lib/atatus/spies/rake.rb
142
169
  - lib/atatus/spies/redis.rb
143
170
  - lib/atatus/spies/resque.rb
171
+ - lib/atatus/spies/s3.rb
144
172
  - lib/atatus/spies/sequel.rb
145
173
  - lib/atatus/spies/shoryuken.rb
146
174
  - lib/atatus/spies/sidekiq.rb
147
175
  - lib/atatus/spies/sinatra.rb
148
176
  - lib/atatus/spies/sneakers.rb
177
+ - lib/atatus/spies/sns.rb
178
+ - lib/atatus/spies/sqs.rb
149
179
  - lib/atatus/spies/sucker_punch.rb
150
180
  - lib/atatus/spies/tilt.rb
151
- - lib/atatus/sql.rb
152
181
  - lib/atatus/sql/signature.rb
153
182
  - lib/atatus/sql/tokenizer.rb
154
183
  - lib/atatus/sql/tokens.rb
155
- - lib/atatus/sql_summarizer.rb
156
184
  - lib/atatus/stacktrace.rb
157
185
  - lib/atatus/stacktrace/frame.rb
158
186
  - lib/atatus/stacktrace_builder.rb
@@ -179,17 +207,19 @@ files:
179
207
  - lib/atatus/transport/user_agent.rb
180
208
  - lib/atatus/transport/worker.rb
181
209
  - lib/atatus/util.rb
210
+ - lib/atatus/util/deep_dup.rb
182
211
  - lib/atatus/util/inflector.rb
183
212
  - lib/atatus/util/lru_cache.rb
213
+ - lib/atatus/util/precision_validator.rb
184
214
  - lib/atatus/util/throttle.rb
185
215
  - lib/atatus/version.rb
186
216
  homepage: https://www.atatus.com
187
217
  licenses:
188
- - Atatus
218
+ - Apache-2.0
189
219
  metadata:
190
220
  changelog_uri: https://docs.atatus.com/docs/release-notes/ruby.html
191
221
  documentation_uri: https://docs.atatus.com/docs/application-monitoring/ruby-agent/overview.html
192
- post_install_message:
222
+ post_install_message:
193
223
  rdoc_options: []
194
224
  require_paths:
195
225
  - lib
@@ -204,8 +234,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
204
234
  - !ruby/object:Gem::Version
205
235
  version: '0'
206
236
  requirements: []
207
- rubygems_version: 3.0.4
208
- signing_key:
237
+ rubygems_version: 3.0.3.1
238
+ signing_key:
209
239
  specification_version: 4
210
240
  summary: Atatus Ruby Agent
211
241
  test_files: []