APM SQL Rest API

[Legacy User]

Hello everyone,

 

I have set up the APM SQL Server process and have successfully connected into it via the SQuirreL client using the "System" connection via TEAM Center.  I am looking to leverage the Rest API functionality, since we can use the token for one of our applications.

 

Has anyone set this up before, and if so, did you need to set the following (in the collector of where the APM SQL Server process is running) IntroscopeEnterpriseManager.properties file to true?

introscope.public.restapi.enabled=true

 

The reason why I asked, is this is an attribute that has been around for awhile and I didn't know if it had anything to do with APM SQL Server.

 

I do see the following entry section below the old entries that indicate that it might be used, but I wanted to confirm with everyone here:

 

###############################################################################
# APM Data configuration
###############################################################################
# If value of this property is set to positive number then data transfer from
# APM Data SQL rest api will be limited to this value (in KB/s).
# Otherwise transfer is unlimited.
# Default value: -1
#introscope.enterprisemanager.restapi.sql.rateLimit=-1

# If value of this property is set to positive number then
# APM Data SQL rest api will be limited to number of paralel connections.
# Otherwise transfer is unlimited.
# Default value: 5
#introscope.enterprisemanager.restapi.sql.connectionLimit=5

# If value of this property is set to positive number then
# number of group by groups in memory in APM Data SQL rest api
# will be limited to to this value.
# Otherwise number of groups hold in memory is unlimited.
# Default value: 100000
#introscope.enterprisemanager.restapi.sql.groupCountLimit=100000

# Period for which IP address is blocked due too many failed logins in
# generating temporary token (in seconds).
# Default value: 5 minutes
#introscope.enterprisemanager.restapi.token.lockTime=300

# Number of allowed failed attempts from IP address before it gets blocked.
# Default value: 5
#introscope.enterprisemanager.restapi.token.maxFailsPerIp=5

# Maximum number of connections in generate temporary token endpoint.
# Default value: 10
#introscope.enterprisemanager.restapi.token.connectionLimit=10

[Hallett German]

Thanks Earl,. Please share your experiences with APMSQL Server. And I hope that others in the Community do the same. I posted your note internally and hopefully soon one will respond.

[Legacy User]

Hi Earl, Apparently it doesn't. You can leave introscope.public.restapi.enabled=false and all you'd need is 54321 connection to your apmsqlsrv from your client and 8081 connection to em from your apmsqlsrv. Hope it helps. Regards, James.

[Sergio Morales Correa]

Hi Earl,

I agree with James, however, your requirement is not clear

    >> "I am looking to leverage the Rest API functionality, since we can use the token for one of our applications"

If it is about REST API, you need to set introscope.public.restapi.enabled=true

see APM REST API - CA Application Performance Management - 10.5 - CA Technologies Documentation 

and this kb: How to enable and query APM REST API? 

I hope this helps,

Regards,

Sergio

[Guenter DI Grossberger]

REST API is used to query/update data from APM Team Center. Totally unrelated to APM SQL.

[Legacy User]

I think we found it on our side.  An application developer was able to connect using the 54321 port TEIID connection, using the library files.

 

We are working with him now to see if we can use this jar file he is creating as a wrapper to pull data from the command line.

 

So from what I gather, the rest API can be used to pull back static data like agent name, versions, Team Center attributes, etc.

We will use the new APM SQL Server to pull metric data back.

[Hallett German]

Earl this is very good to hear. Thanks for reporting this status update!