skywalking 0.0.0.alpha

data/lib/skywalking/tracing/segment.rb

@@ -0,0 +1,57 @@
+#  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 '../utils/id_gen'
+
+module Skywalking
+  module Tracing
+    class Segment
+      attr_accessor :segment_id, :spans, :timestamp, :related_traces
+
+      def initialize
+        @segment_id = Utils::IDGen.new
+        @spans = []
+        @timestamp = (Process.clock_gettime(Process::CLOCK_REALTIME) * 1000).to_i
+        @related_traces = [Utils::IDGen.new]
+      end
+
+      def archive(span)
+        @spans << span
+      end
+
+      def relate(trace_id)
+        @related_traces.shift if @related_traces.first.is_a?(Utils::IDGen.new)
+        @related_traces << trace_id
+      end
+    end
+
+    class SegmentRef
+      attr_reader :trace_id, :ref_type, :segment_id,
+        :span_id, :service, :service_instance,
+        :endpoint, :peer
+
+      def initialize(carrier, ref_type: 'CrossProcess')
+        @ref_type = ref_type
+        @trace_id = carrier.trace_id
+        @segment_id = carrier.segment_id
+        @span_id = carrier.span_id.to_i
+        @service = carrier.service
+        @service_instance = carrier.service_instance
+        @endpoint = carrier.endpoint
+        @peer = carrier.peer
+      end
+    end
+  end
+end

data/lib/skywalking/tracing/span.rb

@@ -0,0 +1,111 @@
+#  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 'constants'
+require_relative 'carrier'
+require_relative '../reporter/client/proto'
+
+module Skywalking
+  module Tracing
+    class Span
+      attr_accessor :operation, :inherit, :component,
+        :context, :tags, :peer, :layer
+
+      attr_reader :stack_depth, :kind, :parent_id,
+        :start_time, :end_time, :span_id, :refs
+
+      def initialize(
+        context:,
+        span_id: -1,
+        parent_id: -1,
+        operation: nil,
+        peer: nil,
+        kind: nil,
+        component: nil,
+        layer: nil
+      )
+        @context = context
+        @operation = operation
+        @span_id = span_id
+        @parent_id = parent_id
+        @peer = peer
+        @layer = layer || Layer::Unknown
+        @kind = kind || nil
+        @component = component || Component::Unknown
+
+        @stack_depth = 0
+        @inherit = Component::Unknown
+        @tags = Hash.new { |hash, key| hash[key] = [] }
+        @logs = []
+        @refs = []
+        @start_time = 0
+        @end_time = 0
+        @error_occurred = false
+      end
+
+      def start
+        @stack_depth += 1
+        return if @stack_depth != 1
+
+        @start_time = (Process.clock_gettime(Process::CLOCK_REALTIME) * 1000).to_i
+        @context.start(self)
+      end
+
+      def stop?
+        @stack_depth -= 1
+        return false unless @stack_depth.zero?
+
+        @context.stop?(self)
+      end
+
+      def finish?(segment)
+        @end_time = (Process.clock_gettime(Process::CLOCK_REALTIME) * 1000).to_i
+        segment.archive(self)
+
+        true
+      end
+
+      def tag(tag)
+        if tag.insert
+          @tags[tag.key] = tag
+        else
+          @tags[tag.key] << tag
+        end
+      end
+
+      def tags_item
+        @tags.values.map { |tag| KeyStringValuePair.new(key: tag.key, value: tag.val) }
+      end
+
+      def inject
+        raise 'can only inject context carrier into ExitSpan, this may be a potential bug in the agent, ' \
+              'please report this in https://github.com/apache/skywalking/issues if you encounter this. '
+      end
+
+      def extract(carrier)
+        return self if carrier.nil?
+
+        @context.segment.relate(carrier.trace_id)
+        @context.correlation = carrier.correlation_carrier.correlation
+
+        return self unless carrier.valid?
+
+        ref = SegmentRef.new(carrier)
+        @refs << ref unless @refs.include?(ref)
+        self
+      end
+    end
+  end
+end

data/lib/skywalking/tracing/span_context.rb

