Metrics

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Metrics

edit

Metrics contain application metric data captured by an APM agent.

Metric Schema

edit

The APM Server uses JSON Schema for validating requests. The specification for metrics is defined below:

{
    "$id": "docs/spec/metricsets/metricset.json",
    "type": "object",
    "description": "Data captured by an agent representing an event occurring in a monitored service",
    "allOf": [
        { "$ref": "../timestamp_epoch.json"},
        { "$ref": "../span_type.json" },
        { "$ref": "../span_subtype.json" },
        { "$ref": "../transaction_name.json" },
        { "$ref": "../transaction_type.json" },
        {
            "properties": {
                "samples": {
                    "type": [
                        "object"
                    ],
                    "description": "Sampled application metrics collected from the agent.",
                    "patternProperties": {
                        "^[^*\"]*$": {
                            "$ref": "sample.json"
                        }
                    },
                    "additionalProperties": false
                },
                "tags": {
                    "$ref": "../tags.json"
                }
            },
            "required": ["samples"]
        },
        {"required": ["timestamp"], "properties": {"timestamp": { "type": "integer" }}}
    ]
}

« Errors Example Request Body »