Extension configuration for PHP

• Introduction
• Global parameters
  • extension
  • nudge.apps
  • nudge.agent_address
  • nudge.agent_port
• Logging configuration
  • nudge.log_level
  • nudge.log_filepath
• Tracing functions
  • nudge.trace_functions

Introduction

Those parameters are defined in the nudge.ini which is part of the Nudge-PHP bundle.

This bundle is available on the Atakama support :

Download Nudge-PHP Bundle

Once the bundle is downloaded and unzipped, you will find the file in the extension/vx.x.x/conf folder.

Global parameters

extension

Type	String
Default value	[none]
Mandatory	Yes

Path file of the Nudge APM PHP extension.

nudge.apps

Type	String
Default value	[none]
Parameter format	folder-path:nudge-application-key
Mandatory	Yes

Attribution of a Nudge APM application key to one of the folder served by your Apache.
You can specify multiples folders by separate them with a comma.

Your application key can be found in the application settings at Nudge APM.

Below, some examples for using this parameter :

• Example 1 - one monitored folder :
  nudge.apps=/var/www/:00000000-0000-0000-0000-000000000000
• Example 2 - two monitored folders :
  nudge.apps=/var/www/appli1:00000000-0000-0000-0000-000000000001,/var/www/appli2:00000000-0000-0000-0000-000000000002

nudge.agent_address

Type	String
Default value	127.0.0.1
Mandatory	No

Hostname or IP adress of you Nudge APM agent.

nudge.agent_port

Type	String
Default value	1025
Mandatory	No

Listening port of you Nudge APM agent.

Logging configuration

nudge.log_level

Type	String
Default value	error
Mandatory	No

Logging levels of the messages provided by the extension.
Values permitted :

• debug
• debugtimer
• infotimer
• info
• warn
• error
• none

nudge.log_filepath

Type	String
Default value	/var/log/nudge/nudge-extension.log
Mandatory	No

Path for the extension logging file.

Tracing functions

nudge.trace_functions

Type	String
Default value	[none]
Mandatory	No
Parameter format	{class_name}:{function_name}.{layer}.{function_param}

With this parameter you can instrument specific classes and functions of your code, and aggregate them in a specific layer (SQL, WS, Elasticsearch, REST, RabbitMQ, business layer, …).

Parameter format :

• class_name (optional) : class name with its namespace . Warning, class and function must be separated with :.
• function_name (mandatory) : function name to be observed
• layer (mandatory) : [sql|ws] layer or a user specific layer
• function_param (optional) : number of function parameter to be used for transaction name, must start with #

An example with a sayHello function, from a Hello class and aggregated in a Nudge layer called user : nudge.trace_functions=AppBundle\Utils\Hello:sayHello.user

You can specify multiple functions to trace, the separator is , :
nudge.trace_functions=functionOne.user,functionTwo.user