state

package
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 7, 2020 License: GPL-3.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthService        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowService          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupService = fmt.Errorf("proto: unexpected end of group")
)

Functions

func RegisterStatusServer 

func RegisterStatusServer(s *grpc.Server, srv StatusServer)

Types

type DumpRequest 

type DumpRequest struct {
	// RequestMetaHeader contains information about request meta headers (should be embedded into message)
	service.RequestMetaHeader `protobuf:"bytes,98,opt,name=Meta,proto3,embedded=Meta" json:"Meta"`
	// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
	service.RequestVerificationHeader `protobuf:"bytes,99,opt,name=Verify,proto3,embedded=Verify" json:"Verify"`
	XXX_NoUnkeyedLiteral              struct{} `json:"-"`
	XXX_unrecognized                  []byte   `json:"-"`
	XXX_sizecache                     int32    `json:"-"`
}

DumpRequest message to fetch current server config.

func (*DumpRequest) Descriptor 

func (*DumpRequest) Descriptor() ([]byte, []int)

func (*DumpRequest) Marshal 

func (m *DumpRequest) Marshal() (dAtA []byte, err error)

func (*DumpRequest) MarshalTo 

func (m *DumpRequest) MarshalTo(dAtA []byte) (int, error)

func (*DumpRequest) MarshalToSizedBuffer 

func (m *DumpRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DumpRequest) ProtoMessage 

func (*DumpRequest) ProtoMessage()

func (*DumpRequest) Reset 

func (m *DumpRequest) Reset()

func (*DumpRequest) Size 

func (m *DumpRequest) Size() (n int)

func (*DumpRequest) String 

func (m *DumpRequest) String() string

func (*DumpRequest) Unmarshal 

func (m *DumpRequest) Unmarshal(dAtA []byte) error

func (*DumpRequest) XXX_DiscardUnknown 

func (m *DumpRequest) XXX_DiscardUnknown()

func (*DumpRequest) XXX_Marshal 

func (m *DumpRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DumpRequest) XXX_Merge 

func (m *DumpRequest) XXX_Merge(src proto.Message)

func (*DumpRequest) XXX_Size 

func (m *DumpRequest) XXX_Size() int

func (*DumpRequest) XXX_Unmarshal 

func (m *DumpRequest) XXX_Unmarshal(b []byte) error

type DumpResponse 

