skywalking 0.0.0.beta1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 440bef4a38e67a74f5da465bfe3e7f0482631f7371d89f8d2848c7519f37c1de
-  data.tar.gz: b536aadb8f8eb25357bf20c2bf16d40c868c2068fbdc5b0559794e3a4e9c9839
+  metadata.gz: 61f4463e396a77b2dbf283cf793f868755b8e350e69bd92246bb1d0ca284655c
+  data.tar.gz: 66371e9c08dcdaf408f43830b2ccfd71673516dc90b4ad620e92c1e5a32b8b0d
 SHA512:
-  metadata.gz: 59b5fefb96f307c1e70d8d975c8c962b69c0410051a2f2951a69f221b17ea896ffde723d224a5a6cbb11eed0b6c51bf74064c7a6e05db72d36e663309b1560fd
-  data.tar.gz: 021b8f374d2f6a22b833b8dddae9ea1cc497859885098d8f04274546409d461d2904d32c22af6cf8347e09ffc51b9d0580739be8fda604e8415feff59b49631a
+  metadata.gz: 438ded62f2650740a7b7806b0b38fc3bcc93ca252162ea3b5e579ef06e4c6b1f05c6116bfb715c93609942a1f05e3581294a27c94bce2fdece3847033b339a03
+  data.tar.gz: eb3ad2986b8f2b31d225ade8a4602220b3b5cf25f6818a0031cf9ba04d0fb2b519d56b4215071d0e94f41d622c4f9130643163a675c451685357d8b64558537a

data/.gitignore

