Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add streams endpoint #3493

Merged
merged 1 commit into from
Sep 25, 2023

Conversation

josedonizetti
Copy link
Contributor

@josedonizetti josedonizetti commented Sep 21, 2023

1. Explain what the PR does

This PR adds the stream endpoint to the grpc server, which closes the implementation of the v1beta1 of the grpc API. The user needs pass which policies to create a stream, and optionally he can filter with fields to get as a response with the field mask.

2. Explain how to test it

test streams:

func main() {
	kk := keepalive.ClientParameters{
		Time:                10 * time.Second, // send pings every 10 seconds if there is no activity
		Timeout:             time.Second,      // wait 1 second for ping ack before considering the connection dead
		PermitWithoutStream: true,             // send pings even without active streams
	}

	var opts []grpc.DialOption
	opts = append(opts, grpc.WithTransportCredentials(insecure.NewCredentials()))
	opts = append(opts, grpc.WithKeepaliveParams(kk))

	conn, err := grpc.Dial(":4466", opts...)
	if err != nil {
		log.Fatalf("fail to dial: %v", err)
	}
	defer conn.Close()

	client := pb.NewTraceeServiceClient(conn)

	stream, err := client.StreamEvents(context.Background(), &pb.StreamEventsRequest{
		Policies: []string{"signature-events", "test"},
	})
	if err != nil {
		log.Fatal(err)
	}
	for {
		event, err := stream.Recv()
		if err == io.EOF {
			break
		}
		if err != nil {
			log.Fatal(err)
		}
		fmt.Printf("receive event: %v", event)
	}
}

test fieldmask:

func main() {
	kk := keepalive.ClientParameters{
		Time:                10 * time.Second, // send pings every 10 seconds if there is no activity
		Timeout:             time.Second,      // wait 1 second for ping ack before considering the connection dead
		PermitWithoutStream: true,             // send pings even without active streams
	}

	var opts []grpc.DialOption
	opts = append(opts, grpc.WithTransportCredentials(insecure.NewCredentials()))
	opts = append(opts, grpc.WithKeepaliveParams(kk))

	conn, err := grpc.Dial(":4466", opts...)
	if err != nil {
		log.Fatalf("fail to dial: %v", err)
	}
	defer conn.Close()

	client := pb.NewTraceeServiceClient(conn)

	stream, err := client.StreamEvents(context.Background(), &pb.StreamEventsRequest{
		Policies: []string{"signature-events", "test"},
		Mask: &fieldmaskpb.FieldMask{
			Paths: []string{
				"name",
			},
		},
	})
	if err != nil {
		log.Fatal(err)
	}
	for {
		event, err := stream.Recv()
		if err == io.EOF {
			break
		}
		if err != nil {
			log.Fatal(err)
		}
		fmt.Println("receive event", event)
	}
}

3. Other comments

pkg/server/grpc/tracee.go Outdated Show resolved Hide resolved
pkg/server/grpc/tracee.go Outdated Show resolved Hide resolved
pkg/server/grpc/tracee.go Outdated Show resolved Hide resolved
pkg/server/grpc/tracee.go Outdated Show resolved Hide resolved
pkg/server/grpc/tracee.go Outdated Show resolved Hide resolved
pkg/server/grpc/tracee.go Outdated Show resolved Hide resolved
@josedonizetti josedonizetti force-pushed the add-streams-endpoint branch 9 times, most recently from eb0b439 to 1746664 Compare September 21, 2023 18:51
@josedonizetti josedonizetti force-pushed the add-streams-endpoint branch 3 times, most recently from 81fd84e to 0af542e Compare September 21, 2023 22:43
@josedonizetti josedonizetti marked this pull request as ready for review September 22, 2023 00:21
pkg/server/grpc/tracee.go Outdated Show resolved Hide resolved
pkg/server/grpc/tracee.go Show resolved Hide resolved
pkg/server/grpc/tracee.go Outdated Show resolved Hide resolved
pkg/server/grpc/tracee.go Outdated Show resolved Hide resolved
Copy link
Collaborator

@yanivagman yanivagman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@josedonizetti josedonizetti merged commit 94cad81 into aquasecurity:main Sep 25, 2023
26 checks passed
@josedonizetti josedonizetti deleted the add-streams-endpoint branch September 25, 2023 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants