機能フラグ追跡はベータ版です。
概要
機能フラグデータにより、どのユーザーに特定の機能が表示されているか、導入した変更がユーザー体験に影響を与えているか、パフォーマンスに悪影響を与えているかを判断できるため、ユーザー体験やパフォーマンス監視の可視性が高まります。
RUM データを機能フラグデータでリッチ化することにより、意図せずにバグやパフォーマンスの低下を引き起こすことなく、その機能が正常に起動することを確信することができます。この追加的な洞察により、機能のリリースとパフォーマンスを関連付け、問題を特定のリリースにピンポイントで特定し、より迅速にトラブルシューティングを行うことができます。
セットアップ
機能フラグの追跡は、RUM ブラウザ SDK で利用可能です。開始するには、RUM ブラウザモニタリングをセットアップします。ブラウザ RUM SDK バージョン >= 4.25.0 が必要です。
機能フラグデータの収集を開始するには、RUM SDK を初期化し、 ["feature_flags"]
で enableExperimentalFeatures
初期化パラメーターを構成します。
npm
import { datadogRum } from '@datadog/browser-rum';
// Datadog ブラウザ SDK を初期化します
datadogRum.init({
...
enableExperimentalFeatures: ["feature_flags"],
...
});
CDN async
window.DD_RUM.onReady(function() {
window.DD_RUM.init({
...
enableExperimentalFeatures: ["feature_flags"],
...
})
})
CDN sync
window.DD_RUM &&
window.DD_RUM.init({
...
enableExperimentalFeatures: ["feature_flags"],
...
})
機能フラグの追跡は、RUM iOS SDK で利用可能です。開始するには、RUM iOS モニタリングをセットアップします。iOS RUM SDK バージョン 1.16.0 以上が必要です。
機能フラグの追跡は、RUM Android SDK で利用可能です。開始するには、RUM Android モニタリングをセットアップします。Android RUM SDK バージョン 1.18.0 以上が必要です。
機能フラグの追跡は、Flutter アプリケーションで利用可能です。開始するには、RUM Flutter モニタリングをセットアップします。Flutter プラグインバージョン 1.3.2 以上が必要です。
機能フラグ追跡は、React Native アプリケーションで利用可能です。まずは、RUM React Native モニタリングをセットアップしてください。React Native RUM SDK のバージョン >= 1.7.0 が必要です。
インテグレーション
機能フラグデータの収集は、カスタム機能フラグ管理ソリューション、または Datadog のインテグレーションパートナーのいずれかを使用して開始することができます。
Datadog は、以下とのインテグレーションをサポートしています。
Amplitude インテグレーション
Amplitude の SDK を初期化し、以下に示すコードスニペットを使用して Datadog に機能フラグの評価を報告する露出リスナーを作成します。
Amplitude の SDK の初期化については、Amplitude の JavaScript SDK ドキュメントを参照してください。
const experiment = Experiment.initialize("CLIENT_DEPLOYMENT_KEY", {
exposureTrackingProvider: {
track(exposure: Exposure) {
// Amplitude が露出を報告したときに機能フラグを送信します
datadogRum.addFeatureFlagEvaluation(exposure.flag_key, exposure.variant);
}
}
})
Amplitude の SDK を初期化し、以下に示すコードスニペットを使用して、Datadog に機能フラグの評価を報告するインスペクターを作成します。
Amplitude の SDK の初期化については、Amplitude の iOS SDK ドキュメントを参照してください。
class DatadogExposureTrackingProvider : ExposureTrackingProvider {
func track(exposure: Exposure) {
// Amplitude で露出が報告された際に機能フラグを送信します
if let variant = exposure.variant {
RUMMonitor.shared().addFeatureFlagEvaluation(name: exposure.flagKey, value: variant)
}
}
}
// 初期化時:
ExperimentConfig config = ExperimentConfigBuilder()
.exposureTrackingProvider(DatadogExposureTrackingProvider(analytics))
.build()
Amplitude の SDK を初期化し、以下に示すコードスニペットを使用して、Datadog に機能フラグの評価を報告するインスペクターを作成します。
Amplitude の SDK の初期化については、Amplitude の Android SDK ドキュメントを参照してください。
internal class DatadogExposureTrackingProvider : ExposureTrackingProvider {
override fun track(exposure: Exposure) {
// Amplitude で露出が報告された際に機能フラグを送信します
GlobalRumMonitor.get().addFeatureFlagEvaluation(
exposure.flagKey,
exposure.variant.orEmpty()
)
}
}
// 初期化時:
val config = ExperimentConfig.Builder()
.exposureTrackingProvider(DatadogExposureTrackingProvider())
.build()
Amplitude はこのインテグレーションをサポートしていません。この機能をリクエストするには、Amplitude にチケットを作成してください。
カスタム機能フラグ管理
機能フラグが評価されるたびに、以下の関数を追加して、機能フラグの情報を RUM に送信します。
datadogRum.addFeatureFlagEvaluation(key, value);
機能フラグが評価されるたびに、以下の関数を追加して、機能フラグの情報を RUM に送信します。
RUMMonitor.shared().addFeatureFlagEvaluation(key, value);
機能フラグが評価されるたびに、以下の関数を追加して、機能フラグの情報を RUM に送信します。
GlobalRumMonitor.get().addFeatureFlagEvaluation(key, value);
機能フラグが評価されるたびに、以下の関数を追加して、機能フラグの情報を RUM に送信します。
DatadogSdk.instance.rum?.addFeatureFlagEvaluation(key, value);
機能フラグが評価されるたびに、以下の関数を追加して、機能フラグの情報を RUM に送信します。
DdRum.addFeatureFlagEvaluation(key, value);
DevCycle インテグレーション
DevCycle の SDK を初期化し、variableEvaluated
イベントにサブスクライブします。すべての変数評価 variableEvaluated:*
または特定の変数評価 variableEvaluated:my-variable-key
にサブスクライブすることを選択します。
DevCycle の SDK の初期化については、DevCycle の JavaScript SDK ドキュメントを、DevCycle のイベントシステムについては、DevCycle の SDK イベントドキュメントを参照してください。
const user = { user_id: "<USER_ID>" };
const dvcOptions = { ... };
const dvcClient = initialize("<DVC_CLIENT_SDK_KEY>", user, dvcOptions);
...
dvcClient.subscribe(
"variableEvaluated:*",
(key, variable) => {
// すべての変数評価を追跡します
datadogRum.addFeatureFlagEvaluation(key, variable.value);
}
)
...
dvcClient.subscribe(
"variableEvaluated:my-variable-key",
(key, variable) => {
// 特定の変数評価を追跡します
datadogRum.addFeatureFlagEvaluation(key, variable.value);
}
)
DevCycle はこのインテグレーションをサポートしていません。この機能をリクエストするには、DevCycle にチケットを作成してください。
DevCycle はこのインテグレーションをサポートしていません。この機能をリクエストするには、DevCycle にチケットを作成してください。
DevCycle はこのインテグレーションをサポートしていません。この機能をリクエストするには、DevCycle にチケットを作成してください。
DevCycle はこのインテグレーションをサポートしていません。この機能をリクエストするには、DevCycle にチケットを作成してください。
Flagsmith インテグレーション
Flagsmith の SDK に datadogRum
オプションを付けて初期化すると、以下に示すコードのスニペットを使用して Datadog に機能フラグの評価を報告することができるようになります。
オプションとして、datadogRum.setUser()
を介して Flagsmith の Trait が Datadog に送信されるようにクライアントを構成することができます。Flagsmith の SDK の初期化についての詳細は、Flagsmith の JavaScript SDK ドキュメントを参照してください。
// Flagsmith SDK を初期化します
flagsmith.init({
datadogRum: {
client: datadogRum,
trackTraits: true,
},
...
})
Flagsmith は、このインテグレーションをサポートしていません。この機能をリクエストするには、Flagsmith でチケットを作成してください。
Flagsmith は、このインテグレーションをサポートしていません。この機能をリクエストするには、Flagsmith でチケットを作成してください。
Flagsmith は、このインテグレーションをサポートしていません。この機能をリクエストするには、Flagsmith でチケットを作成してください。
Flagsmith は現在、このインテグレーションをサポートしていません。この機能をリクエストするには、Flagsmith でチケットを作成してください。
LaunchDarkly インテグレーション
LaunchDarkly の SDK を初期化し、以下に示すコードスニペットを使用して、Datadog に機能フラグの評価を報告するインスペクターを作成します。
LaunchDarkly の SDK の初期化については、LaunchDarkly の JavaScript SDK ドキュメントを参照してください。
const client = LDClient.initialize("<CLIENT_SIDE_ID>", "<CONTEXT>", {
inspectors: [
{
type: "flag-used",
name: "dd-inspector",
method: (key: string, detail: LDClient.LDEvaluationDetail) => {
datadogRum.addFeatureFlagEvaluation(key, detail.value);
},
},
],
});
LaunchDarkly は、このインテグレーションをサポートしていません。この機能をリクエストするには、LaunchDarkly でチケットを作成してください。
LaunchDarkly は、このインテグレーションをサポートしていません。この機能をリクエストするには、LaunchDarkly でチケットを作成してください。
LaunchDarkly は、このインテグレーションをサポートしていません。この機能をリクエストするには、LaunchDarkly でチケットを作成してください。
LaunchDarkly は現在、このインテグレーションをサポートしていません。この機能をリクエストするには、LaunchDarkly でチケットを作成してください。
Split インテグレーション
Split の SDK を初期化し、以下に示すコードスニペットを使用して Datadog に機能フラグの評価を報告するインプレッションリスナーを作成します。
Split の SDK の初期化については、Split の JavaScript SDK ドキュメントを参照してください。
const factory = SplitFactory({
core: {
authorizationKey: "<APP_KEY>",
key: "<USER_ID>",
},
impressionListener: {
logImpression(impressionData) {
datadogRum
.addFeatureFlagEvaluation(
impressionData.impression.feature,
impressionData.impression.treatment
);
},
},
});
const client = factory.client();
Split の SDK を初期化し、以下に示すコードスニペットを使用して、Datadog に機能フラグの評価を報告するインスペクターを作成します。
Split の SDK の初期化については、Split の iOS SDK ドキュメントを参照してください。
let config = SplitClientConfig()
// Split がインプレッションを報告する際に機能フラグを送信します
config.impressionListener = { impression in
if let feature = impression.feature,
let treatment = impression.treatment {
RUMMonitor.shared().addFeatureFlagEvaluation(name: feature, value: treatment)
}
}
Split の SDK を初期化し、以下に示すコードスニペットを使用して、Datadog に機能フラグの評価を報告するインスペクターを作成します。
Split の SDK の初期化については、Split の Android SDK ドキュメントを参照してください。
internal class DatadogSplitImpressionListener : ImpressionListener {
override fun log(impression: Impression) {
// Split でインフレが報告された際に機能フラグを送信
GlobalRumMonitor.get().addFeatureFlagEvaluation(
impression.split(),
impression.treatment()
)
}
override fun close() {
}
}
// 初期化時:
val apikey = BuildConfig.SPLIT_API_KEY
val config = SplitClientConfig.builder()
.impressionListener(DatadogSplitImpressionListener())
.build()
Split の SDK を初期化し、以下に示すコードスニペットを使用して、Datadog に機能フラグの評価を報告するインスペクターを作成します。
Split の SDK の初期化については、Split の Flutter プラグインのドキュメントを参照してください。
StreamSubscription<Impression> impressionsStream = _split.impressionsStream().listen((impression) {
// Split がインプレッションを報告する際に機能フラグを送信します
final split = impression.split;
final treatment = impression.treatment;
if (split != null && treatment != null) {
DatadogSdk.instance.rum?.addFeatureFlagEvaluation(split, treatment);
}
});
Split の SDK を初期化し、以下に示すコードスニペットを使用して Datadog に機能フラグの評価を報告するインプレッションリスナーを作成します。
Split の SDK の初期化については、Split の React Native SDK ドキュメントを参照してください。
const factory = SplitFactory({
core: {
authorizationKey: "<APP_KEY>",
key: "<USER_ID>",
},
impressionListener: {
logImpression(impressionData) {
DdRum
.addFeatureFlagEvaluation(
impressionData.impression.feature,
impressionData.impression.treatment
);
},
},
});
const client = factory.client();
Statsig インテグレーション
機能フラグ追跡は、RUM ブラウザ SDK で利用可能です。詳細なセットアップ方法は、RUM での機能フラグデータの概要をご覧ください。
ブラウザ RUM SDK バージョン 4.25.0 以上に更新します。
RUM SDK を初期化し、["feature_flags"]
で enableExperimentalFeatures
初期化パラメーターを構成します。
Statsig の SDK (>= v4.34.0
) を初期化し、以下のように gateEvaluationCallback
オプションを実装します。
await statsig.initialize('client-<STATSIG CLIENT KEY>',
{userID: '<USER ID>'},
{
gateEvaluationCallback: (key, value) => {
datadogRum.addFeatureFlagEvaluation(key, value);
}
}
);
Statsig はこのインテグレーションをサポートしていません。この機能のリクエストは、support@statsig.com までご連絡ください。
Statsig はこのインテグレーションをサポートしていません。この機能のリクエストは、support@statsig.com までご連絡ください。
Statsig はこのインテグレーションをサポートしていません。この機能のリクエストは、support@statsig.com までご連絡ください。
Statsig は現在このインテグレーションをサポートしていません。この機能のリクエストは、support@statsig.com までご連絡ください。
RUM で機能フラグのパフォーマンスを分析する
機能フラグは、RUM のセッション、ビュー、およびエラーのコンテキストにリストとして表示されます。
RUM エクスプローラーを使用した機能フラグの検索
RUM エクスプローラーで RUM が収集したすべてのデータを検索し、機能フラグの傾向を把握したり、より大きな文脈でパターンを分析したり、ダッシュボードやモニターにエクスポートしたりすることが可能です。RUM エクスプローラーでは、@feature_flags.{flag_name}
属性でセッション、ビュー、またはエラーを検索することができます。
セッション
Sessions を @feature_flags.{flag_name}
属性でフィルタリングすると、指定した時間枠で機能フラグが評価されたすべてのセッションを見つけることができます。
ビュー
Views を @feature_flags.{flag_name}
属性でフィルタリングすると、指定した時間枠で機能フラグが評価された特定のビューを見つけることができます。
エラー
Errors を @feature_flags.{flag_name}
属性でフィルタリングすると、指定した時間枠で機能フラグが評価されたビューで発生したすべてのエラーを見つけることができます。
トラブルシューティング
機能フラグのデータが期待通りに反映されないのはなぜですか?
機能フラグは、それが評価されるイベントのコンテキストに表示されます。つまり、機能フラグのコードロジックが実行されるビューに表示されるはずです。
コードの構成や機能フラグの設定によっては、予期せぬ機能フラグがイベントのコンテキストに表示されることがあります。
例えば、機能フラグがどのビューで評価されているかを確認するには、RUM エクスプローラーを使用して同様のクエリを行うことができます。
機能フラグが無関係なビューで評価されている理由の例をいくつか紹介しますので、調査の参考にしてください。
- 実行されるたびに機能フラグを評価する、複数のページに表示される共通のリアクトコンポーネント。
- 機能フラグを評価したコンポーネントが、URL の変更前/変更後にレンダリングされるルーティングの問題。
調査を行う際、機能フラグに関連する View Name
のデータをスコープすることも可能です。
機能フラグの命名
以下の特殊文字は 機能フラグ追跡 ではサポートされていません: .
、:
、+
、-
、=
、&&
、||
、>
、<
、!
、(
、)
、{
、}
、[
、]
、^
、"
、"
、~
、*
、?
、``。Datadogでは、機能フラグ名にこれらの文字を使用しないことを推奨しています。これらの文字を使用する必要がある場合は、 Datadog にデータを送信する前に文字を置き換えてください。例:
datadogRum.addFeatureFlagEvaluation(key.replace(':', '_'), value);
その他の参考資料