env

Documentation

Overview

Package env contains the environment that stenographer will set up and run. This is the main part of the stenographer server, setting up stenotype's environment and running it, and serving all HTTP requests.

Index

• type Env
  • func New(c config.Config) (_ *Env, returnedErr error)
  • func (d *Env) Close() error
  • func (d *Env) ExportDebugHandlers(mux *http.ServeMux)
  • func (d *Env) Lookup(ctx context.Context, q query.Query) *base.PacketChan
  • func (d *Env) MinLastFileSeen() time.Time
  • func (d *Env) Path() string
  • func (d *Env) RunStenotype()
  • func (e *Env) Serve() error

Types

type Env

type Env struct {

	// StenotypeOutput is the writer that stenotype STDOUT/STDERR will be
	// redirected to.
	StenotypeOutput io.Writer
	// contains filtered or unexported fields
}

Env contains information necessary to run Stenotype.

func New

func New(c config.Config) (_ *Env, returnedErr error)

New returns a new Env for use in running Stenotype.

func (*Env) Close

func (d *Env) Close() error

Close closes the directory. This should only be done when stenotype has stopped using it. After this call, Env should no longer be used.

func (*Env) ExportDebugHandlers

func (d *Env) ExportDebugHandlers(mux *http.ServeMux)

ExportDebugHandlers exports a few debugging handlers to an HTTP ServeMux.

func (*Env) Lookup

func (d *Env) Lookup(ctx context.Context, q query.Query) *base.PacketChan

Lookup looks up the given query in all blockfiles currently known in this Env.

func (*Env) MinLastFileSeen

func (d *Env) MinLastFileSeen() time.Time

MinLastFileSeen returns the timestamp of the oldest among the newest files created by all threads.

func (*Env) Path

func (d *Env) Path() string

Path returns the underlying directory path for the given Env.

func (*Env) RunStenotype

func (d *Env) RunStenotype()

RunStenotype keeps the stenotype binary running, restarting it if necessary but trying not to allow crash loops.

func (*Env) Serve

func (e *Env) Serve() error

Serve starts up an HTTP server using http.DefaultServerMux to handle requests. This server will server over TLS, using the certs stored in c.CertPath to verify itself to clients and verify clients.