SDK 初期化¶

このドキュメントでは、C++ SDK の初期化、基本設定、およびランタイム機能について説明します。

ヘッダーファイルの参照¶

#include "datakit-sdk-cpp/FTSDKFactory.h"

SDK の初期化¶

auto sdk = FTSDKFactory::get();
sdk->init();

フィールド	型	必須	説明
`FTSDKFactory::get`	string	いいえ	設定ファイルを指定します。デフォルトは `ft_sdk_config.json` です。

JSON ファイル設定の起動¶

FTSDKFactory を使用して、JSON ファイルから SDK のデバッグログを有効にできます。

{
  "general_config": {
    "enable_sdk_log": true
  }
}

enable_sdk_log はデバッグログを有効にするために使用します。デフォルトは無効です。

基本設定¶

FTSDKConfig gc;
gc.setServerUrl("http://10.0.0.1:9529")
  .setEnv(EnvType::PROD)
  .addGlobalContext("custom_key", "custom_value")
  .setEnableFileDBCache(true);
sdk->install(gc);

フィールド	型	必須	説明
`setServerUrl`	string	はい	DataKit アクセス URL アドレス。例: `http://10.0.0.1:9529`。デフォルトポートは `9529` です。SDK をインストールするデバイスからこのアドレスにアクセスできる必要があります。
`setEnv`	enum	いいえ	環境設定。デフォルトは `EnvType::PROD` です。
`setAppVersion`	string	いいえ	Windows では自動的に取得されます。Linux では手動で設定する必要があります。
`setEnableFileDBCache`	bool	いいえ	ローカルデータベースキャッシュを有効にするかどうか。デフォルトは `false` です。
`addGlobalContext`	dictionary	いいえ	SDK のグローバル属性を追加します。ルールについてはカスタムタグとフィールド競合の説明を参照してください。
`setServiceName`	string	いいえ	Log および RUM の `service` フィールドデータに影響します。Windows のデフォルトは `df_rum_windows`、Linux のデフォルトは `df_rum_linux` です。

ユーザー情報のバインドとアンバインド¶

/**
 * ユーザーデータをバインドします。
 *
 * @param config ユーザーデータ
 */
FTSDK&& bindUserData(UserData& config);

/**
 * ユーザーデータをアンバインドします。
 */
void unbindUserData();

例：

UserData uc;
uc.init("username", "1001", "someone@email.com");
uc.addCustomizeItem("ft_key", "ft_value");
sdk->bindUserData(uc);

sdk->unbindUserData();

addCustomizeItem のフィールド命名は、同様にフィールド競合の説明に従うことを推奨します。

ランタイム機能¶

SDK の停止¶

sdk->deinit();

deinit() を呼び出すと、リソースのクリーンアップが実行されます。アプリケーションプロセスが引き続き収集を行う必要がある場合は、再度初期化と設定を実行してください。