分桶方法decide

云眼About 5 min

分桶方法decide

本主题概述了 Ruby SDK 的判定方法,这些方法可用于在云眼灰度实验中为用户返回标帜判定。

使用 Decide 方法返回用户的标帜决策。标帜决策包括标帜启用/禁用状态和标帜变体。

本页介绍以下决策方法:

决定

版本

SDK v3.8 及更高版本

描述

返回用户的标帜键的决策结果。决策结果在 EyeofcloudDecision 对象中返回,并包含传递标帜规则所需的所有数据。

Decide 是 UserContext 对象的一种方法。有关详细信息,请参阅 EyeofcloudUserContext

有关返回的决策对象的详细信息,请参阅 EyeofcloudDecision

参数

下表描述了 Decide 方法的参数:

参数

类型

描述

.key

字符串

灰度标帜的键

选项(可选)

数组

Array of EyeofcloudDecideOption enums.请参阅下表。

云眼分桶结果 EyeofcloudDecision选项

下面的示例演示如何在任何 Decide 方法上单独设置选项,或在实例化 Eyeofcloud 客户端时将其设置为全局默认值。

Rubby

require "eyeofcloud" # set global default decide options when initializing the client eyeofcloud_client = Eyeofcloud::Project.new( nil,nil, nil, nil, nil, nil, "<YOUR_SDK_KEY>", nil, nil, nil, [Eyeofcloud::Decide::EyeofcloudDecideOption::DISABLE_DECISION_EVENT] ) user = eyeofcloud_client.create_user_context('test_user') decision_result_map = user.decide_all([Eyeofcloud::Decide::EyeofcloudDecideOption::ENABLED_FLAGS_ONLY, Eyeofcloud::Decide::EyeofcloudDecideOption::IGNORE_USER_PROFILE_SERVICE])

下表显示了可以在“决定方法”上设置的选项的详细信息。

云眼分桶结果 EyeofcloudDecision选项枚举

如果设置:

DISABLE_DECISION_EVENT

防止访问者在仍收到变体的同时触发展示open in new window,从而禁止在“结果”页面上open in new window显示 Decide 方法的结果。

此设置可能是为什么决策事件调度枚举在返回的 falseEyeofcloudDecisionopen in new window 对象或 DECIDE 通知侦听器有效负载。

ENABLED_FLAGS_ONLY

仅返回已启用标帜的决策。此选项仅适用于确定多个标帜的方法,如 Decide All 方法。如果此选项无效,则忽略此选项。如果未设置此选项,SDK 将返回所有决策,无论是否启用该标帜。

IGNORE_USER_PROFILE_SERVICE

When set, the SDK bypasses UPS (both lookup and save) for the decision.

When this option is not set, UPS overrides audience targeting, traffic allocation, and experiment mutual exclusion groups.

INCLUDE_REASONS

Return log messages in the Reasons field of EyeofcloudDecision object. Note that unlike info or debug messages, critical error messages are always returned, regardless of this setting.

EXCLUDE_VARIABLES

Exclude flag variable values from the decision result. Use this option to minimize the returned decision by skipping large JSON variables.

Returns

The Decide method returns an EyeofcloudDecision object. For more information, see EyeofcloudDecision.

If the method encounters a critical error (SDK not ready, invalid flag key, etc), then it returns a decision with a nill Variation Key field and populates the Reasons field with error messages (regardless of the Include Reasons option).

Example Decision

The following is an example of calling the Decide method and accessing the returned EyeofcloudDecision object:

Ruby

# create the user and decide which flag rule & variation they bucket into user = eyeofcloud.create_user_context(userId, attributes) decision = user.decide('product_sort') # variation. if nil, decision fail with a critical error variation_key = decision.variation_key # flag enabled state: enabled = decision.enabled # String variable value: value = decision.variables['logged_in'].to_s # all variable values all_var_values = decision.variables # flag decision reasons reasons = decision.reasons # user for which the decision was made user_context = decision.user_context

Side Effects

Invokes the notification listener if this listener is enabled.DECISION

Decide All

Returns decisions for all active (unarchived) flags for a user.

See EyeofcloudDecision for details on the decision object.

Version

SDK v3.7 and higher

Description

Use the Decide All method to return a map of flag decisions for a user.

Parameters

The following table describes parameters for the Decide All method:

Parameter

Type

Description

options (optional)

Array

Array of EyeofcloudDecideOption enums. See EyeofcloudDecideOption.

返回

方法返回云眼决策的映射。有关更多信息,请参阅云眼决策

如果该方法对所有标帜都失败(例如,SDK 未就绪或用户上下文无效),则返回空映射。如果该方法检测到特定标帜的错误,它将在该标帜的决策的“原因”字段中返回错误消息。

例子

下面是使用“全部决定”调用获取用户的标帜的示例:

Rubby

# make decisions for all active (unarchived) flags in the project for a user decisions = user.decide_all() # or only for enabled flags decisions = user.decide_all([Eyeofcloud::Decide::EyeofcloudDecideOption::ENABLED_FLAGS_ONLY]) decision_for_flag1 = decisions['flag_1']

副作用

为每个决策调用通知侦听器(如果启用了此侦听器)。DECISION

决定键

在 PHP SDK 中,“决定密钥”方法为用户制定指定标帜键的决策。

变体

SDK v3.7 及更高版本

描述

获取标帜键数组的标帜决策图。

参数

下表描述了 Decide 方法的参数:

下表描述了“决定键”方法的参数:

参数

类型

描述

键(Key)

数组

字符串标帜键数组。

选项(可选)

数组

Array of EyeofcloudDecideOption enums.请参阅云眼决策选项

返回

返回云眼决策的映射。有关更多信息,请参阅云眼决策

如果该方法对所有标帜都失败(例如,SDK 未就绪或用户上下文无效),则返回空映射。如果该方法检测到特定标帜的错误,它将在该标帜的决策的“原因”字段中返回错误消息。

以下是获取用户指定标帜的示例:

.PHP

# make a decisions for specific enabled flags options = [Eyeofcloud::Decide::EyeofcloudDecideOption::ENABLED_FLAGS_ONLY] decisions = user.decide_for_keys(["flag_1", "flag_2"], options) decision_for_flag1 = decisions["flag_1"] decision_for_flag2 = decisions["flag_2"]

副作用

为每个决策调用通知侦听器(如果启用了此侦听器)。DECISION

源文件

包含 Ruby 实现的语言/平台源文件是 Eyeofcloud.rubyopen in new window

Last update:
Contributors: “zhangweixue”