Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity
9791783be5
unleash.unleash/website/docs/sdks/index.md
Renato Arruda 018675ad34 Update status of Ruby SDK after release 4.0.0
2021-12-16 22:07:35 +01:00

19 KiB
Raw Blame History

id title slug
index Introduction /sdks

In order to connect your application to Unleash you will need a client SDK (software developer kit) for your programming language and an API token. The SDK will handle connecting to the Unleash server instance and retrieving feature toggles based on your configuration. All versions of Unleash (OSS, Pro, and Enterprise) use the same client SDKs.

Unleash provides official client SDKs for a number of programming language. Additionally, our community have developed and contributed SDKs for other languages. So if you can't find your favorite language in the list of official SDKs, check out the list of clients written by our fantastic community.

Official SDKs

Server-side SDKs:

Server-side clients run on your server and communicate directly with your Unleash instance. We provide these official clients:

Front-end SDKs

For security and performance reasons, the front-end SDKs do not communicate directly with your Unleash instance. Instead, they go via the Unleash Proxy.

Server-side SDK compatibility table

The below table shows what features the various server-side SDKs support. Note that certain features make sense only for some clients due to how the programming language works or due to how the client works.

Legend:

  • ✅: Implemented
  • ⭕: Not yet implemented, but we're looking into it
  • ❌: Not implemented, not planned
  • N/A: Not applicable to this SDK

:::note If you see an item marked with a ❌ that you would find useful, feel free to reach out to us (on Slack, for instance) with your use case. It may not be something we can prioritize right now, but if you'd like to contribute it back to the community, we'd love to help you build it. :::

Capability Java Node.js Go Python Ruby .Net PHP Unleash Proxy Server
Category: Initialization
Async initialization ✅ ✅ ✅ ✅ ✅ ✅ ✅ N/A
Can block until synchronized ✅ ✅ ⭕ ⭕ ⭕ ✅ ⭕ N/A
Default refresh interval 10s 15s 15s 15s 15s 30s 30s 5s
Default metrics interval 60s 60s 60s 60s 30s 60s 30s 30s
Context provider ✅ N/A N/A N/A N/A ✅ ✅ N/A
Global fallback function ✅ ✅ ✅ ✅ ❌ ❌ ❌ N/A
Toggle Query: namePrefix ✅ ✅ ❌ ❌ ❌ ❌ ❌ ✅
Toggle Query: tags ✅ ✅ ❌ ❌ ❌ ❌ ❌ ✅
Toggle Query: project_name ✅ ✅ ✅ ✅ ✅ ✅ N/A ✅
Category: Custom Headers
static ✅ ✅ ✅ ✅ ✅ ✅ ✅ N/A
function ✅ ✅ ⭕ ✅ ⭕ ✅ ⭕ N/A
Category: Built-in strategies
Standard ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Gradual rollout ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Gradual rollout: custom stickiness ✅ ✅ ⭕ ✅ ✅ ✅ ✅ ✅
UserID ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
IP ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
IP: CIDR syntax ✅ ✅ ✅ ✅ ⭕ ⭕ ⭕ ✅
Hostname ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Category: Custom strategies
Basic support ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Category: Strategy constraints
Basic support (IN, NOT_IN operators) ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Category: Unleash Context
Static fields (environment, appName) ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Defined fields ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Custom properties ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Category: isEnabled
Can take context ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Override fallback value ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Fallback function ✅ ✅ ✅ ✅ ✅ ⭕ ⭕ ✅
Category: Variants
Basic support ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Custom fallback variant ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Custom weight ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Custom stickiness (beta) ✅ ✅ ⭕ ✅ ✅ ⭕ ✅ ✅
Category: Local backup
File based backup ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Category: Usage metrics
Can disable metrics ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Client registration ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Basic usage metrics (yes/no) ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Category: Bootstrap (beta)
Bootstrap from file ✅ ⭕ ⭕ ⭕ ⭕ ⭕ ⭕ ⭕
Custom Bootstrap implementation ✅ ⭕ ⭕ ⭕ ⭕ ⭕ ⭕ ⭕

Clients written by awesome enthusiasts

Here's some of the fantastic work our community has done to make Unleash work in even more contexts. If you still can't find your favorite language, let us know and we'd love to help you create the client for it!