skywalking 0.0.0.alpha

data/lib/skywalking/reporter/grpc.rb

@@ -0,0 +1,46 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+require_relative 'protocol'
+require_relative 'client/grpc_client'
+
+module Skywalking
+  module Reporter
+    class Grpc < Protocol
+      def initialize(config)
+        @cfg = config
+        @ms_client = Skywalking::Reporter::Client::GrpcClient::ManagementServiceGrpc.new(config)
+        @trace_client = Skywalking::Reporter::Client::GrpcClient::TraceSegmentReportServiceGrpc.new(config)
+        @send_properties_counter = 0
+        @counter_mutex = Mutex.new
+      end
+
+      def report_heartbeat
+        @counter_mutex.synchronize do
+          @send_properties_counter += 1
+          if (@send_properties_counter.abs % @cfg[:properties_report_period_factor]).zero?
+            @ms_client.report_instance_properties
+          else
+            @ms_client.report_heartbeat
+          end
+        end
+      end
+
+      def report_segment(enumerator)
+        @trace_client.report_segment(enumerator)
+      end
+    end
+  end
+end

data/lib/skywalking/reporter/protocol.rb

@@ -0,0 +1,28 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+module Skywalking
+  module Reporter
+    class Protocol
+      def report_heartbeat
+        raise NotImplementedError 'The report_heartbeat method has not been implemented'
+      end
+      
+      def report_segment
+        raise NotImplementedError 'The report_segment method has not been implemented'
+      end
+    end
+  end
+end

data/lib/skywalking/reporter/report.rb

@@ -0,0 +1,82 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+require_relative 'grpc'
+require_relative 'Scheduler'
+require_relative 'buffer_trigger'
+
+module Skywalking
+  module Reporter
+    class Report
+      def initialize(config)
+        @config = config
+        init_proto
+      end
+
+      def init_proto
+        return if @protocol
+
+        case @config[:report_protocol]
+        when 'grpc'
+          @protocol = Grpc.new(@config)
+        else
+          raise "Unsupported report protocol: #{@config[:report_protocol]}"
+        end
+      end
+
+      def init_reporter
+        @daemon_loop = []
+
+        @scheduler_loop = Scheduler.new
+        @daemon_loop << Thread.new do
+          init_worker_loop
+          @scheduler_loop.run
+        end
+
+        @@trigger = BufferTrigger.new(@config)
+        @daemon_loop << Thread.new do
+          report_segment
+        end
+      end
+
+      def self.trigger
+        @@trigger
+      end
+
+      def init_worker_loop
+        @scheduler_loop.subscribe(:report_heartbeat, @config[:collector_heartbeat_period]) { report_heartbeat }
+      end
+
+      def stop
+        @scheduler_loop.shutdown
+        @@trigger.close_queue
+        @daemon_loop.each do |daemon|
+          if daemon.alive?
+            daemon.wakeup
+            daemon.join
+          end
+        end
+      end
+
+      def report_heartbeat
+        @protocol.report_heartbeat
+      end
+
+      def report_segment
+        @protocol.report_segment(@@trigger.stream_data) until @@trigger.closed?
+      end
+    end
+  end
+end

data/lib/skywalking/reporter/scheduler.rb

