Skip to content

Commit

Permalink
docs: document new exporters API to enable and disable
Browse files Browse the repository at this point in the history
  • Loading branch information
deepthidevaki committed Sep 5, 2024
1 parent 2eb8506 commit 8be9e1f
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions docs/self-managed/zeebe-deployment/operations/management-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The following operations are currently available:

- [Rebalancing](/self-managed/zeebe-deployment/operations/rebalancing.md)
- [Pause and resume exporting](#exporting-api)
- [Enable and disable exporter](#exporters-api)

## Exporting API

Expand Down Expand Up @@ -61,3 +62,61 @@ When all partitions soft pause exporting, a successful response is received. If

</TabItem>
</Tabs>

## Exporters API

Exporters API is used for the operations of the [dual region deployment](/self-managed/operational-guides/multi-region/dual-region-ops.md/). By default, all configured exporters are enabled. When an exporter is enabled, the log is compacted only after the records are exported to this exporter. When an exporter is disabled, records are not exported to this exporter anymore and the log will be compacted.

The OpenAPI spec for this API can be found [here](https://github.com/camunda/camunda/blob/main/dist/src/main/resources/api/cluster/exporter-api.yaml)

<Tabs groupId="exporters" defaultValue="enable" queryString values={[{label: 'Enable an exporter', value: 'enable' },{label: 'Disable an exporter', value: 'disable' }, {label: 'Monitor', value: 'monitor'}]} >

<TabItem value="enable">

To enable a previously disabled exporter, send the following request to the gateway's management API. The exporter must be already configured in the cluster. When enabling, you can optionally provide another exporter from which it should initialize it's state from. The other exporter must be of the same type.

```
POST actuator/exporters/{exporterId}/enable
{
initializeFrom: {anotherExporterId}
}
```

New records written after the exporter is enabled will be exported to this exporter.

</TabItem>

<TabItem value="disable">

To disable an exporter, send the following request to the gateway's management API.

```
POST actuator/exporters/{exporterId}/disable
```

After disabling the exporter, no records will be exported to this exporter. Other exporters continues exporting.

</TabItem>

<TabItem value="monitor">

Both enable and disable requests are processed asynchronously. To monitor the status of the exporters, send the following request to the gateway's management API.

```
GET actuator/exporters/
```

The response is a json object that lists all configured exporters with their status.

<details>
<summary>Example response</summary>

```
[{"exporterId":"elasticsearch0","status":"ENABLED"},{"exporterId":"elasticsearch1","status":"DISABLED"}]
```

</details>

</TabItem>

</Tabs>

0 comments on commit 8be9e1f

Please sign in to comment.