docs: add documentation for XHR instrumentation options

open-telemetry · Mar 21, 2024 · e0c6e5d · e0c6e5d
1 parent 5d48c0f
commit e0c6e5d
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/experimental/packages/opentelemetry-instrumentation-xml-http-request/README.md b/experimental/packages/opentelemetry-instrumentation-xml-http-request/README.md
@@ -64,6 +64,15 @@ req.send();
 
 ```
 
+### XHR Instrumentation options
+
+XHR instrumentation plugin has few options available to choose from. You can set the following:
+
+| Options                                                                                                                                                                           | Type                         | Description                                                                             |
+|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|-----------------------------------------------------------------------------------------|
+| [`applyCustomAttributesOnSpan`](https://github.com/open-telemetry/opentelemetry-js/blob/main/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts#L76) | `XHRCustomAttributeFunction` | Function for adding custom attributes                                                   |
+| [`ignoreNetworkEvents`](https://github.com/open-telemetry/opentelemetry-js/blob/main/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts#L78)         | `boolean`                    | Disable network events being added as span events (network events are added by default) |
+
 ## Example Screenshots
 
 ![Screenshot of the running example](images/main.jpg)