skywalking 0.0.0.alpha → 0.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0423e882de6727f977faeb26288cebb1b2734ad490b228c02b32b2571bb20b9d
-  data.tar.gz: c5196c49afe28fec0f20b9ba2d1a3bc0fa7a8dab342fa488f6492f67f9618658
+  metadata.gz: 440bef4a38e67a74f5da465bfe3e7f0482631f7371d89f8d2848c7519f37c1de
+  data.tar.gz: b536aadb8f8eb25357bf20c2bf16d40c868c2068fbdc5b0559794e3a4e9c9839
 SHA512:
-  metadata.gz: 2f204843987b34bcfae83e094d74fa6629fa31d90af40144c65a81958fe02a3b7b6bb46e4a5330101c543b046ab77b0be288bc0ae6559eda9cba214393dabc3c
-  data.tar.gz: eba2838b49f4208c319d46167d3859b2c8d7a5292325d7069823b70c0d6d84c33c220e3cfd0d7baab997b4951add72526f9d19e09a2cd860402007059a93dacb
+  metadata.gz: 59b5fefb96f307c1e70d8d975c8c962b69c0410051a2f2951a69f221b17ea896ffde723d224a5a6cbb11eed0b6c51bf74064c7a6e05db72d36e663309b1560fd
+  data.tar.gz: 021b8f374d2f6a22b833b8dddae9ea1cc497859885098d8f04274546409d461d2904d32c22af6cf8347e09ffc51b9d0580739be8fda604e8415feff59b49631a

data/.dockerignore

@@ -0,0 +1,19 @@
+# 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.
+
+.idea
+.git
+examples

