C++ アプリケーションの接続¶
C++ アプリケーションのメトリクスデータを収集し、アプリケーションのパフォーマンスを可視化して分析します。現在、C++ SDK は Windows および Linux プラットフォームをサポートしています。
参照フロー¶
- 初回接続:まず接続方法を選択してください。手動接続の場合はクイックスタートを参照できます
- 全体の接続:引き続き本文を参照してください
- パラメータの詳細:SDK の初期化、RUM 設定、Log 設定、Trace 設定を参照してください
- カスタマイズ機能:カスタムタグ、カスタム収集ルールを参照してください
- トラブルシューティング:トラブルシューティングを参照してください
前提条件¶
注意
すでに RUM Headless サービスを開通している場合、前提条件は自動で設定済みのため、アプリケーションに直接接続できます。
ローカル環境にデプロイする場合は、以下のデータ受信側の設定を完了する必要があります。パブリックネットワークの DataWay を使用する場合は、DataKit を自身でデプロイする必要はありません。
- DataKit をインストールする;
- RUM コレクターを設定する;
- DataKit をパブリックネットワークからアクセス可能にし、IP 地理情報ライブラリをインストールする。
アプリケーションの接続¶
Guance コンソールにログインし、リアルユーザーモニタリング(RUM)ページに移動して、左上の アプリケーションを作成 をクリックすると、新しいアプリケーションの作成を開始できます。
作成完了後、アプリケーションに対応する RUM App ID を記録してください。後で FTRUMConfig を初期化する際に必要になります。
接続方法を選択¶
アプリケーション設定ページで「Agent 自動接続」または「手動接続」を選択し、続いて「接続設定」を完了します。既存のアプリケーションは、設定ページに直接移動して接続を続行できます。
| 接続方法 | ユースケース | 操作入口 |
|---|---|---|
| Agent 自動接続 | コーディングアシスタントにプロジェクトを分析させ、SDK の接続を完了したい場合 | コンソールが生成したプロンプトをコピーし、アプリケーションのコードリポジトリでコーディングアシスタントに実行させる |
| 手動接続 | SDK を自身でインストールしてパラメータを設定したい場合 | データ送信方法を確認し、本文とクイックスタートに従って設定を完了する |
Agent 自動接続¶
- 現在のアプリケーションの設定ページで「Agent 自動接続」を選択します。
- 「接続設定」内の完全なプロンプトをコピーし、現在のアプリケーションの接続情報が使用されていることを確認します。
- アプリケーションのコードリポジトリでコーディングアシスタントを開き、プロンプトを貼り付けます。Agent は接続ガイドに従ってプロジェクトを分析し、SDK 設定を完了します。
- アプリケーションをビルドして実行し、ページアクセスなどの操作をトリガーし、現在のアプリケーションのエクスプローラーでデータが受信されたことを確認します。
ページに個人用 API Key または一時認証コードが未準備である旨が表示された場合は、案内に従って補完してからプロンプトを再度コピーしてください。
手動接続¶
アプリケーション設定ページで「手動接続」を選択し、データ送信方法を確認します:
- パブリックネットワークの DataWay:現在のアプリケーションの接続設定から送信先アドレスと Client Token を取得します。DataKit を自身でデプロイする必要はありません。
- ローカル環境へのデプロイ:デプロイ済みの DataKit でデータを受信し、アプリケーションがその送信先アドレスにアクセスできることを確認します。
後述のインストールとクイックスタートに従って、SDK のインストール、初期化、検証を完了してください。既存の SDK 設定がある場合は、まず確認して再利用し、重複した初期化を避けてください。
インストール¶
ソースコード:https://github.com/GuanceCloud/datakit-cpp
デモのアドレス:https://github.com/GuanceCloud/datakit-cpp/ft-sdk-sample
git clone https://github.com/microsoft/vcpkg
#apt install ninja-build
#apt install pkg-config
./vcpkg/bootstrap-vcpkg.sh
cd vcpkg
# カスタム設定の registries ファイルをダウンロード
curl -o vcpkg-configuration.json https://static.guance.com/ft-sdk-package/vcpkg_config/vcpkg-configuration.json
# arm 64 の場合は VCPKG_FORCE_SYSTEM_BINARIES を追加する必要があります
#export VCPKG_FORCE_SYSTEM_BINARIES=1
./vcpkg install datakit-sdk-cpp:x64-linux
# コンパイル環境で VCPKG_ROOT 変数を参照します
export VCPKG_ROOT= [ your_vcpkg_root_dir ]
CMake 設定を追加
cmake_minimum_required(VERSION 3.0)
project(ft-sdk-reference-sample VERSION 1.0.0 LANGUAGES CXX C)
add_definitions(-fPIC -g -Werror=return-type)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17 -O1 -ftree-vectorize -ffast-math ")
set(CMAKE_CXX_STANDARD 17)
if(DEFINED ENV{VCPKG_ROOT})
if (EXISTS "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake")
include ("$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake")
set(VCPKG_CMAKE_SHARE "$ENV{VCPKG_ROOT}/installed/${VCPKG_TARGET_TRIPLET}/share"
CACHE STRING "TEST")
endif ()
else ()
message(STATUS "please set the system environment variable : VCPKG_ROOT" $ENV{VCPKG_ROOT})
endif ()
# Guance SDK の参照を追加
find_path(FT-SDK_INCLUDE_DIR datakit-sdk-cpp/FTSDK.h)
find_library(FT-SDK_LIBRARY ft-sdk "${FT-SDK_INCLUDE_DIR}/../lib/")
include_directories(${FT-SDK_INCLUDE_DIR})
file(GLOB PROJECT_SOURCE "*.cpp")
file(GLOB PROJECT_HEADER "../include/*.h" "*.h")
add_executable (${PROJECT_NAME} ${PROJECT_SOURCE} ${PROJECT_HEADER})
# SDK をリンク
target_link_libraries(${PROJECT_NAME} PRIVATE ${FT-SDK_LIBRARY})
ヘッダーのインクルード¶
初期化について¶
最小限の初期化例については、クイックスタートを参照してください。
完全な初期化と実行時の機能については、SDK の初期化を参照してください。
詳細設定へのリンク¶
高度なシナリオ¶
よくある質問¶
グローバル変数を追加して競合するフィールドを回避する¶
カスタムフィールドと SDK データの競合を避けるため、タグ名には プロジェクトの略称 を接頭辞として追加することをおすすめします。例:custom_tag_name。プロジェクトで使用されている予約済みの key はソースコードを確認できます。
SDK のグローバル変数に RUM や Log と同じフィールドが存在する場合、RUM と Log の同名フィールドが SDK のグローバル変数を上書きします。
接続が成功したかをすばやく確認する方法¶
まず クイックスタート に従って最小限の初期化を完了し、enable_sdk_log デバッグログを有効にした後、View、Action、または Log の送信を一度手動でトリガーし、コンソールでデータが表示されるかを確認することをおすすめします。
初期化後にデータがない場合の対処方法¶
まず次の項目を確認してください:
setServerUrlで設定した DataKit アドレスに現在のデバイスからアクセスできるかsetRumAppIdが正しく入力されているか- 前提条件 の DataKit と RUM コレクターの設定が完了しているか
- 現在のプラットフォームが C++ SDK でサポートされている Windows または Linux か
それでも問題を特定できない場合は、トラブルシューティングを参照してください。