This example shows how to obtain further metrics for 51Degrees' on-premise device detection in Nginx.

This example shows how to obtain further metrics for 51Degrees' on-premise device detection in Nginx. The available metris are Drift, Difference, Method, UserAgents, DeviceId and MatchedNodes. This example is available in full on GitHub.

This example requires a local data file. The free 'Lite' data file can be downloaded with the scripts in the data GitHub repository, which this repository includes at cxx/data. Fetch the submodules by running git submodule update --init --recursive, then run sh cxx/data/get-data-files.sh 51Degrees-LiteV4.1.hash from the repository root, which saves the file as cxx/data/device-detection/51Degrees-LiteV4.1.hash.

The Lite data file is only used for illustration, and has limited accuracy and capabilities. The Enterprise data file has every property. Contact us about a copy.

Make sure to include at least IsMobile property for this to work.

Before using the example, update the followings:

Remove this 'how to' guide block.
Update the %%DAEMON_MODE%% to 'on' or 'off'.
Remove the %%TEST_GLOBALS%%.
Update the %%MODULE_PATH%% with the actual path.
Remove the %%TEST_GLOBALS_HTTP%%.
Update the %%FILE_PATH%% with the actual file path.
Replace the nginx.conf with this file or run Nginx with -c option pointing to this file.
Create a static file metrics in the Nginx document_root.

In a Linux environment, once Nginx has started, run the following command:

$ curl localhost:8080/metrics -I -A "Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit/537.51.2 (KHTML, like Gecko) Version/7.0 Mobile/11D167 Safari/9537.53"

Expected output:

HTTP/1.1 200 OK

...

x-metrics: 0,0,PERFORMANCE,18

x-user-agents: _________.0 (iPhone_______Phone ___7_1 like ____OS X_______WebK__________2 (KHTML,______Gecko_ Ver_________Mobile______7 Safari________

x-device-id: 12280-24384-24305-0

...

NOTE: All the lines above, this line and the end of comment block line after this line should be removed before using this example.

## Update DAEMON_MODE to 'on' or 'off' before running with Nginx ##

daemon %%DAEMON_MODE%%;

worker_processes 4;

## The following line is only for testing. Remove before running ##

## with Nginx ##

%%TEST_GLOBALS%%

## Update MODULE_PATH before running with Nginx ##

load_module %%MODULE_PATH%%modules/ngx_http_51D_module.so;

events {

worker_connections 1024;

}

# // Snippet Start

http {

## The following line is only for testing. Remove before ##

## running with Nginx ##

%%TEST_GLOBALS_HTTP%%

## Set the data file for the 51Degrees module to use ##

## Update the FILE_PATH before running with Nginx ##

51D_file_path %%FILE_PATH%%;

51D_drift 1;

51D_difference 1;

server {

listen 127.0.0.1:8080;

server_name localhost;

location /metrics {

## Get the metrics for the match using single User-Agent ##

51D_match_ua x-metrics Drift,Difference,Method,MatchedNodes;

## Get the matched user agent string ##

51D_match_ua x-user-agents UserAgents;

## Get the matched device ID ##

51D_match_ua x-device-id DeviceId;

## Add to response headers for easy viewing. ##

add_header x-metrics $http_x_metrics;

add_header x-user-agents $http_x_user_agents;

add_header x-device-id $http_x_device_id;

}

# // Snippet End

ngx_http_51D_module

ngx_module_t ngx_http_51D_module

Global module declaration.

Definition ngx_http_51D_module.c:117

hash/matchMetrics.conf