Skip to main content

Start a Samply profile

Required role: read or higher.

Profile the pipeline using the Samply profiler for the next duration_secs seconds.

Path Parameters
pipeline_name string — REQUIRED

Unique pipeline name

Query Parameters
ordinal integer

In a multihost pipeline, the ordinal of the pipeline to sample.

duration_secs int64

The number of seconds to sample for the profile.

Responses
202

Started profiling the pipeline with the Samply tool

404

Pipeline with that name does not exist

Schema — OPTIONAL
details

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.

409

Samply profile collection is already in progress

Schema — OPTIONAL
details

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

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

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.