Cloud Monitor:SDK 設定リファレンス

(必須) Config アドレスの設定

各アプリケーションをその Config アドレスに関連付ける必要があります。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_config_address(alibabacloud_rum_options_t *options, const char *config_address);

例：

alibabacloud_rum_options_set_config_address(options, RUM_CONFIG_ADDRESS);

(必須) アプリケーション ID の設定

各アプリケーションをその AppId に関連付ける必要があります。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_app_id(alibabacloud_rum_options_t *options, const char *app_id)

例：

alibabacloud_rum_options_set_app_id(options, RUM_CONFIG_APPID);

(必須) アプリケーション名の設定

アプリケーション名を設定する必要があります。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_app_name(alibabacloud_rum_options_t *options, const char *app_name)

例：

alibabacloud_rum_options_set_app_name(options, "WindowsDemo");

(必須) アプリケーションのバージョン番号の設定

SDK を使用して、アプリケーションのバージョン番号を設定できます。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出す必要があります。

void alibabacloud_rum_options_set_app_version(alibabacloud_rum_options_t *options, const char *app_version)

例：

alibabacloud_rum_options_set_app_version(options, "0.1.0-beta.2");

(任意) アプリケーション環境の設定

SDK を使用して、アプリケーション環境を設定できます。環境には、local、daily、pre、gray、prod が含まれます。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_env(alibabacloud_rum_options_t *options, alibabacloud_rum_env_t env)

例：

alibabacloud_rum_options_set_env(options, ALIBABACLOUD_RUM_ENV_LOCAL);

(任意) デバイス ID の設定

必要に応じて、アプリケーションのデバイス ID を設定できます。デフォルトでは、SDK はデバイス ID を生成し、ローカルファイルにキャッシュします。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_utdid(alibabacloud_rum_options_t *options, const char *utdid)

例：

alibabacloud_rum_options_set_utdid(options, "b7028408-ddac-4a58-72a9-653f6637f0e6");

(任意) ログレベルの設定

SDK は実行時にログを出力します。SDK の使用中に問題が発生した場合は、SDK のログレベルを調整して、トラブルシューティングのためにより多くの情報を出力できます。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_debug_level(alibabacloud_rum_options_t *options, alibabacloud_rum_level_t level);

例：

alibabacloud_rum_options_set_debug_level(options, ALIBABACLOUD_RUM_LEVEL_DEBUG);

(任意) キャッシュフォルダーの設定

SDK は実行時にキャッシュファイルを生成します。必要に応じてキャッシュフォルダーを指定できます。デフォルトでは、SDK は実行可能ファイルと同じディレクトリに .alibabacloud-rum という名前のフォルダーを作成します。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_cache_path(alibabacloud_rum_options_t *options, const char *path)

例：

alibabacloud_rum_options_set_cache_path(options, "/path/to/your/cache/");

(任意) ネットワークリクエスト収集フィルターの設定

SDK は、libcurl および Chromium Embedded Framework (CEF) フレームワークからのネットワークリクエストデータの収集をサポートしています。ネットワークリクエスト収集フィルターを設定して、特定の URL の収集動作を制御できます。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_network_options(alibabacloud_rum_options_t *options, alibabacloud_rum_network_options_t *network_options)

typedef struct alibabacloud_rum_network_options_s
{
    int (ALIBABACLOUD_RUM_CALLBACK *should_record_request)(const char *url);
    int (ALIBABACLOUD_RUM_CALLBACK *should_tracing)(const char *url);
} alibabacloud_rum_network_options_t;

例：

// 特定の URL に対して収集が許可されているかどうかをフィルターします。
// この関数が 0 を返した場合、データは収集されません。ゼロ以外の値を返した場合、データは収集されます。
int ALIBABACLOUD_RUM_CALLBACK example_should_record_request(const char *url)
{
    LOG("example", "example_should_record_request, url: %s", url);
    return 1;
}

// 特定の URL に対してエンドツーエンドトレースが許可されているかどうかをフィルターします。
// この関数が 0 を返した場合、トレースは許可されます。ゼロ以外の値を返した場合、トレースは許可されません。
int ALIBABACLOUD_RUM_CALLBACK example_should_tracing(const char *url)
{
    LOG("example", "example_should_tracing, url: %s", url);
    return NULL != strstr(url, "/api/data");
}

