error-api.asciidoc

Error API

The following section contains information about:

• Endpoint

• Schema Definition

• Examples

Endpoint

Send a HTTP POST request to the APM Server errors endpoint:

http(s)://{hostname}:{port}/v1/errors

For RUM send a HTTP POST request to the rum errors endpoint instead:

http(s)://{hostname}:{port}/v1/rum/errors

Schema Definition

The APM Server uses JSON Schema for validating requests. The specification for errors is defined bellow: * Payload * Error * Service * System * Context * Stacktrace Frame * Request * User

Payload

link:./spec/errors/payload.json[role=include]

Error

link:./spec/errors/error.json[role=include]

Service

link:./spec/service.json[role=include]

System

link:./spec/system.json[role=include]

Context

link:./spec/context.json[role=include]

Stacktrace Frame

link:./spec/stacktrace_frame.json[role=include]

Request

link:./spec/request.json[role=include]

User

link:./spec/user.json[role=include]

Examples

Request example:

curl http://localhost:8200/v1/errors \
  --header "Content-Type: application/json" \
  --data @docs/data/intake-api/generated/error/payload.json

Example error requests:

• Payload with an Error

• Payload with an Error with minimal Exception Information

• Payload with an Error with minimal Log Information

Payload with an Error

link:./data/intake-api/generated/error/payload.json[role=include]

Payload with an Error with minimal Exception Information

link:./data/intake-api/generated/error/minimal_payload_exception.json[role=include]

Payload with an Error with minimal Log Information

link:./data/intake-api/generated/error/minimal_payload_log.json[role=include]