glutton

package

v0.2.0 Latest Latest Go to latest Published: Sep 25, 2026 License: Apache-2.0 Imports: 29 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/agent-substrate/substrate

Links

Open Source Insights

Documentation ¶

Overview ¶

Package glutton implements the benchmarking workload served by cmd/benchmarking/glutton: an API for consuming RAM, disk, and file descriptors, and for gossiping with other glutton instances, over either gRPC or protobuf-over-HTTP. See internal/proto/glutton/glutton.proto.

Index ¶

Constants
func Handler(mode string, svc *Service) (http.Handler, error)
func NewServer(handler http.Handler) *http.Server
type Service
- func New(dir string) (*Service, error)

Constants ¶

View Source

const (
	ModeGRPC = "grpc"
	ModeHTTP = "http"
)

Wire modes the main listener can serve, selected by the binary's --mode flag.

View Source

const (
	ReadyzRoute    = "/readyz"
	PingRoute      = "/ping"
	WriteDiskRoute = "/writedisk"
	ReadDiskRoute  = "/readdisk"
	WriteRAMRoute  = "/writeram"
	ReadRAMRoute   = "/readram"
)

Routes the HTTP-mode mux serves. ReadyzRoute is served in both modes: ateom blocks RestoreWorkload until it answers 200, so ResumeActor cannot report success before the listener is reachable. The fake in ./fake aliases these, which is what keeps the stand-in and the real mux from drifting apart.

View Source

const Name = "glutton"

Name is the workload's identity to the telemetry SDK: the tracer and meter scope, and the service name the binary reports. Instrument names are written out in full at each call site so they match docs/metrics/registry/metrics.yaml literally.

Variables ¶

This section is empty.

Functions ¶

func Handler ¶

func Handler(mode string, svc *Service) (http.Handler, error)

Handler builds the request handler for the given wire mode. ModeGRPC serves gRPC alongside the wakeup probe on a single listener; ModeHTTP serves the protobuf-over-HTTP route table. An unknown mode comes back as an error so the caller decides how to fail.

func NewServer ¶

func NewServer(handler http.Handler) *http.Server

NewServer enables unencrypted HTTP/2 so gRPC works on the plaintext listener, alongside HTTP/1.1 for the wakeup probe.

Types ¶

type Service ¶

type Service struct {
	gluttonpb.UnimplementedGluttonServer
	// contains filtered or unexported fields
}

func New ¶

func New(dir string) (*Service, error)

New constructs a Service storing WriteDisk files under dir and registers its otel instruments. The caller is responsible for creating dir and for calling Close to stop any running gossip goroutines.

func (*Service) Close ¶

func (s *Service) Close()

Close cancels every running gossip goroutine and waits for them to exit.

func (*Service) Gossip ¶

func (s *Service) Gossip(_ context.Context, req *gluttonpb.GossipRequest) (*gluttonpb.GossipResponse, error)

Sends network traffic to a peer glutton. Messages will be sent on regular intervals separated by delay_ms.

func (*Service) OpenFD ¶

func (s *Service) OpenFD(_ context.Context, req *gluttonpb.OpenFDRequest) (*gluttonpb.OpenFDResponse, error)

Make sure it has the specified number of file descriptors open. It will open or close file descriptors to hit the desired count (note this count is in addition to the other FDs needed to run the process).

func (*Service) Ping ¶

func (s *Service) Ping(ctx context.Context, req *gluttonpb.PingRequest) (*gluttonpb.PingResponse, error)

Receive a ping request, echoing the same response back.

func (*Service) ReadDisk ¶

func (s *Service) ReadDisk(ctx context.Context, req *gluttonpb.ReadDiskRequest) (*gluttonpb.ReadDiskResponse, error)

func (*Service) ReadRAM ¶

func (s *Service) ReadRAM(ctx context.Context, req *gluttonpb.ReadRAMRequest) (*gluttonpb.ReadRAMResponse, error)

Walk RAM previously written by WriteRAM, reading one byte per page so every touched page must be resident before the response returns. After a demand-paged restore this converts restore-time laziness into measurable read latency.

func (*Service) WriteDisk ¶

func (s *Service) WriteDisk(ctx context.Context, req *gluttonpb.WriteDiskRequest) (*gluttonpb.WriteDiskResponse, error)

Write to disk using the specified mode. Data written will be random bytes.

func (*Service) WriteRAM ¶

func (s *Service) WriteRAM(ctx context.Context, req *gluttonpb.WriteRAMRequest) (*gluttonpb.WriteRAMResponse, error)

Write to RAM, either overwriting previously-used RAM or allocating additional RAM per request instructions. Data written will be random bytes.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
fake Package fake provides an httptest-backed stand-in for a glutton actor.	Package fake provides an httptest-backed stand-in for a glutton actor.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL