Relay Proxy

[5.7.0] - 2019-09-18

Added:

• The exitAlways configuration property (or EXIT_ALWAYS) variable causes the Relay Proxy to quit as soon as it has initialized all environments. This can be used for testing (just to make sure everything is working), or to perform a single poll of flags and put them into Redis or another database.
• The endpoints used by the PHP SDK (when it is not in LDD mode) were not previously supported. They are now. There is a new ttlMinutes property to configure caching behavior for PHP, similar to the TTL property on the LaunchDarkly dashboard. (#68)
• The logLevel configuration properties (or LOG_LEVEL and LD_LOG_LEVEL_EnvName) allow you to request more or less verbose logging.
• If debug-level logging is enabled, the Relay Proxy will log every incoming HTTP request. (#51)

Changed:

• Log messages related to a specific environment are now prefixed with [env: EnvironmentName] (where EnvironmentName is the name you specified for that environment in your configuration) rather than [LaunchDarkly Relay (SdkKey ending with xxxxx)] (where xxxxx was the last 5 characters of the SDK key).

Fixed:

• Updated Alpine base image in Docker build because some packages in the old image had vulnerabilities. (Thanks, e96wic!)
• Fixed a CI build problem for Go 1.8.

[5.6.1] - 2019-08-05

Fixed:

• Enabling TLS for Redis as a separate option was not working; it would only work if you specified a rediss:// secure URL. Both methods now work. (#71)

[5.6.0] - 2019-08-02

Added:

• You can now specify a proxy server URL in the configuration file, or in a Docker environment variable.
• Also, Relay now respects the standard Go environment variables HTTP_PROXY and HTTPS_PROXY.
• You may specify additional CA certificates for outgoing HTTPS connections.
• Relay now supports proxy servers that use NTLM authentication.
• You may specify a Redis password, or turn on TLS for Redis, without modifying the Redis URL.
• See README.md for details on configuring all of the above features.

Changed:

• Extracted Config structs so that they could be configured programmatically when Relay is used as a library. (Thanks, mightyguava!)

Fixed:

• The endpoints used by the client-side JavaScript SDKs were incorrectly returning all flags, rather than only the flags with the "client-side" property (as the regular LaunchDarkly service does). (#63)

[5.5.2] - 2019-05-15

Added

• Added documentation for the REDIS_URL environment variable to the README.

Changed

• Replaced import paths for gopkg.in/launchdarkly/go-client.v4 with gopkg.in/launchdarkly/go-server-sdk.v4. The newer import path reflects the new repository URL for the LaunchDarkly Server-side SDK for Go.

[5.5.1] - 2018-12-19

Fixed:

• When proxying events, the Relay now preserves information about what kind of platform they came from: server-side, mobile, or browser. Previously, it delivered all events to LaunchDarkly as if they were server-side events, which could cause your usage statistics to be wrong. (#53)
• The docker-entrypoint.sh script, which is meant to run with any sh-compatible shell, contained some bash syntax that does not work in every shell.
• If the configuration is invalid because more than one database is selected (e.g., Redis + DynamoDB), the Relay will report an error. Previously, it picked one of the databases and ignored the others.
• Clarified documentation about persistent feature stores, and boolean environment variables.

Docker images

• docker pull launchdarkly/ld-relay:5.5.1
• docker pull launchdarkly/ld-relay:v5
• docker pull launchdarkly/ld-relay:latest

[5.5.0] - 2018-11-27

Added

• The relay now supports additional database integrations: Consul and DynamoDB. As with the existing Redis integration, these can be used to store feature flags that will be read from the same database by a LaunchDarkly SDK client (as described here), or simply as a persistence mechanism for the relay itself. See README.MD for configuration details.
• It is now possible to specify a Redis URL in $REDIS_URL, rather than just $REDIS_HOST and $REDIS_PORT, when running the Relay in Docker. (Thanks, lukasmrtvy!)

Fixed

• When deployed in a Docker container, the relay no longer runs as the root user; instead, it creates a user called ldr-user. Also, the configuration file is now in /ldr instead of in /etc. (Thanks, sdif!)

Docker images

• docker pull launchdarkly/ld-relay:5.5.0
• docker pull launchdarkly/ld-relay:v5
• docker pull launchdarkly/ld-relay:latest

[5.4.4] - 2018-11-19

Fixed

• Fixed a bug that would cause the relay to hang after the LaunchDarkly client finished initializing, if you had previously queried any relay endpoint before the client finished initializing (e.g. if there was a delay due to network problems and you checked the status resource during that delay).

Docker images

• docker pull launchdarkly/ld-relay:5.4.4
• docker pull launchdarkly/ld-relay:v5
• docker pull launchdarkly/ld-relay:latest

[5.4.3] - 2018-09-97

Added

• Return flag evaluation reasons for mobile and client-side endpoints when withReasons=true query param is set.
• Added support for metric collection configuration in docker entrypoint script. Thanks @matthalbersma for the suggestion.

Fixes

• Fix internal relay metrics event field.

Docker images

• docker pull launchdarkly/ld-relay:5.4.3
• docker pull launchdarkly/ld-relay:v5
• docker pull launchdarkly/ld-relay:latest

[5.4.2] - 2018-08-29

Changed

• Use latest go client (4.3.0).
• Preserves the "client-side-enabled" property of feature flags so that the new SDK method AllFlagsState() - which has an option for selecting only client-side flags - will work correctly when using the relay.

Fixes

• Ensure that server-side eval endpoints don't panic (work around gorilla mux bug)

Docker images

• docker pull launchdarkly/ld-relay:5.4.2
• docker pull launchdarkly/ld-relay:v5
• docker pull launchdarkly/ld-relay:latest

[5.4.1] - 2018-08-24

Fixed

• Strip trailing slash that was breaking default urls for polling and streaming.
• If set X-LaunchDarkly-User-Agent will be used instead of the User-Agent header for metrics.
• Documentation improvements.

Docker images

• docker pull launchdarkly/ld-relay:5.4.1
• docker pull launchdarkly/ld-relay:v5
• docker pull launchdarkly/ld-relay:latest

[5.4.0] - 2018-08-09

Added

• The Relay now supports the streaming endpoint used by current mobile SDKs. It does not fully proxy the stream, but will send an event causing mobile SDKs to re-request their flags when flags have changed.

Docker images

• docker pull launchdarkly/ld-relay:5.4.0
• docker pull launchdarkly/ld-relay:v5
• docker pull launchdarkly/ld-relay:latest

[5.3.1] - 2018-08-03

Fixed

• Route metrics are now tagged correctly with the route name.
• Datadog exporter now works with 32-bit builds.

Docker images

• docker pull launchdarkly/ld-relay:5.3.1
• docker pull launchdarkly/ld-relay:v5
• docker pull launchdarkly/ld-relay:latest

5.3.0 - 2018-07-30

Added

• The Relay now supports exporting metrics and traces to Datadog, Prometheus, and Stackdriver. See the README for configuration instructions.

Changed

• Packages intended for internal relay use are now marked as internal and no longer accessible exsternally.
• The package is now released using goreleaser.

[5.2.0] - 2018-07-13

Added

• The Redis server location-- and logical database-- can now optionally be specified as a URL (url property in [redis] section) rather than a hostname and port.
• The relay now sends usage metrics back to LaunchDarkly at 1-minute intervals.

Fixed

• The /sdk/goals/<envId> endpoint now supports caching and repeats any headers it received to the client.

[5.1.0] - 2018-06-25

Added

• /status endpoint includes version and clientVersion fields for the relay and go client versions respectively.

Changed

• Official package has moved to gopkg.in/launchdarkly/ld-relay.v5
• Binary target is gopkg.in/launchdarkly/ld-relay.v5/cmd/ld-relay
• gopkg.in/launchdarkly/ld-relay.v5 is now a package that can be used as library code and includes the Relay object with implements http.Handler so you can roll your own relay.

[5.0.0] - 2018-05-29

Changed:

• Instead of the configuration option apiKey, please use sdkKey. It has the same function, but is less misleading (since it is really an SDK key, not an API token).
• The /status endpoint now returns environments as a map of configuration name to details/status. It also no longer exposes full SDK keys so this endpoint should be safe to expose publicly.

Fixed:

• Support for the OPTIONS method for /sdk/goals/{envId} was restored after being accidentally dropped in 4.1.0.

Deprecated:

• The configuration option apiKey is now deprecated, but will still work if there is no sdkKey.

Fixed: Fix JS streaming by sending an empty data field in ping events

Added:

• Add support for client-side (js) and mobile endpoints for evaluation, streaming and publishing events.
• Set UserAgent to LDRelay/VERSION.

Fixed:

• Fix configuration of flush interval for summarizing event relay.

Changes:

• When proxying events, ld-relay now converts analytics events from older SDKs, or from the PHP SDK, into the new summary format. For more details, see Analytics Data Stream Reference.

Changes:

• Fixed a bug causing flag and segment configurations to not be propagated correctly on stream initialization.