Pipelines: Management
Synopsis
The Pipelines interface is where pipelines are created and managed from the web interface: the My Pipelines list, the create flow, the pipeline detail view (metadata plus a YAML editor for processor logic), and the review of updates for pipelines installed from the Content Hub. The pipeline YAML syntax itself is documented in Overview.
Accessing Pipelines
From the sidebar, select
My Pipelines
My Pipelines lists every pipeline in your organization. A toolbar provides a
The table view shows these columns:
| Column | Description |
|---|---|
| Pipeline display name | |
| Associated device type | |
| Associated vendor | |
| Associated device family | |
| Time of the most recent change | |
| Creation time |
An
The row action menu provides:
Manage pipeline — opens the pipeline detail viewDelete pipeline — deletes the pipeline after confirmation
Creating a Pipeline
Click
Creation Method
A pipeline is either built from scratch or converted from a definition written for another platform:
| Method | Produces |
|---|---|
| An empty pipeline that you build processor by processor | |
| A pipeline converted from a Microsoft Sentinel ASIM parser or a raw KQL query | |
| A pipeline converted from a Cribl Stream pipeline export | |
| A pipeline converted from a Logstash pipeline configuration |
The import methods run the same converters as the hosted MCP server's conversion tools, so the same source definition produces the same pipeline whichever route you take. What each converter translates, and where it degrades, is documented in Migration.
Selecting an import method reveals a
| Method | Accepted files |
|---|---|
.kql, .txt, .yaml, .yml | |
.yml, .yaml, .json | |
.conf, .cfg, .txt |
An upload only fills the field, so a loaded definition can still be edited before it is converted. A source definition may be at most 5 MB, enforced on the pasted text and the uploaded file alike.
The definition is converted when you continue. One that cannot be parsed keeps you on this step, and the message reports what the converter objected to rather than a generic failure.
Pipeline Details
Provide the general information:
| Field | Required | Notes |
|---|---|---|
| Yes | Display name, 2 to 149 characters | |
| Yes | Up to 99 characters | |
| Yes | Identifier; lowercase letters, digits, and underscores only, up to 150 characters | |
| No | Optional device association | |
| No | Optional device association | |
| No | Optional device family association |
A KQL or ASIM source that carries its own parser name pre-fills a-z, 0-9 and _ replaced by underscores — so an ASIM parser named vimDnsCiscoUmbrella arrives as vimdnsciscoumbrella. A name you have already typed is never overwritten. Cribl and Logstash definitions carry no name, so both fields stay empty for them.
Review and Complete Setup
The final step summarizes the creation method and the pipeline details, each with a
For an imported pipeline it also shows the converted pipeline preview — the YAML that will be created. Read it before completing. A converter that meets a construct it cannot translate does not fail: it degrades the construct into a Comment processor and adds a warning line to the pipeline's description. This preview is where those warnings surface, and they are the list of things still to finish by hand.
Click
After creation, you land on the new pipeline's Pipeline Overview tab, where you define its processor logic.
Pipeline Detail
The detail view has two tabs:
- General Overview — shows the pipeline's
Title ,Description , andDevice Information (device type, vendor, and target), alongside a Pipeline Information panel listing the created and last-updated times. ClickManage pipeline details to edit, thenSave changes . - Pipeline Overview — a YAML editor for the pipeline's processor configuration. A tree on the left lists the main pipeline and any child pipelines; select a node to edit it, use
Add new child pipeline to add one, and clickSave changes on selected pipeline to save. Processor syntax is covered in Overview.
The detail header provides a
Click
The
Review update — shown when a Content Hub update is available (see Reviewing Content Hub Updates)Add child pipeline — adds a child pipeline (see Adding a Child Pipeline)Open pipeline debugger — opens the pipeline in the debuggerDelete entire pipeline — deletes the pipeline
A pipeline that is applied on routes, devices, or targets cannot be deleted until it is removed from those components.
Adding a Child Pipeline
A child pipeline is added from
Child pipeline name — lowercase letters, digits, and underscores only, up to 150 charactersCreation method —Create new for an empty child, or an import method to convert a definition into one
An import method reveals the same
The new child is added to the pipeline's tree and opened in the editor.
Pipeline Staging
Staging gives a pipeline a second, editable copy so changes can be worked on and deployed to a subset of Directors before they reach the main version.
A pipeline carries a tag saying which it is:
Creating a Staging Version
From that point until the staging version is deleted:
- The main pipeline is read-only. Its detail page shows a This pipeline is read-only alert with an
Open staging pipeline action, and its editor is read-only too. Every change, including Content Hub updates, happens on the staging pipeline. - The main pipeline cannot be deleted while a staging version of it exists. Delete the staging version first.
- Staging Directors deploy the staging version; every other Director keeps the main version. This is what makes a staged rollout possible.
The Actions menu also gains
Syncing Back to Main
The main pipeline's content, settings and unit tests are overwritten — this is not a merge, and nothing is compared first. Every Director using the main version is then redeployed.
A sync leaves the staging pipeline in place, so the main pipeline stays read-only until you delete the staging version.
Creating a staging version requires PIPELINE_CREATE; syncing requires PIPELINE_EDIT.
Editing, Debugging, and Testing
Three companion pages cover working on a pipeline's processor logic:
- Editing — the full-page Pipeline Editor for editing the main pipeline and its child pipelines as YAML tabs, opened with the
Pipeline Editor button. - Debugging — the interactive debugger for running test data through the pipeline, opened from
Actions >Open pipeline debugger . - Source Control — the review step every pipeline edit passes through before it reaches your directors: uncommitted changes, commits, merging, and restoring an earlier version.
- Unit Tests — saved tests that pin a pipeline's behavior, and can be made a condition of merging.
- MCP Server — VirtualMetric's hosted MCP server that lets an AI coding agent test, validate, and author pipelines outside the web interface.
Reviewing Content Hub Updates
When a pipeline installed from the Content Hub has updates, a
The Review Update view presents the main pipeline and its child pipelines in a tree, with a side-by-side diff of the current and updated configuration for the selected pipeline. Click