Version: 2.25.2

Manually setting feature control points

Aperture Go SDK can be used to manually set feature control points within a Go service.

To do so, first create an instance of ApertureClient:

API Key

You can create an API key for your project in the Aperture Cloud UI. For detailed instructions on locating API Keys, refer to the API Keys section.

go get github.com/fluxninja/aperture-go/v2

// grpcOptions creates a new gRPC client that will be passed in order to initialize the Aperture client.
func grpcOptions() []grpc.DialOption {
  var grpcDialOptions []grpc.DialOption
  grpcDialOptions = append(grpcDialOptions, grpc.WithConnectParams(grpc.ConnectParams{
    Backoff:           backoff.DefaultConfig,
    MinConnectTimeout: time.Second * 10,
  }))
  grpcDialOptions = append(grpcDialOptions, grpc.WithUserAgent("aperture-go"))
  certPool, err := x509.SystemCertPool()
  if err != nil {
    return nil
  }
  grpcDialOptions = append(grpcDialOptions, grpc.WithTransportCredentials(credentials.NewClientTLSFromCert(certPool, "")))
  return grpcDialOptions
}

  agentAddress := "ORGANIZATION.app.fluxninja.com:443"
  apiKey := "API_KEY"

  opts := aperture.Options{
      Address:     agentAddress,
      APIKey: apiKey,
      DialOptions: grpcOptions(),
  }

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

The created instance can then be used to start a flow:

  // business logic produces labels
  labels := map[string]string{
      "key": "value",
  }

  rampMode := false

  // StartFlow performs a flowcontrolv1.Check call to Aperture Agent. It returns a Flow object.
  flow := apertureClient.StartFlow(ctx, "featureName", labels, rampMode, 200 * time.Millisecond)

  // See whether flow was accepted by Aperture Agent.
  if flow.ShouldRun() {
      // do actual work
  } else {
      // handle flow rejection by Aperture Agent
      flow.SetStatus(aperture.Error)
  }
  _ = flow.End()

For more context on using Aperture Go SDK to set feature control points, refer to the example app available in the repository.

HTTP Middleware

You can also automatically set middleware for your HTTP server using the SDK. To do so, after creating an instance of ApertureClient, use the middleware on your router:

  mux.Use(aperturemiddlewares.NewHTTPMiddleware(apertureClient, "awesomeFeature", labels, nil, false, 200 * time.Millisecond).Handle)

For simplicity, you can also pass a list of regexp patterns to match against the request path, for which the middleware will pass through. This is especially useful for endpoints like /healthz:

  mux.Use(aperturemiddlewares.NewHTTPMiddleware(apertureClient, "awesomeFeature", labels,  []regexp.Regexp{regexp.MustCompile("/health.*")}, false, 200 * time.Millisecond).Handle)

HTTP Middleware​

HTTP Middleware