admin

Documentation

Index

• func NewService(log logging.Logger, chainManager chains.Manager, httpServer *api.Server) (*common.HTTPHandler, error)
• type Admin
  • func (service *Admin) Alias(_ *http.Request, args *AliasArgs, reply *api.SuccessResponse) error
  • func (service *Admin) AliasChain(_ *http.Request, args *AliasChainArgs, reply *api.SuccessResponse) error
  • func (service *Admin) GetChainAliases(r *http.Request, args *GetChainAliasesArgs, reply *GetChainAliasesReply) error
  • func (service *Admin) LockProfile(_ *http.Request, _ *struct{}, reply *api.SuccessResponse) error
  • func (service *Admin) MemoryProfile(_ *http.Request, _ *struct{}, reply *api.SuccessResponse) error
  • func (service *Admin) Stacktrace(_ *http.Request, _ *struct{}, reply *StacktraceReply) error
  • func (service *Admin) StartCPUProfiler(_ *http.Request, _ *struct{}, reply *api.SuccessResponse) error
  • func (service *Admin) StopCPUProfiler(_ *http.Request, _ *struct{}, reply *api.SuccessResponse) error
• type AliasArgs
• type AliasChainArgs
• type GetChainAliasesArgs
• type GetChainAliasesReply
• type Performance
  • func (p *Performance) LockProfile() error
  • func (p *Performance) MemoryProfile() error
  • func (p *Performance) StartCPUProfiler() error
  • func (p *Performance) StopCPUProfiler() error
• type StacktraceReply

Functions

func NewService

func NewService(log logging.Logger, chainManager chains.Manager, httpServer *api.Server) (*common.HTTPHandler, error)

NewService returns a new admin API service

Types

type Admin

type Admin struct {
	// contains filtered or unexported fields
}

Admin is the API service for node admin management

func (*Admin) Alias

func (service *Admin) Alias(_ *http.Request, args *AliasArgs, reply *api.SuccessResponse) error

Alias attempts to alias an HTTP endpoint to a new name

func (*Admin) AliasChain

func (service *Admin) AliasChain(_ *http.Request, args *AliasChainArgs, reply *api.SuccessResponse) error

AliasChain attempts to alias a chain to a new name

func (*Admin) GetChainAliases

func (service *Admin) GetChainAliases(r *http.Request, args *GetChainAliasesArgs, reply *GetChainAliasesReply) error

GetChainAliases returns the aliases of the chain whose string representation is [args.ChainID]

func (*Admin) LockProfile

func (service *Admin) LockProfile(_ *http.Request, _ *struct{}, reply *api.SuccessResponse) error

LockProfile runs a mutex profile writing to the specified file

func (*Admin) MemoryProfile

func (service *Admin) MemoryProfile(_ *http.Request, _ *struct{}, reply *api.SuccessResponse) error

MemoryProfile runs a memory profile writing to the specified file

func (*Admin) Stacktrace

func (service *Admin) Stacktrace(_ *http.Request, _ *struct{}, reply *StacktraceReply) error

Stacktrace returns the current global stacktrace

func (*Admin) StartCPUProfiler

func (service *Admin) StartCPUProfiler(_ *http.Request, _ *struct{}, reply *api.SuccessResponse) error

StartCPUProfiler starts a cpu profile writing to the specified file

func (*Admin) StopCPUProfiler

func (service *Admin) StopCPUProfiler(_ *http.Request, _ *struct{}, reply *api.SuccessResponse) error

StopCPUProfiler stops the cpu profile

type AliasArgs

type AliasArgs struct {
	Endpoint string `json:"endpoint"`
	Alias    string `json:"alias"`
}

AliasArgs are the arguments for calling Alias

type AliasChainArgs

type AliasChainArgs struct {
	Chain string `json:"chain"`
	Alias string `json:"alias"`
}

AliasChainArgs are the arguments for calling AliasChain

type GetChainAliasesArgs

type GetChainAliasesArgs struct{ ChainID string }

GetChainAliasesArgs are the arguments for Admin.GetChainAliases API call

type GetChainAliasesReply

type GetChainAliasesReply struct{ Aliases []string }

GetChainAliasesReply are the arguments for Admin.GetChainAliases API call

type Performance

type Performance struct {
	// contains filtered or unexported fields
}

Performance provides helper methods for measuring the current performance of the system

func (*Performance) LockProfile

func (p *Performance) LockProfile() error

LockProfile dumps the current lock statistics of this node

func (*Performance) MemoryProfile

func (p *Performance) MemoryProfile() error

MemoryProfile dumps the current memory utilization of this node

func (*Performance) StartCPUProfiler

func (p *Performance) StartCPUProfiler() error

StartCPUProfiler starts measuring the cpu utilization of this node

func (*Performance) StopCPUProfiler

func (p *Performance) StopCPUProfiler() error

StopCPUProfiler stops measuring the cpu utilization of this node

type StacktraceReply

type StacktraceReply struct {
	Stacktrace string `json:"stacktrace"`
}

StacktraceReply are the results from calling Stacktrace