This is an automated email from the ASF dual-hosted git repository. github-bot pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/skywalking-website.git
The following commit(s) were added to refs/heads/asf-site by this push: new af4872b8a1c deploy: bd4acba6263121330589107293b692c01d90db5f af4872b8a1c is described below commit af4872b8a1cdd5695499fddcfef0db4b20bc27ab Author: wu-sheng <wu-sh...@users.noreply.github.com> AuthorDate: Wed Aug 28 10:05:42 2024 +0000 deploy: bd4acba6263121330589107293b692c01d90db5f --- contributors/index.html | 2 +- .../next/en/advanced-features/grpc-tls/index.html | 4 ++-- .../next/en/advanced-features/logging-setup/index.html | 4 ++-- .../advanced-features/manual-apis/toolkit-trace/index.html | 2 +- .../next/en/advanced-features/plugin-exclusion/index.html | 2 +- .../next/en/advanced-features/settings-override/index.html | 4 ++-- .../skywalking-go/next/en/agent/performance-tests/index.html | 4 ++-- .../next/en/agent/plugin-configurations/index.html | 2 +- docs/skywalking-go/next/en/agent/support-plugins/index.html | 2 +- .../next/en/agent/tracing-metrics-logging/index.html | 2 +- .../en/concepts-and-designs/hybrid-compilation/index.html | 2 +- .../next/en/concepts-and-designs/key-principles/index.html | 10 +++++----- .../en/concepts-and-designs/project-structure/index.html | 2 +- .../build-and-use-agent/index.html | 2 +- .../development-guide/index.html | 8 ++++---- .../development-and-contribution/how-to-release/index.html | 6 +++--- .../running-and-debugging/index.html | 2 +- .../write-plugin-testing/index.html | 12 ++++++------ docs/skywalking-go/next/en/setup/docker/index.html | 2 +- docs/skywalking-go/next/en/setup/gobuild/index.html | 2 +- docs/skywalking-go/next/readme/index.html | 2 +- index.json | 2 +- 22 files changed, 40 insertions(+), 40 deletions(-) diff --git a/contributors/index.html b/contributors/index.html index e328abf7055..69ef9d7f40f 100644 --- a/contributors/index.html +++ b/contributors/index.html @@ -17427,7 +17427,7 @@ </a> </span> - <div class="mrproliu mrproliu">66</div> + <div class="mrproliu mrproliu">67</div> <div class="mrproliu mrproliu">1</div> diff --git a/docs/skywalking-go/next/en/advanced-features/grpc-tls/index.html b/docs/skywalking-go/next/en/advanced-features/grpc-tls/index.html index 1102f92b8db..bc217205b93 100644 --- a/docs/skywalking-go/next/en/advanced-features/grpc-tls/index.html +++ b/docs/skywalking-go/next/en/advanced-features/grpc-tls/index.html @@ -542,7 +542,7 @@ We need the following files:"/> })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> @@ -576,7 +576,7 @@ In some use cases, end users report the background:</p> <h2 id="creating-ssltls-certificates">Creating SSL/TLS Certificates</h2> <p>The first step is to generate certificates and key files for encrypting communication. This is fairly straightforward: use <code>openssl</code> from the command line.</p> -<p>Use this <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/tools/TLS/tls_key_generate.sh">script</a> if you are not familiar with how to generate key files.</p> +<p>Use this <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/tools/TLS/tls_key_generate.sh">script</a> if you are not familiar with how to generate key files.</p> <p>We need the following files:</p> <ul> <li><code>client.pem</code>: A private RSA key to sign and authenticate the public key. It’s either a PKCS#8(PEM) or PKCS#1(DER).</li> diff --git a/docs/skywalking-go/next/en/advanced-features/logging-setup/index.html b/docs/skywalking-go/next/en/advanced-features/logging-setup/index.html index 799d1a03e14..119f34987bf 100644 --- a/docs/skywalking-go/next/en/advanced-features/logging-setup/index.html +++ b/docs/skywalking-go/next/en/advanced-features/logging-setup/index.html @@ -539,7 +539,7 @@ Logging Detection Log detection means that the logging plugin would automaticall })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> @@ -570,7 +570,7 @@ Logging Detection Log detection means that the logging plugin would automaticall <h1 id="logging-setup">Logging Setup</h1> <p>Logging Setup is used to integrate the Go Agent with the logging system in the current service. It currently supports the recognition of <code>Logrus</code> and <code>Zap</code> frameworks. If neither of these frameworks is present, it would output logs using <code>Std Error</code>.</p> -<p>You can learn about the configuration details through the “log” configuration item in the <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/tools/go-agent/config/agent.default.yaml">default settings</a>.</p> +<p>You can learn about the configuration details through the “log” configuration item in the <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/tools/go-agent/config/agent.default.yaml">default settings</a>.</p> <h2 id="logging-detection">Logging Detection</h2> <p>Log detection means that the logging plugin would automatically detect the usage of logs in your application. When the log type is set to <code>auto</code>, it would choose the appropriate log based on the creation rules of different frameworks. The selection rules vary depending on the framework:</p> diff --git a/docs/skywalking-go/next/en/advanced-features/manual-apis/toolkit-trace/index.html b/docs/skywalking-go/next/en/advanced-features/manual-apis/toolkit-trace/index.html index a6f8220316e..c013d53d04d 100644 --- a/docs/skywalking-go/next/en/advanced-features/manual-apis/toolkit-trace/index.html +++ b/docs/skywalking-go/next/en/advanced-features/manual-apis/toolkit-trace/index.html @@ -539,7 +539,7 @@ When creating an Entry Span, you need to obtain the context carrier from the req })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/advanced-features/plugin-exclusion/index.html b/docs/skywalking-go/next/en/advanced-features/plugin-exclusion/index.html index e75693d6e25..faee7e653ba 100644 --- a/docs/skywalking-go/next/en/advanced-features/plugin-exclusion/index.html +++ b/docs/skywalking-go/next/en/advanced-features/plugin-exclusion/index.html @@ -536,7 +536,7 @@ Configuration plugin:# List the names of excluded plugins, multiple plugin names })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/advanced-features/settings-override/index.html b/docs/skywalking-go/next/en/advanced-features/settings-override/index.html index d9100d799a3..19e93824623 100644 --- a/docs/skywalking-go/next/en/advanced-features/settings-override/index.html +++ b/docs/skywalking-go/next/en/advanced-features/settings-override/index.html @@ -539,7 +539,7 @@ Configuration Changes The values in the config file should be updated by followi })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> @@ -568,7 +568,7 @@ Configuration Changes The values in the config file should be updated by followi <div class="td-content"> <h1 id="setting-override">Setting Override</h1> -<p>By default, SkyWalking Go agent provides a default <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/tools/go-agent/config/agent.default.yaml">agent.default.yaml</a> to define the default configuration options.</p> +<p>By default, SkyWalking Go agent provides a default <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/tools/go-agent/config/agent.default.yaml">agent.default.yaml</a> to define the default configuration options.</p> <p>This configuration file is used <strong>during hybrid compilation to write the configuration information of the Agent into the program</strong>. When the program boots, the agent would read the pre-configured content.</p> <h2 id="configuration-changes">Configuration Changes</h2> diff --git a/docs/skywalking-go/next/en/agent/performance-tests/index.html b/docs/skywalking-go/next/en/agent/performance-tests/index.html index 5039c3285a6..8f9482e64a3 100644 --- a/docs/skywalking-go/next/en/agent/performance-tests/index.html +++ b/docs/skywalking-go/next/en/agent/performance-tests/index.html @@ -542,7 +542,7 @@ traffic generator -> consumer -> provider The payload(traffic) generator u })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> @@ -575,7 +575,7 @@ traffic generator -> consumer -> provider The payload(traffic) generator u <h2 id="test-objective">Test Objective</h2> <p>By launching both the <strong>agent</strong> and <strong>non-agent</strong> compiled applications, we subject them to the same <strong>QPS</strong> under stress testing, evaluating the CPU, memory, and network latency of the machine during the testing period.</p> -<p>The application has been saved and submitted to the <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/test/benchmark-codebase">test/benchmark-codebase</a> directory, with the following topology:</p> +<p>The application has been saved and submitted to the <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/test/benchmark-codebase">test/benchmark-codebase</a> directory, with the following topology:</p> <pre><code>traffic generator -> consumer -> provider </code></pre><p>The payload(traffic) generator uses multithreading to send HTTP requests to the consumer service. When the consumer receives a request, it sends three requests to the provider service to obtain return data results. diff --git a/docs/skywalking-go/next/en/agent/plugin-configurations/index.html b/docs/skywalking-go/next/en/agent/plugin-configurations/index.html index ee84fb61627..9ea19f0753b 100644 --- a/docs/skywalking-go/next/en/agent/plugin-configurations/index.html +++ b/docs/skywalking-go/next/en/agent/plugin-configurations/index.html @@ -533,7 +533,7 @@ })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/agent/support-plugins/index.html b/docs/skywalking-go/next/en/agent/support-plugins/index.html index 68c6fd9a655..8685f76f21f 100644 --- a/docs/skywalking-go/next/en/agent/support-plugins/index.html +++ b/docs/skywalking-go/next/en/agent/support-plugins/index.html @@ -536,7 +536,7 @@ })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/agent/tracing-metrics-logging/index.html b/docs/skywalking-go/next/en/agent/tracing-metrics-logging/index.html index 16060114da7..6376a95a165 100644 --- a/docs/skywalking-go/next/en/agent/tracing-metrics-logging/index.html +++ b/docs/skywalking-go/next/en/agent/tracing-metrics-logging/index.html @@ -536,7 +536,7 @@ Metadata Mechanism The Go Agent would be identified by the SkyWalking backend af })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/concepts-and-designs/hybrid-compilation/index.html b/docs/skywalking-go/next/en/concepts-and-designs/hybrid-compilation/index.html index a8eb7691e25..19f56ba87c8 100644 --- a/docs/skywalking-go/next/en/concepts-and-designs/hybrid-compilation/index.html +++ b/docs/skywalking-go/next/en/concepts-and-designs/hybrid-compilation/index.html @@ -539,7 +539,7 @@ Toolchain in Golang The -toolexec flag in Golang is a powerful feature that can })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/concepts-and-designs/key-principles/index.html b/docs/skywalking-go/next/en/concepts-and-designs/key-principles/index.html index f435df5140d..e8b90927c6c 100644 --- a/docs/skywalking-go/next/en/concepts-and-designs/key-principles/index.html +++ b/docs/skywalking-go/next/en/concepts-and-designs/key-principles/index.html @@ -539,7 +539,7 @@ Method Interceptor Method interception is particularly important in SkyWalking G })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> @@ -585,7 +585,7 @@ Method Interceptor Method interception is particularly important in SkyWalking G <h3 id="modifying-methods">Modifying Methods</h3> <p>After finding the method, the SkyWalking Go Agent needs to modify the method implication and embed the interceptor code.</p> <h4 id="change-method-body">Change Method Body</h4> -<p>When intercepting a method, the first thing to do is to modify the method and <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/tools/go-agent/instrument/plugins/templates/method_inserts.tmpl">embed the template code</a>. +<p>When intercepting a method, the first thing to do is to modify the method and <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/tools/go-agent/instrument/plugins/templates/method_inserts.tmpl">embed the template code</a>. This code segment includes two method executions:</p> <ol> <li><strong>Before method execution</strong>: Pass in the current method’s arguments, instances, and other information.</li> @@ -597,8 +597,8 @@ This ensures that when an exception occurs in the framework code execution, the <h4 id="write-delegator-file">Write Delegator File</h4> <p>After the agent enhances the method body, it needs to implement the above two methods and write them into a single file, called the <strong>delegator file</strong>. These two methods would do the following:</p> <ol> -<li><strong>Before method execution</strong>: <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/tools/go-agent/instrument/plugins/templates/method_intercept_before.tmpl">Build by the template</a>. Build the context for before and after interception, and pass the parameter information during execution to the interceptor in each plugin.</li> -<li><strong>After method execution</strong>: <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/tools/go-agent/instrument/plugins/templates/method_intercept_after.tmpl">Build by the template</a>. Pass the method return value to the interceptor and execute the method.</li> +<li><strong>Before method execution</strong>: <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/tools/go-agent/instrument/plugins/templates/method_intercept_before.tmpl">Build by the template</a>. Build the context for before and after interception, and pass the parameter information during execution to the interceptor in each plugin.</li> +<li><strong>After method execution</strong>: <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/tools/go-agent/instrument/plugins/templates/method_intercept_after.tmpl">Build by the template</a>. Pass the method return value to the interceptor and execute the method.</li> </ol> <h4 id="copy-files">Copy Files</h4> <p>After completing the delegator file, the agent would perform the following copy operations:</p> @@ -681,7 +681,7 @@ The main key modules that users currently need to introduce include:</p> The Agent Core code would be dynamically added during hybrid compilation, so when the Agent releases new features, users only need to upgrade the Agent enhancement program without modifying the references in the program.</p> <h3 id="code-import">Code Import</h3> -<p>You can see a lot of <code>imports.go</code> files anywhere in the SkyWalking Go, such as <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/imports.go">imports.go in the root directory</a>, but there is no actual code. +<p>You can see a lot of <code>imports.go</code> files anywhere in the SkyWalking Go, such as <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/imports.go">imports.go in the root directory</a>, but there is no actual code. This is because, during hybrid compilation, if the code to be compiled references other libraries, such as <code>os</code>, <code>fmt</code>, etc., they need to be referenced through the <strong>importcfg</strong> file during compilation.</p> <p>The content of the <code>importcfg</code> file is shown below, which specifies the package dependency information required for all Go files to be compiled in the current package path.</p> diff --git a/docs/skywalking-go/next/en/concepts-and-designs/project-structure/index.html b/docs/skywalking-go/next/en/concepts-and-designs/project-structure/index.html index eb4c9fdaee4..1d99f122b7b 100644 --- a/docs/skywalking-go/next/en/concepts-and-designs/project-structure/index.html +++ b/docs/skywalking-go/next/en/concepts-and-designs/project-structure/index.html @@ -533,7 +533,7 @@ })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/development-and-contribution/build-and-use-agent/index.html b/docs/skywalking-go/next/en/development-and-contribution/build-and-use-agent/index.html index bf0242f8f29..02c9b22d86a 100644 --- a/docs/skywalking-go/next/en/development-and-contribution/build-and-use-agent/index.html +++ b/docs/skywalking-go/next/en/development-and-contribution/build-and-use-agent/index.html @@ -542,7 +542,7 @@ import _ "github.com/apache/skywalking-go" Build the Agent When building })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/development-and-contribution/development-guide/index.html b/docs/skywalking-go/next/en/development-and-contribution/development-guide/index.html index 6598b7ae207..09161607670 100644 --- a/docs/skywalking-go/next/en/development-and-contribution/development-guide/index.html +++ b/docs/skywalking-go/next/en/development-and-contribution/development-guide/index.html @@ -539,7 +539,7 @@ All plugins must follow these steps: })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> @@ -577,7 +577,7 @@ All plugins must follow these steps: <li><strong>Import the plugin module</strong>: Import the plugin into the management module for users to use.</li> </ol> <h2 id="create-a-new-plugin-module">Create a new plugin module</h2> -<p>The plugin must create a new module, which is currently stored in the project’s <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/plugins">plugins directory</a>.</p> +<p>The plugin must create a new module, which is currently stored in the project’s <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/plugins">plugins directory</a>.</p> <p>Plugins can import the following two modules:</p> <ol> <li><strong>Agent core</strong>: This module provides all the dependencies needed for the plugin, including the plugin API, enhancement declaration objects, etc. @@ -587,7 +587,7 @@ Agent core plugin should be <code>github.com/apache/skywalking-go/plugins/core</ <p>Note: Plugins should <strong>NOT</strong> import and use any other modules, as this may cause compilation issues for users. If certain tools are needed, they should be provided by the agent core.</p> <h2 id="define-the-enhancement-object">Define the enhancement object</h2> <p>In the root directory of the project, <strong>create a new go file</strong> to define the basic information of the plugin. -The basic information includes the following methods, corresponding to the <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/plugins/core/instrument/declare.go">Instrument interface</a>:</p> +The basic information includes the following methods, corresponding to the <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/plugins/core/instrument/declare.go">Instrument interface</a>:</p> <ol> <li><strong>Name</strong>: The name of the plugin. Please keep this name consistent with the newly created project name. The reason will be explained later.</li> <li><strong>Base Package</strong>: Declare which package this plugin intercepts. For example, if you want to intercept gin, you can write: “github.com/gin-gonic/gin”.</li> @@ -944,7 +944,7 @@ However, in some cases, goroutine would be context sharing due to be scheduled b </span><span style="color:#998;font-style:italic"></span> <span style="color:#900;font-weight:bold">ObserveWithCount</span>(val <span style="color:#458;font-weight:bold">float64</span>, count <span style="color:#458;font-weight:bold">int64</span>) } </code></pre></div><h2 id="import-plugin">Import Plugin</h2> -<p>Once you have finished developing the plugin, you need to import the completed module into the Agent program and <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/tools/go-agent/instrument/plugins/register.go">define it in the corresponding file</a>.</p> +<p>Once you have finished developing the plugin, you need to import the completed module into the Agent program and <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/tools/go-agent/instrument/plugins/register.go">define it in the corresponding file</a>.</p> <p>At this point, your plugin development process is complete. When the Agent performs hybrid compilation on the target program, your plugin will be executed as expected.</p> </div> diff --git a/docs/skywalking-go/next/en/development-and-contribution/how-to-release/index.html b/docs/skywalking-go/next/en/development-and-contribution/how-to-release/index.html index 6346631206f..3cc19f1441a 100644 --- a/docs/skywalking-go/next/en/development-and-contribution/how-to-release/index.html +++ b/docs/skywalking-go/next/en/development-and-contribution/how-to-release/index.html @@ -536,7 +536,7 @@ Prerequisites Close(if finished, or move to next milestone otherwise) all issue })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> @@ -569,8 +569,8 @@ Prerequisites Close(if finished, or move to next milestone otherwise) all issue <h2 id="prerequisites">Prerequisites</h2> <ol> <li>Close(if finished, or move to next milestone otherwise) all issues in the current milestone from <a href="https://github.com/apache/skywalking-go/milestones">skywalking-go</a> and <a href="https://github.com/apache/skywalking/milestones">skywalking</a>, create a new milestone if needed.</li> -<li>Update <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/CHANGES.md">CHANGES.md</a>.</li> -<li>Check the <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/dist/LICENSE">dependency licenses</a> including all dependencies.</li> +<li>Update <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/CHANGES.md">CHANGES.md</a>.</li> +<li>Check the <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/dist/LICENSE">dependency licenses</a> including all dependencies.</li> </ol> <h2 id="add-your-gpg-public-key-to-apache-svn">Add your GPG public key to Apache svn</h2> <ol> diff --git a/docs/skywalking-go/next/en/development-and-contribution/running-and-debugging/index.html b/docs/skywalking-go/next/en/development-and-contribution/running-and-debugging/index.html index 17c1ec40263..968fbe61408 100644 --- a/docs/skywalking-go/next/en/development-and-contribution/running-and-debugging/index.html +++ b/docs/skywalking-go/next/en/development-and-contribution/running-and-debugging/index.html @@ -536,7 +536,7 @@ })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/development-and-contribution/write-plugin-testing/index.html b/docs/skywalking-go/next/en/development-and-contribution/write-plugin-testing/index.html index a67981a3a75..988c5c20144 100644 --- a/docs/skywalking-go/next/en/development-and-contribution/write-plugin-testing/index.html +++ b/docs/skywalking-go/next/en/development-and-contribution/write-plugin-testing/index.html @@ -539,7 +539,7 @@ Developing a plugin involves the following steps: })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> @@ -572,14 +572,14 @@ Developing a plugin involves the following steps: If you haven’t started developing your plugin yet, please read this <a href="./../development-guide">Plugin Development Guide</a> first.</p> <p>Developing a plugin involves the following steps:</p> <ol> -<li><strong>Create a new module</strong>: Please create a new module in the <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/test/plugins/scenarios">specified directory</a>, and it is recommended to name the module the same as the plugin for easy reference.</li> +<li><strong>Create a new module</strong>: Please create a new module in the <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/test/plugins/scenarios">specified directory</a>, and it is recommended to name the module the same as the plugin for easy reference.</li> <li><strong>Write the configuration file</strong>: This file serves as the declaration file for the plugin, and test cases would be run based on this file.</li> <li><strong>Write the test code</strong>: Simulate the actual service operation, including the plugin you want to test.</li> <li><strong>Test execution</strong>: Check if the plugin is running properly.</li> </ol> <h2 id="write-configuration-file">Write Configuration File</h2> <p>The configuration file is used to define the basic information of the test plugin. -You can use <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/test/plugins/scenarios/gin/plugin.yml">the gin plugin configuration file</a> as an example to write your own. +You can use <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/test/plugins/scenarios/gin/plugin.yml">the gin plugin configuration file</a> as an example to write your own. It includes the following information:</p> <ol> <li><strong>entry-service</strong>: The test HTTP service entry URL. When this address is accessed, the plugin code should be triggered.</li> @@ -634,12 +634,12 @@ This corresponds to the <strong>entry-service</strong> address in configuration. <h2 id="test-execution">Test Execution</h2> <p>Once you have completed the plugin configuration and test code writing, you can proceed to test the framework. Please follow these steps:</p> <ol> -<li><strong>Build tools</strong>: Execute the <code>make build</code> command in the <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/test/plugins">test/plugins</a> directory. It would generate some tools needed for testing in the <code>dist</code> folder of this directory.</li> +<li><strong>Build tools</strong>: Execute the <code>make build</code> command in the <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/test/plugins">test/plugins</a> directory. It would generate some tools needed for testing in the <code>dist</code> folder of this directory.</li> <li><strong>Run the plugin locally</strong>: Start the plugin test program and iterate through all framework versions for testing on your local environment.</li> -<li><strong>Add to GitHub Action</strong>: Fill in the name of the test plugin <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/.github/workflows/plugin-tests.yaml">in this file</a>, and the plugin test would be executed and validated each time a pull request is submitted.</li> +<li><strong>Add to GitHub Action</strong>: Fill in the name of the test plugin <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/.github/workflows/plugin-tests.yaml">in this file</a>, and the plugin test would be executed and validated each time a pull request is submitted.</li> </ol> <h3 id="run-the-plugin-test-locally">Run the Plugin Test Locally</h3> -<p>Please execute the <strong>run.sh</strong> script in the <a href="https://github.com/apache/skywalking-go/tree/8f09034f6b61a96c32572ad29bba56c6ba37715b/test/plugins">test/plugins directory</a> and pass in the name of the plugin you wrote (the folder name). +<p>Please execute the <strong>run.sh</strong> script in the <a href="https://github.com/apache/skywalking-go/tree/ce406811e49c5366fa39a478e5e6a3c8064eb808/test/plugins">test/plugins directory</a> and pass in the name of the plugin you wrote (the folder name). At this point, the script would read the configuration file of the plugin test and create a workspace directory in this location for temporarily storing files generated by each plugin. Finally, it would start the test code and validate the data sequentially according to the supported version information.</p> <p>The script supports the following two parameters:</p> diff --git a/docs/skywalking-go/next/en/setup/docker/index.html b/docs/skywalking-go/next/en/setup/docker/index.html index 596f6be3d3f..537acc32c71 100644 --- a/docs/skywalking-go/next/en/setup/docker/index.html +++ b/docs/skywalking-go/next/en/setup/docker/index.html @@ -539,7 +539,7 @@ Customized Dockerfile Using the SkyWalking Go provided image as the base image, })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/en/setup/gobuild/index.html b/docs/skywalking-go/next/en/setup/gobuild/index.html index f755d43ec95..6e02f684b16 100644 --- a/docs/skywalking-go/next/en/setup/gobuild/index.html +++ b/docs/skywalking-go/next/en/setup/gobuild/index.html @@ -545,7 +545,7 @@ Please execute the following command, which would automatically import SkyWalkin })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/docs/skywalking-go/next/readme/index.html b/docs/skywalking-go/next/readme/index.html index dbb472cb685..ae54426936c 100644 --- a/docs/skywalking-go/next/readme/index.html +++ b/docs/skywalking-go/next/readme/index.html @@ -539,7 +539,7 @@ To use SkyWalking Go, simply import the base dependencies into your code and tak })() </script> - <div class="commit-id">Commit Id: 8f09034</div> + <div class="commit-id">Commit Id: ce40681</div> diff --git a/index.json b/index.json index b0b4821e3b5..439226bbce6 100644 --- a/index.json +++ b/index.json @@ -1 +1 @@ -[{"body":"SkyWalking Go 0.5.0 is released. Go to downloads page to find release tars.\n Add go 1.23 support. Remove go 1.16, 1.17, and 1.18 support. Features Add support trace ignore. Enhance the observability of makefile execution. Update the error message if the peer address is empty when creating an exit span. Support enhancement go 1.23. Plugins Support Pulsar MQ. Support Segmentio-Kafka MQ. Support http headers collection for Gin. Support higher versions of grpc. Support go-elas [...] \ No newline at end of file +[{"body":"SkyWalking Go 0.5.0 is released. Go to downloads page to find release tars.\n Add go 1.23 support. Remove go 1.16, 1.17, and 1.18 support. Features Add support trace ignore. Enhance the observability of makefile execution. Update the error message if the peer address is empty when creating an exit span. Support enhancement go 1.23. Plugins Support Pulsar MQ. Support Segmentio-Kafka MQ. Support http headers collection for Gin. Support higher versions of grpc. Support go-elas [...] \ No newline at end of file