31 lines
18 KiB
HTML
31 lines
18 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>DiagLogger | 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_api.html">@opentelemetry/api</a></li><li><a href="../modules/_opentelemetry_api._opentelemetry_api.html">@opentelemetry/api</a></li><li><a href="_opentelemetry_api._opentelemetry_api.DiagLogger.html">DiagLogger</a></li></ul><h1>Interface DiagLogger</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Defines an internal diagnostic logger interface which is used to log internal diagnostic
|
||
messages, you can set the default diagnostic logger via the <a href="../classes/_opentelemetry_api._opentelemetry_api.DiagAPI.html" class="tsd-kind-class">DiagAPI</a> setLogger function.
|
||
API provided implementations include :-</p>
|
||
<ul>
|
||
<li>a No-Op createNoopDiagLogger</li>
|
||
<li>a <a href="../enums/_opentelemetry_api._opentelemetry_api.DiagLogLevel.html" class="tsd-kind-enum">DiagLogLevel</a> filtering wrapper createLogLevelDiagLogger</li>
|
||
<li>a general Console <a href="../classes/_opentelemetry_api._opentelemetry_api.DiagConsoleLogger.html" class="tsd-kind-class">DiagConsoleLogger</a> version.</li>
|
||
</ul>
|
||
</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><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DiagLogger</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_opentelemetry_api._opentelemetry_api.DiagLogger.html#debug">debug</a><span class="tsd-signature-symbol">:</span> <a href="../types/_opentelemetry_api._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_opentelemetry_api._opentelemetry_api.DiagLogger.html#error">error</a><span class="tsd-signature-symbol">:</span> <a href="../types/_opentelemetry_api._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_opentelemetry_api._opentelemetry_api.DiagLogger.html#info">info</a><span class="tsd-signature-symbol">:</span> <a href="../types/_opentelemetry_api._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_opentelemetry_api._opentelemetry_api.DiagLogger.html#verbose">verbose</a><span class="tsd-signature-symbol">:</span> <a href="../types/_opentelemetry_api._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_opentelemetry_api._opentelemetry_api.DiagLogger.html#warn">warn</a><span class="tsd-signature-symbol">:</span> <a href="../types/_opentelemetry_api._opentelemetry_api.DiagLogFunction.html" class="tsd-signature-type tsd-kind-type-alias">DiagLogFunction</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_opentelemetry_api._opentelemetry_api.DiagAPI.html" class="tsd-signature-type tsd-kind-class">DiagAPI</a></li><li><a href="../classes/_opentelemetry_api._opentelemetry_api.DiagConsoleLogger.html" class="tsd-signature-type tsd-kind-class">DiagConsoleLogger</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/api/src/diag/types.ts#L32">diag/types.ts:32</a></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_api._opentelemetry_api.DiagLogger.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_api._opentelemetry_api.DiagLogger.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_api._opentelemetry_api.DiagLogger.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_api._opentelemetry_api.DiagLogger.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_api._opentelemetry_api.DiagLogger.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></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="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="../types/_opentelemetry_api._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"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/api/src/diag/types.ts#L55">diag/types.ts:55</a></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="../types/_opentelemetry_api._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"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/api/src/diag/types.ts#L34">diag/types.ts:34</a></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="../types/_opentelemetry_api._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"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/api/src/diag/types.ts#L47">diag/types.ts:47</a></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="../types/_opentelemetry_api._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"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/api/src/diag/types.ts#L64">diag/types.ts:64</a></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="../types/_opentelemetry_api._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"><ul><li>Defined in <a href="https://github.com/open-telemetry/opentelemetry-js/blob/2d3760898cdc4f0e68f9f956603cc5df279eb3a8/api/src/diag/types.ts#L40">diag/types.ts:40</a></li></ul></aside></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="#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="#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="#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></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>
|