# Fault Injection The Fault Injection feature is an API that intentionally generates failures in order to verify the system’s stability and error-handling capability. With it, you can induce initialization failures, frame processing failures, and delays for decoder, filter, and encoder that use a specific module, and you can run tests by creating an environment similar to real failure scenarios. ## Enabling Fault Injection You can configure Fault Injection in `Server.xml` under `` as follows: ```xml ... ... true ... ... ``` ## API Interface ### Configuring Fault Injection You can configure Fault Injection as an array under `transcoder`. When you apply a new configuration, all existing settings are cleared. Likewise, when OvenMediaEngine is restarted, all related settings are reset to their initial state. > **Request**
POST /v2/internals/tests:setFaultInject **Header** ```http Authorization: Basic {credentials} # Authorization Credentials for HTTP Basic Authentication created with ``` **Body** ```json { "transcoder" : [ { "targetModule" : "default", "targetDeviceId" : 0, "targetComponent" : "decoder", "faultType" : "initFailed", "faultRate" : 50 }, { "targetModule" : "openh264", "targetDeviceId" : 0, "targetComponent" : "filter", "faultType" : "processFailed", "faultRate" : 2.0 }, { "targetModule" : "nv", "targetDeviceId" : 0, "targetComponent" : "encoder", "faultType" : "lagging", "faultRate" : 10.0 }, { "targetModule" : "default", "targetDeviceId" : 0, "targetComponent" : "decoder", "faultType" : "processFailed", "faultRate" : 2.0 } ] } ```
> **Responses**
200 Ok The request has succeeded **Header** ```http Content-Type: application/json ``` **Body** ```json { "message": "OK", "statusCode": 200 } ```
400 Bad Request Fault injection module is not enabled in the server configuration
400 Bad Request Invalid request
ParameterInput RangeDescription
targetModuleCodec Module

Specifies the module that will be targeted by Fault Injection.

  • default, openh264, x264, libvpx, nv, xma. Please refer to the name value in v2/internals/codecs.
targetDeviceId

0~

(Device ID)

Specifies the ID assigned to the target module for Fault Injection.

targetComponentdecoder,
encoder,
filter		Specifies the component type of the target module for Fault Injection.
faultType

initFailed,
processFailed,
lagging

Specifies the type of fault testing to perform.

  • initFailed: Reproduces a module initialization failure.
  • processFailed: Reproduces failures in decoding, filtering, or encoding.
  • lagging: Reproduces a processing delay (300ms).
faultRate0.01~100.0Specifies the probability (%) that fault testing will occur.
### Disabling Fault Injection If you do not specify values in the `transcoder` array, all related settings are disabled. > **Request**
POST /v2/internals/tests:setFaultInject **Header** ```http Authorization: Basic {credentials} # Authorization Credentials for HTTP Basic Authentication created with ``` **Body** ```json { "transcoder" : [ ] } ```
> **Responses**
200 Ok The request has succeeded **Header** ```http Content-Type: application/json ``` **Body** ```json { "message": "OK", "statusCode": 200 } ```
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://ovenmediaengine-enterprise.gitbook.io/guide/features/tests/fault-injection.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.