PHP extension

billionaire edited this page Feb 4, 2017 · 17 revisions

The extension is needed to gather and send statistics data and also to manage timers.
At the request time the extension records time and resource usage and at the request shutdown it computes the difference.
After that the extension creates a protobuf packet and sends it to the server by UDP.

Table of Contents

Installation

See here: Pinba extension installation.

Introduction

Before starting to describe the API we need to explain several basic things about Pinba.
There are several basic design objects you need to understand:

  • request - contains all request data (such as script_name, time taken, hostname, servername etc.)
  • timer - user can set marks to measure time it takes to execute some parts of the code. This is done using timers. Each request might have an unlimited number of timers (*).
  • tag - tags and their values are used to describe timers, so that you could group them afterwards. Each timer might have an unlimited number of tags (*).
There are also PHPDoc helpers for Pinba.

Example:

Say you have a script that connects to the database and performs several queries.
Each SQL operation might use at least two tags:

  • group => sql
  • operation => insert/select/update etc.
This way you can easily group them by both tags.

INI Directives

pinba.enabled

pinba.enabled enables or disables sending request data to the server.
Can be modified using ini_set() function (PHP_INI_ALL).
Default value: 0, i.e. Pinba extension is disabled by default.

pinba.server

pinba.server is a string specifying IP address and port of Pinba server.
You can use this directive in the two ways:

 AAA.BBB.CCC.DDD

or

 AAA.BBB.CCC.DDD:XXXX

where "AAA.BBB.CCC.DDD" is IP address and "XXXX" is port number.
Before version 1.1.0 this value could not be modified using ini_set() function, but this is not true anymore.
The default port value is 30002 (UDP).

Since April 2010 support for IPv6, host names and service names has been added to the Pinba extension. Since IPv6 addresses contain colons, it is not possible to use the above syntax to specify IPv6 addresses with a port number or service name. To work around that problem, the syntax known from the Apache webserver has been implemented, using square brackets to delimit IPv6 addresses.

The following are possible ways to configure the recipient of the UDP packets (since April 2010):

  • <IP-address> or <hostname>
Examples:
 192.0.32.10
 2001:db8::c0:ffee
 example.com
  • <IPv4-address>:<port number> or <host name>:<port number>
Examples:
 192.0.32.10:30002
 example.com:30002
  • [<IP-address>]:<port number> or [<host]:<port number>
Examples:
  [192.0.32.10]:30002
  [2001:db8::c0:ffee]:30002
  [example.com]:30002

pinba.auto_flush

"pinba.auto_flush" is used to prevent Pinba from sending stats packet at the end of the request.
This option is On by default.
Available since version 1.2.0.

Functions

pinba_timer_start()

resource pinba_timer_start(array tags[, array data])

Since version 1.2.0:

resource pinba_timer_start(array tags[[, array data], int hit_count])
Creates and starts new timer.

Parameters:
tags - an array of tags and their values in the form of "tag" => "value". Cannot contain numeric indexes for obvious reasons.
data - optional array with user data, not sent to the server.
hit_count - optional hit_count parameter, set to 1 be default. Available since version 1.2.0.

Return values:
Always returns new timer resource.

pinba_timer_stop()

bool pinba_timer_stop(resource timer)
Stops the timer.

Parameters:
timer - valid timer resource.

Return values:
Returns true on success and false on failure (if the timer has already been stopped).

pinba_timer_add()

resource pinba_timer_add(array tags, int value[, array data])
Creates new timer. This timer is already stopped and have specified time value.

Parameters:
tags - an array of tags and their values in the form of "tag" => "value". Cannot contain numeric indexes for obvious reasons.
value - timer value for new timer.
data - optional array with user data, not sent to the server.

Return values:
Always returns new timer resource.

pinba_timer_delete()

bool pinba_timer_delete(resource timer)
Deletes the timer.

Available since: 0.0.6

Parameters:
timer - valid timer resource.

Return values:
Returns true on success and false on failure.

pinba_timer_tags_merge()

