Logs

Any time you send a request to an Evervault resource, a log of the request and response will be created inside of your app. You can use the Logs view in the Evervault Dashboard to view and filter these log events.

EQL

Logs can be queried using the Evervault Query Language (EQL), which allows you to filter logs based on their attributes.

1// e.g., EQL query to find all logs with a relay category and response
2// status code of 400 or higher
3category="relay" AND response.status>=400

Operators

The following operators are supported in EQL queries, but not every operator is available for every field. See the searchable fields section below for details.

Compound queries

You can combine filters with AND when all conditions must match, OR when any condition can match, and parentheses to group conditions.

1// AND: all conditions must match
2category="relay" AND response.status>=400
3
4// OR: any condition can match
5request.method="POST" OR request.method="PUT"
6
7// Grouped: control evaluation order
8(category="function" AND function.status="failure") OR response.status>=500

Searchable fields

Correlation IDs

Correlation IDs let you tie requests to Evervault with events in your own systems. This makes requests easier to trace across services, and easier to look up when you contact Evervault support.

You can send correlation IDs in two ways. Sending both is fine, and neither is required.

Trace context header

Add a traceparent header that follows the W3C Trace Context specification. You can send it on requests to the Evervault API and on requests sent through Relay. Relay passes the header through to the destination.

1curl -X POST 'https://api.evervault.com/payments/bin-lookups' \
2  -H 'Content-Type: application/json' \
3  -H 'traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01' \
4  -u '<app_id>:<api_key>' \
5  -d '{ "number": "4242424242424242" }'

External customer reference

Add an externalCustomerReference attribute to the JSON body of the request. This method only works with the Evervault API. For requests sent through Relay, use the traceparent header instead.

1curl -X POST 'https://api.evervault.com/payments/bin-lookups' \
2  -H 'Content-Type: application/json' \
3  -u '<app_id>:<api_key>' \
4  -d '{
5    "number": "4242424242424242",
6    "externalCustomerReference": "order_12345"
7  }'

To find requests in the Logs section of the Dashboard, search on the external_customer_reference field.

1external_customer_reference="order_12345"