skywalking 0.0.0.alpha → 0.0.0.beta1

data/lib/skywalking/tracing/tag.rb

@@ -31,7 +31,7 @@ module Skywalking
         @key = 'http.method'
       end
     end
-    
+
     class TagHttpURL < Tag
       def initialize(val)
         super
@@ -39,11 +39,46 @@ module Skywalking
       end
     end
 
+    class TagHttpStatusCode < Tag
+      def initialize(val)
+        super
+        @key = 'http.status_code'
+      end
+    end
+
     class TagDbType < Tag
       def initialize(val)
         super
         @key = 'db.type'
       end
     end
+
+    class TagCacheType < Tag
+      def initialize(val)
+        super
+        @key = 'cache.type'
+      end
+    end
+
+    class TagCacheOp < Tag
+      def initialize(val)
+        super
+        @key = 'cache.op'
+      end
+    end
+
+    class TagCacheCmd < Tag
+      def initialize(val)
+        super
+        @key = 'cache.cmd'
+      end
+    end
+
+    class TagCacheKey < Tag
+      def initialize(val)
+        super
+        @key = 'cache.key'
+      end
+    end
   end
 end

data/lib/skywalking/version.rb

@@ -14,5 +14,5 @@
 #  limitations under the License.
 
 module Skywalking
-  VERSION = "0.0.0.alpha".freeze
+  VERSION = "0.0.0.beta1".freeze
 end

data/skywalking.gemspec