@@ -77,4 +77,5 @@ build-iPhoneSimulator/
 Gemfile.lock
 gemfiles/*.lock
 .DS_Store!
-spec/workspace
+spec/workspace
+*.tgz*

data/CHANGELOG.md

@@ -7,12 +7,13 @@ Release Notes.
 #### Features
 - Initialize the ruby agent core.
 - Implement e2e tests.
-- Add docs.
 
 #### Plugins
 * Support [Sinatra](https://github.com/sinatra/sinatra)
 * Support [redis-rb](https://github.com/redis/redis-rb)
 * Support [net-http](https://github.com/ruby/net-http)
+* Support [memcached](https://github.com/petergoldstein/dalli)
+* Support [elasticsearch](https://github.com/elastic/elasticsearch-ruby)
 
 #### Documentation
 * Initialize the documentation.

data/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to Apache SkyWalking Ruby
+
+Firstly, thanks for your interest in contributing! We hope that this will be a pleasant experience for you,
+so that you will return to continue contributing.
+
+## Code of Conduct
+
+The project and everyone participating in it is governed by the Apache software Foundation's [Code of Conduct](http://www.apache.org/foundation/policies/conduct.html).
+By participating, you are expected to adhere to this code. If you are aware of unacceptable behavior, please visit the [Reporting Guidelines page](http://www.apache.org/foundation/policies/conduct.html#reporting-guidelines)
+and follow the instructions there.
+
+## Contribute
+
+Most of the contributions that we receive are code contributions, but you can also contribute to the documentation or simply report solid bugs for us to fix.
+
+## Report a bug
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/apache/skywalking/issues).
+
+* If you're unable to find an issue addressing the problem, [open a new one](https://github.com/apache/skywalking/issues/new).
+Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not happening.
+
+## Compiling and building
+
+We recommend using a Ruby base image of at least 3.0 to build skywalking-ruby project
+
+```shell
+docker run -it --rm -v $(pwd)/skywalking-ruby:/workspace -w /workspace ruby:3.0 bash
+```
+
+Then run the following commands to build the project:
+
+```shell
+gem build skywalking.gemspec
+```
+
+## Add a new feature or enhance an existing one
+
+_Before making any significant changes, please [open an issue](https://github.com/apache/skywalking/issues)._
+Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
+
+Once we've discussed your changes and you've got your code ready, make sure that tests are passing and open your pull request. Your PR is most likely to be accepted if it:
+
+* Update the README.md with details of changes to the interface.
+* Includes tests for new functionality.
+* References the original issue in description, e.g. "Resolves #123", "Closes #123", or "Fixes #123", etc.
+* Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Questions about the source code
+
+* Join `#skywalking` channel at [Apache Slack](https://s.apache.org/slack-invite)

data/Makefile

@@ -0,0 +1,38 @@
+# 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.
+
+.PHONY: license
+license: license
+	docker run -it --rm -v $(shell pwd):/github/workspace ghcr.io/apache/skywalking-eyes/license-eye:20da317d1ad158e79e24355fdc28f53370e94c8a header check
+
+.PHONY: clean
+clean:
+	rm -rf skywalking-ruby*.tgz*
+	rm -rf skywalking*.gem
+
+.PHONY: release
+release: clean
+	tar -zcvf "skywalking-ruby-src-${VERSION}.tgz" \
+          --exclude .git \
+          --exclude .idea \
+          --exclude .cache \
+          --exclude .DS_Store \
+          --exclude .github \
+          --exclude .gitignore \
+          --exclude .gitmodules \
+          --exclude "skywalking-ruby-*.tgz*" *
+	gpg --batch --yes --armor --detach-sig skywalking-ruby-src-${VERSION}.tgz
+	shasum -a 512 skywalking-ruby-src-${VERSION}.tgz > skywalking-ruby-src-${VERSION}.tgz.sha512

data/README.md

@@ -8,6 +8,12 @@ Apache SkyWalking Ruby Agent
 **SkyWalking**: an APM(application performance monitor) system, especially designed for
 microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures.
 
+## Documentation
+- [Official documentation](https://skywalking.apache.org/docs/#RubyAgent)
+
+## Contributing
+Before submitting a pull request or pushing a commit, please read our [contributing](CONTRIBUTING.md).
+
 ## Contact Us
 * Submit [an issue](https://github.com/apache/skywalking/issues/new) by using [Ruby] as title prefix.
 * Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.

data/docs/en/agent/plugins.md

@@ -3,8 +3,10 @@
 The following plugins provide the distributed tracing capability, and the OAP backend would analyze the topology and
 metrics based on the tracing data.
 
-| Library                                       | Version  | Plugin Name |
-|:----------------------------------------------|:---------|:------------|
-| [redis](https://github.com/redis/redis-rb)    | ~> 5.0   | `redis`     |
-| [net-http](https://github.com/ruby/net-http)  | ~> 0.6.0 | `net_http`  |
-| [sinatra](https://github.com/sinatra/sinatra) | ~> 4.1   | `sinatra`   |
+| Library                                                        | Version  | Plugin Name     |
+|:---------------------------------------------------------------|:---------|:----------------|
+| [redis](https://github.com/redis/redis-rb)                     | ~> 5.0   | `redis5`        |
+| [net-http](https://github.com/ruby/net-http)                   | ~> 0.6.0 | `net_http`      |
+| [sinatra](https://github.com/sinatra/sinatra)                  | ~> 4.1   | `sinatra`       |
+| [memcached](https://github.com/petergoldstein/dalli)           | ~> 3.2   | `memcached`     |
+| [elasticsearch](https://github.com/elastic/elasticsearch-ruby) | ~> 8.0.0 | `elasticsearch` |

data/docs/en/development-and-contribution/how-to-release.md

@@ -25,7 +25,7 @@ export VERSION=<the version to release>
 git clone --recurse-submodules git@github.com:apache/skywalking-ruby && cd skywalking-ruby
 git tag -a "v$VERSION" -m "Release Apache SkyWalking-Ruby $VERSION"
 git push --tags
-
+make release
 ```
 
 ## Upload to Apache svn
@@ -37,11 +37,17 @@ cp skywalking-ruby/skywalking*.tgz release/skywalking/ruby/"$VERSION"
 cp skywalking-ruby/skywalking*.tgz.asc release/skywalking/ruby/"$VERSION"
 cp skywalking-ruby/skywalking*.tgz.sha512 release/skywalking/ruby/"$VERSION"
 
-cd release/skywalking && svn add ruby/$VERSION && svn commit ruby -m "Draft Apache SkyWalking-Ruby release $VERSION"
+cd release/skywalking/ruby && svn add $VERSION && svn commit -m "Draft Apache SkyWalking-Ruby release $VERSION"
 ```
 
 ## Call for vote in dev@ mailing list
 
+First, generate a sha512sum for the source code package generated in last step:
+
+```shell
+sha512sum release/skywalking/ruby/"$VERSION"/skywalking-ruby-src-"$VERSION".tgz
+```
+
 Call for vote in `dev@skywalking.apache.org`.
 
 ```text
@@ -52,6 +58,9 @@ Content:
 Hi the SkyWalking Community:
 This is a call for vote to release Apache SkyWalking Ruby version $VERSION.
 
+We welcome any comments you may have, and will take all feedback into
+account if a quality vote is called for this build.
+
 Release notes:
 
  * https://github.com/apache/skywalking-ruby/blob/v$VERSION/CHANGELOG.md
@@ -76,17 +85,10 @@ Keys to verify the Release Candidate :
 
 Guide to build the release from source :
 
- * https://github.com/apache/skywalking-ruby/blob/master/CONTRIBUTING.md#compiling-and-building
-
-Voting will start now and will remain open for at least 72 hours, all PMC members are required to give their votes.
-
-[ ] +1 Release this package.
-[ ] +0 No opinion.
-[ ] -1 Do not release this package because....
-
-Thanks.
+ * https://github.com/apache/skywalking-ruby/blob/main/CONTRIBUTING.md#compiling-and-building
 
-[1] https://github.com/apache/skywalking-ruby/blob/master/docs/How-to-release.md#vote-check
+A vote regarding the quality of this test build will be initiated
+within the next couple of days.
 ```
 
 ## Vote Check

data/docs/en/setup/quick-start.md

@@ -19,6 +19,29 @@ gem "skywalking"
 
 Besides, you can also make installation as simple as `gem install skywalking`.
 
+## Installing from Source Code
+
+**Download the source tar from the [official website](http://skywalking.apache.org/downloads/), and run the following commands to build from source**
+
+**Make sure you have Ruby 3.0+ and the `gem` command available**
+
+~~~shell
+tar -zxf skywalking-ruby-src-<version>.tgz
+cd skywalking-ruby-src-<version>
+gem build skywalking.gemspec
+~~~
+
+If successful, the following will be displayed:
+
+```ruby
+  Successfully built RubyGem
+  Name: skywalking
+  Version: <version>
+  File: skywalking-<version>.gem
+```
+
+Then you can use `skywalking-<version>.gem` to your gemfile.
+
 ## Getting started with Rails
 
 You need to manually add `Skywalking.start` under config/initializers directory.
@@ -97,7 +120,7 @@ The following lists all the configuration options:
 | log_file_name                   | SW_AGENT_LOG_FILE_NAME                   | skywalking           | The name of the log file.                                                                                                                 |
 | log_file_path                   | SW_AGENT_LOG_FILE_PATH                   | Not set              | The path to the log file.                                                                                                                 |
 | log_level                       | SW_AGENT_LOG_LEVEL                       | info                 | The log level.                                                                                                                            |
-| disable_plugins                 | SW_AGENT_DISABLE_PLUGINS                 | Not set              | The plugins to disable.                                                                                                                   |
+| disable_plugins                 | SW_AGENT_DISABLE_PLUGINS                 | Not set              | The plugins to disable, multiple names should be split by comma, e.g. 'redis5,elasticsearch'.                                             |
 | report_protocol                 | SW_AGENT_REPORT_PROTOCOL                 | grpc                 | The protocol to use for reporting.                                                                                                        |
 | re_ignore_operation             | SW_AGENT_RE_IGNORE_OPERATION             | Not set              | Ignore specific URL paths.                                                                                                                |
 | instance_properties_json        | SW_AGENT_INSTANCE_PROPERTIES_JSON        | Not set              | A custom JSON string to be reported as service instance properties, e.g. `{"key": "value"}`.                                              |

data/lib/skywalking/configuration.rb

@@ -67,7 +67,7 @@ module Skywalking
       :disable_plugins => {
         type: :string,
         default: '',
-        desc: 'The plugins to disable'
+        desc: "The plugins to disable, multiple names should be split by comma, e.g. 'redis5,elasticsearch'"
       },
       :report_protocol => {
         type: :string,

data/lib/skywalking/plugins/elasticsearch.rb

@@ -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.
+
+module Skywalking
+  module Plugins
+    class Elasticsearch < PluginsManager::SWPlugin
+      def plugin_valid?
+        defined?(::Elasticsearch)
+      end
+
+      def install
+        inst_target = if defined?(::Elastic::Transport::Client)
+                        ::Elastic::Transport::Client
+                      elsif defined?(::Elasticsearch::Transport::Client)
+                        ::Elasticsearch::Transport::Client
+                      end
+
+        inst_target.class_eval do
+          def perform_request_with_skywalking(method, path, *args, &block)
+            peer_info = transport.hosts.first
+            db_statement = [{ params: args&.[](0) }]
+            unless args[1].nil? || args[1].empty?
+              db_statement << { body: args[1] }
+            end
+
+            Tracing::ContextManager.new_exit_span(
+              operation: "Elasticsearch/#{method}/#{path}",
+              peer: "#{peer_info[:protocol]}://#{peer_info[:host]}:#{peer_info[:port]}",
+              component: Tracing::Component::Elasticsearch
+            ) do |span|
+              span&.tag(Tracing::TagDbType.new("Elasticsearch"))
+              span&.tag(Tracing::TagDbStatement.new(db_statement))
+              span&.layer = Tracing::Layer::Database
+
+              zuper_perform_request(method, path, *args, &block)
+            rescue
+              span&.error_occurred = true
+            end
+          end
+
+          alias_method :zuper_perform_request, :perform_request
+          alias_method :perform_request, :perform_request_with_skywalking
+        end
+      end
+
+      register :elasticsearch
+    end
+  end
+end

data/lib/skywalking/plugins/memcached.rb

@@ -0,0 +1,74 @@
+#  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 Plugins
+    module MemcachedIntercept
+      def self.included(klass)
+        supported_method =
+          [:add, :append, :delete, :cas, :incr, :increment, :prepend, :replace, :set, :get, :fetch]
+          .select do |method_name|
+            klass.method_defined?(method_name) || klass.private_method_defined?(method_name)
+          end
+
+        supported_method.each do |method_name|
+          zuper_method = :"zuper_#{method_name}"
+          method_with_skywalking = :"#{method_name}_with_skywalking"
+
+          klass.class_eval do
+            define_method(method_with_skywalking) do |*args, &block|
+              cache_key = args[0].to_s if args.length && !args[0].is_a?(Array)
+              Tracing::ContextManager.new_exit_span(
+                operation: "Memcached/#{method_name}",
+                peer: @normalized_servers.join(','),
+                component: Tracing::Component::Memcached
+              ) do |span|
+                span&.layer = Tracing::Layer::Cache
+                span&.tag(Tracing::TagCacheType.new("Memcached"))
+                span&.tag(Tracing::TagCacheKey.new(cache_key))
+
+                resp = __send__(zuper_method, *args, &block)
+                if method_name == :get && args.length && args[0].instance_of?(String)
+                  span&.tag(Tracing::TagCacheMiss.new(resp.nil?))
+                end
+
+                resp
+              rescue
+                span&.error_occurred = true
+              end
+            end
+
+            alias_method zuper_method, method_name
+            alias_method method_name, method_with_skywalking
+          end
+        end
+      end
+    end
+
+    class Memcached < PluginsManager::SWPlugin
+      def plugin_valid?
+        defined?(::Dalli::Client)
+      end
+
+      def install
+        ::Dalli::Client.class_eval do
+          include Skywalking::Plugins::MemcachedIntercept
+        end
+      end
+
+      register :memcached
+    end
+  end
+end

data/lib/skywalking/plugins/net_http.rb

@@ -35,7 +35,7 @@ module Skywalking
           Tracing::ContextManager.new_exit_span(
             operation: "#{method}:#{req_info}",
             peer: host,
-            component: Tracing::Component::Http
+            component: Tracing::Component::HttpClient
           ) do |span|
             span&.tag(Tracing::TagHttpMethod.new(method))
             span&.tag(Tracing::TagHttpURL.new(uri))

data/lib/skywalking/plugins/redis5.rb

@@ -30,7 +30,11 @@ module Skywalking
             span&.tag(Tracing::TagCacheOp.new(operation))
             span&.layer = Tracing::Layer::Cache
 
-            super(args, &block)
+            begin
+              super(args, &block)
+            rescue
+              span&.error_occurred = true
+            end
           end
         end
 

data/lib/skywalking/plugins/sinatra.rb

@@ -21,13 +21,12 @@ module Skywalking
           req_method = @request.request_method if @request.respond_to?(:request_method)
           carrier = Tracing::Carrier.new
           carrier.each do |item|
-            item.val = request.env[item.key.capitalize] if request.env[item.key.capitalize]
+            item.value = request.env["HTTP_#{item.key.upcase}"]
           end
 
           Tracing::ContextManager.new_entry_span(
             operation: "#{req_method}:#{request.env['REQUEST_URI']}",
-            carrier: carrier,
-            inherit: Tracing::Component::General
+            carrier: carrier
           ) do |span|
             span&.tag(Tracing::TagHttpMethod.new(req_method))
             span&.tag(Tracing::TagHttpURL.new(request.env['REQUEST_URI']))
@@ -36,6 +35,8 @@ module Skywalking
             span&.component = Tracing::Component::Sinatra
 
             super(*args, &block)
+          rescue
+            span&.error_occurred = true
           end
         end
       end

data/lib/skywalking/plugins_manager.rb

@@ -34,7 +34,7 @@ module Skywalking
         Dir[File.join(__dir__, 'plugins', '*.rb')].each { |file| require file }
 
         installed_plugins = self.class.installed.keys
-        @enabled_plugins ||= installed_plugins - @config[:disable_plugins].split(',')
+        @enabled_plugins ||= installed_plugins - @config[:disable_plugins].split(',').map(&:to_sym)
         @enabled_plugins.each do |plugin_name|
           self.class.installed[plugin_name].try_install(plugin_name)
         end

data/lib/skywalking/tracing/carrier.rb

@@ -21,7 +21,7 @@ module Skywalking
     class Carrier < CarrierItem
       attr_reader :trace_id, :correlation_carrier, :service_instance,
         :endpoint, :segment_id, :span_id,
-        :peer, :items, :iter_index
+        :peer, :items, :iter_index, :service
 
       def initialize(
         trace_id: '',

data/lib/skywalking/tracing/constants.rb

@@ -17,8 +17,10 @@ module Skywalking
   module Tracing
     module Component
       Unknown = 0
-      Http = 2
+      HttpClient = 2
       Redis = 7
+      Memcached = 20
+      Elasticsearch = 47
       General = 12000
       Sinatra = 12001
     end

data/lib/skywalking/tracing/segment.rb

@@ -32,7 +32,7 @@ module Skywalking
       end
 
       def relate(trace_id)
-        @related_traces.shift if @related_traces.first.is_a?(Utils::IDGen.new)
+        @related_traces.pop if @related_traces[0].is_a?(Utils::IDGen)
         @related_traces << trace_id
       end
     end

data/lib/skywalking/tracing/span.rb

@@ -104,6 +104,7 @@ module Skywalking
 
         ref = SegmentRef.new(carrier)
         @refs << ref unless @refs.include?(ref)
+
         self
       end
     end

data/lib/skywalking/tracing/span_context.rb

@@ -201,9 +201,9 @@ module Skywalking
           end
         end
 
-        def new_exit_span(operation:, peer: nil, component: nil, &block)
+        def new_exit_span(operation:, peer: nil, component: nil, inherit: nil, &block)
           context = current_context
-          span = context.new_exit_span(operation, peer, component: component)
+          span = context.new_exit_span(operation, peer, component: component, inherit: inherit)
           span&.start
 
           begin

data/lib/skywalking/tracing/tag.rb

@@ -53,6 +53,13 @@ module Skywalking
       end
     end
 
+    class TagDbStatement < Tag
+      def initialize(val)
+        super
+        @key = 'db.statement'
+      end
+    end
+
     class TagCacheType < Tag
       def initialize(val)
         super
@@ -80,5 +87,12 @@ module Skywalking
         @key = 'cache.key'
       end
     end
+
+    class TagCacheMiss < Tag
+      def initialize(val)
+        super
+        @key = 'cache.miss'
+      end
+    end
   end
 end

data/lib/skywalking/version.rb

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

data/skywalking.gemspec

@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Communication with OAP
-  spec.add_dependency 'grpc', '1.68.1'
+  spec.add_dependency 'grpc', '~> 1.68.0'
 
   # Base dev dependency
   spec.add_development_dependency 'bundler', '~> 2.0'
@@ -53,9 +53,6 @@ Gem::Specification.new do |spec|
   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/scenarios/common/compose_context.rb

@@ -30,7 +30,7 @@ RSpec.shared_context 'compose' do
 
   before(:each) do
     compose.start
-    compose.wait_for_http(url: client_url, timeout: 600)
+    compose.wait_for_http(url: client_url, timeout: 800)
   end
 
   after(:each) do

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

@@ -0,0 +1,72 @@
+#
+# 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
+  
+  elasticsearch:
+    image: elasticsearch:8.0.0
+    hostname: elasticsearch
+    ports:
+      - "9200:9200"
+    environment:
+      - discovery.type=single-node
+      - bootstrap.memory_lock=true
+      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+      - xpack.security.enabled=false
+    networks:
+      - gem
+    healthcheck:
+      test: [ "CMD-SHELL", "curl --silent --fail localhost:9200/_cluster/health || exit 1" ]
+      interval: 5s
+      timeout: 60s
+      retries: 120
+  
+  service:
+    extends:
+      file: ../common/base-compose.yml
+      service: agent
+    ports:
+      - "8080:8080"
+    volumes:
+      - .:/app/spec/scenarios/elasticsearch
+    environment:
+      SW_AGENT_SERVICE_NAME: "elasticsearch"
+    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 elasticsearch && ruby /app/spec/scenarios/elasticsearch/elasticsearch.rb"
+    depends_on:
+      oap:
+        condition: service_healthy
+    networks:
+      - gem
+
+networks:
+  gem:

data/spec/scenarios/elasticsearch/elasticsearch.rb

@@ -0,0 +1,54 @@
+#  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 'sinatra'
+require 'elasticsearch'
+
+Skywalking.start(disable_plugins: 'net_http')
+
+def create_index(client)
+  client.indices.create(index: 'test_index', body: { mappings: { properties: { name: { type: 'text' } } } })
+  puts "Index created."
+end
+
+def add_document(client, id, name)
+  client.index(index: 'test_index', id: id, body: { name: name })
+  puts "Document added: #{id} => #{name}"
+end
+
+def get_document(client, id)
+  response = client.get(index: 'test_index', id: id)
+  puts "Document retrieved: #{response['_source']}"
+rescue Elasticsearch::Transport::Transport::Errors::NotFound
+  puts "Document not found."
+end
+
+def delete_document(client, id)
+  client.delete(index: 'test_index', id: id)
+  puts "Document deleted: #{id}"
+end
+
+get "/execute" do
+  client = Elasticsearch::Client.new(hosts: ['http://elasticsearch:9200'], log: true, 
+    transport_options: { request: { timeout: 5 } })
+  create_index(client)
+  add_document(client, '1', 'Document 1')
+  get_document(client, '1')
+  delete_document(client, '1')
+end
+
+set :bind, '0.0.0.0'
+set :port, 8080

data/spec/scenarios/elasticsearch/elasticsearch_spec.rb

@@ -0,0 +1,29 @@
+#  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 "Elasticsearch" do
+  include CommonSpecHelper
+  include_context 'compose'
+  include_context 'scenario value'
+
+  let(:root_dir) { File.expand_path(__dir__) }
+
+  it 'test elasticsearch plugin' do
+    test_plugin('elasticsearch')
+  end
+end

data/spec/scenarios/elasticsearch/expected.yml

@@ -0,0 +1,94 @@
+# 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: elasticsearch
+    segmentSize: ge 1
+    segments:
+      - segmentId: not null
+        spans:
+          - operationName: Elasticsearch/PUT/test_index
+            parentSpanId: 0
+            spanId: 1
+            spanLayer: Database
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 47
+            isError: false
+            spanType: Exit
+            peer: http://elasticsearch:9200
+            skipAnalysis: false
+            tags:
+              - { key: db.type, value: Elasticsearch }
+              - { key: db.statement, value: '[{:params=>{}}, {:body=>{:mappings=>{:properties=>{:name=>{:type=>"text"}}}}}]' }
+          - operationName: Elasticsearch/PUT/test_index/_doc/1
+            parentSpanId: 0
+            spanId: 2
+            spanLayer: Database
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 47
+            isError: false
+            spanType: Exit
+            peer: http://elasticsearch:9200
+            skipAnalysis: false
+            tags:
+              - { key: db.type, value: Elasticsearch }
+              - { key: db.statement, value: '[{:params=>{}}, {:body=>{:name=>"Document 1"}}]' }
+          - operationName: Elasticsearch/GET/test_index/_doc/1
+            parentSpanId: 0
+            spanId: 3
+            spanLayer: Database
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 47
+            isError: false
+            spanType: Exit
+            peer: http://elasticsearch:9200
+            skipAnalysis: false
+            tags:
+              - { key: db.type, value: Elasticsearch }
+              - { key: db.statement, value: '[{:params=>{}}]' }
+          - operationName: Elasticsearch/DELETE/test_index/_doc/1
+            parentSpanId: 0
+            spanId: 4
+            spanLayer: Database
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 47
+            isError: false
+            spanType: Exit
+            peer: http://elasticsearch:9200
+            skipAnalysis: false
+            tags:
+              - { key: db.type, value: Elasticsearch }
+              - { key: db.statement, value: '[{:params=>{}}]' }
+          - 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/spec/scenarios/memcached/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
+  
+  memcached:
+    image: memcached:1.6
+    hostname: memcached
+    ports:
+      - "11211:11211"
+    networks:
+      - gem
+    healthcheck:
+      test: [ "CMD", "nc", "-z", "localhost", "11211" ]
+      interval: 5s
+      timeout: 60s
+      retries: 120
+  
+  service:
+    extends:
+      file: ../common/base-compose.yml
+      service: agent
+    ports:
+      - "8080:8080"
+    volumes:
+      - .:/app/spec/scenarios/memcached
+    environment:
+      SW_AGENT_SERVICE_NAME: "memcached"
+    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 dalli && ruby /app/spec/scenarios/memcached/memcached.rb"
+    depends_on:
+      oap:
+        condition: service_healthy
+    networks:
+      - gem
+
+networks:
+  gem:

data/spec/scenarios/memcached/expected.yml

@@ -0,0 +1,81 @@
+# 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: memcached
+    segmentSize: ge 1
+    segments:
+      - segmentId: not null
+        spans:
+          - operationName: Memcached/set
+            parentSpanId: 0
+            spanId: 1
+            spanLayer: Cache
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 20
+            isError: false
+            spanType: Exit
+            peer: memcached:11211
+            skipAnalysis: false
+            tags:
+              - {key: cache.type, value: Memcached}
+              - {key: cache.key, value: sw_key}
+          - operationName: Memcached/get
+            parentSpanId: 0
+            spanId: 2
+            spanLayer: Cache
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 20
+            isError: false
+            spanType: Exit
+            peer: memcached:11211
+            skipAnalysis: false
+            tags:
+              - {key: cache.type, value: Memcached}
+              - {key: cache.key, value: sw_key}
+              - {key: cache.miss, value: 'false'}
+          - operationName: Memcached/delete
+            parentSpanId: 0
+            spanId: 3
+            spanLayer: Cache
+            startTime: gt 0
+            endTime: gt 0
+            componentId: 20
+            isError: false
+            spanType: Exit
+            peer: memcached:11211
+            skipAnalysis: false
+            tags:
+              - {key: cache.type, value: Memcached}
+              - {key: cache.key, value: sw_key}
+          - 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/spec/scenarios/memcached/memcached.rb

@@ -0,0 +1,31 @@
+#  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 'sinatra'
+require 'dalli'
+
+Skywalking.start
+
+get "/execute" do
+  client = Dalli::Client.new('memcached:11211', { namespace: "sw", compress: true })
+  client.set('sw_key', 'sw_value')
+  value = client.get('sw_key')
+  p "The value for 'sw_key' is: #{value}"
+  client.delete('sw_key')
+end
+
+set :bind, '0.0.0.0'
+set :port, 8080

data/spec/scenarios/memcached/memcached_spec.rb

@@ -0,0 +1,29 @@
+#  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 "Memcached" do
+  include CommonSpecHelper
+  include_context 'compose'
+  include_context 'scenario value'
+
+  let(:root_dir) { File.expand_path(__dir__) }
+
+  it 'test memcached plugin' do
+    test_plugin('memcached')
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: skywalking
 version: !ruby/object:Gem::Version
-  version: 0.0.0.beta1
+  version: 0.1.0
 platform: ruby
 authors:
 - Apache SkyWalking Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.68.1
+        version: 1.68.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.68.1
+        version: 1.68.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,34 +108,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.1.5
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: testcontainers-compose
   requirement: !ruby/object:Gem::Requirement
@@ -164,20 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
-- !ruby/object:Gem::Dependency
-  name: rspec-wait
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: The Ruby Agent for Apache SkyWalking
 email:
 - dev@skywalking.apache.org
@@ -197,8 +155,10 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- Makefile
 - NOTICE
 - README.md
 - Rakefile
@@ -214,6 +174,8 @@ files:
 - lib/skywalking/configuration.rb
 - lib/skywalking/environment.rb
 - lib/skywalking/log/logger.rb
+- lib/skywalking/plugins/elasticsearch.rb
+- lib/skywalking/plugins/memcached.rb
 - lib/skywalking/plugins/net_http.rb
 - lib/skywalking/plugins/redis5.rb
 - lib/skywalking/plugins/sinatra.rb
@@ -287,6 +249,14 @@ files:
 - spec/scenarios/common/common_spec_helper.rb
 - spec/scenarios/common/compose_context.rb
 - spec/scenarios/common/validator.rb
+- spec/scenarios/elasticsearch/docker-compose.yml
+- spec/scenarios/elasticsearch/elasticsearch.rb
+- spec/scenarios/elasticsearch/elasticsearch_spec.rb
+- spec/scenarios/elasticsearch/expected.yml
+- spec/scenarios/memcached/docker-compose.yml
+- spec/scenarios/memcached/expected.yml
+- spec/scenarios/memcached/memcached.rb
+- spec/scenarios/memcached/memcached_spec.rb
 - spec/scenarios/net_http/docker-compose.yml
 - spec/scenarios/net_http/expected.yml
 - spec/scenarios/net_http/net_http.rb