atatus 1.7.0 → 2.0.0

data/lib/atatus/transport/serializers/metadata_serializer.rb

@@ -23,14 +23,19 @@ module Atatus
       # @api private
       class MetadataSerializer < Serializer
         def build(metadata)
-          {
-            metadata: {
+          base =
+            {
               service: build_service(metadata.service),
               process: build_process(metadata.process),
               system: build_system(metadata.system),
               labels: build_labels(metadata.labels)
             }
-          }
+
+          if metadata.cloud.provider
+            base[:cloud] = build_cloud(metadata.cloud)
+          end
+
+          { metadata: base }
         end
 
         private
@@ -59,8 +64,8 @@ module Atatus
               }
             }
 
-          if node_name = service.node_name
-            base[:node] = { name: keyword_field(node_name) }
+          if (node_name = service.node_name)
+            base[:node] = { configured_name: keyword_field(node_name) }
           end
 
           base
@@ -75,17 +80,58 @@ module Atatus
         end
 
         def build_system(system)
-          {
-            hostname: keyword_field(system.hostname),
+          base = {
+            configured_hostname: keyword_field(system.configured_hostname),
             architecture: keyword_field(system.architecture),
             platform: keyword_field(system.platform),
-            kubernetes: keyword_object(system.kubernetes)
+            kubernetes: keyword_object(system.kubernetes),
+            container: keyword_object(system.container)
           }
+          if system.detected_hostname
+            base[:detected_hostname] = keyword_field(system.detected_hostname)
+          end
+
+          base
+        end
+
+        def build_cloud(cloud)
+          strip_nulls!(
+            provider: cloud.provider,
+            account: {
+              id: keyword_field(cloud.account_id),
+              name: keyword_field(cloud.account_name)
+            },
+            availability_zone: keyword_field(cloud.availability_zone),
+            instance: {
+              id: keyword_field(cloud.instance_id),
+              name: keyword_field(cloud.instance_name)
+            },
+            machine: { type: keyword_field(cloud.machine_type) },
+            project: {
+              id: keyword_field(cloud.project_id),
+              name: keyword_field(cloud.project_name)
+            },
+            region: keyword_field(cloud.region)
+          )
         end
 
         def build_labels(labels)
           keyword_object(labels)
         end
+
+        # A bug in APM Server 7.9 disallows null values in `cloud`
+        def strip_nulls!(hash)
+          hash.each_key do |key|
+            case value = hash[key]
+            when Hash
+              strip_nulls!(value)
+              hash.delete(key) if value.empty?
+            when nil then hash.delete(key)
+            end
+          end
+
+          hash
+        end
       end
     end
   end

data/lib/atatus/transport/serializers/metricset_serializer.rb

@@ -46,8 +46,8 @@ module Atatus
         private
 
         def build_samples(samples)
-          samples.each_with_object({}) do |(key, value), hsh|
-            hsh[key] = { value: value }
+          samples.transform_values do |value|
+            { value: value }
           end
         end
       end

data/lib/atatus/transport/serializers/span_serializer.rb

@@ -43,14 +43,14 @@ module Atatus
               stacktrace: span.stacktrace.to_a,
               timestamp: span.timestamp,
               trace_id: span.trace_id,
-              sample_rate: span.sample_rate
+              sample_rate: span.sample_rate,
+              outcome: keyword_field(span.outcome)
             }
           }
         end
 
         # @api private
         class ContextSerializer < Serializer
-          # rubocop:disable Metrics/CyclomaticComplexity
           def build(context)
             return unless context
 
@@ -65,9 +65,20 @@ module Atatus
               base[:destination] = build_destination(context.destination)
             end
 
+            if context.message
+              base[:message] = build_message(context.message)
+            end
+
+            if context.service
+              base[:service] = build_service(context.service)
+            end
+
+            if context.links && !context.links.empty?
+              base[:links] = build_links(context.links)
+            end
+
             base
           end
-          # rubocop:enable Metrics/CyclomaticComplexity
 
           private
 
@@ -90,15 +101,50 @@ module Atatus
           end
 
           def build_destination(destination)
