Skip to content

Add WRITE_XML_DECLARATION property for XML payloads in MI #1903

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.

Sign up for GitHub

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

Closed
manojasomarathna wants to merge 7 commits into from
Closed

Add WRITE_XML_DECLARATION property for XML payloads in MI #1903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f9a2945
Add WRITE_XML_DECLARATION property for XML payloads in MI
manojasomarathna Dec 16, 2025
9bb6cb4
Fix YAML formatting for MetricHandler configuration
manojasomarathna Dec 19, 2025
f31baef
Fix indentation for JAVA_OPTS in WSO2 deployment config
manojasomarathna Dec 19, 2025
1b253d2
Refactor Prometheus Agent annotations and resources
manojasomarathna Dec 20, 2025
06271c4
Fix regex pattern in customParsers section
manojasomarathna Dec 20, 2025
0bf2a7b
Fix YAML indentation in WSO2 configuration
manojasomarathna Dec 20, 2025
1434deb
Fix class path and update YAML formatting
manojasomarathna Dec 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 17 additions & 19 deletions en/docs/observe-and-manage/setting-up-cloud-native-observability-in-kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,11 @@ To expose metrics for Prometheus scraping, update your WSO2 Integrator: MI Helm

```yaml
wso2:
config:
synapseHandlers:
- name: MetricHandler
class: org.wso2.micro.integrator.observability.metric.handler.MetricHandler
config:
synapseHandlers:
- name: MetricHandler
class: org.wso2.micro.integrator.observability.metric.handler.MetricHandler

```

For details, refer to the [Configure Helm charts for WSO2 Integrator: MI]({{base_path}}/install-and-setup/setup/deployment/configuring-helm-charts/) guide.
Expand All @@ -143,9 +144,11 @@ To expose metrics for Prometheus scraping, update your WSO2 Integrator: MI Helm

```yaml
wso2:
deployment:
envs:
JAVA_OPTS: "-DenablePrometheusApi=true"
deployment:
Copy link
Copy Markdown
Contributor

@chanikag chanikag Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep original formatting

envs:
JAVA_OPTS: "-DenablePrometheusApi=true"


```

This enables the `/metric-service/metrics` endpoint exposed by WSO2 Integrator: MI for Prometheus scraping.
Expand All @@ -156,11 +159,12 @@ To expose metrics for Prometheus scraping, update your WSO2 Integrator: MI Helm

```yaml
wso2:
deployment:
annotations:
prometheus.io/wso2-path: "/metric-service/metrics"
prometheus.io/wso2-port: "9201"
prometheus.io/wso2-scrape: "true"
deployment:
annotations:
prometheus.io/wso2-path: "/metric-service/metrics"
prometheus.io/wso2-port: "9201"
prometheus.io/wso2-scrape: "true"

```

### Set up the Prometheus Agent
Expand Down Expand Up @@ -198,11 +202,7 @@ To deploy the Prometheus Agent in your Kubernetes cluster, you need to create a
name: prometheus-agent
rules:
- apiGroups: [""]
resources:
- pods
- nodes
- services
- endpoints
resources: ["pods", "nodes", "services", "endpoints"]
verbs: ["get", "list", "watch"]
---
apiVersion: rbac.authorization.k8s.io/v1
Expand Down Expand Up @@ -238,10 +238,8 @@ To deploy the Prometheus Agent in your Kubernetes cluster, you need to create a
prometheus.yml: |
global:
scrape_interval: 15s

remote_write:
- url: "http://host.docker.internal:9090/api/v1/write"

scrape_configs:
- job_name: 'kubernetes-pods-wso2-integration'
kubernetes_sd_configs:
Expand Down
8 changes: 8 additions & 0 deletions en/docs/observe-and-manage/setting-up-cloud-native-observability-on-a-vm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,14 @@ In a clustered deployment, you can view the list of WSO2 Integrator: MI instance

To enable observability for the WSO2 Integrator: MI servers, add the following Synapse handler to the `deployment.toml` file (stored in the `<MI_HOME>/conf/` folder).

### Step 1.5 - Enable XML Declaration in Payloads

If you want your outgoing messages to include the XML declaration, add the following Axis2 property to your Synapse configuration:

```xml
<property name="WRITE_XML_DECLARATION" scope="axis2" value="true"/>
Copy link
Copy Markdown
Contributor

@chanikag chanikag Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should go to https://mi.docs.wso2.com/en/latest/reference/mediators/property-reference/axis2-properties/



```toml
[[synapse_handlers]]
name="CustomObservabilityHandler"
Expand Down