From 732965f9735dd5d0b014822d4fbf154a30ab6c38 Mon Sep 17 00:00:00 2001 From: Leonardo Di Donato Date: Wed, 25 Sep 2019 09:19:08 +0000 Subject: [PATCH] docs(userspace/falco): document output proto messages and service Co-authored-by: Lorenzo Fontana Signed-off-by: Leonardo Di Donato --- userspace/falco/output.proto | 8 ++++++++ userspace/falco/schema.proto | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/userspace/falco/output.proto b/userspace/falco/output.proto index 604c914d..6de1adf8 100644 --- a/userspace/falco/output.proto +++ b/userspace/falco/output.proto @@ -7,16 +7,24 @@ package falco.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 { 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 { bool keepalive = 1; // 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. } +// 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 { google.protobuf.Timestamp time = 1; falco.schema.priority priority = 2; diff --git a/userspace/falco/schema.proto b/userspace/falco/schema.proto index 45967348..bcd90f51 100644 --- a/userspace/falco/schema.proto +++ b/userspace/falco/schema.proto @@ -31,7 +31,7 @@ enum priority { debug = 7; Debug = 7; } - + enum source { option allow_alias = true; SYSCALL = 0;