Pipeline metric catalog

A catalog of the pipeline lifecycle metrics (plexnode.pipeline.*) that SnapLogic emits through OpenTelemetry, with each metric's type, tags, and interpretation guidance so you can find and query the right metric in your observability tool.

This catalog is a single reference for the pipeline lifecycle metrics: what each metric measures, its type, the tags you can filter and group by, and how to interpret it. Use it to onboard to pipeline observability, build dashboards and alerts, troubleshoot failures or performance degradation, monitor SLA compliance, and plan Snaplex capacity — without needing to understand SnapLogic internals.

The metrics are emitted through Third-party Observability and appear in your configured monitoring backend, where you can query them with that tool's query language. For worked monitoring scenarios and sample queries, see Pipeline metrics use cases; for the full technical reference, see Pipeline lifecycle metrics.

Prerequisites

  • Your organization (Org) must have Third-party Observability enabled.
  • An OpenTelemetry (OTel) collector must be configured for each Snaplex node and routed to your monitoring backend.
  • The LIFECYCLE feature flag must be enabled. This flag is disabled by default. See Feature flags.

How metric names appear

SnapLogic emits metric names using the plexnode.pipeline.* prefix with dot separators. After export through OpenTelemetry to a Prometheus-compatible backend, the dots become underscores and a system_metric_ prefix is added. Query using whichever form your monitoring backend presents. For example:

Emitted name Exported name (Prometheus-compatible)
plexnode.pipeline.execution.stop.total system_metric_plexnode_pipeline_execution_stop_total
plexnode.pipeline.active.value system_metric_plexnode_pipeline_active_value

The catalog lists the emitted names. Apply the same transformation to any metric name below when querying a Prometheus-compatible backend.

Execution lifecycle metrics

Track how many pipeline executions start and stop, and their outcomes.

Metric Type Description Key tags
plexnode.pipeline.execution.start.total Counter Number of pipeline executions started. path, invoker_type, snaplex
plexnode.pipeline.execution.stop.total Counter Number of pipeline executions stopped. Combine with the outcome tag to compute success and failure rates. outcome, path, invoker_type

Performance and duration metrics

Measure how long pipelines spend in each execution phase. Each summary metric reports avg, p95, p99, and max values (for example, plexnode.pipeline.executeDuration.p95).

Metric Type Description Key tags
plexnode.pipeline.prepareDuration.* Summary Duration of the pipeline prepare phase. path, root_invoker_path
plexnode.pipeline.executeDuration.* Summary Duration of the pipeline execute phase. path, root_invoker_path

Throughput metrics

Track document processing rate and error volume.

Metric Type Description Key tags
plexnode.pipeline.documents.processed.oneMinRate Gauge Document processing rate over a one-minute window. Slice by the direction tag to separate input, output, and error flow. direction, path
plexnode.pipeline.errors.total Counter Number of pipeline execution errors. Slice by the error tag to identify the most common failure types. error, path, root_invoker_path

Active pipeline metrics

Monitor concurrent load for capacity planning.

Metric Type Description Key tags
plexnode.pipeline.active.value Gauge Number of pipelines currently active. Use to monitor concurrent load per Snaplex. snaplex, invoker_type, path

Tags

Each metric is tagged so you can filter and group results. The following tags are available.

Tag Description Values
path Pipeline path. For example, /snaplogic/projects/shared/child
invoker_type How this pipeline was started. scheduled, trigger, ultra, nested, error, manual
root_invoker_type How the top-level workflow was started. scheduled, trigger, ultra, manual
root_invoker_path Path of the top-level task or trigger. For example, /snaplogic/projects/shared/parent-one-per-doc
snaplex Snaplex where the pipeline executes. For example, cloud
outcome Final execution result. Applies to the stop metric. completed, failed, stopped
error Error description. For example, No script to execute, unknown
direction Document flow direction. Applies to the throughput metric. in, out, error, feed

Query examples

The following examples use PromQL to illustrate common patterns. PromQL is shown only as an example; because the metrics are emitted through OpenTelemetry, you can build equivalent queries in any compatible observability tool using that tool's query language. In PromQL, metric names use the exported (underscore) form.

Failure rate (stopped executions with a failed outcome, as a share of all stops):

sum(rate(system_metric_plexnode_pipeline_execution_stop_total{outcome="failed"}[5m]))
  /
sum(rate(system_metric_plexnode_pipeline_execution_stop_total[5m]))

P95 execute-phase duration by pipeline path:

system_metric_plexnode_pipeline_executeDuration_p95{path=~"$path"}

Active pipelines by task type on a Snaplex:

sum by (invoker_type) (
  system_metric_plexnode_pipeline_active_value{snaplex="$snaplex"}
)

Limitations

  • The catalog covers metrics emitted when the LIFECYCLE feature flag is enabled. This flag is disabled by default.
  • The DETAILED feature flag adds high-cardinality tags (such as ruuid) for per-execution analysis. It is disabled by default and is not recommended for production monitoring backends without first evaluating the storage impact.
  • Nested pipeline executions (invoker_type="nested") are excluded from the default metric views to avoid inflating execution counts. You can still filter for nested executions explicitly when analyzing a workflow chain.

Related third-party resources