42 lines
34 KiB
HTML
42 lines
34 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DiagAPI | OpenTelemetry SDK</title><meta name="description" content="Documentation for OpenTelemetry SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">OpenTelemetry SDK</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">OpenTelemetry SDK</a></li><li><a href="../modules/_opentelemetry_api.html">@opentelemetry/api</a></li><li><a href="_opentelemetry_api.DiagAPI.html">DiagAPI</a></li></ul><h1>Class DiagAPI </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Singleton object which represents the entry point to the OpenTelemetry internal
|
|
diagnostic API</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>1.0.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">DiagAPI</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a></li><li><a href="../interfaces/_opentelemetry_api._internal_.DiagLoggerApi.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLoggerApi</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#createComponentLogger" class="tsd-kind-icon">create<wbr/>Component<wbr/>Logger</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#disable" class="tsd-kind-icon">disable</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#info" class="tsd-kind-icon">info</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#setLogger" class="tsd-kind-icon">set<wbr/>Logger</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#verbose" class="tsd-kind-icon">verbose</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#warn" class="tsd-kind-icon">warn</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_opentelemetry_api.DiagAPI.html#instance" class="tsd-kind-icon">instance</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="createComponentLogger" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Component<wbr/>Logger<a href="#createComponentLogger" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">create<wbr/>Component<wbr/>Logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/_opentelemetry_api.ComponentLoggerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ComponentLoggerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/api/diag.ts#L130">api/src/api/diag.ts:130</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/_opentelemetry_api.ComponentLoggerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ComponentLoggerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/_opentelemetry_api.ComponentLoggerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ComponentLoggerOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="debug" class="tsd-anchor"></a><h3 class="tsd-anchor-link">debug<a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">debug<span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_api.html#DiagLogFunction" class="tsd-signature-type" data-tsd-kind="Type alias">DiagLogFunction</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_api.DiagLogger.html#debug">debug</a></p><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/api/diag.ts#L136">api/src/api/diag.ts:136</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Log a general debug message that can be useful for identifying a failure.
|
|
Information logged at this level may include diagnostic details that would
|
|
help identify a failure scenario.
|
|
For example: Logging the order of execution of async operations.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="disable" class="tsd-anchor"></a><h3 class="tsd-anchor-link">disable<a href="#disable" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">disable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/api/diag.ts#L144">api/src/api/diag.ts:144</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Unregister the global logger and return to Noop</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="error" class="tsd-anchor"></a><h3 class="tsd-anchor-link">error<a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_api.html#DiagLogFunction" class="tsd-signature-type" data-tsd-kind="Type alias">DiagLogFunction</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_api.DiagLogger.html#error">error</a></p><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/api/diag.ts#L139">api/src/api/diag.ts:139</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Log an error scenario that was not expected and caused the requested operation to fail.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="info" class="tsd-anchor"></a><h3 class="tsd-anchor-link">info<a href="#info" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">info<span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_api.html#DiagLogFunction" class="tsd-signature-type" data-tsd-kind="Type alias">DiagLogFunction</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_api.DiagLogger.html#info">info</a></p><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/api/diag.ts#L137">api/src/api/diag.ts:137</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Log a general informational message, this should not affect functionality.
|
|
This is also the default logging level so this should NOT be used for logging
|
|
debugging level information.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="setLogger" class="tsd-anchor"></a><h3 class="tsd-anchor-link">set<wbr/>Logger<a href="#setLogger" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">set<wbr/>Logger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><span class="tsd-signature-symbol">(</span>logger<span class="tsd-signature-symbol">: </span><a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_opentelemetry_api.DiagLoggerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLoggerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><span class="tsd-signature-symbol">(</span>logger<span class="tsd-signature-symbol">: </span><a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a>, logLevel<span class="tsd-signature-symbol">?: </span><a href="../enums/_opentelemetry_api.DiagLogLevel.html" class="tsd-signature-type" data-tsd-kind="Enumeration">DiagLogLevel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_api._internal_.DiagLoggerApi.html">DiagLoggerApi</a>.<a href="../interfaces/_opentelemetry_api._internal_.DiagLoggerApi.html#setLogger">setLogger</a></p><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/api/diag.ts#L126">api/src/api/diag.ts:126</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>logger<span class="tsd-signature-symbol">: </span><a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_opentelemetry_api.DiagLoggerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLoggerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>logger<span class="tsd-signature-symbol">: </span><a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a>, logLevel<span class="tsd-signature-symbol">?: </span><a href="../enums/_opentelemetry_api.DiagLogLevel.html" class="tsd-signature-type" data-tsd-kind="Enumeration">DiagLogLevel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Set the global DiagLogger and DiagLogLevel.
|
|
If a global diag logger is already set, this will override it.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>logger: <a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The <a href="../interfaces/_opentelemetry_api.DiagLogger.html">DiagLogger</a> instance to set as the default logger.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_opentelemetry_api.DiagLoggerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLoggerOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A <a href="../interfaces/_opentelemetry_api.DiagLoggerOptions.html">DiagLoggerOptions</a> object. If not provided, default values will be set.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p><code>true</code> if the logger was successfully registered, else <code>false</code></p>
|
|
</div></li><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>logger: <a href="../interfaces/_opentelemetry_api.DiagLogger.html" class="tsd-signature-type" data-tsd-kind="Interface">DiagLogger</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The <a href="../interfaces/_opentelemetry_api.DiagLogger.html">DiagLogger</a> instance to set as the default logger.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> logLevel: <a href="../enums/_opentelemetry_api.DiagLogLevel.html" class="tsd-signature-type" data-tsd-kind="Enumeration">DiagLogLevel</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The <a href="../enums/_opentelemetry_api.DiagLogLevel.html">DiagLogLevel</a> used to filter logs sent to the logger. If not provided it will default to <a href="../enums/_opentelemetry_api.DiagLogLevel.html#INFO">DiagLogLevel.INFO</a>.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p><code>true</code> if the logger was successfully registered, else <code>false</code></p>
|
|
</div></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="verbose" class="tsd-anchor"></a><h3 class="tsd-anchor-link">verbose<a href="#verbose" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">verbose<span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_api.html#DiagLogFunction" class="tsd-signature-type" data-tsd-kind="Type alias">DiagLogFunction</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_api.DiagLogger.html#verbose">verbose</a></p><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/api/diag.ts#L135">api/src/api/diag.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Log a detailed (verbose) trace level logging that can be used to identify failures
|
|
where debug level logging would be insufficient, this level of tracing can include
|
|
input and output parameters and as such may include PII information passing through
|
|
the API. As such it is recommended that this level of tracing should not be enabled
|
|
in a production environment.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="warn" class="tsd-anchor"></a><h3 class="tsd-anchor-link">warn<a href="#warn" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">warn<span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_api.html#DiagLogFunction" class="tsd-signature-type" data-tsd-kind="Type alias">DiagLogFunction</a></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_api.DiagLogger.html#warn">warn</a></p><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/api/diag.ts#L138">api/src/api/diag.ts:138</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Log a warning scenario to inform the developer of an issues that should be investigated.
|
|
The requested operation may or may not have succeeded or completed.</p>
|
|
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="instance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> instance<a href="#instance" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">instance<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_opentelemetry_api.DiagAPI.html" class="tsd-signature-type" data-tsd-kind="Class">DiagAPI</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/e97cc2e/api/src/api/diag.ts#L44">api/src/api/diag.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Get the singleton instance of the DiagAPI API</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="_opentelemetry_api.DiagAPI.html" class="tsd-signature-type" data-tsd-kind="Class">DiagAPI</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/_opentelemetry_api.html">@opentelemetry/api</a><ul><li class=" tsd-kind-module tsd-parent-kind-module"><a href="../modules/_opentelemetry_api._internal_.html"><internal></a></li></ul></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_api_events.html">@opentelemetry/api-<wbr/>events</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_api_logs.html">@opentelemetry/api-<wbr/>logs</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_context_async_hooks.html">@opentelemetry/context-<wbr/>async-<wbr/>hooks</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_context_zone.html">@opentelemetry/context-<wbr/>zone</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_context_zone_peer_dep.html">@opentelemetry/context-<wbr/>zone-<wbr/>peer-<wbr/>dep</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_core.html">@opentelemetry/core</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_jaeger.html">@opentelemetry/exporter-<wbr/>jaeger</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_logs_otlp_grpc.html">@opentelemetry/exporter-<wbr/>logs-<wbr/>otlp-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_logs_otlp_http.html">@opentelemetry/exporter-<wbr/>logs-<wbr/>otlp-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_logs_otlp_proto.html">@opentelemetry/exporter-<wbr/>logs-<wbr/>otlp-<wbr/>proto</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_metrics_otlp_grpc.html">@opentelemetry/exporter-<wbr/>metrics-<wbr/>otlp-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_metrics_otlp_http.html">@opentelemetry/exporter-<wbr/>metrics-<wbr/>otlp-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_metrics_otlp_proto.html">@opentelemetry/exporter-<wbr/>metrics-<wbr/>otlp-<wbr/>proto</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_prometheus.html">@opentelemetry/exporter-<wbr/>prometheus</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_trace_otlp_grpc.html">@opentelemetry/exporter-<wbr/>trace-<wbr/>otlp-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_trace_otlp_http.html">@opentelemetry/exporter-<wbr/>trace-<wbr/>otlp-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_trace_otlp_proto.html">@opentelemetry/exporter-<wbr/>trace-<wbr/>otlp-<wbr/>proto</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_exporter_zipkin.html">@opentelemetry/exporter-<wbr/>zipkin</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation.html">@opentelemetry/instrumentation</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation_fetch.html">@opentelemetry/instrumentation-<wbr/>fetch</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation_grpc.html">@opentelemetry/instrumentation-<wbr/>grpc</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation_http.html">@opentelemetry/instrumentation-<wbr/>http</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_instrumentation_xml_http_request.html">@opentelemetry/instrumentation-<wbr/>xml-<wbr/>http-<wbr/>request</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_opentelemetry_browser_detector.html">@opentelemetry/opentelemetry-<wbr/>browser-<wbr/>detector</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_otlp_exporter_base.html">@opentelemetry/otlp-<wbr/>exporter-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_otlp_grpc_exporter_base.html">@opentelemetry/otlp-<wbr/>grpc-<wbr/>exporter-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_otlp_transformer.html">@opentelemetry/otlp-<wbr/>transformer</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_propagator_b3.html">@opentelemetry/propagator-<wbr/>b3</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_propagator_jaeger.html">@opentelemetry/propagator-<wbr/>jaeger</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_resources.html">@opentelemetry/resources</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sampler_jaeger_remote.html">@opentelemetry/sampler-<wbr/>jaeger-<wbr/>remote</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_events.html">@opentelemetry/sdk-<wbr/>events</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_logs.html">@opentelemetry/sdk-<wbr/>logs</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_metrics.html">@opentelemetry/sdk-<wbr/>metrics</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_node.html">@opentelemetry/sdk-<wbr/>node</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_trace_base.html">@opentelemetry/sdk-<wbr/>trace-<wbr/>base</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_trace_node.html">@opentelemetry/sdk-<wbr/>trace-<wbr/>node</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_sdk_trace_web.html">@opentelemetry/sdk-<wbr/>trace-<wbr/>web</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_semantic_conventions.html">@opentelemetry/semantic-<wbr/>conventions</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_shim_opencensus.html">@opentelemetry/shim-<wbr/>opencensus</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_shim_opentracing.html">@opentelemetry/shim-<wbr/>opentracing</a></li><li class=" tsd-kind-module"><a href="../modules/_opentelemetry_web_common.html">@opentelemetry/web-<wbr/>common</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="_opentelemetry_api.DiagAPI.html" class="tsd-kind-icon">DiagAPI</a><ul><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#createComponentLogger" class="tsd-kind-icon">create<wbr/>Component<wbr/>Logger</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#disable" class="tsd-kind-icon">disable</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#info" class="tsd-kind-icon">info</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#setLogger" class="tsd-kind-icon">set<wbr/>Logger</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#verbose" class="tsd-kind-icon">verbose</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="_opentelemetry_api.DiagAPI.html#warn" class="tsd-kind-icon">warn</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_opentelemetry_api.DiagAPI.html#instance" class="tsd-kind-icon">instance</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |