Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewMonitoringError ¶
NewMonitoringError creates and returns a new gRPC monitoring error, wrapped under sharedesec.MonitoringError
Types ¶
type HandlerOperation ¶
type HandlerOperation struct {
dyngo.Operation
Error error
trace.TagsHolder
trace.SecurityEventsHolder
}
HandlerOperation represents a gRPC server handler operation. It must be created with StartHandlerOperation() and finished with its Finish() method. Security events observed during the operation lifetime should be added to the operation using its AddSecurityEvent() method.
func (*HandlerOperation) Finish ¶
func (op *HandlerOperation) Finish(res HandlerOperationRes) []any
Finish the gRPC handler operation, along with the given results, and emit a finish event up in the operation stack.
type HandlerOperationArgs ¶
type HandlerOperationArgs struct {
// Method is the gRPC method name.
// Corresponds to the address `grpc.server.method`.
Method string
// RPC metadata received by the gRPC handler.
// Corresponds to the address `grpc.server.request.metadata`.
Metadata map[string][]string
// ClientIP is the IP address of the client that initiated the gRPC request.
// Corresponds to the address `http.client_ip`.
ClientIP netip.Addr
}
HandlerOperationArgs is the grpc handler arguments.
func (HandlerOperationArgs) IsArgOf ¶
func (HandlerOperationArgs) IsArgOf(*HandlerOperation)
type HandlerOperationRes ¶
type HandlerOperationRes struct{}
HandlerOperationRes is the grpc handler results. Empty as of today.
func (HandlerOperationRes) IsResultOf ¶
func (HandlerOperationRes) IsResultOf(*HandlerOperation)
type MonitoringError ¶
type MonitoringError struct {
// contains filtered or unexported fields
}
MonitoringError is used to vehicle a gRPC error that also embeds a request status code
func (*MonitoringError) Error ¶
func (e *MonitoringError) Error() string
Error implements the error interface
func (*MonitoringError) GRPCStatus ¶
func (e *MonitoringError) GRPCStatus() uint32
GRPCStatus returns the gRPC status code embedded in the error
type ReceiveOperation ¶
ReceiveOperation type representing an gRPC server handler operation. It must be created with StartReceiveOperation() and finished with its Finish().
func (ReceiveOperation) Finish ¶
func (op ReceiveOperation) Finish(res ReceiveOperationRes)
Finish the gRPC handler operation, along with the given results, and emits a finish event up in the operation stack.
type ReceiveOperationArgs ¶
type ReceiveOperationArgs struct{}
ReceiveOperationArgs is the gRPC handler receive operation arguments Empty as of today.
func (ReceiveOperationArgs) IsArgOf ¶
func (ReceiveOperationArgs) IsArgOf(ReceiveOperation)
type ReceiveOperationRes ¶
type ReceiveOperationRes struct {
// Message received by the gRPC handler.
// Corresponds to the address `grpc.server.request.message`.
Message interface{}
}
ReceiveOperationRes is the gRPC handler receive operation results which contains the message the gRPC handler received.
func (ReceiveOperationRes) IsResultOf ¶
func (ReceiveOperationRes) IsResultOf(ReceiveOperation)
Source Files