> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/resilience-testing/chaos-engineering/faults/chaos-fault-categories/kubernetes/pod/pod-jvm-solace-exception.md).

# Pod JVM Solace exception

Pod JVM Solace exception is a Kubernetes pod-level chaos fault that causes Solace messaging calls from a JVM running in a target container to throw a configurable exception on a chosen destination and client mode for a configurable duration. Only matched calls fail; other Solace traffic and other code paths run normally. When the fault ends, Solace calls behave normally again immediately.

Use this fault to test how a Java service handles Solace messaging failures: a broker rejecting publishes, a subscriber that fails deserialization, or a JMS session error.

{% hint style="info" %}
**RUN YOUR FIRST EXPERIMENT**

If you have not configured the chaos infrastructure yet, go to [Quickstart](/resilience-testing/chaos-engineering/new-to-chaos-engineering/quickstart.md) to install the chaos infrastructure and run an experiment end to end.
{% endhint %}

***

### Use cases <a href="#use-cases" id="use-cases"></a>

Run this fault when you want to answer concrete questions like:

* **Publisher error handling:** When publish throws on a critical destination, does the application retry, buffer, or drop the message?
* **Subscriber poison messages:** Simulate processing errors on the subscriber side and verify dead-letter or skip semantics.
* **JMS vs native API:** Verify behavior of `jms` and other approaches on the same destination.
* **Destination scope:** Confirm that failing one destination does not unintentionally fail other destinations on the same client.
* **Observability coverage:** Do publisher-error metrics and dashboards surface the failure clearly?

***

### Prerequisites <a href="#prerequisites" id="prerequisites"></a>