@@ -0,0 +1,61 @@
+#  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 File.expand_path('lib/skywalking/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name = 'skywalking'
+  spec.version = Skywalking::VERSION
+  spec.authors = ['Apache SkyWalking Team']
+  spec.email = ['dev@skywalking.apache.org']
+
+  spec.summary = 'Skywalking Ruby Agent'
+  spec.description = 'The Ruby Agent for Apache SkyWalking'
+  spec.homepage = 'https://skywalking.apache.org/'
+  spec.license = 'Apache-2.0'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/apache/skywalking-ruby'
+  spec.metadata["changelog_uri"] = 'https://github.com/apache/skywalking-ruby/blob/main/CHANGELOG.md'
+
+  files =
+    begin
+      `git ls-files`.split("\n")
+    rescue StandardError
+      Dir.glob("**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+    end
+  spec.files = files
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Communication with OAP
+  spec.add_dependency 'grpc', '1.68.1'
+
+  # Base dev dependency
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '13.2.1'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rubocop', '1.69.2'
+  spec.add_development_dependency 'rubocop-performance', '1.23.0'
+  spec.add_development_dependency 'bigdecimal', '3.1.5'
+
+  # E2E test dependency
+  spec.add_development_dependency 'redis', '~> 5.0'
+  spec.add_development_dependency 'sinatra', '~> 4.1'
+  spec.add_development_dependency 'testcontainers-compose', '~> 0.2.0'
+  spec.add_development_dependency 'faraday', '~> 2.12'
+  spec.add_development_dependency 'rspec-wait', '~> 1.0'
+end

data/spec/fixtures/agent.yaml

@@ -0,0 +1,33 @@
+# 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.
+
+common: &defaults
+  service_name: Ruby-Agent-Common
+  log_level: debug
+
+development:
+  <<: *defaults
+  service_name: Ruby-Agent-Development
+
+test:
+  <<: *defaults
+  service_name: Ruby-Agent-Test
+
+production:
+  <<: *defaults
+  service_name: Ruby-Agent-Production
+  

data/spec/scenarios/common/Dockerfile.agent

@@ -0,0 +1,26 @@
+# 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.
+
+ARG SW_RUBY_VERSION
+
+FROM ruby:${SW_RUBY_VERSION}
+
+ARG ROOT=.
+
+WORKDIR /app
+
+ADD $ROOT /app
+
+RUN bundle

data/spec/scenarios/common/base-compose.yml

@@ -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.
+#
+
+version: '2.1'
+
+services:
+  oap:
+    image: ghcr.io/apache/skywalking-agent-test-tool/mock-collector:b6efe6af0a5499502b8cf8b76c7351e3f172a616
+    ports:
+      - "12800:12800"
+      - "19876:19876"
+    networks:
+      - gem
+    healthcheck:
+      test: [ "CMD", "bash", "-c", "cat < /dev/null > /dev/tcp/127.0.0.1/12800" ]
+      interval: 5s
+      timeout: 60s
+      retries: 120
+
+  agent:
+    build:
+      context: ../../../
+      dockerfile: spec/scenarios/common/Dockerfile.agent
+      args:
+        - SW_RUBY_VERSION=${SW_RUBY_VERSION:-3.0}
+    environment:
+      SW_AGENT_COLLECTOR_BACKEND_SERVICES: oap:19876
+    networks:
+      - gem
+
+networks:
+  gem:

data/spec/scenarios/common/common_spec_helper.rb

@@ -0,0 +1,40 @@
+#  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 'testcontainers/compose'
+require 'faraday'
+require_relative 'validator'
+
+module CommonSpecHelper
+  include Validator
+
+  def test_plugin(plugin_name)
+    p "Now testing #{plugin_name} plugin"
+    expected_data = File.read(File.join(root_dir, 'expected.yml'))
+
+    with_retries do
+      resp = Faraday.post(data_validate_url) do |req|
+        req.body = expected_data
+        req.headers['Content-Type'] = 'application/x-yaml'
+      end
+      unless resp.status == 200
+        actual_data = Faraday.get(receive_data_url).body
+        raise "Data validation failed, actual Data: #{actual_data} and cause by: #{resp.body}"
+      end
+    end
+  end
+end
+
+

data/spec/scenarios/common/compose_context.rb

@@ -0,0 +1,39 @@
+#  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.
+
+RSpec.shared_context 'scenario value' do
+  let(:data_validate_url) { 'http://localhost:12800/dataValidate' }
+  let(:receive_data_url) { 'http://localhost:12800/receiveData' }
+end
+
+RSpec.shared_context 'compose' do
+  let(:client_url) { 'http://localhost:8080/execute' }
+
+  let(:compose) do
+    Testcontainers::ComposeContainer.new(
+      filepath: root_dir,
+      compose_filenames: ["docker-compose.yml"]
+    )
+  end
+
+  before(:each) do
+    compose.start
+    compose.wait_for_http(url: client_url, timeout: 600)
+  end
+
+  after(:each) do
+    compose.stop
+  end
+end

data/spec/scenarios/common/validator.rb

@@ -0,0 +1,41 @@
+#  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 Validator
+  def with_retries(retries: 3, backoff_max: 16, backoff_base: 1)
+    return if retries < 0
+
+    backoff ||= 0
+
+    yield if block_given?
+  rescue SystemExit, Interrupt
+    raise
+  rescue Exception => e
+    p e
+    if retries.zero?
+      p "Retries exhausted"
+      raise e
+    else
+      retries -= 1
+      backoff = [backoff == 0 ? 1 : backoff * 2, backoff_max].min
+      backoff *= 0.5 * (1 + Kernel.rand)
+      backoff = [backoff_base, backoff].max
+      p "Retrying in #{backoff} seconds"
+
+      sleep backoff
+      retry
+    end
+  end
+end

data/spec/scenarios/net_http/docker-compose.yml

@@ -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.
+#
+
+version: "2.1"
+
+services:
+  oap:
+    extends:
+      file: ../common/base-compose.yml
+      service: oap
+    networks:
+      - gem
+  
+  service:
+    extends:
+      file: ../common/base-compose.yml
+      service: agent
+    ports:
+      - "8080:8080"
+    volumes:
+      - .:/app/spec/scenarios/net_http
+    environment:
+      SW_AGENT_SERVICE_NAME: "NetHttp"
+    entrypoint:
+      - "sh"
+      - "-c"
+      - "ruby /app/spec/scenarios/net_http/net_http.rb"
+    depends_on:
+      oap:
+        condition: service_healthy
+    networks:
+      - gem
+
+networks:
+  gem:

data/spec/scenarios/net_http/expected.yml

@@ -0,0 +1,39 @@
+# 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.
+
+segmentItems:
+  - serviceName: NetHttp
+    segmentSize: ge 1
+    segments:
+      - segmentId: not null
+        spans:
+          - operationName: "GET:/json?a=1"
+            parentSpanId: -1
+            spanId: 0
+            spanLayer: Http
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 2
+            isError: false
+            spanType: Exit
+            peer: httpbin.org
+            skipAnalysis: false
+            tags:
+              - { key: http.method, value: GET }
+              - { key: http.url, value: "http://httpbin.org/json?a=1" }
+              - { key: http.status_code, value: "200" }
+meterItems: [ ]
+logItems: [ ]

data/spec/scenarios/net_http/net_http.rb

@@ -0,0 +1,33 @@
+#  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 '../../../lib/skywalking'
+require 'net/http'
+require 'uri'
+require 'json'
+
+Skywalking.start
+
+url = URI.parse('http://httpbin.org/json?a=1')
+
+response = Net::HTTP.get_response(url)
+
+if response.is_a?(Net::HTTPSuccess)
+  puts JSON.pretty_generate(JSON.parse(response.body))
+else
+  puts "Error..."
+end
+
+sleep 10

data/spec/scenarios/net_http/net_http_spec.rb

@@ -0,0 +1,43 @@
+#  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 '../common/common_spec_helper'
+require_relative '../common/compose_context'
+
+RSpec.describe 'NetHttp' do
+  include CommonSpecHelper
+  include_context 'scenario value'
+
+  let(:root_dir) { File.expand_path(__dir__) }
+
+  let(:compose) do
+    Testcontainers::ComposeContainer.new(
+      filepath: root_dir,
+      compose_filenames: ["docker-compose.yml"]
+    )
+  end
+
+  before(:each) do
+    compose.start
+  end
+
+  after(:each) do
+    compose.stop
+  end
+
+  it 'test the net_http plugin' do
+    test_plugin('net_http')
+  end
+end

data/spec/scenarios/redis/docker-compose.yml

@@ -0,0 +1,67 @@
+#
+# 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.
+#
+
+version: "2.1"
+
+services:
+  oap:
+    extends:
+      file: ../common/base-compose.yml
+      service: oap
+    networks:
+      - gem
+  
+  redis:
+    image: redis:7-alpine
+    hostname: redis
+    ports:
+      - "6379:6379"
+    healthcheck:
+      test: [ "CMD", "bash", "-c", "cat < /dev/null > /dev/tcp/127.0.0.1/6379" ]
+      interval: 5s
+      timeout: 60s
+      retries: 120
+    networks:
+      - gem
+  
+  service:
+    extends:
+      file: ../common/base-compose.yml
+      service: agent
+    ports:
+      - "8080:8080"
+    volumes:
+      - .:/app/spec/scenarios/redis
+    environment:
+      SW_AGENT_SERVICE_NAME: "redis"
+    healthcheck:
+      test: [ "CMD", "bash", "-c", "cat < /dev/null > /dev/tcp/127.0.0.1/8080" ]
+      interval: 5s
+      timeout: 60s
+      retries: 120
+    entrypoint:
+      - "sh"
+      - "-c"
+      - "gem install sinatra rackup puma redis && ruby /app/spec/scenarios/redis/redis.rb"
+    depends_on:
+      oap:
+        condition: service_healthy
+    networks:
+      - gem
+
+networks:
+  gem:

data/spec/scenarios/redis/expected.yml

@@ -0,0 +1,66 @@
+# 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.
+
+segmentItems:
+  - serviceName: redis
+    segmentSize: ge 1
+    segments:
+      - segmentId: not null
+        spans:
+          - operationName: Redis/SET
+            parentSpanId: 0
+            spanId: 1
+            spanLayer: Cache
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 7
+            isError: false
+            spanType: Exit
+            peer: redis:6379
+            skipAnalysis: false
+            tags:
+              - { key: cache.type, value: Redis }
+              - { key: cache.op, value: set }
+          - operationName: Redis/GET
+            parentSpanId: 0
+            spanId: 2
+            spanLayer: Cache
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 7
+            isError: false
+            spanType: Exit
+            peer: redis:6379
+            skipAnalysis: false
+            tags:
+              - { key: cache.type, value: Redis }
+              - { key: cache.op, value: get }
+          - operationName: GET:/execute
+            parentSpanId: -1
+            spanId: 0
+            spanLayer: Http
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 12001
+            isError: false
+            spanType: Entry
+            peer: localhost:8080
+            skipAnalysis: false
+            tags:
+              - { key: http.method, value: GET }
+              - { key: http.url, value: /execute }
+meterItems: [ ]
+logItems: [ ]

data/{examples/sinatra-demo/sinatra-demo.rb → spec/scenarios/redis/redis.rb}

@@ -15,18 +15,16 @@
 
 require 'sinatra'
 require 'redis'
+require_relative '../../../lib/skywalking'
 
-require_relative '../../lib/skywalking'
 Skywalking.start
 
-get '/sw' do
-  "Hello, SkyWalking!"
-end
-
-get '/hello/:name' do
-  redis = Redis.new(host: 'localhost', port: 6379)
+get '/execute' do
+  redis = Redis.new(host: 'redis', port: 6379)
   redis.set('hello', 'world')
   value = redis.get("hello")
-  puts "Value of 'hello': #{value}"
-  "Hello #{params[:name]}!"
-end
+  "Hello #{value}!"
+end
+
+set :bind, '0.0.0.0'
+set :port, 8080