Mezmo Logs API

Log line ingestion

OpenAPI Specification

mezmo-logs-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Mezmo Alerts Archiving Logs API
  description: 'Manage Mezmo preset alerts. Preset alerts encapsulate presence or absence

    triggers, frequency, count thresholds, and notification channels (PagerDuty,

    Slack, webhook, email) that views attach to.

    '
  version: '1.0'
servers:
- url: https://api.mezmo.com
security:
- AccessToken: []
tags:
- name: Logs
  description: Log line ingestion
paths:
  /logs/ingest:
    post:
      tags:
      - Logs
      summary: Ingest Logs
      description: 'Send a batch of log lines to Mezmo. Each line carries a timestamp, line

        body, app, level, env, and free-form meta. Recommended batch size is

        under 10 MB per request.

        '
      operationId: ingestLogs
      parameters:
      - name: hostname
        in: query
        required: true
        schema:
          type: string
        description: Originating host name for the batch.
      - name: mac
        in: query
        required: false
        schema:
          type: string
        description: MAC address of the originating host.
      - name: ip
        in: query
        required: false
        schema:
          type: string
        description: IP address of the originating host.
      - name: now
        in: query
        required: false
        schema:
          type: integer
          format: int64
        description: Current unix epoch milliseconds on the sending host.
      - name: tags
        in: query
        required: false
        schema:
          type: string
        description: Comma-separated tags to attach to every line in the batch.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IngestBatch'
      responses:
        '200':
          description: Batch accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestAck'
        '401':
          description: Authentication failed.
        '403':
          description: Account suspended or over plan limit.
        '413':
          description: Batch payload too large.
components:
  schemas:
    IngestBatch:
      type: object
      required:
      - lines
      properties:
        lines:
          type: array
          items:
            $ref: '#/components/schemas/LogLine'
    LogLine:
      type: object
      required:
      - line
      properties:
        timestamp:
          type: integer
          format: int64
          description: Unix epoch milliseconds.
        line:
          type: string
          description: Log line body.
        app:
          type: string
          description: Originating application name.
        level:
          type: string
          description: Log level (DEBUG, INFO, WARN, ERROR, FATAL).
        env:
          type: string
          description: Environment (prod, staging, dev).
        meta:
          type: object
          description: Free-form structured metadata.
          additionalProperties: true
    IngestAck:
      type: object
      properties:
        status:
          type: string
        batchID:
          type: string
  securitySchemes:
    AccessToken:
      type: http
      scheme: bearer