Skip to main content

Retrieve circuit metrics of a running or paused pipeline.

Retrieve circuit metrics of a running or paused pipeline.

Path Parameters
pipeline_name string REQUIRED

Unique pipeline name

Query Parameters
format string

Possible values: [prometheus, json]

Circuit metrics output format.

  • prometheus: format expected by Prometheus
  • json: JSON format
Responses
200

Pipeline circuit metrics retrieved successfully

Schema OPTIONAL
object
404

Pipeline with that name does not exist

Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

500
Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

503
Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

get_pipeline_metrics
GET /v0/pipelines/:pipeline_name/metrics
pipeline_name — path
format — query
curl -L 'https://docs.feldera.com/v0/pipelines/:pipeline_name/metrics' \
-H 'Accept: application/json'