Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add gateway endpoints for exporter disable request #18421

Open
Tracked by #18030
deepthidevaki opened this issue May 10, 2024 · 1 comment
Open
Tracked by #18030

Add gateway endpoints for exporter disable request #18421

deepthidevaki opened this issue May 10, 2024 · 1 comment
Assignees
Labels
component/zeebe Related to the Zeebe component/team kind/task Categorizes an issue as a breakdown of low-level implementation detail from a parent issue scope/broker Marks an issue or PR to appear in the broker section of the changelog

Comments

@deepthidevaki
Copy link
Contributor

deepthidevaki commented May 10, 2024

Add gateway endpoint to disable an exporter by its id. We should also add a way to monitor the progress of the operation. To be discussed if we should reuse the endpoint for cluster (scaling, force configure etc..) or define a new one specific for exporting or a general configurations.

@deepthidevaki deepthidevaki added kind/task Categorizes an issue as a breakdown of low-level implementation detail from a parent issue scope/broker Marks an issue or PR to appear in the broker section of the changelog component/zeebe Related to the Zeebe component/team labels May 10, 2024
@deepthidevaki deepthidevaki self-assigned this May 14, 2024
@deepthidevaki
Copy link
Contributor Author

Currently we have two related endpoints

  • actuator/exporting/ for pausing an resuming exporting
  • actuator/cluster for monitoring cluster configuration changes and the topology

For the new endpoints for enabling and disabling exporters

Proposal 1

POST actuator/exporters/{exportId} to enable // Here we also have to specify which other exporer to initialize from
DELETE actuator/exporters/{exporterId} to disable. We are not technically deleting the exporter. It remains in the config.

Proposal 2

POST actuator/exporters/enable/{exporterId} // Here we also have to specify which other exporer to initialize from
POST actuator/exporters/disable/{exporterId}

Proposal 3

POST actuator/exporters/{exporterId} 
{
 state: "enabled"
 initializeFrom: "otherExporterId"
}

POST actuator/exporters/{exporterId} 
{
 state: "disabled"
}

Monitoring

Users can also monitor the state of exporters and also monitor when enabling or disabling request is completed.

Proposal 1

We can reuse the endpoint for the cluster
GET actuator/cluster that respond with the full ClusterConfiguration including the ongoing change.

Proposal 2

Define a new endpoint
GET actuator/exporting or GET actuator/exporters that respond with only relevant fields from ClusterConfiguration including the ongoing change.

If going with this approach, we have to decide what should be included in the response for GET actuator/cluster.

@npepinpe Any suggestions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/zeebe Related to the Zeebe component/team kind/task Categorizes an issue as a breakdown of low-level implementation detail from a parent issue scope/broker Marks an issue or PR to appear in the broker section of the changelog
Projects
None yet
Development

No branches or pull requests

1 participant