• /
  • Log in
  • Free account

newrelic_capture_params (PHP agent API)

Syntax

newrelic_capture_params([bool $enable_flag])

Enable or disable the capture of URL parameters.

Requirements

Compatible with all agent versions.

Description

Enable or disable the capture of URL parameters (everything after the ? in the URL). This overrides the newrelic.capture_params config file setting.

Important

If you pass sensitive information directly in the URL, keep this disabled.

Parameters

Parameter

Description

$enable_flag

boolean

Optional. Defaults to true.

If true or omitted, enables the capture of URL parameters.

If false, disables the capture of URL parameters.

Examples

Enable capture of URL parameters

function example() {
    if (extension_loaded('newrelic')) { // Ensure PHP agent is available
        newrelic_capture_params();
    }
    ...
}

Disable capture of URL parameters

function example() {
    if (extension_loaded('newrelic')) { // Ensure PHP agent is available
        newrelic_capture_params(false);
    }
    ...
}

For more help

If you need more help, check out these support and learning resources:

Create issueEdit page
Copyright © 2021 New Relic Inc.