OneAgent metric API
Early Adopter
You can use the local http://localhost:<port>/metrics/ingest
API endpoint to push locally retrieved metrics to Dynatrace over a secure and authenticated channel. This endpoint is available only to local clients and cannot be reached from remote hosts.
Enable the OneAgent metric API
The OneAgent metric API comes with OneAgent version 1.201 by default. You only need to enable the OneAgent metric API at the environment or host level. Note that the host-level configuration overrides the environment configuration.
Communication port
The default metric ingestion port is 14499
. If necessary, you can use oneagentctl command-line interface to check or change the port. Changing the metric ingestion port requires restart of OneAgent. Add --restart-service to the command to restart OneAgent automatically.
Check the ingestion port
Use the --get-extensions-ingest-port
parameter to show the current local ingestion port, 14499
by default.
- Linux:
./oneagentctl --get-extensions-ingest-port
- Windows:
.\oneagentctl.exe --get-extensions-ingest-port
Set a custom ingestion port
Use the --set-extensions-ingest-port=<arg>
parameter to set a custom local ingestion port.
- Linux:
./oneagentctl --set-extensions-ingest-port=14499 --restart-service
- Windows:
.\oneagentctl.exe --set-extensions-ingest-port=14499 --restart-service
Note that changing the port for the OneAgent metric API also affects scripting integration and Telegraf.
Topology awareness
Using the local API endpoint, the host ID and host name context are automatically added to each metric as dimensions. For more information, see Metric ingestion.
Metric format
Provided data points must follow the Metrics ingestion protocol.
The request consumes a plain/text
payload with the charset=utf-8
character set. The payload is limited to 1,000
lines.
Example
With this curl
command, you'll ingest the cpu.temperature
metric assigned to the cpu=1
dimension. The metric will be automatically assigned to a respective host ID and host name.
curl --data "cpu.temperature,cpu=1 55" http://localhost:14499/metrics/ingest \
-H "Content-Type: text/plain; charset=utf-8"
Successful response:
{
"error": null,
"linesValid": 1,
"linesInvalid": 0
}