Component schema

GetLogRecordsResponse

object1 direct reference

Definition

Response for the GetLogRecords API. The response contains the log records that match the request.

This API deliberately reuses the full OTLP JSON format for logs. This is done to aid compatibility with existing OTLP consumers.

FixedTime

The property is only included when includeOTLPSchemaExtensions is true.

TimeRange

The property is only included when includeOTLPSchemaExtensions is true.

NextCursors

The cursors for the next sets of results. This property is included to support pagination through the result set when additional pages are available.

ResourceLogs[]required

There is one ResourceLogs per resource. This is aligned to the data most OTLP batching algorithms would produce, where there is one ResourceLogs per resource. This is done to aid compatibility with existing OTLP consumers.

ResourceLogs are NOT sorted. There is no guarantee that ResourceLogs are sorted or that LogRecords within them are sorted. However, it is guaranteed that all data is sorted across paged requests.

Clients are advised to implement sorting within a page descending by the LogRecord's timeUnixNano, observedTimeUnixNano and then id.

Used by 1

These schemas and endpoints reference this type directly.

EndpointPOST /api/logs

json

OpenAPI source123456789101112131415161718192021222324252627
{
  "description": "Response for the `GetLogRecords` API. The response contains the log records that match the request.\n\nThis API deliberately reuses the full OTLP JSON format for logs. This is done to aid compatibility\nwith existing OTLP consumers.\n",
  "properties": {
    "executionTime": {
      "$ref": "#/components/schemas/FixedTime",
      "description": "The property is only included when `includeOTLPSchemaExtensions` is `true`."
    },
    "timeRange": {
      "$ref": "#/components/schemas/TimeRange",
      "description": "The property is only included when `includeOTLPSchemaExtensions` is `true`."
    },
    "cursors": {
      "$ref": "#/components/schemas/NextCursors",
      "description": "The cursors for the next sets of results. This property is included\nto support pagination through the result set when additional pages are available.\n"
    },
    "resourceLogs": {
      "description": "There is one `ResourceLogs` per resource. This is aligned to the data most OTLP batching algorithms would\nproduce, where there is one `ResourceLogs` per resource. This is done to aid compatibility with existing\nOTLP consumers.\n\n`ResourceLogs` are **NOT** sorted. There is no guarantee that `ResourceLogs` are sorted or that\n`LogRecord`s within them are sorted. However, it is guaranteed that all data is sorted across paged\nrequests.\n\nClients are advised to implement sorting within a page descending by the `LogRecord`'s `timeUnixNano`,\n`observedTimeUnixNano` and then `id`.\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ResourceLogs"
      }
    }
  },
  "required": [
    "resourceLogs"
  ]
}