Skip to content
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

chore: [CHAOS-7225]: Support SQL Chaos in JVM based services #8934

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: [CHAOS-7225]: Support SQL Chaos in JVM based services #8934

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a9fe5c
chore: [CHAOS-7225]: Support SQL Chaos in JVM based services
ispeakc0de Dec 19, 2024
86c912e
Add fault diagrams
SmritiSatya Dec 19, 2024
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
14 changes: 13 additions & 1 deletion docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/experiments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,19 @@ export const experiments: ExperimentDetails[] = [
name: "Pod JVM trigger gc",
description:"Pod JVM trigger gc triggers the garbage collector for a Java process executing in a Kubernetes pod. This causes unused (or out of scope) objects and variables to be garbage collected and recycled, thereby freeing up memory space.",
tags: ["pod", "jvm"],
category: "kubernetes",
category: "kubernetes",
},
{
name: "Pod JVM SQL Exception",
description:"Pod JVM SQL Exception injects exception in sql queries for a Java application executing in a Kubernetes pod",
tags: ["pod", "jvm", "sql", "exception"],
category: "kubernetes",
},
{
name: "Pod JVM SQL Latency",
description:"Pod JVM SQL Latency injects latency in sql queries for a Java application executing in a Kubernetes pod",
tags: ["pod", "jvm", "sql", "latency"],
category: "kubernetes",
},
{
name: "Pod memory hog exec",
Expand Down
32 changes: 32 additions & 0 deletions docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,38 @@ Pod JVM trigger gc triggers the garbage collector for a Java process executing i

<FaultDetailsCard category="kubernetes" subCategory="pod">

### Pod JVM sql exception

Pod JVM sql exception injects chaos into a Java application executing in a Kubernetes pod by invoking an SQL exception.

<Accordion color="green">
<summary>Use cases</summary>
- Determines the performance bottlenecks of the application
- Simulates SQL exceptions to ensure if application can recover gracefully
- Assess if the monitoring systems and alerting mechanisms can accurately detect and report SQL query exceptions in real-time.
- Determines the performance and resilience of the dependant application (or services) running on Kubernetes.
</Accordion>

</FaultDetailsCard>

<FaultDetailsCard category="kubernetes" subCategory="pod">

### Pod JVM sql latency

Pod JVM sql latency injects chaos into a Java application executing in a Kubernetes pod by invoking latency in sql queries.

<Accordion color="green">
<summary>Use cases</summary>
- Determines the performance bottlenecks of the application
- Simulate database latency to evaluate how the application handles slower SQL queries
- Test the impact of SQL query latency on the end-user experience, ensuring the application behaves gracefully under slower response times.
- Determines the performance and resilience of the dependant application (or services) running on Kubernetes.
</Accordion>

</FaultDetailsCard>

<FaultDetailsCard category="kubernetes" subCategory="pod">

### Pod memory hog exec

Pod memory hog exec is a Kubernetes pod-level chaos fault that consumes memory resources on the application container in megabytes.
Expand Down
167 changes: 167 additions & 0 deletions ...engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-jvm-sql-exception.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
---
id: pod-jvm-sql-exception
title: Pod JVM SQL Exception
---

Pod JVM SQL Exception fault simulates SQL query failures by raising exceptions for SQL queries executed by the Java process running inside a Kubernetes pod. This helps test the application's behavior and resilience against SQL-related errors.

:::tip
JVM chaos faults use the [Byteman utility](https://byteman.jboss.org/) to inject chaos faults into the JVM.
:::

![Pod JVM SQL Exception](./static/images/pod-jvm-sql-exception.png)

### Use cases
Pod JVM SQL exception:
- Validate the application's resilience by simulating SQL exceptions to ensure it can recover gracefully, retry operations, or switch to backup databases without affecting functionality.
- Assess if the monitoring systems and alerting mechanisms can accurately detect and report SQL query exceptions in real-time.
- Trigger exception-handling paths in the application to ensure coverage of edge cases related to SQL query failures during testing.


### Mandatory tunables
<table>
<tr>
<th> Tunable </th>
<th> Description </th>
<th> Notes </th>
</tr>
<tr>
<td> TABLE </td>
<td> The name of the SQL table to be targeted. </td>
<td> For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
<tr>
<td> SQL_DATA_ACCESS_FRAMEWORK </td>
<td> The name of the data access framework. </td>
<td> It supports MYSQL5, MYSQL8, and HIBERNATE types. For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
<tr>
<td> SQL_EXCEPTION_CLASS </td>
<td> The name of the exception class. </td>
<td> For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
<tr>
<td> SQL_EXCEPTION_MESSAGE </td>
<td> The exception message to be raised. </td>
<td> For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
</table>

### Optional tunables
<table>
<tr>
<th> Tunable </th>
<th> Description </th>
<th> Notes </th>
</tr>
<tr>
<td> TOTAL_CHAOS_DURATION </td>
<td> Duration through which chaos is injected into the target resource. Should be provided in <code>[numeric-hours]h[numeric-minutes]m[numeric-seconds]s</code> format. </td>
<td> Default: <code>30s</code>. Examples: <code>1m25s</code>, <code>1h3m2s</code>, <code>1h3s</code>. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/common-tunables-for-all-faults/#duration-of-the-chaos"> duration of the chaos.</a></td>
</tr>
<tr>
<td> SQL_OPERATION </td>
<td> The type of SQL query to be targeted. </td>
<td> If not provided, it targets all SQL queries. For example: <code>select</code>. For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
<tr>
<td> TRANSACTION_PERCENTAGE </td>
<td> The percentage of total SQL queries to be targeted. </td>
<td> Supports percentage in (0.00,1.00] range. If not provided, it targets all SQL queries. For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
<tr>
<td> POD_AFFECTED_PERCENTAGE </td>
<td> Percentage of total pods to target. Provide numeric values. </td>
<td> Default: 0 (corresponds to 1 replica). For more information, go to <a href="/docs/chaos-engineering/chaos-faults/use-harness-ce/kubernetes/pod/common-tunables-for-pod-faults#pod-affected-percentage">pods affected percentage. </a> </td>
</tr>
<tr>
<td> JAVA_HOME </td>
<td> Path to the Java installation directory. </td>
<td> For example, /tmp/dir/jdk. </td>
</tr>
<tr>
<td> BYTEMAN_PORT </td>
<td> Port used by the Byteman agent. </td>
<td> Default: <code>9091</code>. </td>
</tr>
<tr>
<td> CONTAINER_RUNTIME </td>
<td> Container runtime interface for the cluster. </td>
<td> Default: containerd. Support values: docker, containerd and crio. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-api-modify-body#container-runtime-and-socket-path">container runtime</a>.</td>
</tr>
<tr>
<td> SOCKET_PATH </td>
<td> Path of the containerd or crio or docker socket file. </td>
<td> Default: <code>/run/containerd/containerd.sock</code>. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-api-modify-body#container-runtime-and-socket-path">socket path</a>.</td>
</tr>
<tr>
<td> RAMP_TIME </td>
<td> Period to wait before and after injecting chaos. Should be provided in <code>[numeric-hours]h[numeric-minutes]m[numeric-seconds]s</code> format. </td>
<td> Default: <code>0s</code>. Examples: <code>1m25s</code>, <code>1h3m2s</code>, <code>1h3s</code>. For more information, go to <a href= "/docs/chaos-engineering/use-harness-ce/chaos-faults/common-tunables-for-all-faults#ramp-time">ramp time.</a></td>
</tr>
<tr>
<td> SEQUENCE </td>
<td> Sequence of chaos execution for multiple target pods. </td>
<td> Default: parallel. Supports serial and parallel. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/common-tunables-for-all-faults#sequence-of-chaos-execution">sequence of chaos execution</a>.</td>
</tr>
<tr>
<td> TARGET_CONTAINER </td>
<td> Name of the container subject to API header modification. </td>
<td> None. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/common-tunables-for-pod-faults#target-specific-container">target specific container</a></td>
</tr>
<tr>
<td> TARGET_PODS </td>
<td> Comma-separated list of application pod names subject to pod HTTP modify body.</td>
<td> If not provided, the fault selects target pods randomly based on provided appLabels. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/common-tunables-for-pod-faults#target-specific-pods"> target specific pods</a>.</td>
</tr>
<tr>
<td> NODE_LABEL </td>
<td> It filters the target pods that are scheduled on nodes matching the specified `NODE_LABEL`. </td>
<td> For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/node/common-tunables-for-node-faults#target-nodes-with-labels">node label.</a></td>
</tr>
<tr>
<td> LIB_IMAGE </td>
<td> Image used to inject chaos. </td>
<td> Default: <code>harness/ddcr-faults:main-latest</code>. For more information, go to <a href = "/docs/chaos-engineering/use-harness-ce/chaos-faults/common-tunables-for-all-faults#image-used-by-the-helper-pod">image used by the helper pod.</a></td>
</tr>
</table>

### Parameters

The following YAML snippet illustrates the use of these tunables:

[embedmd]:# (./static/manifests/pod-jvm-sql-exception/params.yaml yaml)
```yaml
kind: KubernetesChaosExperiment
apiVersion: litmuschaos.io/v1alpha1
metadata:
name: pod-jvm-sql-exception
namespace: hce
spec:
tasks:
- definition:
chaos:
env:
- name: TOTAL_CHAOS_DURATION
value: "60"
# provide the sql table name
- name: TABLE
value: "product"
# provide the sql operation name
# it supports select, insert, update, delete, replace types
- name: SQL_OPERATION
value: "select"
# name of the data access framework
# it supports MYSQL5, MYSQL8, HIBERNATE types
- name: SQL_DATA_ACCESS_FRAMEWORK
value: "MYSQL8"
# name of the sql exception class
- name: SQL_EXCEPTION_CLASS
value: "com.mysql.cj.exceptions.CJException"
# provide the exception message
- name: SQL_EXCEPTION_MESSAGE
value: "CHAOS BOOM!"
# provide the transaction percentage
- name: TRANSACTION_PERCENTAGE
value: "50"
```
157 changes: 157 additions & 0 deletions ...s-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-jvm-sql-latency.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
---
id: pod-jvm-sql-latency
title: Pod JVM SQL Latency
---

Pod JVM SQL Latency fault introduces latency in the SQL queries executed by the Java process running inside a Kubernetes pod.
:::tip
JVM chaos faults use the [Byteman utility](https://byteman.jboss.org/) to inject chaos faults into the JVM.
:::

![Pod JVM SQL Latency](./static/images/pod-jvm-sql-latency.png)

### Use cases
Pod JVM SQL latency:
- Simulate database latency to evaluate how the application handles slower SQL queries, assess system performance under delayed database responses, and identify potential bottlenecks in handling high volumes of requests.
- Test the impact of SQL query latency on the end-user experience, ensuring the application behaves gracefully under slower response times. This includes validating timeouts, retries, and fallback mechanisms to maintain a seamless user experience.
- Ensure that the application can handle delayed SQL queries without failing. Test timeout configurations, error-handling strategies, and automatic recovery processes to verify that the system can withstand latency-induced delays without causing critical failures.

### Mandatory tunables
<table>
<tr>
<th> Tunable </th>
<th> Description </th>
<th> Notes </th>
</tr>
<tr>
<td> TABLE </td>
<td> The name of the SQL table to be targeted. </td>
<td> For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
<tr>
<td> SQL_DATA_ACCESS_FRAMEWORK </td>
<td> The name of the data access framework. </td>
<td> It supports MYSQL5, MYSQL8, and HIBERNATE types. For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
<tr>
<td> SQL_LATENCY </td>
<td> The latency to be injected into the SQL queries (in ms). </td>
<td> For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
</table>

### Optional tunables
<table>
<tr>
<th> Tunable </th>
<th> Description </th>
<th> Notes </th>
</tr>
<tr>
<td> TOTAL_CHAOS_DURATION </td>
<td> Duration through which chaos is injected into the target resource. Should be provided in <code>[numeric-hours]h[numeric-minutes]m[numeric-seconds]s</code> format. </td>
<td> Default: <code>30s</code>. For example: <code>1m25s</code>, <code>1h3m2s</code>, <code>1h3s</code>. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/common-tunables-for-all-faults/#duration-of-the-chaos"> duration of the chaos.</a></td>
</tr>
<tr>
<td> SQL_OPERATION </td>
<td> The type of SQL query to be targeted. </td>
<td> If not provided it targets all SQL queries. For example: <code>select</code>. For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
<tr>
<td> TRANSACTION_PERCENTAGE </td>
<td> The percentage of total SQL queries to be targeted. </td>
<td> Supports percentage in (0.00,1.00] range. If not provided, it targets all SQL queries. For more information, go to <a href= "#parameters">Parameters</a></td>
</tr>
<tr>
<td> POD_AFFECTED_PERCENTAGE </td>
<td> Percentage of total pods to target. Provide numeric values. </td>
<td> Default: 0 (corresponds to 1 replica). For more information, go to <a href="/docs/chaos-engineering/chaos-faults/use-harness-ce/kubernetes/pod/common-tunables-for-pod-faults#pod-affected-percentage">pods affected percentage </a> </td>
</tr>
<tr>
<td> JAVA_HOME </td>
<td> Path to the Java installation directory. </td>
<td> For example, /tmp/dir/jdk. </td>
</tr>
<tr>
<td> BYTEMAN_PORT </td>
<td> Port used by the Byteman agent. </td>
<td> Default: <code>9091</code>. </td>
</tr>
<tr>
<td> CONTAINER_RUNTIME </td>
<td> Container runtime interface for the cluster</td>
<td> Default: containerd. Support values: docker, containerd and crio. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-api-modify-body#container-runtime-and-socket-path">container runtime</a>.</td>
</tr>
<tr>
<td> SOCKET_PATH </td>
<td> Path of the containerd or crio or docker socket file. </td>
<td> Default: <code>/run/containerd/containerd.sock</code>. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/pod-api-modify-body#container-runtime-and-socket-path">socket path</a>.</td>
</tr>
<tr>
<td> RAMP_TIME </td>
<td> Period to wait before and after injecting chaos. Should be provided in <code>[numeric-hours]h[numeric-minutes]m[numeric-seconds]s</code> format. </td>
<td> Default: <code>0s</code>. For example: <code>1m25s</code>, <code>1h3m2s</code>, <code>1h3s</code>. For more information, go to <a href= "/docs/chaos-engineering/use-harness-ce/chaos-faults/common-tunables-for-all-faults#ramp-time">ramp time.</a></td>
</tr>
<tr>
<td> SEQUENCE </td>
<td> Sequence of chaos execution for multiple target pods. </td>
<td> Default: parallel. Supports serial and parallel. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/common-tunables-for-all-faults#sequence-of-chaos-execution">sequence of chaos execution</a>.</td>
</tr>
<tr>
<td> TARGET_CONTAINER </td>
<td> Name of the container subject to API header modification. </td>
<td> None. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/common-tunables-for-pod-faults#target-specific-container">target specific container</a></td>
</tr>
<tr>
<td> TARGET_PODS </td>
<td> Comma-separated list of application pod names subject to pod HTTP modify body.</td>
<td> If not provided, the fault selects target pods randomly based on provided appLabels. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/pod/common-tunables-for-pod-faults#target-specific-pods"> target specific pods</a>.</td>
</tr>
<tr>
<td> NODE_LABEL </td>
<td> It filters the target pods that are scheduled on nodes matching the specified `NODE_LABEL`. </td>
<td> For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/node/common-tunables-for-node-faults#target-nodes-with-labels">node label.</a></td>
</tr>
<tr>
<td> LIB_IMAGE </td>
<td> Image used to inject chaos. </td>
<td> Default: <code>harness/ddcr-faults:main-latest</code>. For more information, go to <a href = "/docs/chaos-engineering/use-harness-ce/chaos-faults/common-tunables-for-all-faults#image-used-by-the-helper-pod">image used by the helper pod.</a></td>
</tr>
</table>

### Parameters

The following YAML snippet illustrates the use of these tunables:

[embedmd]:# (./static/manifests/pod-jvm-sql-latency/params.yaml yaml)
```yaml
kind: KubernetesChaosExperiment
apiVersion: litmuschaos.io/v1alpha1
metadata:
name: pod-jvm-sql-latency
namespace: hce
spec:
tasks:
- definition:
chaos:
env:
- name: TOTAL_CHAOS_DURATION
value: "60"
# provide the sql table name
- name: TABLE
value: "product"
# provide the sql operation name
# it supports select, insert, update, delete, replace types
- name: SQL_OPERATION
value: "select"
# name of the data access framework
# it supports MYSQL5, MYSQL8, HIBERNATE types
- name: SQL_DATA_ACCESS_FRAMEWORK
value: "MYSQL8"
# provide the latency in ms
- name: SQL_LATENCY
value: "2000" #in ms
# provide the transaction percentage
- name: TRANSACTION_PERCENTAGE
value: "50"
```
Binary file added ...-harness-ce/chaos-faults/kubernetes/pod/static/images/pod-jvm-sql-exception.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...se-harness-ce/chaos-faults/kubernetes/pod/static/images/pod-jvm-sql-latency.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading