Micro Integrator Observability Overview¶
This section explains how to set up the observability solutions and perform management tasks for the Micro Integrator.
There are two observability solutions for the Micro Integrator; The cloud-native observability deployment and the classic observability deployment.
The cloud-native and classic observability solution are suitable for the following combination of operations.
|Kubernetes cloud-native solution||
||The default Kubernetes cloud-native solution comes with metrics enabled. You can also configure logging and tracing in combination with this. This solution is ideal if you want a complete cloud-native solution to observability and you already have Prometheus, Grafana, and Jaeger as your in-house monitoring and observability tools.|
|VM cloud-native deployment||
||The default VM cloud-native solution comes with metrics enabled. You can additionally set up logging or tracing separatly as part of this solution later. This solution is ideal if you want a complete cloud-native solution to observability, but you need to set this up on a VM. Ideally you would already have Prometheus, Grafana, and Jaeger as your in-house monitoring and observability tools.|
||This solution uses the Analytics profile of WSO2 EI 6.x.x and if can be configured to have metrics and tracing by enabling them once set up. You will have to configure logging separately by setting it up in the Micro Integrator itself. This is useful if you require more business analytics and less operation observability and also if you already have an observability stack such as ELK.. This is a more simpler solution.|
For instructions to set up the above observability solutions, see Setting Up the cloud-native observability solutions or Setting up classic observability solution.
For more information on how to use the cloud-native solution, see Cloud Native Observability Solution.
For more information on how to use the classic observability solution, see Classic Observability Deployment.
Understanding observability solutions¶
Predecessors of the WSO2 Micro Integrator (i.e., WSO2 Enterprise Integrator 7.0.0 and older versions) offer an analytics distribution that mainly provides business analytics functionality together with a few observability related features. Clients with comprehensive observability requirements had to rely on external tools/stacks such as ELK, Prometheus, AppDynamics, Jaeger, Zipkin, etc. This resulted in multiple scattered systems to observe the system where debugging and troubleshooting were not sufficiently stream-lined.
The current observability solution utilizes a selected set of external tools together with the older analytic distribution intact. This section explains the features and usage of both solutions.
The older analytics distribution is referred to as the Classic Observability Deployment, and the newer solution (introduced with WSO2 Enterprise Integrator 7.1.0) is the Cloud-Native Observability Deployment.
You can monitor and manage various artifacts that you have deployed. The following are the options that enable you to do this.
- Micro Integrator Dashboard: Allows you to perform administration tasks related to your Micro Integrator deployment
- Using the Management API: The CLI for the Micro Integrator of APIM 4.0.0 (apictl) and the Micro Integrator dashboard communicate with this service to obtain administrative information of the server instance and to perform various administration tasks. If you are not using the dashboard or the CLI, you can directly access the resources of the management API
Integration with external tools¶
You can integrate with external tools to do the following:
TCP Message MonitoringTop