-            {
-              service: {
-                name: keyword_field(destination.name),
-                resource: keyword_field(destination.resource),
-                type: keyword_field(destination.type)
-              },
+            return unless destination
+
+            base = {
               address: keyword_field(destination.address),
               port: destination.port
             }
+
+            if (service = destination.service) && !service.empty?
+              base[:service] = service.to_h
+            end
+
+            if (cloud = destination.cloud) && !cloud.empty?
+              base[:cloud] = cloud.to_h
+            end
+
+            base
+          end
+
+          def build_message(message)
+            {
+              queue: {
+                name: keyword_field(message.queue_name)
+              },
+              age: {
+                ms: message.age_ms.to_i
+              }
+            }
+          end
+
+          def build_service(service)
+            {
+              target: {
+                name: keyword_field(service.target&.name),
+                type: keyword_field(service.target&.type)
+              }
+            }
+          end
+
+          def build_links(links)
+            {
+              links: links.map do |link|
+                {"trace_id" => link.trace_id, "span_id" => link.span_id}
+              end
+            }
           end
         end
 

data/lib/atatus/transport/serializers/transaction_serializer.rb

@@ -35,6 +35,7 @@ module Atatus
               name: keyword_field(transaction.name),
               type: keyword_field(transaction.type),
               result: keyword_field(transaction.result.to_s),
+              outcome: keyword_field(transaction.outcome),
               duration: ms(transaction.duration),
               timestamp: transaction.timestamp,
               sampled: transaction.sampled?,

data/lib/atatus/transport/serializers.rb

@@ -45,18 +45,20 @@ module Atatus
         def keyword_object(hash)
           return unless hash
 
-          hash.tap do |h|
-            h.each { |k, v| hash[k] = keyword_field(v) }
+          hash.each do |k, v|
+            hash[k] =
+              case v
+              when Hash then keyword_object(v)
+              else keyword_field(v)
+              end
           end
         end
 
         def mixed_object(hash)
           return unless hash
 
-          hash.tap do |h|
-            h.each do |k, v|
-              hash[k] = v.is_a?(String) ? keyword_field(v) : v
-            end
+          hash.each do |k, v|
+            hash[k] = v.is_a?(String) ? keyword_field(v) : v
           end
         end
       end
@@ -72,6 +74,7 @@ module Atatus
         end
 
         attr_reader :transaction, :span, :error, :metadata, :metricset
+
         def serialize(resource)
           case resource
           when Transaction

data/lib/atatus/transport/user_agent.rb

@@ -21,7 +21,8 @@ module Atatus
   module Transport
     # @api private
     class UserAgent
-      def initialize(config)
+      def initialize(config, version: VERSION)
+        @version = version
         @built = build(config)
       end
 
@@ -32,16 +33,22 @@ module Atatus
       private
 
       def build(config)
-        metadata = Metadata.new(config)
+        service = Metadata::ServiceInfo.new(config)
 
         [
-          "atatus-ruby/#{VERSION}",
-          HTTP::Request::USER_AGENT,
-          [
-            metadata.service.runtime.name,
-            metadata.service.runtime.version
-          ].join('/')
-        ].join(' ')
+          "atatus-ruby/#{@version}",
+          formatted_service_info(service)
+        ].compact.join(' ')
+      end
+
+      def formatted_service_info(service)
+        if service.name
+          "(#{[
+                service.name,
+                service.version
+               ].compact.join(' ')
+             })"
+        end
       end
     end
   end

data/lib/atatus/transport/worker.rb

@@ -53,11 +53,12 @@ module Atatus
       end
 
       attr_reader :queue, :filters, :name, :connection, :serializers
+
       def work_forever
         while (msg = queue.pop)
           case msg
           when StopMessage
-            debug 'Stopping worker -- %s', self
+            debug 'Stopping worker [%s]', self
             connection.flush(:halt)
             break
           else

data/lib/atatus/util/deep_dup.rb

@@ -0,0 +1,65 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  module Util
+    # @api private
+    #
+    # Makes a deep copy of an Array or Hash
+    # NB: Not guaranteed to work well with complex objects, only simple Hash,
+    # Array, String, Number, etc.
+    class DeepDup
+      def initialize(obj)
+        @obj = obj
+      end
+
+      def dup
+        deep_dup(@obj)
+      end
+
+      def self.dup(obj)
+        new(obj).dup
+      end
+
+      private
+
+      def deep_dup(obj)
+        case obj
+        when Hash then hash(obj)
+        when Array then array(obj)
+        else obj.dup
+        end
+      end
+
+      def array(arr)
+        arr.map { |obj| deep_dup(obj) }
+      end
+
+      def hash(hsh)
+        result = hsh.dup
+
+        hsh.each_pair do |key, value|
+          result[key] = deep_dup(value)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/atatus/util/precision_validator.rb

