spinframework / spinframework/spin

Expose an Admin API

Open
#528 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
6.5k
Forks
310
Avg merge
1d 20h
Merged PRs (30d)
24

Description

Spin keeps its logs and manifest on the filesystem, which makes them opaque to anything outside system its hosted on. Could we expose an API for administration of Spin apps? I think it would be an aliasable route, and flagged off by default. Maybe on a path like http://localhost:3000/_spin/?

I don't know what the shape of this API would be, but for my purposes something like

  1. /logs/:id?stdout&stderr - Exposes the logs of any component as a service, something like HTTPAppender
  2. / - Exposes the manifest as JSON

... would do the job!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review Spin's existing application routing and the filesystem handling for logs and manifests. The proposed entry points are /_spin/, /logs/:id, and /, with administration disabled by default, but the API shape and scope still need to be defined. Done means an agreed administration API design and an implementation plan with clear behavior for routes, access, and opt-in configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, wasm
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.