Cloud Monitor:SDK configuration reference

(Required) Set the Config address

You must associate each application with its Config address. Call this function before you call the alibabacloud_rum_init function.

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

Example:

alibabacloud_rum_options_set_config_address(options, RUM_CONFIG_ADDRESS);

(Required) Set the application ID

You must associate each application with its AppId. Call this function before you call the alibabacloud_rum_init function.

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

Example:

alibabacloud_rum_options_set_app_id(options, RUM_CONFIG_APPID);

(Required) Set the application name

You must set the application name. Call this function before you call the alibabacloud_rum_init function.

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

Example:

alibabacloud_rum_options_set_app_name(options, "WindowsDemo");

(Required) Set the application version number

The SDK lets you set the version number of the application. You must call this function before you call the alibabacloud_rum_init function.

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

Example:

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

(Optional) Set the application environment

The SDK lets you set the application environment. Environments include local, daily, pre, gray, and prod. Call this function before you call the alibabacloud_rum_init function.

void alibabacloud_rum_options_set_env(alibabacloud_rum_options_t *options, alibabacloud_rum_env_t env)

Example:

alibabacloud_rum_options_set_env(options, ALIBABACLOUD_RUM_ENV_LOCAL);

(Optional) Set the device ID

You can set the device ID for the application as needed. By default, the SDK generates a device ID and caches it in a local file. Call this function before you call the alibabacloud_rum_init function.

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

Example:

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

(Optional) Set the log level

The SDK outputs logs during runtime. If you encounter issues when you use the SDK, you can adjust the SDK log level to output more information for troubleshooting. Call this function before you call the alibabacloud_rum_init function.

void alibabacloud_rum_options_set_debug_level(alibabacloud_rum_options_t *options, alibabacloud_rum_level_t level);

Example:

alibabacloud_rum_options_set_debug_level(options, ALIBABACLOUD_RUM_LEVEL_DEBUG);

(Optional) Set the cache folder

The SDK generates cache files during runtime. You can specify a cache folder as needed. By default, the SDK creates a folder named .alibabacloud-rum in the same directory as the executable file. Call this function before you call the alibabacloud_rum_init function.

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

Example:

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

(Optional) Set a filter for network request collection

The SDK supports collecting network request data from the libcurl and Chromium Embedded Framework (CEF) frameworks. You can configure a network request collection filter to control the collection behavior for specific URLs. Call this function before you call the alibabacloud_rum_init function.

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;

Example:

// Filters whether collection is allowed for a specific URL.
// If this function returns 0, the data is not collected. If it returns a non-zero value, the data is collected.
int ALIBABACLOUD_RUM_CALLBACK example_should_record_request(const char *url)
{
    LOG("example", "example_should_record_request, url: %s", url);
    return 1;
}

// Filters whether end-to-end tracing is allowed for a specific URL.
// If this function returns 0, tracing is allowed. If it returns a non-zero value, tracing is not allowed.
int ALIBABACLOUD_RUM_CALLBACK example_should_tracing(const char *url)
{
    LOG("example", "example_should_tracing, url: %s", url);
    return NULL != strstr(url, "/api/data");
}

// Note: The SDK configures network_options by default. By default, data from all URL requests is collected, and end-to-end tracing is not allowed for any 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);

(Optional) Enable or disable the libcurl network request collection module

The SDK lets you configure whether to enable the libcurl network request module. This module is enabled by default. Call this function before you call the alibabacloud_rum_init function.

void alibabacloud_rum_options_set_auto_curl_tracking(alibabacloud_rum_options_t *options, int enabled)

Example:

// Enable the libcurl network request collection module.
alibabacloud_rum_options_set_auto_curl_tracking(options, 1);

Note: Before you enable the libcurl network request collection module, you must integrate the libcurl library. Currently, only data collection from the libcurl dynamic library is supported.

(Optional) Enable or disable the crash collection module

The SDK lets you configure whether to enable the crash data collection module. This module is enabled by default. Call this function before you call the alibabacloud_rum_init function.

void alibabacloud_rum_options_set_auto_crash_tracking(alibabacloud_rum_options_t *options, int enabled)

Example:

// Enable the crash data collection module.
alibabacloud_rum_options_set_auto_crash_tracking(options, 1);

(Optional) Enable or disable the CEF framework data collection module

The SDK lets you configure whether to enable the CEF data collection module. This module is disabled by default. Call this function before you call the alibabacloud_rum_init function.

void alibabacloud_rum_options_set_auto_cef_tracking(alibabacloud_rum_options_t *options, int enabled)

Example:

// Enable the CEF framework data collection module.
alibabacloud_rum_options_set_auto_cef_tracking(options, 1);

Note: Before you enable the CEF data collection module, you must integrate the CEF library. Currently, only data collection from the CEF dynamic library is supported.

(Required) Start the SDK

Use the alibabacloud_rum_init function to initialize the SDK.

int alibabacloud_rum_init(alibabacloud_rum_options_t *options)

(Required) Shut down the SDK

Use the alibabacloud_rum_close function to shut down the SDK.

int alibabacloud_rum_close()

Example:

alibabacloud_rum_close()

Set the username

The SDK lets you set user-related information. This helps you associate data analytics with actual users. Call this function after you call the alibabacloud_rum_init function.

void alibabacloud_rum_set_username(const char *username)

Example:

alibabacloud_rum_set_username("my nick name is xxxx");

Set the user ID

The SDK lets you set user-related information. This helps you associate data analytics with actual users. Call this function after you call the alibabacloud_rum_init function.

void alibabacloud_rum_set_userid(const char *userid)

Example:

alibabacloud_rum_set_userid("1234567890");

Set extended user information

The SDK lets you set user-related information. This helps you associate data analytics with actual users.

void alibabacloud_rum_set_user_tags(const char *user_tags)

Set global properties

The SDK lets you set custom global business properties. After you set custom global properties, newly generated data automatically includes these properties. This helps you associate data analytics with business properties. A call to the alibabacloud_rum_set_properties function overwrites the previous value.

#define alibabacloud_rum_set_properties(...)

Example:

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

Report a custom exception

You can call the custom exception function and pass the corresponding parameters to collect custom exception data. The C/C++ SDK provides a set of functions to report custom exceptions.

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);

Example:

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);

Report a custom event

The SDK supports reporting custom events. You can call the corresponding function and pass the required parameters to collect custom event data. The C/C++ SDK provides a set of functions to report custom events.

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);

Example:

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);

Report a custom log

The SDK supports reporting custom log information. You can call the corresponding function and pass the required parameters to collect custom log data. The C/C++ SDK provides a set of functions to report custom logs.

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);

Example:

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);

Report a custom resource

The SDK supports reporting custom resource information. You can call the corresponding function and pass the required parameters to collect custom resource data. The C/C++ SDK provides a set of functions to report custom resources.

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);

The following table describes the parameters and definitions for the measurement metrics.

Example:

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;
}

// Set resource type
alibabacloud_rum_custom_resource_set_type(resource, ALIBABACLOUD_RUM_RESOURCE_TYPE_XHR);

// Set HTTP response info
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");

// Set all performance metrics at once
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
);

// Add custom attributes
alibabacloud_rum_custom_resource_add_attribute(resource, "endpoint", "/users");
alibabacloud_rum_custom_resource_add_attribute(resource, "api_version", "v1");

// Report the event
alibabacloud_rum_custom_resource_report(resource);

// Clean up
alibabacloud_rum_custom_resource_free(resource);