Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

runtime

package

Go to main page

Versions in this module

v1

v1.1.0

Sep 28, 2026

Changes in this version

type Option

+ func WithApplicationProviders(providers ...locator.Provider) Option

+ func WithClientProviders(http xhttp.Provider, mcp xmcp.Provider) Option

+ func WithRemoteMapper(value *remotecore.Mapper) Option

type Runtime

+ func (r *Runtime) CacheRoute(path string) (spec.RouteRef, bool)

+ func (r *Runtime) CacheRoutes() []*spec.Route

+ func (r *Runtime) CacheTarget(path string) (dexec.ComponentTarget, bool)

+ func (r *Runtime) ClientProviders() []locator.Provider

+ func (r *Runtime) InvalidateCache(ctx context.Context, target dexec.ComponentTarget, view, scope string) ([]dexec.CacheInvalidation, error)

v1.0.0

Sep 22, 2026

Changes in this version

+ type ComponentLoader interface

+ LoadComponent func(context.Context, spec.Key) (*RegisteredComponent, error)

+ type Observability struct

+ Recorder *observability.Recorder

+ func NewObservability(config ObservabilityConfig) (*Observability, error)

+ func (o *Observability) ExportStats() otel.Stats

+ func (o *Observability) Shutdown(ctx context.Context) error

+ func (o *Observability) Stop()

+ type ObservabilityConfig struct

+ Logger xlogger.Logger

+ OTel *otel.Config

+ ReadingData observability.ReadingData

+ type Option func(*options) error

+ func WithExposedPackages(include, exclude []string) Option

+ func WithManagedObservability(owner *Observability) Option

+ func WithObservability(config ObservabilityConfig) Option

+ func WithResourceFS(name string, source fs.FS) Option

+ func WithResources(resources *resource.Store) Option

+ type RegisteredComponent = rregistry.RegisteredComponent

+ type Runtime struct

+ func NewIndexedRuntime(components []*spec.Component, preloaded []*RegisteredComponent, ...) (*Runtime, error)

+ func NewRuntime(components []*RegisteredComponent, runtimeOptions ...Option) (*Runtime, error)

+ func (r *Runtime) AllowedMethodsForPath(path string) []string

+ func (r *Runtime) ComponentTargetByMethodPath(method, path string) (dexec.ComponentTarget, bool)

+ func (r *Runtime) Components() []*spec.Component

+ func (r *Runtime) ExecuteRoute(ctx context.Context, method, path string, scope dexec.ProviderScope) (any, error)

+ func (r *Runtime) ExposesComponent(key spec.Key) bool

+ func (r *Runtime) ExposesMCPComponent(key spec.Key) bool

+ func (r *Runtime) InvokeComponent(ctx context.Context, request dexec.ComponentRequest) (any, error)

+ func (r *Runtime) LoadComponent(ctx context.Context, key spec.Key) (*RegisteredComponent, error)

+ func (r *Runtime) LoadComponents(ctx context.Context, key spec.Key) ([]*RegisteredComponent, error)

+ func (r *Runtime) MatchPathParams(method, path string) (map[string]string, bool)

+ func (r *Runtime) NewAsyncService(config jobs.Config) (*jobs.Service, error)

+ func (r *Runtime) NewWarmup(target dexec.ComponentTarget) (*Warmup, error)

+ func (r *Runtime) Observability() *Observability

+ func (r *Runtime) OutputByRoute(method, path string) (*registry.OutputContract, bool)

+ func (r *Runtime) ReadResource(reference string) ([]byte, error)

+ func (r *Runtime) ResolveComponentRoute(method, path string) (spec.Key, *spec.Route, bool)

+ func (r *Runtime) ResolveOutputByRoute(ctx context.Context, method, path string) (*registry.OutputContract, error)

+ func (r *Runtime) ResourceFS(name string) (fs.FS, bool)

+ func (r *Runtime) Resources() *resource.Store

+ func (r *Runtime) RouteByMethodPath(method, path string) (*spec.Route, bool)

+ func (r *Runtime) Routes() []*spec.Route

+ func (r *Runtime) Shutdown(ctx context.Context) error

+ func (r *Runtime) Warmup(ctx context.Context, target dexec.ComponentTarget) (int, error)

+ func (r *Runtime) WarmupRoute(path string) (spec.RouteRef, bool)

+ func (r *Runtime) WarmupRoutes() []*spec.Route

+ func (r *Runtime) WarmupTarget(path string) (dexec.ComponentTarget, bool)

+ type Warmup struct

+ func (w *Warmup) CredentialHeaders() ([]string, error)

+ func (w *Warmup) PlannedCases() (int, error)

+ func (w *Warmup) Prepare(ctx context.Context, providers ...locator.Provider) (*Warmup, error)

+ func (w *Warmup) Run(ctx context.Context) (int, error)