@@ -0,0 +1,46 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  module Util
+    # @api private
+    # Rounds half away from zero.
+    # If `minimum` is provided, and the value rounds to 0 (but was not zero to
+    # begin with), use the minimum instead.
+    module PrecisionValidator
+      module_function
+
+      def validate(value, precision: 0, minimum: nil)
+        float = Float(value)
+        return nil unless (0.0..1.0).cover?(float)
+        return float if float == 0
+
+        multiplier = Float(10**precision)
+        rounded = (float * multiplier + 0.5).floor / multiplier
+        if rounded == 0 && minimum
+          minimum
+        else
+          rounded
+        end
+      rescue ArgumentError
+        nil
+      end
+    end
+  end
+end

data/lib/atatus/util.rb

@@ -55,6 +55,8 @@ module Atatus
 
     def self.truncate(value, max_length: 1024)
       return unless value
+
+      value = String(value)
       return value if value.length <= max_length
 
       value[0...(max_length - 1)] + '…'

data/lib/atatus/version.rb

@@ -19,5 +19,5 @@
 
 module Atatus
   AGENT_NAME = 'Ruby'
-  VERSION = '1.7.0'
+  VERSION = '2.0.0'
 end

data/lib/atatus.rb

@@ -26,12 +26,14 @@ require 'logger'
 require 'concurrent'
 require 'forwardable'
 require 'securerandom'
+require 'ruby2_keywords'
 
 require 'atatus/version'
 require 'atatus/internal_error'
 require 'atatus/logging'
 
 # Core
+require 'atatus/fields'
 require 'atatus/agent'
 require 'atatus/config'
 require 'atatus/context'
@@ -106,6 +108,7 @@ module Atatus
     # @yield [String|nil, String|nil, String|nil] The transaction, span,
     # and trace ids.
     # @return [String] Unless block given
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def log_ids
       trace_id = (current_transaction || current_span)&.trace_id
       if block_given?
@@ -118,6 +121,7 @@ module Atatus
       ids << "trace.id=#{trace_id}" if trace_id
       ids.join(' ')
     end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # Start a new transaction
     #
@@ -183,7 +187,12 @@ module Atatus
             context: context,
             trace_context: trace_context
           )
-        yield transaction
+        result = yield transaction
+        transaction&.outcome ||= Transaction::Outcome::SUCCESS
+        result
+      rescue
+        transaction&.outcome ||= Transaction::Outcome::FAILURE
+        raise
       ensure
         end_transaction
       end
@@ -235,9 +244,12 @@ module Atatus
 
     # Ends the current span
     #
+    # @param span [Span] Optional span to be ended instead of the last span
+    #   created, useful for asynchronous environments where multiple spans are created in parallel
+    #
     # @return [Span]
-    def end_span
-      agent&.end_span
+    def end_span(span = nil)
+      agent&.end_span(span)
     end
 
     # rubocop:disable Metrics/ParameterLists
@@ -287,7 +299,12 @@ module Atatus
             parent: parent,
             sync: sync
           )
-        yield span
+        result = yield span
+        span&.outcome ||= Span::Outcome::SUCCESS
+        result
+      rescue
+        span&.outcome ||= Span::Outcome::FAILURE
+        raise
       ensure
         end_span
       end
@@ -392,6 +409,16 @@ module Atatus
       agent&.set_response_body(response_body.to_s)
     end
 
+    # Provide a filter to transform payloads before sending them off
+    #
+    # @param address [String] Destination address
+    # @param address [String] Destination address
+    # @param address [Hash] Destination service
+    # @param address [Hash] Destination cloud
+    def set_destination(address: nil, port: nil, service: nil, cloud: nil)
+      agent&.set_destination(address: address, port: port, service: service, cloud: cloud)
+    end
+
     # Provide a filter to transform payloads before sending them off
     #
     # @param key [Symbol] Unique filter key
@@ -399,7 +426,7 @@ module Atatus
     # @yield [Hash] A filter. Used if provided. Otherwise using `callback`
     # @return [Bool] true
     def add_filter(key, callback = nil, &block)
-      if callback.nil? && !block_given?
+      if callback.nil? && !block
         raise ArgumentError, '#add_filter needs either `callback\' or a block'
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atatus
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Atatus
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,8 +38,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description:
-email: success@atatus.com
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- success@atatus.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -70,8 +85,11 @@ files:
 - lib/atatus/config.rb
 - lib/atatus/config/bytes.rb
 - lib/atatus/config/duration.rb
