liveBook · Manning

Ingestion api

As explained in Effective Platform Engineering

An ingestion API is a software interface that accepts, validates, formats, and routes data into an observability system.

An ingestion API is a gateway that accepts observability data, validates and formats it, then routes it into the appropriate storage backend. Dedicated pipelines handle metrics, logs, and traces so each data type is processed correctly. section 5.1.4

A practical ingestion architecture:

  • Receives data from cloud services, applications, infrastructure components, and monitoring services through observability system API endpoints. section 5.1.4
  • Processes metrics, logs, and traces through separate ingestion pipelines suited to aggregation, parsing, indexing, and correlation. section 5.1.4
  • Supports periodic polling and scrubbing when security restrictions or network configuration prevent direct transmission. section 5.1.4

Protected data source

A source behind a firewall can be polled periodically and scrubbed before its observability data enters the ingestion pipeline, preserving collection in a secure environment. section 5.1.4

How Effective Platform Engineering covers it

How deep it goes
Explains high-level validation, formatting, storage, and data-specific pipelines, but does not specify endpoint protocols or schemas.
Examples
Uses cloud services, applications, infrastructure, monitoring services, firewalls, polling, and protected data sources as architectural examples.
What you can do after
Operate/configure ingestion by assigning separate pipelines and storage backends to metrics, logs, and traces.
How it connects
Connects observability APIs with metrics, logs, traces, polling, time-series databases, log management, and distributed tracing.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Effective Platform Engineering. The section links point to the parts of the book it draws on.