monitorEndpoint

Use the monitorEndpoint command to enable monitoring of the specified endpoint. The endpoint will be monitored by the monitor agent (or group) that discovered it.

Once an endpoint is monitored, you can apply policies to it and the system can connect measurements, log messages, or record transaction instances that include the endpoint. In most cases, observer-discovered endpoints are automatically monitored. However, if the type of endpoint you want to monitor is not monitored by default, you might need to use this command to start monitoring.

The observer communication policy settings determine whether an endpoint is monitored by default. The default settings for this policy always monitor discovered endpoints immediately. But the user can deselect that option for any or all genres.

Use the unmonitorEndpoint command to disable monitoring.

Command Syntax

btmcli monitorEndpoint -n name | -e endpointUrl1 [[endpointUrl2]...]
                       -s sphereUrl -l username:password
Name Long Name Description
-n -name The friendly name of the endpoint to monitor.
-e -endpointUrl A list of endpoint URLs for the endpoints you want to monitor.

If this is a web service, you can supply the actual URL to reach the endpoint. If this is another type of component, look in the Profile tab in the management console to determine the endpoint's URL.

-s -sphereUrl The URL of the sphere.

http://hostname:port/btmcentral/sphere/

This flag is not required if you have set the AP_SPHERE_URL environment variable for your sphere.

-l -userLogin The username and password associated with the sphere, in the format: username:password. This set of credentials must belong to a user in the btmadmin role.

See Security Options in Accessing CLI Commands for information on furnishing login credentials.

You can encrypt passwords using the encryptPassword command.


Examples

The following example shows the monitorEndpoint command used to monitor MyEndpoint.

btmcli monitorEndpoint -n MyEndpoint
                       -s http://localhost:8080/btmcentral/sphere
                       -l admin:abracadabra