// 注： SDK はデフォルトで network_options を設定します。デフォルトでは、すべての URL リクエストのデータが収集され、どの URL に対してもエンドツーエンドトレースは許可されません。
alibabacloud_rum_network_options_t *network_options = alibabacloud_rum_network_options_new();
network_options->should_tracing = example_should_tracing;
network_options->should_record_request = example_should_record_request;
alibabacloud_rum_options_set_network_options(options, network_options);

(任意) libcurl ネットワークリクエスト収集モジュールの有効化/無効化

SDK を使用して、libcurl ネットワークリクエストモジュールを有効にするかどうかを設定できます。このモジュールはデフォルトで有効になっています。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_auto_curl_tracking(alibabacloud_rum_options_t *options, int enabled)

例：

// libcurl ネットワークリクエスト収集モジュールを有効にします。
alibabacloud_rum_options_set_auto_curl_tracking(options, 1);

注： libcurl ネットワークリクエスト収集モジュールを有効にする前に、libcurl ライブラリを統合する必要があります。現在、libcurl 動的ライブラリからのデータ収集のみがサポートされています。

(任意) クラッシュ収集モジュールの有効化/無効化

SDK を使用して、クラッシュデータ収集モジュールを有効にするかどうかを設定できます。このモジュールはデフォルトで有効になっています。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_auto_crash_tracking(alibabacloud_rum_options_t *options, int enabled)

例：

// クラッシュデータ収集モジュールを有効にします。
alibabacloud_rum_options_set_auto_crash_tracking(options, 1);

(任意) CEF フレームワークデータ収集モジュールの有効化/無効化

SDK を使用して、CEF データ収集モジュールを有効にするかどうかを設定できます。このモジュールはデフォルトで無効になっています。この関数は、alibabacloud_rum_init 関数を呼び出す前に呼び出してください。

void alibabacloud_rum_options_set_auto_cef_tracking(alibabacloud_rum_options_t *options, int enabled)

例：

// CEF フレームワークデータ収集モジュールを有効にします。
alibabacloud_rum_options_set_auto_cef_tracking(options, 1);

注： CEF データ収集モジュールを有効にする前に、CEF ライブラリを統合する必要があります。現在、CEF 動的ライブラリからのデータ収集のみがサポートされています。

(必須) SDK の起動

alibabacloud_rum_init 関数を使用して SDK を初期化します。

int alibabacloud_rum_init(alibabacloud_rum_options_t *options)

(必須) SDK のシャットダウン

alibabacloud_rum_close 関数を使用して SDK をシャットダウンします。

int alibabacloud_rum_close()

例：

alibabacloud_rum_close()

ユーザー名の設定

SDK を使用して、ユーザー関連の情報を設定できます。これにより、データ分析を実際のユーザーと関連付けることができます。この関数は、alibabacloud_rum_init 関数を呼び出した後に呼び出してください。

void alibabacloud_rum_set_username(const char *username)

例：

alibabacloud_rum_set_username("my nick name is xxxx");

ユーザー ID の設定

SDK を使用して、ユーザー関連の情報を設定できます。これにより、データ分析を実際のユーザーと関連付けることができます。この関数は、alibabacloud_rum_init 関数を呼び出した後に呼び出してください。

void alibabacloud_rum_set_userid(const char *userid)

例：

alibabacloud_rum_set_userid("1234567890");

拡張ユーザー情報の設定

SDK を使用して、ユーザー関連の情報を設定できます。これにより、データ分析を実際のユーザーと関連付けることができます。

void alibabacloud_rum_set_user_tags(const char *user_tags)

グローバルプロパティの設定

SDK を使用して、カスタムのグローバルビジネスプロパティを設定できます。カスタムグローバルプロパティを設定すると、新しく生成されたデータにこれらのプロパティが自動的に含まれます。これにより、データ分析をビジネスプロパティと関連付けることができます。alibabacloud_rum_set_properties 関数を呼び出すと、以前の値が上書きされます。

#define alibabacloud_rum_set_properties(...)

例：

alibabacloud_rum_set_properties("shop_id", "gz_xihu_001", "shop_name", "Xihu Main Store");