type DumpResponse struct {
	Config               []byte   `protobuf:"bytes,1,opt,name=Config,proto3" json:"Config,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

DumpResponse message contains current server config. Config stored in JSON encoded into slice of bytes.

func EncodeConfig 

func EncodeConfig(v *viper.Viper) (*DumpResponse, error)

EncodeConfig encodes viper settings into DumpConfig message, if something went wrong returns gRPC Status error (can be returned from service).

func (*DumpResponse) Descriptor 

func (*DumpResponse) Descriptor() ([]byte, []int)

func (*DumpResponse) GetConfig 

func (m *DumpResponse) GetConfig() []byte

func (*DumpResponse) Marshal 

func (m *DumpResponse) Marshal() (dAtA []byte, err error)

func (*DumpResponse) MarshalTo 

func (m *DumpResponse) MarshalTo(dAtA []byte) (int, error)

func (*DumpResponse) MarshalToSizedBuffer 

func (m *DumpResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DumpResponse) ProtoMessage 

func (*DumpResponse) ProtoMessage()

func (*DumpResponse) Reset 

func (m *DumpResponse) Reset()

func (*DumpResponse) Size 

func (m *DumpResponse) Size() (n int)

func (*DumpResponse) String 

func (m *DumpResponse) String() string

func (*DumpResponse) Unmarshal 

func (m *DumpResponse) Unmarshal(dAtA []byte) error

func (*DumpResponse) XXX_DiscardUnknown 

func (m *DumpResponse) XXX_DiscardUnknown()

func (*DumpResponse) XXX_Marshal 

func (m *DumpResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DumpResponse) XXX_Merge 

func (m *DumpResponse) XXX_Merge(src proto.Message)

func (*DumpResponse) XXX_Size 

func (m *DumpResponse) XXX_Size() int

func (*DumpResponse) XXX_Unmarshal 

func (m *DumpResponse) XXX_Unmarshal(b []byte) error

type HealthRequest 

type HealthRequest struct {
	// RequestMetaHeader contains information about request meta headers (should be embedded into message)
	service.RequestMetaHeader `protobuf:"bytes,98,opt,name=Meta,proto3,embedded=Meta" json:"Meta"`
	// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
	service.RequestVerificationHeader `protobuf:"bytes,99,opt,name=Verify,proto3,embedded=Verify" json:"Verify"`
	XXX_NoUnkeyedLiteral              struct{} `json:"-"`
	XXX_unrecognized                  []byte   `json:"-"`
	XXX_sizecache                     int32    `json:"-"`
}

HealthRequest message to check current state

func (*HealthRequest) Descriptor 

func (*HealthRequest) Descriptor() ([]byte, []int)

func (*HealthRequest) Marshal 

func (m *HealthRequest) Marshal() (dAtA []byte, err error)

func (*HealthRequest) MarshalTo 

func (m *HealthRequest) MarshalTo(dAtA []byte) (int, error)

func (*HealthRequest) MarshalToSizedBuffer 

func (m *HealthRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*HealthRequest) ProtoMessage 

func (*HealthRequest) ProtoMessage()

func (*HealthRequest) Reset 

func (m *HealthRequest) Reset()

func (*HealthRequest) Size 

func (m *HealthRequest) Size() (n int)

func (*HealthRequest) String 

func (m *HealthRequest) String() string

func (*HealthRequest) Unmarshal 

func (m *HealthRequest) Unmarshal(dAtA []byte) error

func (*HealthRequest) XXX_DiscardUnknown 

func (m *HealthRequest) XXX_DiscardUnknown()

func (*HealthRequest) XXX_Marshal 

func (m *HealthRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HealthRequest) XXX_Merge 

func (m *HealthRequest) XXX_Merge(src proto.Message)

func (*HealthRequest) XXX_Size 

func (m *HealthRequest) XXX_Size() int

func (*HealthRequest) XXX_Unmarshal 

func (m *HealthRequest) XXX_Unmarshal(b []byte) error

type HealthResponse 

type HealthResponse struct {
	// Healthy is true when node alive and healthy
	Healthy bool `protobuf:"varint,1,opt,name=Healthy,proto3" json:"Healthy,omitempty"`
	// Status contains detailed information about health status
	Status               string   `protobuf:"bytes,2,opt,name=Status,proto3" json:"Status,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

HealthResponse message with current state

func (*HealthResponse) Descriptor 

func (*HealthResponse) Descriptor() ([]byte, []int)

func (*HealthResponse) GetHealthy 

func (m *HealthResponse) GetHealthy() bool

func (*HealthResponse) GetStatus 

func (m *HealthResponse) GetStatus() string

func (*HealthResponse) Marshal 

func (m *HealthResponse) Marshal() (dAtA []byte, err error)

func (*HealthResponse) MarshalTo 

func (m *HealthResponse) MarshalTo(dAtA []byte) (int, error)

func (*HealthResponse) MarshalToSizedBuffer 

func (m *HealthResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*HealthResponse) ProtoMessage 

func (*HealthResponse) ProtoMessage()

func (*HealthResponse) Reset 

func (m *HealthResponse) Reset()

func (*HealthResponse) Size 

func (m *HealthResponse) Size() (n int)

func (*HealthResponse) String 

func (m *HealthResponse) String() string

func (*HealthResponse) Unmarshal 

func (m *HealthResponse) Unmarshal(dAtA []byte) error

func (*HealthResponse) XXX_DiscardUnknown 

func (m *HealthResponse) XXX_DiscardUnknown()

func (*HealthResponse) XXX_Marshal 

func (m *HealthResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HealthResponse) XXX_Merge 

func (m *HealthResponse) XXX_Merge(src proto.Message)

func (*HealthResponse) XXX_Size 

func (m *HealthResponse) XXX_Size() int

func (*HealthResponse) XXX_Unmarshal 

func (m *HealthResponse) XXX_Unmarshal(b []byte) error

type MetricFamily 

type MetricFamily = dto.MetricFamily

MetricFamily is type alias for proto.Message generated from github.com/prometheus/client_model/metrics.proto.

func DecodeMetrics 

func DecodeMetrics(r *MetricsResponse) ([]*MetricFamily, error)

DecodeMetrics decodes metrics from MetricsResponse to []MetricFamily, if something went wrong returns error.

type MetricsRequest 

type MetricsRequest struct {
	// RequestMetaHeader contains information about request meta headers (should be embedded into message)
	service.RequestMetaHeader `protobuf:"bytes,98,opt,name=Meta,proto3,embedded=Meta" json:"Meta"`
	// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
	service.RequestVerificationHeader `protobuf:"bytes,99,opt,name=Verify,proto3,embedded=Verify" json:"Verify"`
	XXX_NoUnkeyedLiteral              struct{} `json:"-"`
	XXX_unrecognized                  []byte   `json:"-"`
	XXX_sizecache                     int32    `json:"-"`
}

MetricsRequest message to request node metrics

func (*MetricsRequest) Descriptor 

func (*MetricsRequest) Descriptor() ([]byte, []int)

func (*MetricsRequest) Marshal 

func (m *MetricsRequest) Marshal() (dAtA []byte, err error)

func (*MetricsRequest) MarshalTo 

func (m *MetricsRequest) MarshalTo(dAtA []byte) (int, error)

func (*MetricsRequest) MarshalToSizedBuffer 

func (m *MetricsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*MetricsRequest) ProtoMessage 

func (*MetricsRequest) ProtoMessage()

func (*MetricsRequest) Reset 

func (m *MetricsRequest) Reset()

func (*MetricsRequest) Size 

func (m *MetricsRequest) Size() (n int)

func (*MetricsRequest) String 

func (m *MetricsRequest) String() string

func (*MetricsRequest) Unmarshal 

func (m *MetricsRequest) Unmarshal(dAtA []byte) error

func (*MetricsRequest) XXX_DiscardUnknown 

func (m *MetricsRequest) XXX_DiscardUnknown()

func (*MetricsRequest) XXX_Marshal 

func (m *MetricsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetricsRequest) XXX_Merge 

func (m *MetricsRequest) XXX_Merge(src proto.Message)

func (*MetricsRequest) XXX_Size 

func (m *MetricsRequest) XXX_Size() int

func (*MetricsRequest) XXX_Unmarshal 

func (m *MetricsRequest) XXX_Unmarshal(b []byte) error

type MetricsResponse 

type MetricsResponse struct {
	Metrics              [][]byte `protobuf:"bytes,1,rep,name=Metrics,proto3" json:"Metrics,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

MetricsResponse contains [][]byte, every []byte is marshaled MetricFamily proto message from github.com/prometheus/client_model/metrics.proto

func EncodeMetrics 

func EncodeMetrics(g prometheus.Gatherer) (*MetricsResponse, error)

EncodeMetrics encodes metrics from gatherer into MetricsResponse message, if something went wrong returns gRPC Status error (can be returned from service).

func (*MetricsResponse) Descriptor 

func (*MetricsResponse) Descriptor() ([]byte, []int)

func (*MetricsResponse) GetMetrics 

func (m *MetricsResponse) GetMetrics() [][]byte

func (*MetricsResponse) Marshal 

func (m *MetricsResponse) Marshal() (dAtA []byte, err error)

func (*MetricsResponse) MarshalTo 

func (m *MetricsResponse) MarshalTo(dAtA []byte) (int, error)

func (*MetricsResponse) MarshalToSizedBuffer 

func (m *MetricsResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*MetricsResponse) ProtoMessage 

func (*MetricsResponse) ProtoMessage()

func (*MetricsResponse) Reset 

func (m *MetricsResponse) Reset()

func (*MetricsResponse) Size 

func (m *MetricsResponse) Size() (n int)

func (*MetricsResponse) String 

func (m *MetricsResponse) String() string

func (*MetricsResponse) Unmarshal 

func (m *MetricsResponse) Unmarshal(dAtA []byte) error

func (*MetricsResponse) XXX_DiscardUnknown 

func (m *MetricsResponse) XXX_DiscardUnknown()

func (*MetricsResponse) XXX_Marshal 

func (m *MetricsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetricsResponse) XXX_Merge 

func (m *MetricsResponse) XXX_Merge(src proto.Message)

func (*MetricsResponse) XXX_Size 

func (m *MetricsResponse) XXX_Size() int

func (*MetricsResponse) XXX_Unmarshal 

func (m *MetricsResponse) XXX_Unmarshal(b []byte) error

type NetmapRequest 

type NetmapRequest struct {
	// RequestMetaHeader contains information about request meta headers (should be embedded into message)
	service.RequestMetaHeader `protobuf:"bytes,98,opt,name=Meta,proto3,embedded=Meta" json:"Meta"`
	// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
	service.RequestVerificationHeader `protobuf:"bytes,99,opt,name=Verify,proto3,embedded=Verify" json:"Verify"`
	XXX_NoUnkeyedLiteral              struct{} `json:"-"`
	XXX_unrecognized                  []byte   `json:"-"`
	XXX_sizecache                     int32    `json:"-"`
}

NetmapRequest message to request current node netmap

func (*NetmapRequest) Descriptor 

func (*NetmapRequest) Descriptor() ([]byte, []int)

func (*NetmapRequest) Marshal 

func (m *NetmapRequest) Marshal() (dAtA []byte, err error)

func (*NetmapRequest) MarshalTo 

func (m *NetmapRequest) MarshalTo(dAtA []byte) (int, error)

func (*NetmapRequest) MarshalToSizedBuffer 

func (m *NetmapRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*NetmapRequest) ProtoMessage 

func (*NetmapRequest) ProtoMessage()

func (*NetmapRequest) Reset 

func (m *NetmapRequest) Reset()

func (*NetmapRequest) Size 

func (m *NetmapRequest) Size() (n int)

func (*NetmapRequest) String 

func (m *NetmapRequest) String() string

func (*NetmapRequest) Unmarshal 

func (m *NetmapRequest) Unmarshal(dAtA []byte) error

func (*NetmapRequest) XXX_DiscardUnknown 

func (m *NetmapRequest) XXX_DiscardUnknown()

func (*NetmapRequest) XXX_Marshal 

func (m *NetmapRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NetmapRequest) XXX_Merge 

func (m *NetmapRequest) XXX_Merge(src proto.Message)

func (*NetmapRequest) XXX_Size 

func (m *NetmapRequest) XXX_Size() int

func (*NetmapRequest) XXX_Unmarshal 

func (m *NetmapRequest) XXX_Unmarshal(b []byte) error

type StatusClient 

type StatusClient interface {
	// Netmap request allows to receive current [bootstrap.SpreadMap](bootstrap.md#bootstrap.SpreadMap)
	Netmap(ctx context.Context, in *NetmapRequest, opts ...grpc.CallOption) (*bootstrap.SpreadMap, error)
	// Metrics request allows to receive metrics in prometheus format
	Metrics(ctx context.Context, in *MetricsRequest, opts ...grpc.CallOption) (*MetricsResponse, error)
	// HealthCheck request allows to check health status of the node.
	// If node unhealthy field Status would contains detailed info.
	HealthCheck(ctx context.Context, in *HealthRequest, opts ...grpc.CallOption) (*HealthResponse, error)
	// DumpConfig request allows dumping settings for the current node.
	// To permit access, used server config options.
	// The request should be signed.
	DumpConfig(ctx context.Context, in *DumpRequest, opts ...grpc.CallOption) (*DumpResponse, error)
}

StatusClient is the client API for Status service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewStatusClient 

func NewStatusClient(cc *grpc.ClientConn) StatusClient

type StatusServer 

type StatusServer interface {
	// Netmap request allows to receive current [bootstrap.SpreadMap](bootstrap.md#bootstrap.SpreadMap)
	Netmap(context.Context, *NetmapRequest) (*bootstrap.SpreadMap, error)
	// Metrics request allows to receive metrics in prometheus format
	Metrics(context.Context, *MetricsRequest) (*MetricsResponse, error)
	// HealthCheck request allows to check health status of the node.
	// If node unhealthy field Status would contains detailed info.
	HealthCheck(context.Context, *HealthRequest) (*HealthResponse, error)
	// DumpConfig request allows dumping settings for the current node.
	// To permit access, used server config options.
	// The request should be signed.
	DumpConfig(context.Context, *DumpRequest) (*DumpResponse, error)
}

StatusServer is the server API for Status service.

type UnimplementedStatusServer 

type UnimplementedStatusServer struct {
}

UnimplementedStatusServer can be embedded to have forward compatible implementations.

func (*UnimplementedStatusServer) DumpConfig 

func (*UnimplementedStatusServer) DumpConfig(ctx context.Context, req *DumpRequest) (*DumpResponse, error)

func (*UnimplementedStatusServer) HealthCheck 

func (*UnimplementedStatusServer) HealthCheck(ctx context.Context, req *HealthRequest) (*HealthResponse, error)

func (*UnimplementedStatusServer) Metrics 

func (*UnimplementedStatusServer) Metrics(ctx context.Context, req *MetricsRequest) (*MetricsResponse, error)

func (*UnimplementedStatusServer) Netmap 

func (*UnimplementedStatusServer) Netmap(ctx context.Context, req *NetmapRequest) (*bootstrap.SpreadMap, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.