Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterDebugServer(s grpc.ServiceRegistrar, srv DebugServer)
- type DebugClient
- type DebugServer
- type GetInfoRequest
- type GetInfoResponse
- func (*GetInfoResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetInfoResponse) GetCachedJwtSvidsCount() int32
- func (x *GetInfoResponse) GetCachedSvidstoreX509SvidsCount() int32
- func (x *GetInfoResponse) GetCachedX509SvidsCount() int32
- func (x *GetInfoResponse) GetLastSyncSuccess() int64
- func (x *GetInfoResponse) GetSvidChain() []*GetInfoResponse_Cert
- func (x *GetInfoResponse) GetSvidsCount() int32deprecated
- func (x *GetInfoResponse) GetUptime() int32
- func (*GetInfoResponse) ProtoMessage()
- func (x *GetInfoResponse) ProtoReflect() protoreflect.Message
- func (x *GetInfoResponse) Reset()
- func (x *GetInfoResponse) String() string
- type GetInfoResponse_Cert
- func (*GetInfoResponse_Cert) Descriptor() ([]byte, []int)deprecated
- func (x *GetInfoResponse_Cert) GetExpiresAt() int64
- func (x *GetInfoResponse_Cert) GetId() *types.SPIFFEID
- func (x *GetInfoResponse_Cert) GetSubject() string
- func (*GetInfoResponse_Cert) ProtoMessage()
- func (x *GetInfoResponse_Cert) ProtoReflect() protoreflect.Message
- func (x *GetInfoResponse_Cert) Reset()
- func (x *GetInfoResponse_Cert) String() string
- type UnimplementedDebugServer
- type UnsafeDebugServer
Constants ¶
const (
Debug_GetInfo_FullMethodName = "/spire.agent.debug.v1.Debug/GetInfo"
)
Variables ¶
var Debug_ServiceDesc = grpc.ServiceDesc{ ServiceName: "spire.agent.debug.v1.Debug", HandlerType: (*DebugServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetInfo", Handler: _Debug_GetInfo_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "spire/api/agent/debug/v1/debug.proto", }
Debug_ServiceDesc is the grpc.ServiceDesc for Debug service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_spire_api_agent_debug_v1_debug_proto protoreflect.FileDescriptor
Functions ¶
func RegisterDebugServer ¶
func RegisterDebugServer(s grpc.ServiceRegistrar, srv DebugServer)
Types ¶
type DebugClient ¶
type DebugClient interface {
// Get information about SPIRE agent
GetInfo(ctx context.Context, in *GetInfoRequest, opts ...grpc.CallOption) (*GetInfoResponse, error)
}
DebugClient is the client API for Debug service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewDebugClient ¶
func NewDebugClient(cc grpc.ClientConnInterface) DebugClient
type DebugServer ¶
type DebugServer interface {
// Get information about SPIRE agent
GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
// contains filtered or unexported methods
}
DebugServer is the server API for Debug service. All implementations must embed UnimplementedDebugServer for forward compatibility.
type GetInfoRequest ¶
type GetInfoRequest struct {
// contains filtered or unexported fields
}
func (*GetInfoRequest) Descriptor
deprecated
func (*GetInfoRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetInfoRequest.ProtoReflect.Descriptor instead.
func (*GetInfoRequest) ProtoMessage ¶
func (*GetInfoRequest) ProtoMessage()
func (*GetInfoRequest) ProtoReflect ¶
func (x *GetInfoRequest) ProtoReflect() protoreflect.Message
func (*GetInfoRequest) Reset ¶
func (x *GetInfoRequest) Reset()
func (*GetInfoRequest) String ¶
func (x *GetInfoRequest) String() string
type GetInfoResponse ¶
type GetInfoResponse struct {
// Agent SVID chain
SvidChain []*GetInfoResponse_Cert `protobuf:"bytes,1,rep,name=svid_chain,json=svidChain,proto3" json:"svid_chain,omitempty"`
// Agent uptime in seconds
Uptime int32 `protobuf:"varint,2,opt,name=uptime,proto3" json:"uptime,omitempty"`
// Number of SVIDs cached in memory
// Deprecated in favor of cached_x509_svids_count, cached_jwt_svids_count, and cached_svidstore_x509_svids_count
//
// Deprecated: Marked as deprecated in spire/api/agent/debug/v1/debug.proto.
SvidsCount int32 `protobuf:"varint,3,opt,name=svids_count,json=svidsCount,proto3" json:"svids_count,omitempty"`
// last successful sync with server (in seconds since unix epoch)
LastSyncSuccess int64 `protobuf:"varint,4,opt,name=last_sync_success,json=lastSyncSuccess,proto3" json:"last_sync_success,omitempty"`
// Number of X.509-SVIDs in Agent primary in-memory cache
CachedX509SvidsCount int32 `` /* 126-byte string literal not displayed */
// Number of JWT-SVIDs in Agent primary in-memory cache
CachedJwtSvidsCount int32 `protobuf:"varint,6,opt,name=cached_jwt_svids_count,json=cachedJwtSvidsCount,proto3" json:"cached_jwt_svids_count,omitempty"`
// Number of X.509-SVIDs in Agent svidstore in-memory cache
CachedSvidstoreX509SvidsCount int32 `` /* 155-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*GetInfoResponse) Descriptor
deprecated
func (*GetInfoResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetInfoResponse.ProtoReflect.Descriptor instead.
func (*GetInfoResponse) GetCachedJwtSvidsCount ¶ added in v1.10.4
func (x *GetInfoResponse) GetCachedJwtSvidsCount() int32
func (*GetInfoResponse) GetCachedSvidstoreX509SvidsCount ¶ added in v1.10.4
func (x *GetInfoResponse) GetCachedSvidstoreX509SvidsCount() int32
func (*GetInfoResponse) GetCachedX509SvidsCount ¶ added in v1.10.4
func (x *GetInfoResponse) GetCachedX509SvidsCount() int32
func (*GetInfoResponse) GetLastSyncSuccess ¶
func (x *GetInfoResponse) GetLastSyncSuccess() int64
func (*GetInfoResponse) GetSvidChain ¶
func (x *GetInfoResponse) GetSvidChain() []*GetInfoResponse_Cert
func (*GetInfoResponse) GetSvidsCount
deprecated
func (x *GetInfoResponse) GetSvidsCount() int32
Deprecated: Marked as deprecated in spire/api/agent/debug/v1/debug.proto.
func (*GetInfoResponse) GetUptime ¶
func (x *GetInfoResponse) GetUptime() int32
func (*GetInfoResponse) ProtoMessage ¶
func (*GetInfoResponse) ProtoMessage()
func (*GetInfoResponse) ProtoReflect ¶
func (x *GetInfoResponse) ProtoReflect() protoreflect.Message
func (*GetInfoResponse) Reset ¶
func (x *GetInfoResponse) Reset()
func (*GetInfoResponse) String ¶
func (x *GetInfoResponse) String() string
type GetInfoResponse_Cert ¶
type GetInfoResponse_Cert struct {
// Cerfificate SPIFFE ID
Id *types.SPIFFEID `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Expiration time
ExpiresAt int64 `protobuf:"varint,2,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
// Subject
Subject string `protobuf:"bytes,3,opt,name=subject,proto3" json:"subject,omitempty"`
// contains filtered or unexported fields
}
func (*GetInfoResponse_Cert) Descriptor
deprecated
func (*GetInfoResponse_Cert) Descriptor() ([]byte, []int)
Deprecated: Use GetInfoResponse_Cert.ProtoReflect.Descriptor instead.
func (*GetInfoResponse_Cert) GetExpiresAt ¶
func (x *GetInfoResponse_Cert) GetExpiresAt() int64
func (*GetInfoResponse_Cert) GetId ¶
func (x *GetInfoResponse_Cert) GetId() *types.SPIFFEID
func (*GetInfoResponse_Cert) GetSubject ¶
func (x *GetInfoResponse_Cert) GetSubject() string
func (*GetInfoResponse_Cert) ProtoMessage ¶
func (*GetInfoResponse_Cert) ProtoMessage()
func (*GetInfoResponse_Cert) ProtoReflect ¶
func (x *GetInfoResponse_Cert) ProtoReflect() protoreflect.Message
func (*GetInfoResponse_Cert) Reset ¶
func (x *GetInfoResponse_Cert) Reset()
func (*GetInfoResponse_Cert) String ¶
func (x *GetInfoResponse_Cert) String() string
type UnimplementedDebugServer ¶
type UnimplementedDebugServer struct{}
UnimplementedDebugServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedDebugServer) GetInfo ¶
func (UnimplementedDebugServer) GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
type UnsafeDebugServer ¶
type UnsafeDebugServer interface {
// contains filtered or unexported methods
}
UnsafeDebugServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DebugServer will result in compilation errors.