|
1 | | -# AxonIQ Console Framework Client |
| 1 | +# AxonIQ Platform client |
2 | 2 |
|
3 | 3 | [](https://maven-badges.herokuapp.com/maven-central/io.axoniq.console/console-framework-client) |
4 | 4 |
|
5 | | -AxonIQ Console superpowers your Axon Framework application with advanced monitoring and enabling easy access to actions |
| 5 | +Axoniq Platform superpowers your Axon Framework application with advanced monitoring and enabling easy access to actions |
6 | 6 | within the framework. |
7 | 7 |
|
8 | 8 |  |
9 | 9 |
|
10 | 10 | This repository contains the Open-Source connectors that your application will use through maven dependencies. |
11 | 11 | For actual configuration, please consult the setup instructions that will be provided by AxonIQ Console itself. |
12 | 12 |
|
13 | | -[You can visit AxonIQ Console here.](https://console.axoniq.io) |
| 13 | +[You can visit Axoniq Platform here.](https://platform.axoniq.io) |
14 | 14 |
|
15 | 15 | ## Spring Boot Starter |
16 | 16 |
|
17 | 17 | ### application properties |
18 | 18 |
|
19 | 19 | * `axoniq.console.credentials` - this need to be set, otherwise the auto configuration won't do anything. The correct |
20 | 20 | value can be retrieved via the AxonIQ console UI. |
21 | | -* `axoniq.console.dlq-mode` - change the mode to access the messages in the DLQ and be able to retry them from console, |
22 | | - default: `none`. Several options are available: |
23 | | - * `none` - nothing is accessed, it will seem as if the dead letters are not even there. |
24 | | - * `masked` - message payloads and diagnostic data won't be shown. The aggregate identifier will be hashed. The event |
25 | | - type and the optional exception will be shown as-is. |
26 | | - * `limited` - message payloads won't be shown. The aggregate identifier will be shown as-is. From the diagnostics |
27 | | - only the keys set in the `axoniq.console.dlq-diagnostics-whitelist` will be shown. |
28 | | - * `full` - all the message payloads, aggregate identifier, and the diagnostics data will be visible. |
29 | | - |
30 | | - |
31 | | -* `axoniq.console.dlq-diagnostics-whitelist` - a comma-separated list of messages that will be shown in the DLQ |
32 | | - diagnostics. |
33 | | - |
34 | | - |
35 | | -* `axoniq.console.domain-event-access-mode` – change the visibility and access level of Domain Events in the system, |
36 | | -default: `none`. Several options are available: |
37 | | - |
38 | | - * `none` – no payloads are visible, and aggregate loading is disabled. |
39 | | - |
40 | | - * `preview_payload_only` – payloads of events are visible via the API or UI, but snapshot loading is disabled. |
41 | | - |
42 | | - * `load_domain_state_only` – event payloads are not shown, but domain state loading is enabled for the domain entity. |
43 | | - |
44 | | - * `full` – full access: event payloads are visible, and aggregate loading is supported. |
45 | 21 |
|
46 | 22 | ## Data sent to AxonIQ |
47 | 23 |
|
48 | | -AxonIQ Console is an [AxonIQ](https://axoniq.io) SaaS product. Your application will periodically, or upon request, send |
| 24 | +Axoniq Platform is an [AxonIQ](https://axoniq.io) SaaS product. Your application will periodically, or upon request, send |
49 | 25 | information to the servers of AxonIQ. Please check our [Privacy Policy](https://www.axoniq.io/privacy-policy) and [Data Processing Addendum](https://lp.axoniq.io/axoniq-data-processing-addendum) for the |
50 | 26 | measures we implemented to protect your data. |
51 | 27 |
|
|
0 commit comments