APPTRACE Trace technology integration

ServicePilot trace-apptrace

# AppTrace


This package enables apptrace collection.


ServicePilot can be sent web service performance statistics that are stored by this trace-apptrace package into a ServicePilot Apptrace data collection. These statistics can then be used to produce AppTrace statistics by querying this database using the trace-apptrace-query package.


  • Network Flows - It is is necessary to ensure network connectivity between your apptrace collector and the ServicePilot Agent that will insert this data in the ServicePilot AppTrace data collection. In case of a network infrastructure using a firewall, all the ports below must be opened:

    • AppTrace data (by default UDP/9411 although this port is configurable): Between device sending AppTrace data and ServicePilot Agent
  • ServicePilot Requirements

    • ServicePilot Manager minimum version: 8.5
    • ServicePilot Agent minimum version: 8.5 installed and configured


Before adding a resource to monitor, make certain that all pre-requisites are in place and if a ServicePilot Agent is required, that it is communicating correctly with the ServicePilot Manager.

Add resource using Views Configuration web interface

  1. As an administrative user of ServicePilot, open the ServicePilot web interface.
  2. Navigate to Administration. The Configuration > Views web page will open.
  3. Click on the view in which to place the new resource in the Views hierarchy on the left of the interface. The View editor section will show the existing view contents.
  4. From the Packages list on the right of the interface, click and drag the trace-apptrace package into the View editor and let go.
  5. The Resource properties dialog box will open to allow resource configuration.
  6. Click OK to close the Resource properties dialog box. Note that the dialog box will not close if required parameters are not set.
  7. Click Save to apply the new resource to ServicePilot configuration.


Object TypeLicense object ConsumedCondition
AppTrace Collector1

Key field notes

  1. In the Policies tab, specify the policy or policies to apply to the resource

  2. Basic Parameters tab:

    1. Trace Port: The UDP port on which to accept apptrace data


The format of the UDP packets to send to the Trace Port opened by the ServicePilot Agent is as follows:


This text string is UTF8 encoded and each field value should be URI escaped.

The following table gives notes for each field:

Apptrace collection field nameField TypeNotes
traceidTextTrace Identifier
errorPositive IntegerHTTP Error Text, if an error status code is returned
parentidTextTrace Parent Identifier
parentservicenameTextTrace Parent Service Name
parent_ipv4IPv4 AddressTrace Parent IP Address
durationPositive IntegerDuration in milliseconds
ipv4_1IPv4 AddressRequest Service IP Address
port_1IPv4 PortRequest Service IP Port
servicename_1TextRequest Service Name
timestamp_1UTC Timestamp (YYYY-mm-dd HH:MM:SS.000)Request Service Timestamp
value_1TextRequest Service Value
ipv4_2IPv4 AddressResponse Service IP Address
port_2IPv4 PortResponse Service IP Port
servicename_2TextResponse Service Name
timestamp_2UTC Timestamp (YYYY-mm-dd HH:MM:SS.000)Response Service Timestamp
value_2TextResponse Service Value
http_hostTextHTTP Hostname
http_methodHTTP Method in lower case (get, post)HTTP Method
http_pathTextHTTP Path starting with /
http_urlTextHTTP URL
http_status_codePositive IntegerHTTP Status Code
http_request_sizePositive IntegerHTTP Request Size in Bytes
http_response_sizePositive IntegerHTTP Response Size in Bytes
client_usernameTextClient Username
client_ipv4IPv4 AddressClient IP Address
client_portIPv4 PortClient IP Port
client_servicenameTextClient Service Name

How can we help you?

Or call us at +33 2 40 60 13 30