カスタム例外のレポート

カスタム例外関数を呼び出し、対応するパラメーターを渡して、カスタム例外データを収集できます。C/C++ SDK は、カスタム例外をレポートするための一連の関数を提供します。

alibabacloud_rum_custom_exception_t* alibabacloud_rum_custom_exception_new(const char *name, const char *message);
void alibabacloud_rum_custom_exception_set_file(alibabacloud_rum_custom_exception_t *event, const char *file);
void alibabacloud_rum_custom_exception_set_source(alibabacloud_rum_custom_exception_t *event, const char *source);
void alibabacloud_rum_custom_exception_set_caused_by(alibabacloud_rum_custom_exception_t *event, const char *caused_by);
void alibabacloud_rum_custom_exception_set_stack(alibabacloud_rum_custom_exception_t *event, const char *stack);
void alibabacloud_rum_custom_exception_free(alibabacloud_rum_custom_exception_t *event);
void alibabacloud_rum_custom_exception_report(alibabacloud_rum_custom_exception_t *event);

例：

alibabacloud_rum_custom_exception_t *custom_exception = alibabacloud_rum_custom_exception_new("exception", "NullPointerException");
alibabacloud_rum_custom_exception_set_file(custom_exception, "/example/main.c");
alibabacloud_rum_custom_exception_set_caused_by(custom_exception, "NullPointerException");
alibabacloud_rum_custom_exception_set_stack(custom_exception, "Exception in thread 'main' java.util.NullPointerException");
alibabacloud_rum_custom_exception_report(custom_exception);

カスタムイベントのレポート

SDK はカスタムイベントのレポートをサポートしています。対応する関数を呼び出し、必要なパラメーターを渡して、カスタムイベントデータを収集できます。C/C++ SDK は、カスタムイベントをレポートするための一連の関数を提供します。

alibabacloud_rum_custom_event_t* alibabacloud_rum_custom_event_new(const char *type, const char *name);
void alibabacloud_rum_custom_event_set_value(alibabacloud_rum_custom_event_t *event, double value);
void alibabacloud_rum_custom_event_set_group(alibabacloud_rum_custom_event_t *event, const char *group);
void alibabacloud_rum_custom_event_set_snapshots(alibabacloud_rum_custom_event_t *event, const char *snapshots);
void alibabacloud_rum_custom_event_add_extra(alibabacloud_rum_custom_event_t *event, const char *k, const  char *v);
void alibabacloud_rum_custom_event_free(alibabacloud_rum_custom_event_t *event);
void alibabacloud_rum_custom_event_report(alibabacloud_rum_custom_event_t *event);

例：

alibabacloud_rum_custom_event_t *event = alibabacloud_rum_custom_event_new("custom_event_type", "custom_event_name");
alibabacloud_rum_custom_event_set_group(event, "custom_event_group");
alibabacloud_rum_custom_event_set_value(event, 123.3456);
alibabacloud_rum_custom_event_set_snapshots(event, "custom event snapshots");
alibabacloud_rum_custom_event_add_extra(event, "event_key1", "event_value1");
alibabacloud_rum_custom_event_add_extra(event, "event_key2", "event_value2");
alibabacloud_rum_custom_event_report(event);

カスタムログのレポート

SDK はカスタムログ情報のレポートをサポートしています。対応する関数を呼び出し、必要なパラメーターを渡して、カスタムログデータを収集できます。C/C++ SDK は、カスタムログをレポートするための一連の関数を提供します。

alibabacloud_rum_custom_log_t *alibabacloud_rum_custom_log_new(const char *type, const char *name);
void alibabacloud_rum_custom_log_set_log(alibabacloud_rum_custom_log_t *log, alibabacloud_rum_custom_log_level_t level, const char *content);
void alibabacloud_rum_custom_log_set_value(alibabacloud_rum_custom_log_t *log, double value);
void alibabacloud_rum_custom_log_set_group(alibabacloud_rum_custom_log_t *log, const char *group);
void alibabacloud_rum_custom_log_set_snapshots(alibabacloud_rum_custom_log_t *log, const char *snapshots);
void alibabacloud_rum_custom_log_add_extra(alibabacloud_rum_custom_log_t *log, const char *k, const char *v);
void alibabacloud_rum_custom_log_free(alibabacloud_rum_custom_log_t *log);
void alibabacloud_rum_custom_log_report(alibabacloud_rum_custom_log_t *log);

