Retrieving recorded trace data


The API contains the following topics:

API overview

Method—GET

Request parameter—id 

API registration

Use the following URL to register the API:

https://portalHost:portalPort/portal/rest/traces

Replace the following entries, as required:

Entry

Description

https

Protocol used to send the request

portalHost

Host name or IP address of the App Visibility portal

portalPort

Communication port number of the App Visibility portal.

The default port number is 8100.

Request parameter

Entry

Description

Mandatory

id

Identifying string (automatically assigned) of the transaction

Yes

URL example

https://my-portal-33:8100/portal/rest/traces?id=64FdafowmnCHeM3KpM3vHV5

Sample JSON response

appvis_traceapi.png

Response content

The response show details about the transaction fragments, such as the information you can see in the Trace Details view.

Object

Description

allCollectorsOnline

If true, all App Visibility collectors are online; if false, some data might be missing

partialResults

If true, some results might be missing because the portal cannot reach one or more collectors; if false, all results are recorded

fragmentInstancesList

Class of request fragment data

Fragments are listed with most recent request first.

serverId

Identifying string (automatically assigned) of the application server

application

Application name

duration

Duration of the request

startTime

Epoch time, in milliseconds, that the request began

topLevel

Indication of  the first fragment in the transaction (true) or not (false)

errorViolation

Indication of error on the request (true) or not (false)

requestID

Identifying string (automatically assigned) of the request

latencyViolation

Indication that the duration exceeds thresholds (true) or not (false)

traceId

Identifying string (automatically assigned) of the trace

entryPoint

Entry point name

exitStatus

If the fragment has an error, the HTTP status code

euemTag

Object for internal use

fragmentId

Represents the fragment level regarding the flow of the transaction:

  • fragmentId: "1" represents the top-level fragment, that is the first request of the transaction
  • fragmentId: "1-1" represents a second-level fragment. If the transaction has more than one second-level request, they are represented as fragmentId: "1-2" and fragmentId: "1-3" and so on.
  • fragmentId: "1-1-1" represents a third-level fragment, where the first two numbers are the parent fragment.

Related topics

Using-APIs-to-generate-report-data-for-App-Visibility-Manager

Analyzing-diagnostics-data-for-a-trace

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*