data/.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,42 @@
+<!--
+    ⚠️ Please make sure to read this template first, pull requests that don't accord with this template
+    maybe closed without notice.
+    Texts surrounded by `<` and `>` are meant to be replaced by you, e.g. <framework name>, <issue number>.
+    Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]`
+-->
+
+<!-- ==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👇 ====
+### Fix <bug description or bug issue link>
+- [ ] Add a unit test to verify that the fix works.
+- [ ] Explain briefly why the bug exists and how to fix it.
+     ==== 🐛 Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist 👆 ==== -->
+
+<!-- ==== 📈 Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist 👇 ====
+### Improve the performance of <class or module or ...>
+- [ ] Add a benchmark for the improvement, refer to [the existing ones](https://github.com/apache/skywalking/blob/master/oap-server/microbench/src/main/java/org/apache/skywalking/oap/server/microbench/library/datacarrier/LinkedArrayBenchmark.java)
+- [ ] The benchmark result.
+```text
+<Paste the benchmark results here>
+```
+- [ ] Links/URLs to the theory proof or discussion articles/blogs. <links/URLs here>
+     ==== 📈 Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist 👆 ==== -->
+
+<!-- ==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👇 ====
+### <Feature description>
+- [ ] If this is non-trivial feature, paste the links/URLs to the design doc.
+- [ ] Update the documentation to include this new feature.
+- [ ] Tests(including UT, IT, E2E) are added to verify the new feature.
+- [ ] If it's UI related, attach the screenshots below.
+- [ ] I have rebuilt the `Configuration.md` documentation by running `make doc-gen`
+     ==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👆 ==== -->
+
+<!-- ==== 📱 Remove this line WHEN AND ONLY WHEN you're adding or modifying a plugin instrumentation, follow the checklist 👇 ====
+### <Feature description>
+- [ ] If adding a new plugin, add a component id in [the main repo](https://github.com/apache/skywalking/blob/master/oap-server/server-starter/src/main/resources/component-libraries.yml)
+- [ ] If adding a new plugin, add a logo in [the UI repo](https://github.com/apache/skywalking-booster-ui/tree/main/src/assets/img/technologies)
+- [ ] I have added the library to `pyproject.toml` (plugin group) by running `poetry add library --group plugins`
+- [ ] I have rebuilt the `Plugins.md` documentation by running `make doc-gen`
+     ==== 📱 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👆 ==== -->
+
+- [ ] If this pull request closes/resolves/fixes an existing issue, replace the issue url. Closes: <URL to main repo issue>
+- [ ] Update the [`CHANGELOG.md`](https://github.com/apache/skywalking-ruby/blob/main/CHANGELOG.md).

data/.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+# 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.
+
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+
+concurrency:
+  group: ci-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-and-check:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby-version }} | Build and Check
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: [ 3.0 ]
+
+    steps:
+      - name: Checkout source codes
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Check License
+        uses: apache/skywalking-eyes/header@3ea9df11bb3a5a85665377d1fd10c02edecf2c40
+      - name: Install system dependency
+        run: |
+          gem install bundler
+          bundler install
+      - name: RuboCop Linter
+        run: bundler exec rubocop
+
+  CheckStatus:
+    if: always()
+    needs:
+      - build-and-check
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Merge Requirement
+        run: |
+          if [[ ${{ needs.build-and-check.result }} != 'success' ]]; then
+            exit -1
+          fi

data/.github/workflows/e2e.yml

@@ -0,0 +1,73 @@
+# 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.
+
+name: e2e
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: e2e-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  prep-build-plugin:
+    name: Build matrix
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    outputs:
+      plugins: ${{ steps.plugins.outputs.plugins }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - id: plugins
+        run: echo "plugins=$(ls spec/scenarios | grep -v common | jq --raw-input | jq --slurp --compact-output)" >> "$GITHUB_OUTPUT"
+
+  e2e-test:
+    name: Run E2E Tests | ${{ matrix.plugin }} | Ruby ${{ matrix.ruby-version }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 90
+    needs: [ prep-build-plugin ]
+    strategy:
+      matrix:
+        plugin: ${{ fromJson(needs.prep-build-plugin.outputs.plugins) }}
+        ruby-version: [ "3.0" ]
+    env:
+      SW_RUBY_VERSION: ${{ matrix.ruby-version }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install docker-compose
+        shell: bash
+        run: |
+          if ! command docker-compose 2>&1 > /dev/null; then
+            echo "Installing docker-compose"
+            sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+            sudo chmod +x /usr/local/bin/docker-compose
+          fi
+      - name: Run E2E tests
+        run: |
+          gem install bundler && bundle
+          bundle exec rspec spec/scenarios/${{ matrix.plugin }}

data/.gitignore

@@ -0,0 +1,80 @@
+# 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.
+
+.idea/
+.fleet/
+*.iml
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+Gemfile.lock
+gemfiles/*.lock
+.DS_Store!
+spec/workspace

data/.gitmodules

@@ -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.
+
+[submodule "protocol"]
+	path = protocol
+	url = https://github.com/apache/skywalking-data-collect-protocol.git

data/.licenserc.yaml

@@ -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.
+#
+header:
+  license:
+    spdx-id: Apache-2.0
+    copyright-owner: Apache Software Foundation
+
+  paths-ignore:
+    - 'licenses'
+    - '**/*.md'
+    - 'LICENSE'
+    - 'NOTICE'
+    - '.github/PULL_REQUEST_TEMPLATE'
+    - '**/.gitignore'
+    - '.gitmodules'
+    - 'lib/skywalking/proto/**'
+    - 'examples/**'
+    - '.rspec'
+
+  comment: on-failure

data/.rspec

@@ -1,3 +1,2 @@
 --format documentation
---color
---require spec_helper
+--color

data/.rubocop.yml

@@ -124,6 +124,12 @@ Style/SymbolProc:
 Style/ExplicitBlockArgument:
   Enabled: false
 
+Style/ClassVars:
+  Enabled: false
+  
+Style/CombinableDefined:
+  Enabled: false
+
 #####
 # Lint
 #####

data/CHANGELOG.md

@@ -6,10 +6,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)
 
 #### Documentation
 * Initialize the documentation.

data/Gemfile

@@ -0,0 +1,20 @@
+#  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.
+
+source 'https://rubygems.org'
+
+gemspec name: 'skywalking'
+
+ruby ">= 3.0.0"

data/NOTICE

@@ -1,5 +1,5 @@
 Apache SkyWalking
-Copyright 2017-2024 The Apache Software Foundation
+Copyright 2017-2025 The Apache Software Foundation
 
 This product includes software developed at
 The Apache Software Foundation (http://www.apache.org/).

data/docs/README.md

@@ -0,0 +1,7 @@
+# SkyWalking Ruby Agent
+
+**This is the official documentation of SkyWalking Ruby agent. Welcome to the SkyWalking community!**
+
+SkyWalking Ruby is an open-source auto-instrument agent that provides support for distributed tracing across different frameworks within the Ruby language.
+
+This documentation covers a number of ways to set up the Ruby agent for various use cases.

data/docs/en/agent/plugins.md

@@ -0,0 +1,10 @@
+# Tracing Plugins
+
+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`   |