例：

alibabacloud_rum_custom_log_t *log = alibabacloud_rum_custom_log_new("custom_log_type", "custom_log_name");
alibabacloud_rum_custom_log_set_group(log, "custom_log_group");
alibabacloud_rum_custom_log_set_value(log, 343.4222);
alibabacloud_rum_custom_log_set_snapshots(log, "custom log snapshots");
alibabacloud_rum_custom_log_set_log(log, LOG_DEBUG, "This is the custom log content");
alibabacloud_rum_custom_log_add_extra(log, "log_key1", "log_value1");
alibabacloud_rum_custom_log_add_extra(log, "log_key2", "log_value2");
alibabacloud_rum_custom_log_report(log);

カスタムリソースのレポート

SDK はカスタムリソース情報のレポートをサポートしています。対応する関数を呼び出し、必要なパラメーターを渡して、カスタムリソースデータを収集できます。C/C++ SDK は、カスタムリソースをレポートするための一連の関数を提供します。

alibabacloud_rum_custom_resource_t* alibabacloud_rum_custom_resource_new(const char *url, const char *method);
void alibabacloud_rum_custom_resource_set_type(alibabacloud_rum_custom_resource_t *resource, alibabacloud_rum_resource_type_t type);
void alibabacloud_rum_custom_resource_set_status_code(alibabacloud_rum_custom_resource_t *resource, int32_t status_code);
void alibabacloud_rum_custom_resource_set_success(alibabacloud_rum_custom_resource_t *resource, int32_t success);
void alibabacloud_rum_custom_resource_set_measuring(
    alibabacloud_rum_custom_resource_t *resource,
    int64_t duration,
    int64_t size,
    int32_t connect_duration,
    int32_t ssl_duration,
    int32_t dns_duration,
    int32_t redirect_duration,
    int32_t first_byte_duration,
    int32_t download_duration);
void alibabacloud_rum_custom_resource_set_trace_id(alibabacloud_rum_custom_resource_t *resource, const char *trace_id);
void alibabacloud_rum_custom_resource_set_span_id(alibabacloud_rum_custom_resource_t *resource, const char *span_id);
void alibabacloud_rum_custom_resource_set_provider(alibabacloud_rum_custom_resource_t *resource, const char *provider);
void alibabacloud_rum_custom_resource_add_attribute(alibabacloud_rum_custom_resource_t *resource, const char *key, const char *value);
void alibabacloud_rum_custom_resource_free(alibabacloud_rum_custom_resource_t *resource);
void alibabacloud_rum_custom_resource_report(alibabacloud_rum_custom_resource_t *resource);

次の表に、測定メトリックのパラメーターと定義を示します。

例：

alibabacloud_rum_custom_resource_t *resource = 
        alibabacloud_rum_custom_resource_new("https://api.example.com/users", "GET");
if (!resource) {
    printf("Failed to create resource event\n");
    return;
}

// リソースタイプを設定します
alibabacloud_rum_custom_resource_set_type(resource, ALIBABACLOUD_RUM_RESOURCE_TYPE_XHR);

// HTTP 応答情報を設定します
alibabacloud_rum_custom_resource_set_status_code(resource, 200);
alibabacloud_rum_custom_resource_set_success(resource, 1);
alibabacloud_rum_custom_resource_set_provider(resource, "first-party");

// すべてのパフォーマンスメトリックを一度に設定します
alibabacloud_rum_custom_resource_set_measuring(
    resource,
    285,    // duration
    2048,   // size
    25,     // connect_duration
    45,     // ssl_duration
    15,     // dns_duration
    0,      // redirect_duration
    120,    // first_byte_duration
    80      // download_duration
);

// カスタム属性を追加します
alibabacloud_rum_custom_resource_add_attribute(resource, "endpoint", "/users");
alibabacloud_rum_custom_resource_add_attribute(resource, "api_version", "v1");

// イベントをレポートします
alibabacloud_rum_custom_resource_report(resource);

// クリーンアップ
alibabacloud_rum_custom_resource_free(resource);