✨ New: Try our AI‑powered Search (Ctrl + K) — Read more

Advanced Topic: Ingestion Specification Custom Metrics

Prev Next

About Ingestion Specification

The Ingestion Staging feature is a user interface that provides users with an intuitive mechanism for configuring how they want their objects, metrics, and metadata to appear in Crosswork Assurance. "Under the hood," these preferences are stored in an Ingestion Specification — a JSON-formatted template that stores all relevant details about how the object type and metrics should be stored and represented in Crosswork Assurance.

Ingestion Specification Template

This is a skeleton of what the ingestion specification template looks like:

{
  "object-type": "string",
  "family": "string",                   // Called 'category' in the UI
  "permissions": "ReadOnly/ReadWrite/ReadWriteGlobal",
  "state": "Draft/Published/Diverged",
  "version": "x.y.z",
  "transformations": {

    // Transformations Applied At The Collection Stage
    "collection": {},                    // Telemetry Collector config — not in use today

    // Transformations Applied At The Ingestion Stage
    "ingestion": {},                     // Sensor Collector config — not in use today

    // Transformations Applied At The Normalization Stage
    "normalization": {                   // Metrics for the ingestion dictionary
      "dimensions": [],
      "metrics": []
    },

    // Transformations Applied At The Enhancement Stage
    "enhancement": {}                    // Custom metrics for the ingestion dictionary
  }
}