aperture-go

Aperture-Go SDK

aperture-go is an SDK to interact with Aperture Agent. It allows flow control functionality on fine-grained features inside service code.

Usage

ApertureClient Interface

ApertureClient maintains a GRPC connection with Aperture Agent.

 options := aperture.Options{
  ClientConn: client,
  // checkTimeout is the time that the client will wait for a response from Aperture Agent.
  // if not provided, the default value of 200 milliseconds will be used.
  CheckTimeout: 200 * time.Millisecond,
 }

 // initialize Aperture Client with the provided options.
 apertureClient, err := aperture.NewClient(options)
 if err != nil {
  log.Fatalf("failed to create client: %v", err)
 }

Flow Interface

Flow is created every time ApertureClient.BeginFlow is called.

 // StartFlow performs a flowcontrolv1.Check call to Aperture Agent. It returns a Flow and an error if any.
 flow, err := a.apertureClient.StartFlow(ctx, "awesomeFeature", labels)
 if err != nil {
  log.Printf("Aperture flow control got error. Returned flow defaults to Allowed. flow.Accepted(): %t", flow.Accepted())
 }

 // See whether flow was accepted by Aperture Agent.
 if flow.Accepted() {
  // Simulate work being done
  time.Sleep(5 * time.Second)
  // Need to call End on the Flow in order to provide telemetry to Aperture Agent for completing the control loop. The first argument captures whether the feature captured by the Flow was successful or resulted in an error. The second argument is error message for further diagnosis.
  _ = flow.End(aperture.OK)
 } else {
  // Flow has been rejected by Aperture Agent.
  _ = flow.End(aperture.Error)
 }

Relevant Resources

FluxNinja Aperture