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
eb433185a1
unleash.unleash/website/docs/reference/sdks/index.md
Thomas Heartman d5fbd0b743
refactor: move docs into new structure / fix links for SEO (#2416) 
## What

This (admittedly massive) PR updates the "physical" documentation
structure and fixes url inconsistencies and SEO problems reported by
marketing. The main points are:

- remove or move directories : advanced, user_guide, deploy, api
- move the files contained within to the appropriate one of topics,
how-to, tutorials, or reference
- update internal doc links and product links to the content
- create client-side redirects for all the urls that have changed.

A number of the files have been renamed in small ways to better match
their url and to make them easier to find. Additionally, the top-level
api directory has been moved to /reference/api/legacy/unleash (see the
discussion points section for more on this).

## Why

When moving our doc structure to diataxis a while back, we left the
"physical' files lying where they were, because it didn't matter much to
the new structure. However, that did introduce some inconsistencies with
where you place docs and how we organize them.

There's also the discrepancies in whether urls us underscores or hyphens
(which isn't necessarily the same as their file name), which has been
annoying me for a while, but now has also been raised by marketing as an
issue in terms of SEO.

## Discussion points

The old, hand-written API docs have been moved from /api to
/reference/api/legacy/unleash. There _is_ a /reference/api/unleash
directory, but this is being populated by the OpenAPI plugin, and mixing
those could only cause trouble. However, I'm unsure about putting
/legacy/ in the title, because the API isn't legacy, the docs are. Maybe
we could use another path? Like /old-docs/ or something? I'd appreciate
some input on this.
2022-11-22 09:05:30 +00:00

10 KiB
Raw Blame History

title
SDK overview

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:

Client-side SDKs

Client-side SDKs can connect to the Unleash Proxy or to the Unleash front-end API, but not to the regular Unleash client API.

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 Rust Unleash Proxy
Category: Initialization
Async initialization ✅ ✅ ✅ ✅ ✅ ✅ ❌ ✅ N/A
Can block until synchronized ✅ ✅ ✅ ⭕ ⭕ ✅ ✅ ⭕ N/A
Default refresh interval 10s 15s 15s 15s 15s 30s 30s 15s 5s
Default metrics interval 60s 60s 60s 60s 60s 60s 30s 15s 30s
Context provider ✅ N/A 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 ✅ ✅ ⭕ ✅ ✅ (4.3) ✅ ✅ ⭕ 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) ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Advanced support (Semver, date, numeric and extended string operators) (introduced in) ✅ (5.1) ✅ (3.12) ✅ (3.3) ✅ (5.1) ✅ (4.2) ✅ (2.1) ✅ (1.3.1) ⭕ ✅ (0.8)
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) ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Impression data ⭕ ✅ ⭕ ⭕ ⭕ ⭕ ✅ ⭕ ✅
Category: Bootstrap (beta)
Bootstrap from file ✅ ✅ ✅ ⭕ ✅ ✅ ✅ ⭕ ✅
Custom Bootstrap implementation ✅ ✅ ✅ ⭕ ✅ ✅ ✅ ⭕ ✅

Community SDKs ❤️

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!

Implement your own SDK

If you can't find an SDK that fits your need, you can also develop your own SDK. To make implementation easier, check out these resources:

  • Unleash Client Specifications - Used by all official SDKs to make sure they behave correctly across different language implementations. This lets us verify that a gradual rollout to 10% of the users would affect the same users regardless of which SDK you're using.
  • Client SDK overview - A brief, overall guide of the Unleash Architecture and important aspects of the SDK role in it all.

Working offline

Once they have been initialised, all Unleash clients will continue to work perfectly well without an internet connection or in the event that the Unleash Server has an outage.

Because the SDKs and the Unleash Proxy cache their feature toggle states locally and only communicate with the Unleash server (in the case of the server-side SDKs and the Proxy) or the Proxy (in the case of front-end SDKs) at predetermined intervals, a broken connection only means that they won't get any new updates.

Unless the SDK supports bootstrapping it will need to connect to Unleash at startup to get its initial feature toggle data set. If the SDK doesn't have a feature toggle data set available, all toggles will fall back to evaluating as disabled or as the specified default value (in SDKs that support that).

Bootstrapping

By default, all SDKs reach out to the Unleash Server at startup to fetch their toggle configuration. Additionally some of the server-side SDKs and the Proxy (see the above compatibility table) also support bootstrapping, which allows them to get their toggle configuration from a file, the environment, or other local resources. These SDKs can work without any network connection whatsoever.

Bootstrapping is also supported by the following front-end client SDKs: