Agents and collectors (REST)

Agents

The AppMon Server offers two RESTful interfaces to interact with AppMon Agents. Use the List Agents interface to gather information about AppMon Agents. Use the Hot Sensor Placement interface to perform a Hot Sensor Placement for a specific AppMon Agent.

List agents

This interface lists all known AppMon Agents and provides information such as which AppMon Collector they are related to and other metadata.

GET https://<server>:8021/rest/management/agents produces text/xml

Hot Sensor Placement

This interface performs a Hot Sensor Placement on an AppMon Agent with ID <agent_id>.

GET https://<server>:8021/rest/management/agents/<agent_id>/hotsensorplacement produces text/xml

Collectors

List of collectors

GET https://<server>:8021/rest/management/collectors produces text/xml

The returned XML contains a collectors root node and collectorinformation sub-nodes with detailed information about connected collectors.

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<collectors href="https://localhost:8021/rest/management/collectors">
  <collectorinformation href="https://localhost:8021/rest/management/collectors/Embedded%20dynaTrace%20Collector@GRABS">
    <connected>true</connected>
    <embedded>true</embedded>
    <host>GRABS</host>
    <name>Embedded dynaTrace Collector</name>
  </collectorinformation>
</collectors>

Collector details

GET https://<server>:8021/rest/management/collectors/<collectorname> produces text/xml

The returned XML contains a collectorinformation root node with detailed information about the collector.

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<collectorinformation href="https://localhost:8021/rest/management/collectors/Embedded%20dynaTrace%20Collector@GRABS">
  <connected>true</connected>
  <embedded>true</embedded>
  <host>GRABS</host>
  <name>Embedded dynaTrace Collector</name>
</collectorinformation>

Restart and shut down a collector

The AppMon Server offers two REST interfaces to restart and shut down connected AppMon Collectors. Both are HTTP POST requests. The following two example calls show how to restart or stop collectors connected to a local AppMon Server.

POST https://<server>:8021/rest/management/collector/<collectorname>/restart HTTP/1.1
POST https://<server>:8021/rest/management/collector/<collectorname>/shutdown HTTP/1.1

Deprecated

This section contains deprecated REST interfaces for server management. These interfaces have been replaced and should not be used.

They are disabled by default.

If, however, you need to enable these interfaces, use the debug flag com.dynatrace.diagnostics.rest.depricatedinterfaces.enabled=true.

Restart and shut down a collector

Deprecated

Use POST interfaces to shut down or restart an AppMon Collector.

The AppMon Server offers two REST interfaces to stop and restart connected AppMon Collectors. Both are simple HTTP GET requests. The following two example calls show how to restart or stop collectors connected to a local AppMon Server.

GET https://<server>:8021/rest/management/collector/<collectorname>/restart HTTP/1.1
GET https://<server>:8021/rest/management/collector/<collectorname>/shutdown HTTP/1.1