Skip to content

Commit 5fb4659

Browse files
committed
feat(desktop-modeler): document connection event
Closes camunda/camunda-modeler#5809
1 parent 226566f commit 5fb4659

File tree

2 files changed

+52
-2
lines changed
  • docs/components/modeler/desktop-modeler/telemetry
  • versioned_docs/version-8.8/components/modeler/desktop-modeler/telemetry

2 files changed

+52
-2
lines changed

docs/components/modeler/desktop-modeler/telemetry/telemetry.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Example event:
194194
}
195195
```
196196

197-
## Task testing events
197+
### Task testing events
198198

199199
Task testing events are sent when using the [task testing](../task-testing.md) feature:
200200

@@ -212,3 +212,28 @@ Example task testing finished event:
212212
"incidentType": "JOB_NO_RETRIES"
213213
}
214214
```
215+
216+
### Connection event
217+
218+
The `Connection Event` is sent in the following situations:
219+
220+
- Modeler fails to connect to a cluster configured via [connection manager](../connect-to-camunda-8.md)
221+
- Modeler connects to a configured cluster
222+
223+
The `Connection Event` has the following properties:
224+
225+
- `success`: true or false
226+
- `targetType`: SaaS or Self-Managed
227+
- `isLocal`: true or false
228+
- `reason`: error reason or null
229+
230+
Example connection event:
231+
232+
```json
233+
{
234+
"success": true,
235+
"targetType": "Self-Managed",
236+
"isLocal": true,
237+
"reason": null
238+
}
239+
```

versioned_docs/version-8.8/components/modeler/desktop-modeler/telemetry/telemetry.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Example event:
194194
}
195195
```
196196

197-
## Task testing events
197+
### Task testing events
198198

199199
Task testing events are sent when using the [task testing](../task-testing.md) feature:
200200

@@ -212,3 +212,28 @@ Example task testing finished event:
212212
"incidentType": "JOB_NO_RETRIES"
213213
}
214214
```
215+
216+
### Connection event
217+
218+
The `Connection Event` is sent in the following situations:
219+
220+
- Modeler fails to connect to a cluster configured via [connection manager](../connect-to-camunda-8.md)
221+
- Modeler connects to a configured cluster
222+
223+
The `Connection Event` has the following properties:
224+
225+
- `success`: true or false
226+
- `targetType`: SaaS or Self-Managed
227+
- `isLocal`: true or false
228+
- `reason`: error reason or null
229+
230+
Example connection event:
231+
232+
```json
233+
{
234+
"success": true,
235+
"targetType": "Self-Managed",
236+
"isLocal": true,
237+
"reason": null
238+
}
239+
```

0 commit comments

Comments
 (0)