@@ -0,0 +1,158 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+module Skywalking
+  module Reporter
+    class Scheduler
+      include Log::Logging
+
+      def initialize
+        @read_side, @write_side = IO.pipe
+        @queue = Queue.new
+        @workers = {}
+        @jobs = Hash.new { |h, k| h[k] = [] }
+        @jobs[:timer_job] << proc { |worker| add_worker(worker) }
+        @jobs[:event_job] << proc { |event, blk| @jobs[event] << blk }
+        @running = true
+      end
+
+      def run
+        while running?
+          reads = IO.select([@read_side], nil, nil, find_next_trigger)
+          if reads&.dig(0, 0) == @read_side
+            @read_side.read(1)
+          end
+          @workers.each_value do |worker|
+            if worker.need_trigger?
+              @queue << [worker.job_name]
+              worker.set_latest_trigger_time
+            end
+          end
+
+          until @queue.empty?
+            job, args = @queue.pop
+            dispatch(job, args)
+            @workers[job]&.init_next_trigger_time
+          end
+        end
+      end
+
+      def dispatch(job, args)
+        @jobs[job].each do |orig_job|
+          begin
+            orig_job.call(*args)
+          rescue Exception => e
+            warn "Error in job #{job}: #{e.message}"
+          end
+        end
+      end
+
+      def subscribe(job_name, job_interval, &job_func)
+        trigger(:event_job, [job_name, job_func])
+        trigger(:timer_job, Timer.new(job_name, job_interval))
+      end
+
+      def trigger(job_type, *args)
+        @queue.push([job_type, *args])
+        notify
+      end
+
+      def find_next_trigger
+        return nil if @workers.empty?
+
+        timeout = @workers.values.map(&:next_trigger_time).min - Process.clock_gettime(Process::CLOCK_REALTIME)
+        timeout.positive? ? timeout : 0
+      end
+
+      def notify
+        @write_side.write_nonblock('n')
+      end
+
+      def add_worker(worker)
+        orig_job = @workers[worker.job_name]
+        orig_job.adjust_next_trigger_time(Process.clock_gettime(Process::CLOCK_REALTIME) - orig_job.latest_trigger) if orig_job
+
+        @workers[worker.job_name] = worker
+        trigger_worker(worker)
+      end
+
+      def trigger_worker(worker)
+        if worker.need_trigger?
+          @queue.push([worker.job_name])
+          worker.set_latest_trigger_time
+        end
+      end
+
+      def running?
+        @running
+      end
+
+      def shutdown
+        return unless running?
+
+        @running = false
+        @write_side.write_nonblock('s')
+      end
+
+      class Timer
+        attr_reader :job_name, :job_interval, :next_trigger_time, :latest_trigger_time
+
+        def initialize(job_name, job_interval)
+          @job_name = job_name
+          @job_interval = job_interval
+          @start_time = Process.clock_gettime(Process::CLOCK_REALTIME)
+          @latest_trigger_time = nil
+
+          init_next_trigger_time
+        end
+
+        def init_next_trigger_time
+          @next_trigger_time = gen_next_trigger_time
+        end
+
+        def set_latest_trigger_time
+          @latest_trigger_time = Process.clock_gettime(Process::CLOCK_REALTIME)
+        end
+
+        def to_s
+          "<Timer job_name: #{@job_name}, job_interval: #{@job_interval}, start_time: #{@start_time}, 
+          latest_trigger_time: #{@latest_trigger_time}>"
+        end
+
+        def latest_trigger
+          @start_time || @latest_trigger_time
+        end
+
+        def adjust_next_trigger_time(time)
+          @next_trigger_time -= time
+        end
+
+        def need_trigger?(now = Process.clock_gettime(Process::CLOCK_REALTIME))
+          now >= @next_trigger_time
+        end
+
+        def gen_next_trigger_time
+          now = Process.clock_gettime(Process::CLOCK_REALTIME)
+          return now if @job_interval == 0
+
+          ret = @latest_trigger_time || now
+          ret += @job_interval while ret <= now
+
+          ret
+        end
+      end
+    end
+  end
+end

data/lib/skywalking/tracing/carrier.rb

@@ -0,0 +1,121 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+require 'base64'
+require_relative 'carrier_item'
+
+module Skywalking
+  module Tracing
+    class Carrier < CarrierItem
+      attr_reader :trace_id, :correlation_carrier, :service_instance,
+        :endpoint, :segment_id, :span_id, :peer
+
+      def initialize(
+        trace_id: '',
+        segment_id: '',
+        span_id: '',
+        service: '',
+        service_instance: '',
+        endpoint: '',
+        peer: '',
+        correlation: nil
+      )
+        super(key: 'sw8')
+
+        @trace_id = trace_id
+        @segment_id = segment_id
+        @span_id = span_id
+        @service = service
+        @service_instance = service_instance
+        @endpoint = endpoint
+        @peer = peer
+        @correlation_carrier = SW8CorrelationCarrier.new
+        @items = [@correlation_carrier, self]
+        @iter_index = 0
+        @correlation_carrier.correlation = correlation unless correlation.nil?
+      end
+
+      def val
+        [
+          '1',
+          Base64.strict_encode64(@trace_id),
+          Base64.strict_encode64(@segment_id),
+          @span_id,
+          Base64.strict_encode64(@service),
+          Base64.strict_encode64(@service_instance),
+          Base64.strict_encode64(@endpoint),
+          Base64.strict_encode64(@client_address)
+        ].join('-')
+      end
+
+      def val=(val)
+        @val = val
+        return if val.nil? || val.empty?
+
+        parts = val.split('-')
+        return if parts.size != 8
+
+        @trace_id = Base64.strict_decode64(parts[1])
+        @segment_id = Base64.strict_decode64(parts[2])
+        @span_id = parts[3]
+        @service = Base64.strict_decode64(parts[4])
+        @service_instance = Base64.strict_decode64(parts[5])
+        @endpoint = Base64.strict_decode64(parts[6])
+        @client_address = Base64.strict_decode64(parts[7])
+      end
+
+      def valid?
+        !@trace_id.empty? && !@segment_id.empty? && !@service.empty? &&
+          !@service_instance.empty? && !@endpoint.empty? &&
+          !@client_address.empty? && @span_id.match?(/^\d+$/)
+      end
+
+      def suppressed?
+        @val && !valid?
+      end
+
+      def each
+        @items.each { |item| yield item }
+      end
+    end
+
+    class SW8CorrelationCarrier < CarrierItem
+      attr_accessor :correlation
+
+      def initialize
+        super(key: 'sw8-correlation')
+        @correlation = {}
+      end
+
+      def val
+        return '' if @correlation.nil? || @correlation.empty?
+
+        @correlation.map { |k, v| "#{Base64.strict_encode64(k)}:#{Base64.strict_encode64(v)}" }.join(',')
+      end
+
+      def val=(val)
+        @val = val
+        return if val.nil? || val.empty?
+
+        val.split(',').each do |per|
+          parts = per.split(':')
+          next if parts.size != 2
+
+          @correlation[Base64.strict_decode64(parts[0])] = Base64.strict_decode64(parts[1])
+        end
+      end
+    end
+  end
+end

