Package io.camunda.zeebe.shared.management

Class JobStreamEndpoint

java.lang.Object

io.camunda.zeebe.shared.management.JobStreamEndpoint

@Component
@WebEndpoint(id="jobstreams")
public final class JobStreamEndpoint
extends Object

An actuator endpoint which allows viewing the current registered streams. Here remote refers to RemoteStream instances registered on the broker, and client refers to all ClientStream instances registered on the gateway.

If running a broker with an embedded gateway, both can be viewed; otherwise, one or the other will always be empty.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	JobStreamEndpoint.ClientJobStream	View model of a client job stream for JSON serialization.
static final record	JobStreamEndpoint.JobStreams	View model for the combined list of all remote and client job streams.
static final record	JobStreamEndpoint.Metadata	View model for the JobActivationProperties of a job stream.
static final record	JobStreamEndpoint.RemoteJobStream	View model of a single remote job stream for JSON serialization
static final record	JobStreamEndpoint.RemoteStreamId	View model for a remote job stream ID
static interface	JobStreamEndpoint.Service

Constructor Summary

Constructors

Constructor	Description
JobStreamEndpoint(JobStreamEndpoint.Service service)

Method Summary

Modifier and Type	Method	Description
org.springframework.boot.actuate.endpoint.web.WebEndpointResponse<JobStreamEndpoint.JobStreams>	list()	Returns the complete list of remote and client job streams as an object with two keys: remote and client.
org.springframework.boot.actuate.endpoint.web.WebEndpointResponse<?>	list(String type)	Returns either the list of client or remote job streams, based on the given type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JobStreamEndpoint

@Autowired
public JobStreamEndpoint(JobStreamEndpoint.Service service)

Method Details

list

@ReadOperation
public org.springframework.boot.actuate.endpoint.web.WebEndpointResponse<JobStreamEndpoint.JobStreams> list()

Returns the complete list of remote and client job streams as an object with two keys: remote and client. Both are collections of the job streams of the appropriate type.

This view is mostly used for human debugging to quickly correlate the state of a stream on the gateway and brokers.

list

@ReadOperation
public org.springframework.boot.actuate.endpoint.web.WebEndpointResponse<?> list(@Selector
 String type)

Returns either the list of client or remote job streams, based on the given type. If the type is unknown, returns a 400 with a singleton map containing an error field with an appropriate message.

Parameters:

type - the type of streams to return