From b2e6a3a9f5d61b887511859fef0c7b13033d899d Mon Sep 17 00:00:00 2001 From: moander Date: Thu, 21 Oct 2021 19:57:27 +0200 Subject: [PATCH] docs: expose existing comments --- .../src/xhr.ts | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts b/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts index 09d8a0c588..d2d126be8e 100644 --- a/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts +++ b/experimental/packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts @@ -57,13 +57,15 @@ export type XHRCustomAttributeFunction = ( */ export interface XMLHttpRequestInstrumentationConfig extends InstrumentationConfig { - // the number of timing resources is limited, after the limit - // (chrome 250, safari 150) the information is not collected anymore - // the only way to prevent that is to regularly clean the resources - // whenever it is possible, this is needed only when PerformanceObserver - // is not available + /** + * The number of timing resources is limited, after the limit + * (chrome 250, safari 150) the information is not collected anymore. + * The only way to prevent that is to regularly clean the resources + * whenever it is possible. This is needed only when PerformanceObserver + * is not available + */ clearTimingResources?: boolean; - // urls which should include trace headers when origin doesn't match + /** URLs which should include trace headers when origin doesn't match */ propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls; /** * URLs that partially match any regex in ignoreUrls will not be traced.