@@ -0,0 +1,242 @@
+#  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'
+require_relative 'entry_span'
+require_relative 'exit_span'
+require_relative 'carrier'
+require_relative '../reporter/report'
+
+module Skywalking
+  module Tracing
+    class SpanContext
+      include Log::Logging
+
+      attr_accessor :segment, :span_id, :correlation, :n_spans, :create_time
+
+      def initialize
+        @segment = Tracing::Segment.new
+        @span_id = -1
+        @correlation = {}
+        @n_spans = 0
+        @create_time = (Process.clock_gettime(Process::CLOCK_REALTIME) * 1000).to_i
+        @primary_endpoint = nil
+      end
+
+      def cfg
+        @config ||= ::Skywalking::Agent.config
+      end
+
+      def ignore_check(operation, carrier: nil)
+        if cfg[:re_ignore_operation].match?(operation) || carrier&.suppressed?
+          return Tracing::NoopSpan
+        end
+
+        nil
+      end
+
+      def peek
+        spans = ContextManager.spans
+        return spans.last unless spans.empty?
+
+        nil
+      end
+
+      def new_span(span_klass, parent, **kwargs)
+        finished = parent && !parent.stack_depth
+        context = finished ? SpanContext.new : self
+
+        span = span_klass.new(
+          span_id: context.span_id += 1,
+          parent_id: parent && !finished ? parent.span_id : -1,
+          context: context,
+          **kwargs
+        )
+
+        if finished
+          carrier = Carrier.new(
+            trace_id: parent.context.segment.related_traces[0],
+            segment_id: parent.context.segment.segment_id,
+            span_id: parent.span_id,
+            service: cfg[:service_name],
+            service_instance: cfg[:instance_name],
+            endpoint: parent.operation,
+            peer: parent.peer,
+            correlation: parent.context.correlation
+          )
+          span.extract(carrier)
+        end
+
+        span
+      end
+
+      def new_entry_span(operation, carrier: nil, inherit: nil)
+        span = ignore_check(operation)
+        return span if span
+
+        parent = peek
+        info 'create new entry span'
+        if parent && parent.kind == Kind::Entry && inherit == parent.component
+          span = parent
+          span.operation = operation
+        else
+          span = new_span(EntrySpan, parent, operation: operation)
+          span.extract(carrier) if carrier&.valid?
+        end
+
+        span
+      end
+
+      def new_local_span(operation)
+        span = ignore_check(operation)
+        return span if span
+
+        parent = peek
+        info 'create new local span'
+        new_span(Span, parent, operation: operation, kind: Kind::Local)
+      end
+
+      def new_exit_span(operation, peer, component: nil, inherit: nil)
+        span = ignore_check(operation)
+        return span if span
+
+        parent = peek
+        info 'create new exit span'
+
+        if parent && parent.kind == Kind::Exit && inherit == parent.inherit
+          span = parent
+          span.operation = operation
+          span.peer = peer
+          span.component = component
+        else
+          span = new_span(ExitSpan, parent, operation: operation, peer: peer, component: component)
+        end
+        span.inherit = inherit if inherit
+
+        span
+      end
+
+      def start(span)
+        @n_spans += 1
+        spans = ContextManager.spans_dup
+        unless spans.include?(span)
+          spans << span
+          if @primary_endpoint.nil?
+            @primary_endpoint = PrimaryEndpoint.new(span)
+          else
+            @primary_endpoint.set_primary_endpoint(span)
+          end
+        end
+      end
+
+      def stop?(span)
+        spans = ContextManager.spans_dup
+        span.finish?(@segment)
+        spans.delete(span)
+        @n_spans -= 1
+        if @n_spans.zero?
+          Reporter::Report.trigger << @segment
+          return true
+        end
+
+        false
+      end
+
+      def active_span
+        peek
+      end
+
+      class PrimaryEndpoint
+        def initialize(span)
+          @span = span
+        end
+
+        def set_primary_endpoint(span)
+          if @span.kind != Kind::Entry && span.kind == Kind::Entry
+            @span = span
+          end
+        end
+
+        def get_name
+          @span.operation
+        end
+      end
+    end
+
+    class ContextManager
+      class << self
+        def spans
+          Thread.current[:spans] ||= []
+        end
+
+        def spans_dup
+          spans_dup = spans.dup
+          Thread.current[:spans] = spans_dup
+
+          spans_dup
+        end
+
+        def reset_spans
+          Thread.current[:spans] = []
+        end
+
+        def current_context
+          spans_ret = spans
+          if spans_ret.any?
+            spans.last.context
+          else
+            SpanContext.new
+          end
+        end
+
+        def new_exit_span(operation:, peer: nil, component: nil, &block)
+          context = current_context
+          span = context.new_exit_span(operation, peer, component: component)
+          span&.start
+
+          begin
+            yield span if block_given?
+          ensure
+            span&.stop?
+          end
+        end
+
+        def new_entry_span(operation:, carrier: nil, inherit: nil, &block)
+          context = current_context
+          span = context.new_entry_span(operation, carrier: carrier, inherit: inherit)
+          span&.start
+
+          begin
+            yield span if block_given?
+          ensure
+            span&.stop?
+          end
+        end
+
+        def new_local_span(operation:, &block)
+          context = current_context
+          span = context.new_local_span(operation)
+          span&.start
+
+          begin
+            yield span if block_given?
+          ensure
+            span&.stop?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skywalking/tracing/tag.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
+    class Tag
+      attr_accessor :val
+      attr_reader :key, :insert
+
+      def initialize(val)
+        @val = val.to_s
+        @insert = true
+      end
+    end
+
+    class TagHttpMethod < Tag
+      def initialize(val)
+        super
+        @key = 'http.method'
+      end
+    end
+    
+    class TagHttpURL < Tag
+      def initialize(val)
+        super
+        @key = 'http.url'
+      end
+    end
+
+    class TagDbType < Tag
+      def initialize(val)
+        super
+        @key = 'db.type'
+      end
+    end
+  end
+end

data/lib/skywalking/utils/id_gen.rb

@@ -0,0 +1,30 @@
+#  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 'securerandom'
+
+module Skywalking
+  module Utils
+    class IDGen
+      def initialize(raw_id: nil)
+        @value = raw_id || SecureRandom.uuid.delete('-')
+      end
+
+      def to_s
+        @value
+      end
+    end
+  end
+end

data/lib/skywalking/version.rb

@@ -0,0 +1,18 @@
+#  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
+  VERSION = "0.0.0.alpha".freeze
+end

data/lib/skywalking.rb

@@ -0,0 +1,36 @@
+#  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 'skywalking/log/logger'
+require_relative 'skywalking/agent'
+
+module Skywalking
+  class << self
+    def start(config = nil)
+      if started?
+        return
+      end
+      Agent.start(config)
+    end
+
+    def started?
+      Agent.started?
+    end
+
+    def stop
+      Agent.stop
+    end
+  end
+end