39 lines
33 KiB
HTML
39 lines
33 KiB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">OpenTelemetry SDK</a></li><li><a href="../modules/_opentelemetry_sdk-node.html">@opentelemetry/sdk-node</a></li><li><a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html">@opentelemetry/api</a></li><li><a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html">DiagAPI</a></li></ul><h1>Class DiagAPI</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Singleton object which represents the entry point to the OpenTelemetry internal
|
||
diagnostic API</p>
|
||
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since" class="tsd-anchor"></a>Since<a href="#since" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>1.0.0</p>
|
||
</div></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-signature-type tsd-kind-interface">DiagLogger</a></li><li><span class="tsd-signature-type">DiagLoggerApi</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/diag.d.ts:8</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html#createcomponentlogger" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Component<wbr/>Logger</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html#debug" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>debug</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html#disable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html#error" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html#info" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>info</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html#setlogger" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Logger</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html#verbose" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>verbose</span></a>
|
||
<a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html#warn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>warn</span></a>
|
||
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html#instance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>instance</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="createcomponentlogger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Component<wbr/>Logger</span><a href="#createcomponentlogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createComponentLogger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.ComponentLoggerOptions.html" class="tsd-signature-type tsd-kind-interface">ComponentLoggerOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-signature-type tsd-kind-interface">DiagLogger</a></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/diag.d.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="debug" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>debug</span><a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html#debug">debug</a></p><ul><li>Defined in api/build/src/api/diag.d.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="disable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disable</span><a href="#disable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disable</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></div><div class="tsd-comment tsd-typography"><p>Unregister the global logger and return to Noop</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/diag.d.ts:30</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="error" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a></div><div class="tsd-comment tsd-typography"><p>Log an error scenario that was not expected and caused the requested operation to fail.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html#error">error</a></p><ul><li>Defined in api/build/src/api/diag.d.ts:26</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>info</span><a href="#info" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">info</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html#info">info</a></p><ul><li>Defined in api/build/src/api/diag.d.ts:24</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setlogger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Logger</span><a href="#setlogger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">setLogger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">logger</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-signature-type tsd-kind-interface">DiagLogger</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLoggerOptions.html" class="tsd-signature-type tsd-kind-interface">DiagLoggerOptions</a><span class="tsd-signature-symbol">,</span><br/> <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><br/> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">logger</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-signature-type tsd-kind-interface">DiagLogger</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">logLevel</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node._opentelemetry_api.DiagLogLevel.html" class="tsd-signature-type tsd-kind-enum">DiagLogLevel</a><span class="tsd-signature-symbol">,</span><br/> <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><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Set the global DiagLogger and DiagLogLevel.
|
||
If a global diag logger is already set, this will override it.</p>
|
||
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">logger</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-signature-type tsd-kind-interface">DiagLogger</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLoggerOptions.html" class="tsd-signature-type tsd-kind-interface">DiagLoggerOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">logger</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-signature-type tsd-kind-interface">DiagLogger</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLoggerOptions.html" class="tsd-signature-type tsd-kind-interface">DiagLoggerOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">logger</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-signature-type tsd-kind-interface">DiagLogger</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">logLevel</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node._opentelemetry_api.DiagLogLevel.html" class="tsd-signature-type tsd-kind-enum">DiagLogLevel</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">logger</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-signature-type tsd-kind-interface">DiagLogger</a></span><div class="tsd-comment tsd-typography"><p>The <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-kind-interface">DiagLogger</a> instance to set as the default logger.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">logLevel</span>: <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../enums/_opentelemetry_sdk-node._opentelemetry_api.DiagLogLevel.html" class="tsd-signature-type tsd-kind-enum">DiagLogLevel</a></span><div class="tsd-comment tsd-typography"><p>The <a href="../enums/_opentelemetry_sdk-node._opentelemetry_api.DiagLogLevel.html" class="tsd-kind-enum">DiagLogLevel</a> used to filter logs sent to the logger. If not provided it will default to <a href="../enums/_opentelemetry_sdk-node._opentelemetry_api.DiagLogLevel.html#info" class="tsd-kind-enum-member">DiagLogLevel.INFO</a>.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the logger was successfully registered, else <code>false</code></p>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-logger" class="tsd-anchor"></a>Param: logger<a href="#param-logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html" class="tsd-kind-interface">DiagLogger</a> instance to set as the default logger.</p>
|
||
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-options" class="tsd-anchor"></a>Param: options<a href="#param-options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>A <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLoggerOptions.html" class="tsd-kind-interface">DiagLoggerOptions</a> object. If not provided, default values will be set.</p>
|
||
</div><div class="tsd-tag-returns"><h4 class="tsd-anchor-link"><a id="returns" class="tsd-anchor"></a>Returns<a href="#returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><code>true</code> if the logger was successfully registered, else <code>false</code></p>
|
||
</div></div><aside class="tsd-sources"><p>Implementation of DiagLoggerApi.setLogger</p><ul><li>Defined in api/build/src/api/diag.d.ts:17</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="verbose" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>verbose</span><a href="#verbose" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">verbose</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html#verbose">verbose</a></p><ul><li>Defined in api/build/src/api/diag.d.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="warn" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>warn</span><a href="#warn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">warn</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="../types/_opentelemetry_sdk-node._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html">DiagLogger</a>.<a href="../interfaces/_opentelemetry_sdk-node._opentelemetry_api.DiagLogger.html#warn">warn</a></p><ul><li>Defined in api/build/src/api/diag.d.ts:25</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="instance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>instance</span><a href="#instance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="instance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">instance</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html" class="tsd-signature-type tsd-kind-class">DiagAPI</a><a href="#instance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the singleton instance of the DiagAPI API</p>
|
||
</div><h4 class="tsd-returns-title">Returns <a href="../modules/_opentelemetry_sdk-node._opentelemetry_api.html" class="tsd-signature-type tsd-kind-namespace">@opentelemetry/api</a><span class="tsd-signature-symbol">.</span><a href="_opentelemetry_sdk-node._opentelemetry_api.DiagAPI.html" class="tsd-signature-type tsd-kind-class">DiagAPI</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in api/build/src/api/diag.d.ts:11</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#createcomponentlogger" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Component<wbr/>Logger</span></a><a href="#debug" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>debug</span></a><a href="#disable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable</span></a><a href="#error" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error</span></a><a href="#info" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>info</span></a><a href="#setlogger" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Logger</span></a><a href="#verbose" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>verbose</span></a><a href="#warn" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>warn</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#instance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>instance</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">OpenTelemetry SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|