* **Kubernetes version:** 1.21 or later. Go to [What's supported](/resilience-testing/chaos-engineering/new-to-chaos-engineering/whats-supported.md) to confirm distribution support.
* **Target pod is Running:** The Java application pod is in the `Running` state.
* **Java agent attach available:** The Java process allows agent attach. Utilities such as `ps`, `pgrep`, and `bash` are present in the container, and the JVM is not built with a restricted runtime that strips attach modules.
* **Solace client in classpath:** The target JVM uses a supported Solace Java messaging client (for example the Solace JMS client) and exercises the configured `STREAM`, `SOLACE_DESTINATION_TYPE`, `SOLACE_MODE`, and `SOLACE_APPROACH`.
* **Privileged pods allowed:** The cluster lets you schedule privileged pods in the chaos namespace. GKE Autopilot supports this fault but requires the one-time setup in [Chaos on GKE Autopilot](/resilience-testing/chaos-engineering/use-chaos-engineering/gke-autopilot.md); other locked-down distributions may need similar exemptions.
* **Container runtime access:** The chaos pod can reach the container runtime socket on the target node (`/run/containerd/containerd.sock`, `/var/run/docker.sock`, or `/var/run/crio/crio.sock`).
* **Workload selector defined:** The chaos experiment knows the target workload by kind, namespace, and either names or labels.

{% hint style="info" %}
**JVM CHAOS USES THE BYTEMAN AGENT**

This fault attaches a [Byteman](https://byteman.jboss.org/) agent to the target JVM over `BYTEMAN_PORT`. The port must be reachable from the chaos pod and must not be in use by the application.
{% endhint %}

***

### Supported environments <a href="#supported-environments" id="supported-environments"></a>

| Platform                                 | Support status                                                                                                 |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| Amazon EKS                               | Supported                                                                                                      |
| Azure AKS                                | Supported                                                                                                      |
| Google GKE                               | Supported                                                                                                      |
| Red Hat OpenShift                        | Supported                                                                                                      |
| Rancher                                  | Supported                                                                                                      |
| VMware Tanzu                             | Supported                                                                                                      |
| Self-managed Kubernetes (CNCF-certified) | Supported                                                                                                      |
| GKE Autopilot                            | Supported with [Autopilot setup](/resilience-testing/chaos-engineering/use-chaos-engineering/gke-autopilot.md) |
| EKS Fargate, ACI virtual nodes           | Not supported (no access to container runtime sockets)                                                         |

***

### Permissions required <a href="#permissions-required" id="permissions-required"></a>

The fault runs under the chaos infrastructure's service account.

| Resource (`apiGroup`)                                               | Verbs                                                                    | Why it is needed                                            |
| ------------------------------------------------------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------- |
| `pods` (`""`)                                                       | `get`, `list`, `create`, `delete`, `deletecollection`, `patch`, `update` | Discover target pods and run the chaos pod on the same node |
| `pods/log` (`""`)                                                   | `get`, `list`, `watch`                                                   | Stream chaos pod logs for status and debugging              |
| `deployments`, `statefulsets`, `replicasets`, `daemonsets` (`apps`) | `get`, `list`                                                            | Resolve the target workload to the pods it owns             |
| `events` (`""`)                                                     | `get`, `list`, `create`, `patch`, `update`                               | Record fault progress as Kubernetes events                  |
| `jobs` (`batch`)                                                    | `get`, `list`, `create`, `delete`, `deletecollection`                    | Run the chaos job that drives the fault                     |

The default Harness chaos infrastructure service account already includes these permissions.

***

### Fault tunables <a href="#fault-tunables" id="fault-tunables"></a>

Configure the following fault parameters when you add Pod JVM Solace exception to an experiment in Chaos Studio. Defaults are shown for reference.

**Solace filters**

| Tunable                   | Description                                                                                                      | Default       |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------- |
| `STREAM`                  | Name of the Solace topic or queue to target.                                                                     | `""`          |
| `SOLACE_MODE`             | Client mode to target. One of `publisher` (publish-side) or `subscriber` (subscribe-side).                       | `"publisher"` |
| `SOLACE_DESTINATION_TYPE` | Destination type. One of `topic` or `queue`.                                                                     | `"topic"`     |
| `SOLACE_APPROACH`         | Client API approach. For example `jms`.                                                                          | `"jms"`       |
| `TRANSACTION_PERCENTAGE`  | Percentage of matched Solace operations to fail, between `0` and `100`. `0` fails none; `100` fails every match. | `0`           |

**Exception**

| Tunable             | Description                                                       | Default                      |
| ------------------- | ----------------------------------------------------------------- | ---------------------------- |
| `EXCEPTION_CLASS`   | Exception class to throw. Defaults to a common runtime exception. | `"IllegalArgumentException"` |
| `EXCEPTION_MESSAGE` | Message attached to the thrown exception.                         | `"CHAOS BOOM!"`              |

**Chaos parameters**

| Tunable                | Description                       | Default |
| ---------------------- | --------------------------------- | ------- |
| `TOTAL_CHAOS_DURATION` | Duration of the fault in seconds. | `60`    |

**JVM**

| Tunable        | Description                                                                                                   | Default |
| -------------- | ------------------------------------------------------------------------------------------------------------- | ------- |
| `BYTEMAN_PORT` | Port on which the Byteman agent listens inside the container. Must not conflict with any port already in use. | `9091`  |
| `JAVA_HOME`    | Absolute path to the Java installation inside the container. Empty auto-detects from `PATH`.                  | `""`    |

**Targeting**

| Tunable                   | Description                                                                                                          | Default    |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------- | ---------- |
| `TARGET_PODS`             | Comma-separated list of pod names to target. Empty selects from the workload's pods using `POD_AFFECTED_PERCENTAGE`. | `""`       |
| `TARGET_CONTAINER`        | Container in the pod running the JVM. Empty targets the first container in the pod spec.                             | `""`       |
| `NODE_LABEL`              | Label selector to filter target pods by the node they run on. Empty disables node-based filtering.                   | `""`       |
| `POD_AFFECTED_PERCENTAGE` | Percentage of the workload's pods to target. `0` means one pod.                                                      | `0`        |
| `SEQUENCE`                | When multiple pods are targeted, inject `parallel` (all at once) or `serial` (one after another).                    | `parallel` |

**Runtime and helper**

| Tunable             | Description                                                                                                                                                                                                      | Default                           |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `CONTAINER_RUNTIME` | Container runtime on the target nodes. One of `containerd`, `docker`, `crio`.                                                                                                                                    | `containerd`                      |
| `SOCKET_PATH`       | Path to the container runtime socket on the target node. Set to match `CONTAINER_RUNTIME`.                                                                                                                       | `/run/containerd/containerd.sock` |
| `RAMP_TIME`         | Wait period in seconds before and after the fault. Go to [ramp time](/resilience-testing/chaos-engineering/faults/chaos-fault-categories/common-tunables-for-all-faults.md#ramp-time) to read how it is applied. | `0`                               |

Common pod selection tunables (`TARGET_WORKLOAD_KIND`, `TARGET_WORKLOAD_NAMESPACE`, `TARGET_WORKLOAD_NAMES`, `TARGET_WORKLOAD_LABELS`) are documented in [common pod fault tunables](/resilience-testing/chaos-engineering/faults/chaos-fault-categories/kubernetes/pod/common-tunables-for-pod-faults.md). Tunables that apply to every fault are documented in [common tunables for all faults](/resilience-testing/chaos-engineering/faults/chaos-fault-categories/common-tunables-for-all-faults.md).

{% hint style="info" %}
**USE A REALISTIC EXCEPTION TYPE**

Choose an exception the caller can plausibly receive (for example `javax.jms.JMSException` for JMS clients). Picking an unrelated exception type often surfaces uncaught-exception bugs that would not happen in real failures.
{% endhint %}

#### Configure for your container runtime <a href="#configure-for-your-container-runtime" id="configure-for-your-container-runtime"></a>

Set `CONTAINER_RUNTIME` and `SOCKET_PATH` to match the runtime on the target node:

| `CONTAINER_RUNTIME`    | `SOCKET_PATH`                     |
| ---------------------- | --------------------------------- |
| `containerd` (default) | `/run/containerd/containerd.sock` |
| `docker`               | `/var/run/docker.sock`            |
| `crio`                 | `/var/run/crio/crio.sock`         |

***

### Fault execution in brief <a href="#fault-execution-in-brief" id="fault-execution-in-brief"></a>

Attaches a Java agent to the target JVM and intercepts Solace client operations matching `STREAM`, `SOLACE_MODE`, `SOLACE_DESTINATION_TYPE`, and `SOLACE_APPROACH` to throw an instance of `EXCEPTION_CLASS` with `EXCEPTION_MESSAGE` on the configured percentage of calls, for `TOTAL_CHAOS_DURATION` seconds.

***

### Expected behavior during fault execution <a href="#expected-behavior-during-fault-execution" id="expected-behavior-during-fault-execution"></a>

* Matched Solace operations throw the configured exception. Other destinations and the unmatched mode run normally.
* Application logs show stack traces from the configured exception class.
* The Solace broker is not stressed; from the broker's perspective, no real message was published or consumed for the failed calls.
* Tracing systems show the Solace span ending in error.

{% hint style="info" %}
**WHEN THE FAULT ENDS**

Solace calls behave normally again immediately. Cached state in callers (open circuits, exhausted retry budgets, dead-letter queues that filled during the fault) may take additional time to drain.
{% endhint %}

#### Signals to watch <a href="#signals-to-watch" id="signals-to-watch"></a>

Attach [resilience probes](/resilience-testing/chaos-engineering/use-chaos-engineering/probes.md) to assert each layer:

* **Publisher error rate:** Use a [Prometheus probe](/resilience-testing/chaos-engineering/use-chaos-engineering/probes/apm-probes.md) on your application's Solace error counter.
* **Subscriber error rate and queue depth:** Use a Prometheus probe on subscriber processing counters to detect failed handlers.
* **Application logs:** Use a [command probe](/resilience-testing/chaos-testing/probes/command-probe.md) to grep for the configured `EXCEPTION_MESSAGE`.

***

### Verify the fault execution effect <a href="#verify-the-fault-execution-effect" id="verify-the-fault-execution-effect"></a>

While the experiment is running, confirm operations are failing:

1. **Exercise the matched code path from a client.**

   ```bash
   kubectl run -n <namespace> tester --image=nicolaka/netshoot --rm -it -- \
     curl -s http://<service>:<port>/<endpoint-that-uses-the-stream>
   ```
2. **Confirm the exception in logs.**

   ```bash
   kubectl logs -n <namespace> <target-pod> --tail=200 | grep "<EXCEPTION_MESSAGE>"
   ```

***

### Recovery and cleanup <a href="#recovery-and-cleanup" id="recovery-and-cleanup"></a>

* **End of duration:** Solace calls behave normally again automatically.
* **Abort the experiment:** Stopping the experiment from Chaos Studio triggers the same cleanup path.
* **Backlog drainage:** Allow time for normal processing to drain any backlog, or scale subscribers temporarily if needed.

***

### Limitations <a href="#limitations" id="limitations"></a>

* **Serverless Kubernetes (EKS Fargate, ACI virtual nodes):** These platforms do not expose container runtime sockets and reject the privileged access the fault needs. GKE Autopilot is supported once the one-time setup in [Chaos on GKE Autopilot](/resilience-testing/chaos-engineering/use-chaos-engineering/gke-autopilot.md) is in place.
* **Windows containers:** This fault is supported on Linux pods only.
* **Non-JVM and non-Solace workloads:** This fault targets Solace Java messaging clients inside a JVM.

***

### Troubleshooting <a href="#troubleshooting" id="troubleshooting"></a>

<details>

<summary>Pod JVM Solace exception experiment stays Pending or never starts in Harness Chaos Engineering</summary>

Inspect the chaos pods in the experiment namespace with kubectl describe pod -n . The most common causes are taints on the target node that the chaos pods do not tolerate, insufficient resources, or a PodSecurity admission policy blocking privileged pods. Add the required tolerations or run in a namespace with privileged Pod Security level.

</details>

<details>

<summary>No exception observed during pod-jvm-solace-exception</summary>

The most common causes are: STREAM does not match the topic or queue name; SOLACE\_MODE does not match what the application uses; SOLACE\_DESTINATION\_TYPE or SOLACE\_APPROACH do not match the client library; or TRANSACTION\_PERCENTAGE is 0 (default). Re-run with TRANSACTION\_PERCENTAGE=100 to confirm the path is working.

</details>

<details>

<summary>Connection to container runtime fails for pod-jvm-solace-exception in Harness Chaos Engineering</summary>

The default SOCKET\_PATH is /run/containerd/containerd.sock. For Docker, set CONTAINER\_RUNTIME=docker and SOCKET\_PATH=/var/run/docker.sock. For CRI-O, set CONTAINER\_RUNTIME=crio and SOCKET\_PATH=/var/run/crio/crio.sock.

</details>

***

### Related faults <a href="#related-faults" id="related-faults"></a>

* [Pod JVM Solace latency](/resilience-testing/chaos-engineering/faults/chaos-fault-categories/kubernetes/pod/pod-jvm-solace-latency.md): Add latency to Solace calls instead of failing them.
* [Pod JVM Kafka exception](/resilience-testing/chaos-engineering/faults/chaos-fault-categories/kubernetes/pod/pod-jvm-kafka-exception.md): Kafka equivalent for the Apache Kafka Java client.
* [Pod JVM method exception](/resilience-testing/chaos-engineering/faults/chaos-fault-categories/kubernetes/pod/pod-jvm-method-exception.md): Generic Java method-level exception injection.
* [Common pod fault tunables](/resilience-testing/chaos-engineering/faults/chaos-fault-categories/kubernetes/pod/common-tunables-for-pod-faults.md): Shared environment variables for selecting target pods and workloads.