Skip to content

Apache SkyWalking SDK

Grow Codes CI License

One API for Apache SkyWalking in five languages: TypeScript, Rust, Go, Python and Java. Every package has the same functions, options, defaults, error codes and behaviour, tested against a real apache/skywalking-oap-server:10.4.0 with BanyanDB 0.10.3 in Docker. OAP needs SW_RECEIVER_ZIPKIN + SW_QUERY_ZIPKIN=default for OTLP spans to be readable; see Compatibility.

Language Package Coverage
TypeScript @grow-codes/apache-skywalking TypeScript coverage
Rust grow-apache-skywalking Rust coverage
Go github.com/grow-codes-packages/apache-skywalking/go Go coverage
Python grow-apache-skywalking Python coverage
Java codes.grow.packages:apache-skywalking Java coverage

What you get

  • Client for one OAP server: health, ping, server version, raw GraphQL (Client and status).
  • Query API over GraphQL: services, endpoints, instances, native traces, logs and topology (Query API).
  • Trace queries (TraceQueryClient) over both OAP trace stores: OTLP spans through the Zipkin query API and SkyWalking agent traces through GraphQL, native ids kept verbatim (Trace queries).
  • Tracing: OpenTelemetry setup exporting OTLP/gRPC to OAP (port 11800), span helpers, framework adapters and an sw8 propagator next to W3C (Tracing setup and sw8, Tracing).
  • Logging: batching log client to OAP's native /v3/logs API, correlated with the active trace, and log search with client-side free-text matching (Logs, Logging).
  • Configuration from code or GROW_APACHE_SKYWALKING_*, SW_* and OTEL_EXPORTER_OTLP_* variables, immutable and validated (Configuration).
  • Retries with full-jitter backoff and Retry-After, connect/request/total timeouts and cancellation in every language; typed errors with one set of codes (Error handling).
  • Redaction everywhere: the OAP token and gateway headers never appear in errors, logs, hooks or toString (Redaction).

Start with Install and the Quickstart.

Independent project

This SDK is made by Grow Codes. Apache SkyWalking is a trademark of The Apache Software Foundation. This project is not affiliated with or endorsed by The Apache Software Foundation. See License & disclaimer.