bool pinba_timer_tags_merge(resource timer, array tags)
Merges $tags array with the timer tags replacing existing elements.

Parameters:
timer - valid timer resource
tags - an array of tags.

pinba_timer_tags_replace()

bool pinba_timer_tags_replace(resource timer, array tags)
Replaces timer tags with the passed $tags array.

Parameters:
timer - valid timer resource
tags - an array of tags.

pinba_timer_data_merge()

bool pinba_timer_data_merge(resource timer, array data)
Merges $data array with the timer user data replacing existing elements.

Parameters:
timer - valid timer resource
data - an array of user data.

Return values:
Returns true on success and false on failure.

pinba_timer_data_replace()

bool pinba_timer_data_replace(resource timer, array data)
Replaces timer user data with the passed $data array.
Use NULL value to reset user data in the timer.

Parameters:
timer - valid timer resource
data - an array of user data.

pinba_timer_get_info()

array pinba_timer_get_info(resource timer)
Returns timer data.

Parameters:
timer - valid timer resource.

Output example:

 array(4) {
   ["value"]=>
   float(0.0213)
   ["tags"]=>
   array(1) {
     ["foo"]=>
     string(3) "bar"
   }
   ["started"]=>
   bool(true)
   ["data"]=>
   NULL
 }

pinba_timers_stop()

bool pinba_timers_stop(void)
Stops all running timers.

pinba_timers_get()

array pinba_timers_get([int flag = PINBA_ONLY_STOPPED_TIMERS])
Get all timers info.

Available since: 1.1.0

pinba_get_info()

array pinba_get_info(void)
Returns all request data (including timers user data). Example:
 array(9) {
   ["mem_peak_usage"]=>
   int(786432)
   ["req_time"]=>
   float(0.001529)
   ["ru_utime"]=>
   float(0)
   ["ru_stime"]=>
   float(0)
   ["req_count"]=>
   int(1)
   ["doc_size"]=>
   int(0)
   ["server_name"]=>
   string(7) "unknown"
   ["script_name"]=>
   string(1) "-"
   ["timers"]=>
   array(1) {
     [0]=>
     array(4) {
       ["value"]=>
       float(4.5E-5)
       ["tags"]=>
       array(1) {
         ["foo"]=>
        string(3) "bar"
       }
       ["started"]=>
       bool(true)
       ["data"]=>
       NULL
     }
   }
 }

pinba_schema_set()

bool pinba_schema_set(string schema)
Set request schema (HTTP/HTTPS/whatever).

pinba_script_name_set()

bool pinba_script_name_set(string script_name)
Set custom script name instead of $_SERVER['SCRIPT_NAME'] used by default.
Useful for those using front controllers, when all requests are served by one PHP script.

pinba_server_name_set()

bool pinba_server_name_set(string server_name)
Set custom server name instead of $_SERVER['SERVER_NAME'] used by default.

pinba_request_time_set()

bool pinba_request_time_set(float request_time)
Set custom request time.

pinba_tag_set()

bool pinba_tag_set(string tag, string value)
Set/update request tag.

pinba_tag_get()

string pinba_tag_get(string tag)
Get previously set request tag value.

pinba_tag_delete()

bool pinba_tag_delete(string tag)
Delete previously set request tag.

pinba_tags_get()

array pinba_tags_get()
Return an array of all previously set request tags.

pinba_hostname_set()

bool pinba_hostname_set(string hostname)
Set custom hostname instead of the result of gethostname() used by default.

pinba_flush()

void pinba_flush([string script_name][, int flags = PINBA_FLUSH_ONLY_STOPPED_TIMERS])
Useful when you need to send request data to the server immediately (for long running scripts).
You can use optional argument script_name to set custom script name.

