Data Ingestions API

This guide provides an overview and setup instructions for Middleware’s OpenTelemetry Data Ingestion API. The OpenTelemetry Ingestion API has two endpoints: Metrics and Logs.

Resource Types

For both endpoints, the resource type attribute groups the ingested data under the specified label on Middleware dashboards and reports. The resource type field requires one of the following options.

Metrics Endpoint

The Metrics endpoint lets you send custom metrics to the Middleware backend.

To send custom metrics to Middleware, POST to the following endpoint.

POST https://<UID>.middleware.io/v1/metrics

View the following example of a curl request sending a custom metric, swap-usage, to Middleware.

curl -X POST "https://demo.middleware.io/v1/metrics" \
-H "Accept: application.json" \
-H "Content-type: application.json" \
-d @ << EOF
{
  "resource_metrics": [
      {
        "resource": {
            "attributes": [
                {

Resource Attributes

Metrics

There are two components for Metrics: metadata and datapoint

Metadata

The metadata fields are the request body attributes that define the metric and determine how it will appear in Middleware.

Datapoint

The datapoint fields are defined within the data attribute. The datapoint fields are consistent across all data attribute types, and explained below. The data attribute is named one of the following types:

• Gauge: A scalar metric that always exports the current value for every data point. It should be used for unknown aggregation.
• Sum: A scalar metric that is calculated as a sum of all reported measurements over a time interval.
• Histogram: A metric that is calculated by aggregating as a histogram of all reported measurements over a time interval.
• Exponential Histogram: A metric that is calculated by aggregating as an exponential histogram of all reported double measurements over a time interval.
• Summary: Metric data used to convey quantile summaries.

Log Endpoint

The Log Endpoint lets you send custom logs to the Middleware backend.

To send custom logs to Middleware, POST to the following endpoint.

POST https://<UID>.middleware.io:443/v1/logs

View the following example of a curl request sending custom logs to Middleware.

curl -X POST "https://demo.middleware.io:443/v1/logs" \
-H "Accept: application/json" \
-H "Content-type: application/json" \
-d @- << EOF
{
   "resource_logs": [
      {
         "resource": {
            "attributes": [
               {

Resource Attributes

Log Records

severity_number