Standalone Machine Agent HTTP Listener

On this page:

You can send metrics to the Standalone Machine Agent using its HTTP listener. You can report metrics through the Standalone Machine Agent by making HTTP calls to the agent instead of piping to the agent through sysout.

Activate the HTTP Listener

The HTTP listener is not enabled by default. To activate the HTTP listener, restart the Standalone Machine Agent and set the metric.http.listener system property to true. Optionally, you can specify the host and port for the listener with system properties.

The

-D system properties are as follows:

metric.http.listener: Required. Set to true.
metric.http.listener.port: Optional. Set to the port to be used, defaults to 8293.
metric.http.listener.host: Optional. This describes which interface to accept requests on. You can set it as follows:
- If you do not specify the metric.http.listener.host, it defaults to localhost, which means requests are only accepted from localhost.
- Set to 0.0.0.0 to accept on all interfaces (including from remote clients)
- Set to the IP address of the specific interface to accept requests on.

<machine_agent_home>/bin/machine-agent -Dmetric.http.listener=true -Dmetric.http.listener.port=<port_number> -Dmetric.http.listener.host=0.0.0.0

If starting the agent by invoking the Machine Agent JAR, be sure to put the options before the JAR name in your start up command. For example:

java  -Dmetric.http.listener=true  -jar MACHINE_AGENT_HOME/machineagent.jar

Create Metrics

Use to post custom metrics to the Machine Agent for uploading to the Controller. Define one or more events in the body of the request as JSON data.

URI

POST /api/v1/metrics

Metric Definition Fields

Parameter

Description

metricName

Name for the metric as it will appear in the Controller UI.

aggregatorType

How the metrics should be aggregated. Options are:

AVERAGE: The average of all one-minute data points when adding it to the 10-minute or 60-minute granularity table.
SUM: The sum of all one-minute data points when adding it to the 10-minute or 60-minute granularity table.
OBSERVATION: Last reported one-minute data point in that 10-minute or 60-minute interval.

Value

A 64-bit integer value for the metric.

Format

POST /api/v1/metrics

[
  {
    "metricName": "<name>",
    "aggregatorType": "<metric_aggregation_type>",
    "value": <64bit_integer>
  },
  {
    "metricName": "<metric_name>",
    "aggregatorType": "<metric_aggregation_type>",
    "value": <64bit_integer>
  }...
]

Create Events

Use to post custom events to the Machine Agent for uploading to the Controller. Define one or more events in the body of the request as JSON data.

URI

POST /api/v1/events

Event Definition Fields

Parameter Name	Description
eventSeverity	Severity of the event, from INFO, WARN, ERROR.
type	A string describing the event subtype. The event will be of type CUSTOM, subtype will be the value of this parameter.
summaryMessage	A summary of the event.
properties	Event properties. These properties are retrieved along with events by the Controller in a given query, and provides a means for filtering the events. The maximum size of a key is 500 chars and of a value is 5000 characters. The values can be a numeric or string value.
details	Arbitrary key-value details for the event; similar in constraints to properties but are retrieved in a separate call. Use this to store details that should only by retrieved when requested by the user, which avoids the expense of retrieving this data in the usual event calls.

Format

POST /api/v1/events
[
  {
    "eventSeverity": <event_severity>,
    "type": "<event_type>",
    "summaryMessage": "<event_summary>",
    "properties": {
      "<key>": {
        <user-specified_object>
      },...
    },
    "details": {
      "<key>": "<value>"
    }
  },
  {
    "eventSeverity": <event_severity>,
    "type": "<event_type>",
    "summaryMessage": "event_summary>",
    "properties": {
      "<key>": {
        <user-specified_object>
      },...
    },
    "details": {
      "<key>": "<value>"
    }
  },...
]

Legacy Machine Agent HTTP APIs

The following API endpoints are supported for backwards compatibility, but will not be extended or enhanced in future versions.

Upload Metrics

You can use GET or POST to upload metrics to the Metric Browser under Application Performance > Tier where the tier is the one defined for the Standalone Machine Agent.

The format for GET is:

GET /machineagent/metrics

For example:

http://host:port/machineagent/metrics?name=Custom Metrics|Test|My Metric&value=42&type=average

The format for POST is:

POST /machineagent/metrics

with header:

Content-Type: application/xml

with body content:

<?xml version="1.0"?>
<request>
<metric name="[name of metric 1]", type="[aggregation type]", value="[value of metric 1]" />
<metric name="[name of metric 2]", type="[aggregation type]", value="[value of metric 2]" />
...
<metric name="[name of metric n]", type="[aggregation type]", value="[value of metric n]" />
</request>

Example:

http://host:port/machineagent/metrics

Example of body content:

<request>
<metric name="Custom Metrics|Test|My Metric 1", type="AVERAGE", value="22" />
<metric name="Custom Metrics|Test|My Metric 2", type="SUM", value="98737" />
<metric name="Custom Metrics|Test|My Metric 3", type="CURRENT", value="93" />
</request>

Valid values for type are:

AVERAGE: Average of all one-minute data points when adding it to the 10-minute or 60-minute granularity table.
SUM: Sum of all one-minute data points when adding it to the 10-minute or 60-minute granularity table.
CURRENT: Last reported one-minute data point in that 10-minute or 60-minute interval.

Upload events

Send events using HTTP GET requests to upload events to the Machine Agent. The format is:

GET /machineagent/event

For example:

http://localhost:8293/machineagent/event?type=<event_type>&summary=<summary_text>

Event_type is one of the following:

error
info
warning