Application Real-Time Monitoring Service:SDK configuration reference

Set the config address (required)

Specify the configuration endpoint for your application.

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

Set the application ID (required)

Assign the unique application ID generated by the Real User Monitoring platform.

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

Set the application version (required)

Specify a version string for your application.

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

Set the application environment (optional)

Tag data with the deployment environment for filtering in the monitoring dashboard.

void alibabacloud_rum_options_set_env(alibabacloud_rum_options_t *options, alibabacloud_rum_env_t env)

Supported values:

Example:

alibabacloud_rum_options_set_env(options, ALIBABACLOUD_RUM_ENV_LOCAL);

Set a custom device ID (optional)

Override the auto-generated device ID with a custom value. By default, the SDK generates a device ID and caches it to a local file.

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

Set the log level (optional)

Adjust SDK log verbosity for troubleshooting. Higher levels produce more detailed output.

void alibabacloud_rum_options_set_debug_level(alibabacloud_rum_options_t *options, alibabacloud_rum_level_t level);

Supported values (from least to most verbose):

Example:

alibabacloud_rum_options_set_debug_level(options, ALIBABACLOUD_RUM_LEVEL_DEBUG);

Set the cache directory (optional)

Specify a custom directory for SDK cache files. By default, the SDK creates a .alibabacloud-rum folder in the same directory as the executable.

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

Enable or disable crash tracking (optional)

Toggle crash data collection. Enabled by default. Call this function before alibabacloud_rum_init.

void alibabacloud_rum_options_set_auto_crash_tracking(alibabacloud_rum_options_t *options, int enabled)

Example:

alibabacloud_rum_options_set_auto_crash_tracking(options, 1);

Set a network request filter (optional)

Control which URLs the SDK collects network data from and which URLs participate in end-to-end tracing.

void alibabacloud_rum_options_set_network_options(alibabacloud_rum_options_t *options, alibabacloud_rum_network_options_t *network_options)

The alibabacloud_rum_network_options_t struct provides two callback functions:

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:

// Filter whether to allow collection for a specific URL.
// If this function returns 0, data is not collected. If it returns a non-zero value, 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;
}

// Filter whether to allow end-to-end tracing 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, request data for all URLs is collected, but 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);

Enable or disable libcurl tracking (optional)

Toggle network data collection from the libcurl dynamic library. Enabled by default.

void alibabacloud_rum_options_set_auto_curl_tracking(alibabacloud_rum_options_t *options, int enabled)

Example:

alibabacloud_rum_options_set_auto_curl_tracking(options, 1);

Enable or disable CEF tracking (optional)

Toggle data collection from the Chromium Embedded Framework (CEF). Disabled by default.

void alibabacloud_rum_options_set_auto_cef_tracking(alibabacloud_rum_options_t *options, int enabled)

Example:

alibabacloud_rum_options_set_auto_cef_tracking(options, 1);

Initialize the SDK (required)

Start the SDK after all required options are set. Complete all startup configuration before this call.

int alibabacloud_rum_init(alibabacloud_rum_options_t *options)

Shut down the SDK (required)

Shut down the SDK by calling alibabacloud_rum_close.

int alibabacloud_rum_close()

Example:

alibabacloud_rum_close();

Set the username

void alibabacloud_rum_set_username(const char *username)

Example:

alibabacloud_rum_set_username("my nick name is xxxx");

Set the user ID

void alibabacloud_rum_set_userid(const char *userid)

Example:

alibabacloud_rum_set_userid("1234567890");

Set user tags

Attach custom tags to the current user for filtering and grouping in analytics.

void alibabacloud_rum_set_user_tags(const char *user_tags)

Report a custom exception

Create and report a custom exception with contextual details.

Functions:

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

Create and report a custom event with associated metrics and metadata.

Functions:

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

Create and report a custom log entry with severity level and content.

Functions:

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