Skip to content

Install

Pick your language. Every package has the same API; only the naming follows each language's conventions (see Compatibility for runtime versions).

Node.js 22.12 or newer (ESM and CommonJS).

npm install @grow-codes/apache-skywalking

Optional peer dependencies are only needed for the adapters you use (for example pino, winston, express, fastify).

Rust 1.88 or newer (edition 2021), tokio runtime.

cargo add grow-apache-skywalking
cargo add tokio --features macros,rt-multi-thread

Cargo features:

  • blocking — synchronous blocking::SkyWalkingClient
  • testing — in-memory fakes and the conformance runner
  • tracing-layer, log-bridge (default) — tracing and log adapters for the log client
  • tower, reqwest-middleware — HTTP server and client tracing adapters

Go 1.26 or newer. The module lives in the go/ folder of the repository; the package name is skywalking.

go get github.com/grow-codes-packages/apache-skywalking/go@latest
import skywalking "github.com/grow-codes-packages/apache-skywalking/go"

Python 3.10 or newer.

pip install grow-apache-skywalking

Extras add optional integrations, for example pip install "grow-apache-skywalking[all]".

Java 17 or newer.

<dependency>
  <groupId>codes.grow.packages</groupId>
  <artifactId>apache-skywalking</artifactId>
  <version>0.1.0</version>
</dependency>

Gradle: implementation("codes.grow.packages:apache-skywalking:0.1.0").

Verify the installation

Run the Quickstart against a running Apache SkyWalking. To start one locally with the same image the tests use:

docker run --rm -p 12800:12800 apache/skywalking-oap-server + apache/skywalking-ui:10.4.0 + BanyanDB

The service may need extra settings to start (see docker/compose.yml in the repository).

Versions

Packages follow Semantic Versioning. Before 1.0, minor versions may contain breaking changes; they are listed in each package's CHANGELOG.md. The five packages are released together from one release pull request, so the same version number means the same API.