flags is an optional argument added in version 1.0.0.
Possible values (it's a bitmask, so you can add the constants):

  • PINBA_FLUSH_ONLY_STOPPED_TIMERS - flush only stopped timers (by default all existing timers are stopped and flushed) - available since v. 1.0.0.
  • PINBA_FLUSH_RESET_DATA - reset common request data - available since version 1.1.0.

PinbaClient class

PinbaClient class provides simple interface that allows you to construct arbitrary Pinba data packets in PHP.

PinbaClient::__construct()

PinbaClient PinbaClient::__construct(array servers[, int flags])

Creates and returns new PinbaClient object.

Parameters:
servers - array of strings of hostnames, 'hostname:port' strings or IPv6 hostnames.
flags - optional flags, bitmask.

Possible flags:

  • PINBA_FLUSH_ONLY_STOPPED_TIMERS - flush only stopped timers
  • PINBA_FLUSH_RESET_DATA - reset request data
  • PINBA_AUTO_FLUSH - send data automatically when the object is destroyed

PinbaClient::setHostname()

bool PinbaClient::setHostname(string hostname)

Set hostname field in the data packet.

PinbaClient::setServername()

bool PinbaClient::setServername(string server_name)

Set server_name field in the data packet.

PinbaClient::setServername()

bool PinbaClient::setServername(string server_name)

Set server_name field in the data packet.

PinbaClient::setScriptname()

bool PinbaClient::setScriptname(string script_name)

Set script_name field in the data packet.

PinbaClient::setSchema()

bool PinbaClient::setSchema(string schema)

Set schema field in the data packet.

PinbaClient::setRequestCount()

bool PinbaClient::setRequestCount(int request_count)

Set req_count field in the data packet. Provided value cannot be less than zero.

PinbaClient::setMemoryFootprint()

bool PinbaClient::setMemoryFootprint(int memory_footprint)

Set memory_footprint field in the data packet. Provided value cannot be less than zero.

PinbaClient::setMemoryPeak()

bool PinbaClient::setMemoryPeak(int memory_peak)

Set memory_peak field in the data packet. Provided value cannot be less than zero.

PinbaClient::setDocumentSize()

bool PinbaClient::setDocumentSize(int document_size)

Set document_size field in the data packet. Provided value cannot be less than zero.

PinbaClient::setStatus()

bool PinbaClient::setStatus(int status)

Set status field in the data packet. Provided value cannot be less than zero.

PinbaClient::setRequestTime()

bool PinbaClient::setRequestTime(float request_time)

Set request_time field in the data packet. Provided value cannot be less than zero.

PinbaClient::setRusage()

bool PinbaClient::setRusage(array rusage)

Set rusage values. This method accepts an array of exactly two numeric values in the following order:

  1. ru_utime
  2. ru_stime

PinbaClient::setTag()

bool PinbaClient::setTag(string name, string value)

Set request tag.

Parameters:
name - name of the request tag
value - its value

PinbaClient::setTimer()

bool PinbaClient::setTimer(array tags, float value[, array rusage[, int hit_count]])

Creates new timer. If there is a timer with the same tags, it's replaced with the newly created one.

Parameters:
tags - hash of strings with string indexes, which are used as tag names
value - timer value, seconds
rusage - array of two numeric items: ru_utime and ru_stime
hit_count - timer hit count

PinbaClient::addTimer()

bool PinbaClient::addTimer(array tags, float value[, array rusage[, int hit_count]])

Updates existing timer or creates a new one. If there is a timer with the same tags, we add it and store the sum of the new and the old timers.

Parameters:
tags - hash of strings with string indexes, which are used as tag names
value - timer value, seconds
rusage - array of two numeric items: ru_utime and ru_stime
hit_count - timer hit count

PinbaClient::send()

bool PinbaClient::send([int flags])

Send the data to the server(s).

Parameters:
flags - optional flags, bitmask. Override object flags if specified.

Possible flags:

  • PINBA_FLUSH_ONLY_STOPPED_TIMERS - flush only stopped timers
  • PINBA_FLUSH_RESET_DATA - reset request data
  • PINBA_AUTO_FLUSH - send data automatically when the object is destroyed

PinbaClient::getData()

bool PinbaClient::getData([int flags])

Returns raw packet data. This is basically a copy of send(), but instead of sending it just returns the data.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.