+- lib/atatus/config/log_level_map.rb
 - lib/atatus/config/options.rb
 - lib/atatus/config/regexp_list.rb
+- lib/atatus/config/round_float.rb
+- lib/atatus/config/server_info.rb
 - lib/atatus/config/wildcard_pattern_list.rb
 - lib/atatus/context.rb
 - lib/atatus/context/company.rb
@@ -86,6 +104,7 @@ files:
 - lib/atatus/error/exception.rb
 - lib/atatus/error/log.rb
 - lib/atatus/error_builder.rb
+- lib/atatus/fields.rb
 - lib/atatus/grape.rb
 - lib/atatus/graphql.rb
 - lib/atatus/grpc.rb
@@ -93,6 +112,7 @@ files:
 - lib/atatus/internal_error.rb
 - lib/atatus/logging.rb
 - lib/atatus/metadata.rb
+- lib/atatus/metadata/cloud_info.rb
 - lib/atatus/metadata/process_info.rb
 - lib/atatus/metadata/service_info.rb
 - lib/atatus/metadata/system_info.rb
@@ -102,6 +122,7 @@ files:
 - lib/atatus/metrics.rb
 - lib/atatus/metrics/breakdown_set.rb
 - lib/atatus/metrics/cpu_mem_set.rb
+- lib/atatus/metrics/jvm_set.rb
 - lib/atatus/metrics/metric.rb
 - lib/atatus/metrics/set.rb
 - lib/atatus/metrics/span_scoped_set.rb
@@ -128,9 +149,13 @@ files:
 - lib/atatus/span/context/db.rb
 - lib/atatus/span/context/destination.rb
 - lib/atatus/span/context/http.rb
+- lib/atatus/span/context/links.rb
+- lib/atatus/span/context/message.rb
+- lib/atatus/span/context/service.rb
 - lib/atatus/span_helpers.rb
 - lib/atatus/spies.rb
 - lib/atatus/spies/action_dispatch.rb
+- lib/atatus/spies/azure_storage_table.rb
 - lib/atatus/spies/delayed_job.rb
 - lib/atatus/spies/dynamo_db.rb
 - lib/atatus/spies/elasticsearch.rb
@@ -139,21 +164,23 @@ files:
 - lib/atatus/spies/json.rb
 - lib/atatus/spies/mongo.rb
 - lib/atatus/spies/net_http.rb
+- lib/atatus/spies/racecar.rb
 - lib/atatus/spies/rake.rb
 - lib/atatus/spies/redis.rb
 - lib/atatus/spies/resque.rb
+- lib/atatus/spies/s3.rb
 - lib/atatus/spies/sequel.rb
 - lib/atatus/spies/shoryuken.rb
 - lib/atatus/spies/sidekiq.rb
 - lib/atatus/spies/sinatra.rb
 - lib/atatus/spies/sneakers.rb
+- lib/atatus/spies/sns.rb
+- lib/atatus/spies/sqs.rb
 - lib/atatus/spies/sucker_punch.rb
 - lib/atatus/spies/tilt.rb
-- lib/atatus/sql.rb
 - lib/atatus/sql/signature.rb
 - lib/atatus/sql/tokenizer.rb
 - lib/atatus/sql/tokens.rb
-- lib/atatus/sql_summarizer.rb
 - lib/atatus/stacktrace.rb
 - lib/atatus/stacktrace/frame.rb
 - lib/atatus/stacktrace_builder.rb
@@ -180,17 +207,19 @@ files:
 - lib/atatus/transport/user_agent.rb
 - lib/atatus/transport/worker.rb
 - lib/atatus/util.rb
+- lib/atatus/util/deep_dup.rb
 - lib/atatus/util/inflector.rb
 - lib/atatus/util/lru_cache.rb
+- lib/atatus/util/precision_validator.rb
 - lib/atatus/util/throttle.rb
 - lib/atatus/version.rb
 homepage: https://www.atatus.com
 licenses:
-- Atatus
+- Apache-2.0
 metadata:
   changelog_uri: https://docs.atatus.com/docs/release-notes/ruby.html
   documentation_uri: https://docs.atatus.com/docs/application-monitoring/ruby-agent/overview.html
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -205,8 +234,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Atatus Ruby Agent
 test_files: []