https://github.com/skyapm/vantage-studio
Vantage Studio is an advanced UI for SkyWalking OAP management
https://github.com/skyapm/vantage-studio
apm observability skywalking
Last synced: 23 days ago
JSON representation
Vantage Studio is an advanced UI for SkyWalking OAP management
- Host: GitHub
- URL: https://github.com/skyapm/vantage-studio
- Owner: SkyAPM
- License: apache-2.0
- Created: 2026-04-25T13:50:11.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-11T13:42:28.000Z (about 2 months ago)
- Last Synced: 2026-05-28T23:41:47.160Z (29 days ago)
- Topics: apm, observability, skywalking
- Language: TypeScript
- Homepage:
- Size: 1.31 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
# Vantage Studio
A web admin for Apache SkyWalking's runtime-rule hot-update system —
browse, edit, and push MAL / LAL rules without restarting the OAP
cluster.
[](https://github.com/wu-sheng/vantage-studio/actions/workflows/ci.yml)
[](LICENSE)
## What it is
Vantage Studio is an **extension** of Apache SkyWalking, not a fork.
It runs as a separate process (Docker image) and talks to the OAP
server's runtime-rule admin HTTP port (default `17128`) plus the
upstream status APIs on the query port (`12800`). It adds the things
SkyWalking's runtime-rule receiver intentionally doesn't ship:
- A login + RBAC layer in front of an admin port that has none today.
- A pixel-careful UI for browsing rule catalogs (`otel-rules`,
`log-mal-rules`, `lal`), editing YAML with Monaco + bundled MAL/LAL
DSL grammar autocomplete, and pushing via `addOrUpdate` /
`inactivate` / `delete`.
- Cluster status across every OAP node, dump (`tar.gz`) of the live
ruleset, and the destructive-confirm gate for `allowStorageChange`
and `revertToBundled`.
## Quick start
```bash
git clone https://github.com/wu-sheng/vantage-studio
cd vantage-studio
make compose-up
```
Visit ; login `admin` / `vantage-changeme`.
> Replace the default password by editing the `studio.yaml` that
> lives in the `studio-data` volume — see
> [`docs/auth.md`](docs/auth.md) for the `vsadmin:hash` workflow.
> See [`docs/install.md`](docs/install.md) for the OAP image build
> step needed until SWIP-13 lands in a tagged SkyWalking release.
## Documentation
**Get started**
- [`docs/install.md`](docs/install.md) — demo `docker compose` stack
(Studio + OAP + BanyanDB) and the OAP module selectors Studio
depends on.
- [`docs/compatibility.md`](docs/compatibility.md) — required
SkyWalking version (10.5.0+) and the ports Studio talks to.
**Configure**
- [`docs/docker.md`](docs/docker.md) — running the image: env vars,
volumes, override patterns (mount the file, point `STUDIO_CONFIG`
elsewhere, layer secrets), Kubernetes manifests, reverse-proxy /
TLS notes, reload + restart semantics.
- [`docs/configure.md`](docs/configure.md) — `studio.yaml` schema
reference: every key, every default, every constraint.
- [`docs/auth.md`](docs/auth.md) — local auth, optional RBAC + verb
table, audit log JSONL shape, deferred LDAP / OIDC plan.
**Operate**
- [`docs/operator-workflows.md`](docs/operator-workflows.md) — push
a rule, recover from a broken push, inspect cluster convergence,
take a dump, the inactivate / delete / revert-to-bundled
semantics.
**Reference**
- [`CHANGELOG.md`](CHANGELOG.md) — release notes.
- [`branding/README.md`](branding/README.md) — logo assets + how
they're sized for app shell, favicon, and marketing.
## Repository layout
```
vantage-studio/
├── apps/
│ ├── ui/ # Vue 3 + Vite SPA
│ └── bff/ # Fastify TypeScript BFF
├── packages/
│ ├── api-client/ # typed wrappers for the OAP runtime-rule REST surface
│ └── design-tokens/ # rrDark + RR_FONT_* + spacing scale
├── deploy/
│ └── docker/ # Dockerfile + docker-compose.yml + studio.yaml.example
├── docs/ # operator documentation
├── scripts/ # license-header check
├── Makefile # make compose-up / make image / make check
└── .github/workflows/ # ci.yml + release.yml
```
## Releases
Releases are cut by GitHub Actions, not by hand. Push a `vX.Y.Z` tag
(or run the `Release` workflow manually) and the
[release.yml](.github/workflows/release.yml) job builds the image,
publishes `ghcr.io/:` + `:latest`, signs both with
cosign keyless, and attaches a CycloneDX SBOM attestation. Commit
images for `main` are published by [ci.yml](.github/workflows/ci.yml)
under `:sha-` / `:main`.
## License
Apache License 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
Apache, Apache SkyWalking, and SkyWalking are trademarks of The
Apache Software Foundation. Vantage Studio is an independent
extension and is not endorsed by the ASF.