Retrieving application server data and metrics

The GET method of the Application Server API retrieves application server health data for applications that are monitored by App Visibility Manager.

The API contains the following topics:

API overview

Method—GET

Request parameters:

  • Agents—tier, serverId

    Tip

    Run the API only for agents, without additional request parameters, to retrieve a list of all the App Visibility agents communicating with the App Visibility portal. In this way, you can retrieve the following values that you can use as request parameter with other APIs:

    • serverId for each application server
    • applicagtionId for each application on the server
  • Metrics samples—time (from, to), metric, serverId
  • Fragment metrics samples—time (from, to), topLevelOnly, entryPoint, serverId, applicationId

API registration

Use the following URLs to register the API:

https://portalHost:portalPort/portal/rest/admin/agents

https://portalHost:portalPort/portal/rest/metrics/samples

https://portalHost:portalPort/portal/rest/fragments/metrics/samples

Replace the following entries, as required:

EntryDescription
httpsProtocol used to send the request
portalHostHost 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 parameters, examples, and responses for agents

Request parameters for agents

Use this API to retrieve data about the App Visibility agents for Java or .NET.

EntryDescriptionMandatory
tier

Tier by which to limit the response

Accepted values are WEB, BUSINESS, or SYNTHETIC.

No
serverId

One or more server IDs by which to limit the response

Example: serverId=id1&serverId=id2&server=id3

No

URL example for agents

https://my-portal-33:8100/portal/rest/admin/agents?tier=WEB&serverID=VW-TLV-AD-QA18

Sample JSON response for agents

Response content for agents

The following table lists the details about App Visibility agents on the application servers.

ObjectDescription
uuidUniversally unique identifier (UUID) value of the App Visibility agent
platformServer platform: WINDOWS or LINUX
statusServer status: ONLINE, OFFLINE, or N/A (for IIS)

policyID

Identifying number (automatically assigned) of the App Visibility agent policy
serverIDIdentifying string (automatically assigned) of the server
serverIPApplication server IP address

serverPort

(Java) Communication port for the agent

(.NET) -1 (not applicable)

serverHostNameApplication server host name

serverDisplayName

Application server display name
agentApplicationsList of applications IDs that use the server
serverTypeServer type, such as IIS or Tomcat
versionVersion of the App Visibility agent
tierTier that the server is associated with: WEB or BUSINESS
severityCurrent severity of events on the server: OK, WARNING, or CRITICAL
serverStartTime

(Java) Time, in milliseconds, that the server has been running, that is, the amount of time since the last server restart

(.NET) Time, in milliseconds, that the agent has been running since is was last started

Request parameters, examples, and responses for metrics samples

Request parameters for metrics samples

Use this API to retrieve metrics for a five-minute period at the specified time from the application server or servers.

EntryDescriptionMandatory
from

Epoch time stamp in milliseconds from which to start the data collection

Use a time stamp converter, such as http://www.epochconverter.com/, to generate the value.

Yes
to

Epoch time stamp in milliseconds from which to end the data collection

Use a time stamp converter, such as http://www.epochconverter.com/, to generate the value.

Yes
metric

One or more metrics by which to limit the response

Example: metric=CPU_USAGE&metric=MEMORY_USAGE

Yes

serverId

One or more server IDs by which to limit the response

The serverId is an identifying string (automatically assigned) of the server.

Example: serverId=id1&serverId=id2&serverId=id3

Yes

URL example for metrics samples

https://my-portal-33:8100/portal/rest/metrics/samples?from=1444969200000&to=1444969500000&metric=CPU_USAGE&metric=MEMORY_USAGE&serverId=my-server-18

Sample JSON response for metrics samples

{
    my-server-18: {
        1444969200000: {
            CPU_USAGE: {
                minValue: 0,
                maxValue: 54,
                avgValue: 2,
                weight: 300000,
                count: -1
            },
            MEMORY_USAGE: {
                minValue: 18225,
                maxValue: 16116,
                avgValue: 12219,
                weight: 300000,
                count: -1
            }
        },
        1444969500000: {
            CPU_USAGE: {
                minValue: 20,
                maxValue: 42,
                avgValue: 21,
                weight: 300000,
                count: -1
            },
            MEMORY_USAGE: {
                minValue: 15565,
                maxValue: 64652,
                avgValue: 17794,
                weight: 300000,
                count: -1
            }
        }
    }
}

Response content for metrics samples

The following table lists the details about metrics samples on the application servers.

ObjectDescription
serverId

Identifying string that you specified

startTime

Epoch start time stamp in milliseconds that you entered

Values reflect the five-minute time frame that the start time is in

metricMetric that you entered
minValue

(CPU_USAGE) Minimum percentage of CPU used

(MEMORY_USAGE) Minimum memory used, in megabytes

maxValue

(CPU_USAGE) Maximum percentage of CPU used

(MEMORY_USAGE) Maximum memory used, in megabytes

avgValue

(CPU_USAGE) Average percentage of CPU used

(MEMORY_USAGE) Average memory used, in megabytes

weight

Object for internal use

count

Object for internal use

endTime

Epoch end time stamp in milliseconds that you entered

Values reflect the five-minute time frame that the end time is in

metricMetric that you entered
minValue

(CPU_USAGE) Minimum percentage of CPU used

(MEMORY_USAGE) Minimum memory used, in megabytes

maxValue

(CPU_USAGE) Maximum percentage of CPU used

(MEMORY_USAGE) Maximum memory used, in megabytes

avgValue

(CPU_USAGE) Average percentage of CPU used

(MEMORY_USAGE) Average memory used, in megabytes

weight

Object for internal use

count

Object for internal use

Request parameters, examples, and responses for fragment metrics samples

Request parameters for fragment metrics samples

Use this API to retrieve data about transactions and requests.

EntryDescriptionMandatory
from

Epoch time stamp in milliseconds from which to start the data collection

Use a time stamp converter, such as http://www.epochconverter.com/, to generate the value.

Yes
to

Epoch time stamp in milliseconds from which to end the data collection

Use a time stamp converter, such as http://www.epochconverter.com/, to generate the value.

Yes
topLevelOnly

Response contains only the top-level request (Transaction type)

See Analyzing business transactions for details about transaction types.

The default value is false.

No

entryPoint

One or more entry points by which to limit the response

Example: entryPoint=entryPointName1&entryPoint=entryPointName2

No
serverId

One or more server IDs by which to limit the response

The serverId is an identifying string (automatically assigned) of the server.

Example: serverId=id1&serverId=id2&serverId=id3

Yes
applicationId

One or more application IDs by which to limit the response

The applicationId is an identifying string (automatically assigned) of the application.

Example: applicationId=id1&applicationId=id2

No

URL example for fragment metrics samples

https://my-portal-33:8100/portal/rest/fragments/metrics/samples?from=1441626300000&to=1441626600000&serverId=VW-TLV-AD-QA18

Sample JSON response for fragment metrics samples

Response content for fragment metrics samples

The following table lists the details about fragment metrics samples on the application servers.

Only the specified object is applicable. Other objects are for internal use.

ObjectDescription
startTimeEpoch start time stamp in milliseconds that you entered
startTime.metric.count

(REQUEST_VIOLATION_DURATION) Number of requests with latency violations

(REQUEST_COUNT) Total number of requests

(REQUEST_VIOLATION_ERROR) Number of request with errors

Related topic

Using APIs to generate report data for App Visibility Manager

Was this page helpful? Yes No Submitting... Thank you

Comments