podman-desktop/api/interfaces/TelemetryLogger.html

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-interfaces/TelemetryLogger" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.4.0">
<title data-rh="true">Interface: TelemetryLogger | Podman Desktop</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" name="twitter:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" property="og:url" content="https://podman-desktop.io/api/interfaces/TelemetryLogger"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-api-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-api-current"><meta data-rh="true" property="og:title" content="Interface: TelemetryLogger | Podman Desktop"><meta data-rh="true" name="description" content="A telemetry logger which can be used by extensions to log usage and error telementry."><meta data-rh="true" property="og:description" content="A telemetry logger which can be used by extensions to log usage and error telementry."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/interfaces/TelemetryLogger"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/TelemetryLogger" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/TelemetryLogger" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://MR01ANKQ9S-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Podman Desktop RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Podman Desktop Atom Feed">
<link rel="alternate" type="application/json" href="/blog/feed.json" title="Podman Desktop JSON Feed">


<link rel="search" type="application/opensearchdescription+xml" title="Podman Desktop" href="/opensearch.xml">

<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<script async src="//gc.zgo.at/count.js" data-goatcounter="https://podman-desktop-website.goatcounter.com/count"></script><link rel="stylesheet" href="/assets/css/styles.e62b4589.css">
<script src="/assets/js/runtime~main.c7bfbd19.js" defer="defer"></script>
<script src="/assets/js/main.5904e39c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):window.matchMedia("(prefers-color-scheme: light)").matches?t("light"):t("dark")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_oPtH" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--light_hHel" height="56"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--dark_yETr" height="56"></div><b class="navbar__title text--truncate">podman desktop</b></a><a class="navbar__item navbar__link" href="/docs/intro">Documentation</a><a class="navbar__item navbar__link" href="/core-values">Core Values</a><a class="navbar__item navbar__link" href="/features">Features</a><a class="navbar__item navbar__link" href="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/extend">Extend</a><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link"></a><div class="toggle_ki11 colorModeToggle_Hewu"><button class="clean-btn toggleButton_MMFG toggleButtonDisabled_Uw7m" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_lgto"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_U96C"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4
<p>A telemetry logger which can be used by extensions to log usage and error telementry.</p>
<p>A logger wraps around an <a href="/api/interfaces/TelemetrySender">sender</a> but it guarantees that</p>
<ul>
<li>user settings to disable or tweak telemetry are respected, and that</li>
<li>potential sensitive data is removed</li>
</ul>
<p>It also enables an &quot;echo UI&quot; that prints whatever data is send and it allows the editor
to forward unhandled errors to the respective extensions.</p>
<p>To get an instance of a <code>TelemetryLogger</code>, use
<a href="/api/namespaces/env/functions/createTelemetryLogger"><code>createTelemetryLogger</code></a>.</p>
<h2 class="anchor anchorWithStickyNavbar_JmGV" id="properties">Properties<a class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" href="/api/interfaces/TelemetryLogger#properties"></a></h2>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="iserrorsenabled">isErrorsEnabled<a class="hash-link" aria-label="Direct link to isErrorsEnabled" title="Direct link to isErrorsEnabled" href="/api/interfaces/TelemetryLogger#iserrorsenabled"></a></h3>
<blockquote>
<p><code>readonly</code> <strong>isErrorsEnabled</strong>: <code>boolean</code></p>
</blockquote>
<p>Whether or not error telemetry is enabled for this logger.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/TelemetryLogger#defined-in"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/10d471eb0d232f18c29110af8461b4f300ca281e/packages/extension-api/src/extension-api.d.ts#L4179" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:4179</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="isusageenabled">isUsageEnabled<a class="hash-link" aria-label="Direct link to isUsageEnabled" title="Direct link to isUsageEnabled" href="/api/interfaces/TelemetryLogger#isusageenabled"></a></h3>
<blockquote>
<p><code>readonly</code> <strong>isUsageEnabled</strong>: <code>boolean</code></p>
</blockquote>
<p>Whether or not usage telemetry is enabled for this logger.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-1">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/TelemetryLogger#defined-in-1"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/10d471eb0d232f18c29110af8461b4f300ca281e/packages/extension-api/src/extension-api.d.ts#L4174" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:4174</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ondidchangeenablestates">onDidChangeEnableStates<a class="hash-link" aria-label="Direct link to onDidChangeEnableStates" title="Direct link to onDidChangeEnableStates" href="/api/interfaces/TelemetryLogger#ondidchangeenablestates"></a></h3>
<blockquote>
<p><code>readonly</code> <strong>onDidChangeEnableStates</strong>: <a href="/api/interfaces/Event"><code>Event</code></a>&lt;<a href="/api/interfaces/TelemetryLogger"><code>TelemetryLogger</code></a>&gt;</p>
</blockquote>
<p>An <a href="/api/interfaces/Event">Event</a> which fires when the enablement state of usage or error telemetry changes.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-2">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/TelemetryLogger#defined-in-2"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/10d471eb0d232f18c29110af8461b4f300ca281e/packages/extension-api/src/extension-api.d.ts#L4169" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:4169</a></p>
<h2 class="anchor anchorWithStickyNavbar_JmGV" id="methods">Methods<a class="hash-link" aria-label="Direct link to Methods" title="Direct link to Methods" href="/api/interfaces/TelemetryLogger#methods"></a></h2>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="dispose">dispose()<a class="hash-link" aria-label="Direct link to dispose()" title="Direct link to dispose()" href="/api/interfaces/TelemetryLogger#dispose"></a></h3>
<blockquote>
<p><strong>dispose</strong>(): <code>void</code></p>
</blockquote>
<p>Dispose this object and free resources.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="returns">Returns<a class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" href="/api/interfaces/TelemetryLogger#returns"></a></h4>
<p><code>void</code></p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-3">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/TelemetryLogger#defined-in-3"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/10d471eb0d232f18c29110af8461b4f300ca281e/packages/extension-api/src/extension-api.d.ts#L4214" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:4214</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="logerror">logError()<a class="hash-link" aria-label="Direct link to logError()" title="Direct link to logError()" href="/api/interfaces/TelemetryLogger#logerror"></a></h3>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="logerroreventname-data">logError(eventName, data)<a class="hash-link" aria-label="Direct link to logError(eventName, data)" title="Direct link to logError(eventName, data)" href="/api/interfaces/TelemetryLogger#logerroreventname-data"></a></h4>
<blockquote>
<p><strong>logError</strong>(<code>eventName</code>, <code>data</code>?): <code>void</code></p>
</blockquote>
<p>Log an error event.</p>
<p>After completing cleaning, telemetry setting checks, and data mix-in calls <code>TelemetrySender.sendEventData</code> to log the event. Differs from <code>logUsage</code> in that it will log the event if the telemetry setting is Error+.
Automatically supports echoing to extension telemetry output channel.</p>
<h5 class="anchor anchorWithStickyNavbar_JmGV" id="parameters">Parameters<a class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" href="/api/interfaces/TelemetryLogger#parameters"></a></h5>
<p>• <strong>eventName</strong>: <code>string</code></p>
<p>The event name to log</p>
<p>• <strong>data?</strong>: <code>Record</code>&lt;<code>string</code>, <code>any</code>&gt;</p>
<p>The data to log</p>
<h5 class="anchor anchorWithStickyNavbar_JmGV" id="returns-1">Returns<a class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" href="/api/interfaces/TelemetryLogger#returns-1"></a></h5>
<p><code>void</code></p>
<h5 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-4">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/TelemetryLogger#defined-in-4"></a></h5>
<p><a href="https://github.com/containers/podman-desktop/blob/10d471eb0d232f18c29110af8461b4f300ca281e/packages/extension-api/src/extension-api.d.ts#L4201" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:4201</a></p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="logerrorerror-data">logError(error, data)<a class="hash-link" aria-label="Direct link to logError(error, data)" title="Direct link to logError(error, data)" href="/api/interfaces/TelemetryLogger#logerrorerror-data"></a></h4>
<blockquote>
<p><strong>logError</strong>(<code>error</code>, <code>data</code>?): <code>void</code></p>
</blockquote>
<p>Log an error event.</p>
<h5 class="anchor anchorWithStickyNavbar_JmGV" id="parameters-1">Parameters<a class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" href="/api/interfaces/TelemetryLogger#parameters-1"></a></h5>
<p>• <strong>error</strong>: <code>Error</code></p>
<p>The error object which contains the stack trace cleaned of PII</p>
<p>• <strong>data?</strong>: <code>Record</code>&lt;<code>string</code>, <code>any</code>&gt;</p>
<p>Additional data to log alongside the stack trace</p>
<h5 class="anchor anchorWithStickyNavbar_JmGV" id="returns-2">Returns<a class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" href="/api/interfaces/TelemetryLogger#returns-2"></a></h5>
<p><code>void</code></p>
<h5 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-5">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/TelemetryLogger#defined-in-5"></a></h5>
<p><a href="https://github.com/containers/podman-desktop/blob/10d471eb0d232f18c29110af8461b4f300ca281e/packages/extension-api/src/extension-api.d.ts#L4209" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:4209</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="logusage">logUsage()<a class="hash-link" aria-label="Direct link to logUsage()" title="Direct link to logUsage()" href="/api/interfaces/TelemetryLogger#logusage"></a></h3>
<blockquote>
<p><strong>logUsage</strong>(<code>eventName</code>, <code>data</code>?): <code>void</code></p>
</blockquote>
<p>Log a usage event.</p>
<p>After completing cleaning, telemetry setting checks, and data mix-in calls <code>TelemetrySender.sendEventData</code> to log the event.
Automatically supports echoing to extension telemetry output channel.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="parameters-2">Parameters<a class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" href="/api/interfaces/TelemetryLogger#parameters-2"></a></h4>
<p>• <strong>eventName</strong>: <code>string</code></p>
<p>The event name to log</p>
<p>• <strong>data?</strong>: <code>Record</code>&lt;<code>string</code>, <code>any</code>&gt;</p>
<p>The data to log</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="returns-3">Returns<a class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" href="/api/interfaces/TelemetryLogger#returns-3"></a></h4>
<p><code>void</code></p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="defined-in-6">Defined in<a class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in" href="/api/interfaces/TelemetryLogger#defined-in-6"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/10d471eb0d232f18c29110af8461b4f300ca281e/packages/extension-api/src/extension-api.d.ts#L4190" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:4190</a></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/interfaces/StorageStats"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">StorageStats</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/interfaces/TelemetryLoggerOptions"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">TelemetryLoggerOptions</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_XG6w thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/TelemetryLogger#properties">Properties</a><ul><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/TelemetryLogger#iserrorsenabled">isErrorsEnabled</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/TelemetryLogger#isusageenabled">isUsageEnabled</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/TelemetryLogger#ondidchangeenablestates">onDidChangeEnableStates</a></li></ul></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/TelemetryLogger#methods">Methods</a><ul><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/TelemetryLogger#dispose">dispose()</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/TelemetryLogger#logerror">logError()</a></li><li><a class="table-of-contents__link toc-highlight" href="/api/interfaces/TelemetryLogger#logusage">logUsage()</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Documentation</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installing Podman Desktop</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/migrating-from-docker">Migrating from Docker</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/kubernetes">Working with Kubernetes</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://discord.com/invite/x5GzFF6QH4" target="_blank" rel="noopener noreferrer" class="footer__link-item">Chat (bridged): #podman-desktop on Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/containers/podman-desktop#communication" target="_blank" rel="noopener noreferrer" class="footer__link-item">Other ways to Communicate<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg><
</body>
</html>