data/docs/{How-to-release.md → en/development-and-contribution/how-to-release.md}

@@ -5,7 +5,7 @@ This documentation guides the release manager to release the SkyWalking Ruby in
 ## Prerequisites
 
 1. Close (if finished, or move to next milestone otherwise) all issues in the current milestone from [skywalking-ruby](https://github.com/apache/skywalking-ruby/milestones) and [skywalking](https://github.com/apache/skywalking/milestones), create a new milestone for the next release.
-1. Update [CHANGELOG.md](../CHANGELOG.md) and `version` in [Version.rb](../lib/skywalking/version.rb).
+1. Update [CHANGELOG.md](../../../CHANGELOG.md) and `version` in [Version.rb](../../../lib/skywalking/version.rb).
 
 
 ## Add your GPG public key to Apache svn
@@ -143,6 +143,8 @@ Vote result should follow these:
 1. Publish to rubygems.org, this is optional for Apache releases, but we usually want to do this to let users use it conveniently.
 
   ```shell
+  gem build skywalking.gemspec
+  gem push skywalking.gemspec
   ```
 
 **NOTE**: please double check before publishing to rubygems.org, it's difficult to unpublish and republish the module at the moment.
@@ -169,11 +171,10 @@ Vote result should follow these:
     Website: http://skywalking.apache.org/
 
     SkyWalking Ruby Resources:
-- Issue: https://github.com/apache/skywalking/issues
+    Issue: https://github.com/apache/skywalking/issues
+
     - Mailing list: dev@skywalking.apache.org
     - Documents: https://github.com/apache/skywalking-ruby/blob/v$VERSION/README.md
 
     The Apache SkyWalking Team
-```
-
-
+   ```

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

@@ -0,0 +1,106 @@
+# Quick Start
+
+## Requirements
+
+**SkyWalking Ruby agent requires SkyWalking 8.0+ and Ruby 3.0+**
+
+## Installing the gem
+
+The Ruby agent's gem is available from [RubyGems](https://rubygems.org/) as `skywalking`, we recommend you install and
+manage the skywalking gem dependency with [Bundler](http://bundler.io/), add the following line to your `Gemfile`, then
+run `bundle install` to install the gem.
+
+~~~ruby
+# Gemfile
+source "https://rubygems.org"
+
+gem "skywalking"
+~~~
+
+Besides, you can also make installation as simple as `gem install skywalking`.
+
+## Getting started with Rails
+
+You need to manually add `Skywalking.start` under config/initializers directory.
+
+Optionally the command `bundle exec rails generate skywalking:start`, will create a config file
+`config/initializers/skywalking.rb`, and then you can configure the start parameters.
+
+## Getting started with Sinatra
+
+You can list `gem 'skywalking'` after sinatra in your Gemfile and use `Bundler.require` during initialization or calling
+`require 'skywalking'` after sinatra gem is loaded, that is, skywalking gem needs to be after the other gems you
+require (e.g. redis, elasticsearch), like the following code:
+
+~~~ruby
+require 'redis'
+require 'sinatra'
+require 'skywalking'
+
+Skywalking.start
+
+get '/sw' do
+  "Hello, SkyWalking!"
+end
+~~~
+
+## Configuration
+
+You can configure the SkyWalking Ruby agent in various ways, the Ruby agent follows this order of precedence for
+configuration:
+
+- Defaults (please
+  see [DEFAULTS](https://github.com/apache/skywalking-ruby/blob/main/lib/skywalking/configuration.rb#L21))
+- Arguments to `Skywalking.start`
+- Configuration file (e.g. `conifg/skywalking.yml`)
+- Environment variables
+
+The following is an example of configuration at start:
+
+~~~ruby
+Skywalking.start(
+  service_name: 'sw-srv',
+  instance_name: 'sw-inst',
+  collector_backend_services: 'oap:11800'
+)
+~~~
+
+The following is an example of a configuration file:
+~~~yaml
+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
+~~~
+
+The following lists all the configuration options:
+
+| key                             | environment key                          | default value        | description                                                                                                                               |
+|---------------------------------|------------------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| service_name                    | SW_AGENT_SERVICE_NAME                    | Your_ApplicationName | The name of the service which showed in UI.                                                                                               |
+| instance_name                   | SW_AGENT_INSTANCE_NAME                   | Your_InstanceName    | To obtain the environment variable key for the instance name, if it cannot be obtained, an instance name will be automatically generated. |
+| namespace                       | SW_AGENT_NAMESPACE                       | Not set              | Namespace represents a subnet, such as kubernetes namespace, or 172.10..                                                                  |
+| environment                     | SW_AGENT_ENVIRONMENT                     | Not set              | The name of the environment this service is deployed in                                                                                   |
+| collector_backend_services      | SW_AGENT_COLLECTOR_BACKEND_SERVICES      | 127.0.0.1:11800      | Collector SkyWalking trace receiver service addresses.                                                                                    |
+| config_file                     | SW_AGENT_CONFIG_FILE                     | Not set              | The absolute path to the configuration file, if empty, it will automatically search for config/skywalking.yml in the root directory.      |
+| 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.                                                                                                                   |
+| 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"}`.                                              |
+| collector_heartbeat_period      | SW_AGENT_COLLECTOR_HEARTBEAT_PERIOD      | 30                   | he agent will send heartbeat to OAP every `collector_heartbeat_period` seconds.                                                           |
+| properties_report_period_factor | SW_AGENT_PROPERTIES_REPORT_PERIOD_FACTOR | 10                   | The agent will report service instance properties every `collector_heartbeat_period * properties_report_period_factor` seconds.           |
+| max_queue_size                  | SW_AGENT_MAX_QUEUE_SIZE                  | 10000                | The maximum queue size for reporting data.                                                                                                |

data/docs/menu.yml

@@ -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.
+
+catalog:
+  - name: SkyWalking Ruby Overview
+    path: /readme
+  - name: Quick Start
+    path: /en/setup/quick-start
+  - name: Agent
+    catalog:
+      - name: Supported Plugins
+        path: /en/agent/plugins
+  - name: Development and Contribution
+    catalog:
+      - name: How to Release
+        path: /en/development-and-contribution/how-to-release
+  - name: Changelog
+    path: https://github.com/apache/skywalking-ruby/blob/master/CHANGELOG.md

data/lib/rails/generators/skywalking/start_generator.rb

@@ -0,0 +1,47 @@
+#  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
+  class StartGenerator < ::Rails::Generators::Base
+    source_root File.join(File.dirname(__FILE__), 'templates')
+    desc 'Creates a skywalking initializer'
+
+    @namespace = "skywalking:start"
+
+    def copy_initializer
+      print_header
+      print_footer
+
+      template "skywalking_initializer.rb", "config/initializers/skywalking.rb"
+    end
+
+    private
+
+    def print_header
+      say ""
+      say shell.set_color "Welcome to the SkyWalking Ruby Agent instrumentation setup.", :green, :bold
+      say ""
+    end
+
+    def print_footer
+      say ""
+      say "You can configure skywalking start parameters by modifying config/initializers/skywalking.rb."
+      say ""
+      say "Thanks for using! Welcome to contribute to the SkyWalking community."
+      say ""
+    end
+  end
+end
+