LaunchDarkly PHP SDK Consul integration

3.2.0 2023-10-25 17:30 UTC

This package is auto-updated.

Last update: 2024-04-04 19:08:55 UTC


Run CI Packagist Documentation

This library provides a Consul-backed data source for the LaunchDarkly PHP SDK, replacing the default behavior of querying the LaunchDarkly service endpoints. The underlying Consul client implementation is the friendsofphp/consul-php-sdk package.

The minimum version of the LaunchDarkly PHP SDK for use with this library is 4.0.0. In earlier versions of the SDK, the Consul integration was bundled in the main SDK package.

This version of the package uses version 5.x of the consul-php-sdk client. If your application needs to use an earlier version of consul-php-sdk, use launchdarkly/server-sdk-consul 1.x (for version 2.x of consul-php-sdk) or launchdarkly/server-sdk-consul 2.x (for version 4.x of consul-php-sdk).

The minimum PHP version is 7.4.

For more information, see our SDK documentation.

Quick setup

This assumes that you have already installed the LaunchDarkly PHP SDK in your project.

  1. Install this package with composer:
php composer.phar install launchdarkly/server-sdk-consul --save

If your project does not already have a dependency on friendsofphp/consul-php-sdk, that package will be loaded automatically as a dependency of launchdarkly/server-sdk-consul.

  1. In your SDK configuration code, configure the Consul integration:
    $fr = LaunchDarkly\Integrations\Consul::featureRequester([
        "prefix" => "my-key-prefix"
    $config = [ "feature_requester" => $fr ];
    $client = new LDClient("sdk_key", $config);

By default, the store will try to connect to a local Consul instance on port 8500. You may specify an alternate configuration as described in the API documentation for Consul::featureRequester. Make sure the prefix option corresponds to the key prefix that is being used by the Relay Proxy.

About LaunchDarkly

  • LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
    • Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
    • Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
    • Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
    • Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
  • LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out our documentation for a complete list.
  • Explore LaunchDarkly