mirror of
https://github.com/falcosecurity/falco.git
synced 2025-09-02 23:26:24 +00:00
docs(userspace/falco): document output proto messages and service
Co-authored-by: Lorenzo Fontana <lo@linux.com> Signed-off-by: Leonardo Di Donato <leodidonato@gmail.com>
This commit is contained in:
committed by
Leo Di Donato
parent
905379c6da
commit
732965f973
@@ -7,16 +7,24 @@ package falco.output;
|
|||||||
|
|
||||||
option go_package = "github.com/falcosecurity/client-go/pkg/api/output";
|
option go_package = "github.com/falcosecurity/client-go/pkg/api/output";
|
||||||
|
|
||||||
|
// The `subscribe` service defines the RPC call
|
||||||
|
// to perform an output `request` which will lead to obtain an output `response`.
|
||||||
service service {
|
service service {
|
||||||
rpc subscribe(request) returns (stream response);
|
rpc subscribe(request) returns (stream response);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The `request` message is the logical representation of the request model.
|
||||||
|
// It is the input of the `subscribe` service.
|
||||||
|
// It is used to configure the kind of subscription to the gRPC streaming server.
|
||||||
message request {
|
message request {
|
||||||
bool keepalive = 1;
|
bool keepalive = 1;
|
||||||
// string duration = 2; // TODO(leodido, fntlnz): not handled yet but keeping for reference.
|
// string duration = 2; // TODO(leodido, fntlnz): not handled yet but keeping for reference.
|
||||||
// repeated string tags = 3; // TODO(leodido, fntlnz): not handled yet but keeping for reference.
|
// repeated string tags = 3; // TODO(leodido, fntlnz): not handled yet but keeping for reference.
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The `response` message is the logical representation of the output model.
|
||||||
|
// It contains all the elements that Falco emits in an output along with the
|
||||||
|
// definitions for priorities and source.
|
||||||
message response {
|
message response {
|
||||||
google.protobuf.Timestamp time = 1;
|
google.protobuf.Timestamp time = 1;
|
||||||
falco.schema.priority priority = 2;
|
falco.schema.priority priority = 2;
|
||||||
|
@@ -31,7 +31,7 @@ enum priority {
|
|||||||
debug = 7;
|
debug = 7;
|
||||||
Debug = 7;
|
Debug = 7;
|
||||||
}
|
}
|
||||||
|
|
||||||
enum source {
|
enum source {
|
||||||
option allow_alias = true;
|
option allow_alias = true;
|
||||||
SYSCALL = 0;
|
SYSCALL = 0;
|
||||||
|
Reference in New Issue
Block a user