data/lib/skywalking/tracing/carrier_item.rb

@@ -0,0 +1,27 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+module Skywalking
+  module Tracing
+    class CarrierItem
+      attr_accessor :key, :value
+
+      def initialize(key: '', value: '')
+        @key = key
+        @value = value
+      end
+    end
+  end
+end

data/lib/skywalking/tracing/constants.rb

@@ -0,0 +1,49 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+module Skywalking
+  module Tracing
+    module Component
+      Unknown = 0
+      Redis = 7
+      General = 12000
+      Sinatra = 12001
+    end
+
+    module Layer
+      Unknown = 0
+      Database = 1
+      RPCFramework = 2
+      Http = 3
+      MQ = 4
+      Cache = 5
+      FAAS = 6
+    end
+
+    module Kind
+      Local = 0
+      Entry = 1
+      Exit = 2
+    end
+
+    def self.find_mapping(category, value)
+      category.constants.each do |const_name|
+        return const_name if category.const_get(const_name) == value
+      end
+
+      'Unknown'
+    end
+  end
+end

data/lib/skywalking/tracing/entry_span.rb

@@ -0,0 +1,48 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+require_relative 'span'
+
+module Skywalking
+  module Tracing
+    class EntrySpan < Span
+      def initialize(
+        context:,
+        span_id: -1,
+        parent_id: -1,
+        operation: nil,
+        peer: nil,
+        component: nil,
+        layer: nil
+      )
+        super(context: context, span_id: span_id, parent_id: parent_id,
+              operation: operation, peer: peer, kind: Kind::Entry,
+              component: component, layer: layer)
+
+        @current_max_depth = 0
+      end
+
+      def start
+        super
+
+        @current_max_depth = @stack_depth
+        @component = Component::Unknown
+        @layer = Layer::Unknown
+        @lags = []
+        @tags = Hash.new { |hash, key| hash[key] = [] }
+      end
+    end
+  end
+end

data/lib/skywalking/tracing/exit_span.rb

@@ -0,0 +1,53 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+require_relative 'span'
+
+module Skywalking
+  module Tracing
+    class ExitSpan < Span
+      def initialize(
+        context:,
+        span_id: -1,
+        parent_id: -1,
+        operation: nil,
+        peer: nil,
+        component: nil,
+        layer: nil
+      )
+        super(context: context, span_id: span_id, parent_id: parent_id,
+              operation: operation, peer: peer, kind: Kind::Exit,
+              component: component, layer: layer)
+      end
+
+      def cfg
+        @config ||= ::Skywalking::Agent.config
+      end
+
+      def inject
+        Carrier.new(
+          trace_id: @context.segment.related_traces[0].to_s,
+          segment_id: @context.segment.segment_id.to_s,
+          span_id: @span_id.to_s,
+          service: cfg[:service_name],
+          service_instance: cfg[:instance_name],
+          endpoint: @operation,
+          peer: @peer,
+          correlation: @context.correlation
+        )
+      end
+    end
+  end
+end

data/lib/skywalking/tracing/ignored_context.rb

@@ -0,0 +1,34 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+require_relative 'span_context'
+
+module Skywalking
+  module Tracing
+    class IgnoredContext < SpanContext
+      def initialize(context)
+        Span.new(context: context, operation: '', kind: Kind::Local)
+      end
+
+      def self.inject
+        Carrier.new
+      end
+
+      def self.extract(carrier)
+        nil
+      end
+    end
+  end
+end

data/lib/skywalking/tracing/noop_span.rb

@@ -0,0 +1,32 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF 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.
+
+require_relative 'span'
+
+module Skywalking
+  module Tracing
+    class NoopSpan < Span
+      def initialize(context: nil)
+        super(context: context, operation: '', kind: Tracing::Kind::EXIT)
+      end
+
+      def extract(carrier) end
+
+      def inject
+        Carrier.new
+      end
+    end
+  end
+end