Google Git
Sign in
apache / pulsar-site / aee2d9089b6b8e327f04261353077211f4abd636 / . / content / docs / en / 2.8.1 / io-debug.html
blob: 5bbc386b4ce75372a8328ad7a6a420f89857d207 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>How to debug Pulsar connectors · Apache Pulsar</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="This guide explains how to debug connectors in localrun or cluster mode and gives a debugging checklist."/><meta name="docsearch:version" content="2.8.1"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="How to debug Pulsar connectors · Apache Pulsar"/><meta property="og:type" content="website"/><meta property="og:url" content="https://pulsar.apache.org/"/><meta property="og:description" content="This guide explains how to debug connectors in localrun or cluster mode and gives a debugging checklist."/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://pulsar.apache.org/img/pulsar.svg"/><link rel="shortcut icon" href="/img/pulsar.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://pulsar.apache.org/blog/atom.xml" title="Apache Pulsar Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://pulsar.apache.org/blog/feed.xml" title="Apache Pulsar Blog RSS Feed"/><link rel="stylesheet" href="/css/code-blocks-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/custom.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/pulsar.svg" alt="Apache Pulsar"/></a><a href="/en/versions"><h3>2.8.1</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/en/2.8.1/getting-started-standalone" target="_self">Docs</a></li><li class=""><a href="/en/download" target="_self">Download</a></li><li class="siteNavGroupActive"><a href="/docs/en/2.8.1/client-libraries" target="_self">Clients</a></li><li class=""><a href="#restapis" target="_self">REST APIs</a></li><li class=""><a href="#cli" target="_self">Cli</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="#community" target="_self">Community</a></li><li class=""><a href="#apache" target="_self">Apache</a></li><li class=""><a href="https://pulsar-next.staged.apache.org/" target="_self">New Website (Beta)</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>English</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/ja/2.8.1/io-debug">日本語</a></li><li><a href="/docs/fr/2.8.1/io-debug">Français</a></li><li><a href="/docs/ko/2.8.1/io-debug">한국어</a></li><li><a href="/docs/zh-CN/2.8.1/io-debug">中文</a></li><li><a href="/docs/zh-TW/2.8.1/io-debug">繁體中文</a></li><li><a href="https://crowdin.com/project/apache-pulsar" target="_blank" rel="noreferrer noopener">Help Translate</a></li></ul></div></li><script>
const languagesMenuItem = document.getElementById("languages-menu");
const languagesDropDown = document.getElementById("languages-dropdown");
languagesMenuItem.addEventListener("click", function(event) {
event.preventDefault();
if (languagesDropDown.className == "hide") {
languagesDropDown.className = "visible";
} else {
languagesDropDown.className = "hide";
}
});
</script></span></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Pulsar IO</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Get Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/getting-started-standalone">Run Pulsar locally</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/getting-started-docker">Run Pulsar in Docker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/getting-started-helm">Run Pulsar in Kubernetes</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Concepts and Architecture</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-messaging">Messaging</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-architecture-overview">Architecture</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-clients">Clients</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-replication">Geo Replication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-multi-tenancy">Multi Tenancy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-authentication">Authentication and Authorization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-topic-compaction">Topic Compaction</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-proxy-sni-routing">Proxy support with SNI routing</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/concepts-multiple-advertised-listeners">Multiple advertised listeners</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar Schema</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/schema-get-started">Get started</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/schema-understand">Understand schema</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/schema-evolution-compatibility">Schema evolution and compatibility</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/schema-manage">Manage schema</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar Functions</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/functions-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/functions-runtime">Setup: Configure Functions runtime</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/functions-worker">Setup: Pulsar Functions Worker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/functions-develop">How-to: Develop</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/functions-package">How-to: Package</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/functions-debug">How-to: Debug</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/functions-deploy">How-to: Deploy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/functions-cli">Reference: CLI</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/window-functions-context">Window Functions: Context</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar IO</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/io-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/io-quickstart">Get started</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/io-use">Use</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/en/2.8.1/io-debug">Debug</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/io-connectors">Built-in connector</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/io-cdc">CDC connector</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/io-develop">Develop</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/io-cli">CLI</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar SQL</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/sql-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/sql-getting-started">Query data</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/sql-deployment-configurations">Configuration and deployment</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/sql-rest-api">REST APIs</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Tiered Storage</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/tiered-storage-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/tiered-storage-aws">AWS S3 offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/tiered-storage-gcs">GCS offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/tiered-storage-filesystem">Filesystem offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/tiered-storage-azure">Azure BlobStore offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/tiered-storage-aliyun">Aliyun OSS offloader</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Transactions</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/txn-why">Why transactions?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/txn-what">What are transactions?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/txn-how">How transactions work?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/txn-use">How to use transactions?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/txn-monitor">How to monitor transactions?</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Kubernetes (Helm)</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/helm-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/helm-prepare">Prepare</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/helm-install">Install</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/helm-deploy">Deployment</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/helm-upgrade">Upgrade</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/helm-tools">Required Tools</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Deployment</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/deploy-aws">Amazon Web Services</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/deploy-kubernetes">Kubernetes</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/deploy-bare-metal">Bare metal</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/deploy-bare-metal-multi-cluster">Bare metal multi-cluster</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/deploy-docker">Docker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/deploy-monitoring">Monitor</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Administration</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/administration-zk-bk">ZooKeeper and BookKeeper</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/administration-geo">Geo-replication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/administration-pulsar-manager">Pulsar Manager</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/administration-stats">Pulsar statistics</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/administration-load-balance">Load balance</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/administration-proxy">Pulsar proxy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/administration-upgrade">Upgrade</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/administration-isolation">Pulsar isolation</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Security</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-tls-transport">Transport Encryption using TLS</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-tls-authentication">Authentication using TLS</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-tls-keystore">Using TLS with KeyStore configure</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-jwt">Authentication using JWT</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-athenz">Authentication using Athenz</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-kerberos">Authentication using Kerberos</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-oauth2">Authentication using OAuth 2.0 access tokens</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-authorization">Authorization and ACLs</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-encryption">End-to-End Encryption</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-extending">Extending</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/security-bouncy-castle">Bouncy Castle Providers</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Performance</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/performance-pulsar-perf">Pulsar Perf</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Client Libraries</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/client-libraries">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/client-libraries-java">Java</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/client-libraries-go">Go</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/client-libraries-python">Python</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/client-libraries-cpp">C++</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/client-libraries-node">Node.js</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/client-libraries-websocket">WebSocket</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/client-libraries-dotnet">C#</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Admin API</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/admin-api-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/admin-api-clusters">Clusters</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/admin-api-tenants">Tenants</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/admin-api-brokers">Brokers</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/admin-api-namespaces">Namespaces</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/admin-api-permissions">Permissions</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/admin-api-topics">Topics</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/admin-api-functions">Functions</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/admin-api-packages">Packages</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Adaptors</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/adaptors-kafka">Kafka client wrapper</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/adaptors-spark">Apache Spark</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/adaptors-storm">Apache Storm</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Cookbooks</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/cookbooks-compaction">Topic compaction</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/cookbooks-deduplication">Message deduplication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/cookbooks-non-persistent">Non-persistent messaging</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/cookbooks-retention-expiry">Message retention and expiry</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/cookbooks-encryption">Encryption</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/cookbooks-message-queue">Message queue</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/cookbooks-bookkeepermetadata">BookKeeper Ledger Metadata</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Development</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/develop-tools">Simulation tools</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/developing-binary-protocol">Binary protocol</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/develop-schema">Custom schema storage</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/develop-load-manager">Modular load manager</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Reference</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/reference-terminology">Terminology</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/reference-cli-tools">Pulsar CLI tools</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/reference-configuration">Pulsar configuration</a></li><li class="navListItem"><a class="navItem" href="/docs/en/2.8.1/reference-metrics">Pulsar Metrics</a></li></ul></div></div></section></div><script>
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length; j++) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings && headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/apache/pulsar/edit/master/site2/docs/io-debug.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">How to debug Pulsar connectors</h1></header><article><div><span><p>This guide explains how to debug connectors in localrun or cluster mode and gives a debugging checklist.
To better demonstrate how to debug Pulsar connectors, here takes a Mongo sink connector as an example.</p>
<p><strong>Deploy a Mongo sink environment</strong></p>
<ol>
<li>Start a Mongo service.
<pre><code class="hljs css language-bash">docker pull mongo:4
docker run -d -p 27017:27017 --name pulsar-mongo -v <span class="hljs-variable">$PWD</span>/data:/data/db mongo:4
</code></pre></li>
<li>Create a DB and a collection.
<pre><code class="hljs css language-bash">docker <span class="hljs-built_in">exec</span> -it pulsar-mongo /bin/bash
mongo
&gt; use pulsar
&gt; db.createCollection(<span class="hljs-string">'messages'</span>)
&gt; <span class="hljs-built_in">exit</span>
</code></pre></li>
<li>Start Pulsar standalone.
<pre><code class="hljs css language-bash">docker pull apachepulsar/pulsar:2.4.0
docker run -d -it -p 6650:6650 -p 8080:8080 -v <span class="hljs-variable">$PWD</span>/data:/pulsar/data --link pulsar-mongo --name pulsar-mongo-standalone apachepulsar/pulsar:2.4.0 bin/pulsar standalone
</code></pre></li>
<li>Configure the Mongo sink with the <code>mongo-sink-config.yaml</code> file.
<pre><code class="hljs css language-bash">configs:
mongoUri: <span class="hljs-string">"mongodb://pulsar-mongo:27017"</span>
database: <span class="hljs-string">"pulsar"</span>
collection: <span class="hljs-string">"messages"</span>
batchSize: 2
batchTimeMs: 500
</code></pre>
<pre><code class="hljs css language-bash">docker cp mongo-sink-config.yaml pulsar-mongo-standalone:/pulsar/
</code></pre></li>
<li>Download the Mongo sink nar package.
<pre><code class="hljs css language-bash">docker <span class="hljs-built_in">exec</span> -it pulsar-mongo-standalone /bin/bash
curl -O http://apache.01link.hk/pulsar/pulsar-2.4.0/connectors/pulsar-io-mongo-2.4.0.nar
</code></pre></li>
</ol>
<h2><a class="anchor" aria-hidden="true" id="debug-in-localrun-mode"></a><a href="#debug-in-localrun-mode" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Debug in localrun mode</h2>
<p>Start the Mongo sink in localrun mode using the <code>localrun</code> command.</p>
<blockquote>
<h4><a class="anchor" aria-hidden="true" id="tip"></a><a href="#tip" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Tip</h4>
<p>For more information about the <code>localrun</code> command, see <a href="/docs/en/2.8.1/reference-connector-admin/#localrun-1"><code>localrun</code></a>.</p>
</blockquote>
<pre><code class="hljs css language-bash">./bin/pulsar-admin sinks localrun \
--archive pulsar-io-mongo-2.4.0.nar \
--tenant public --namespace default \
--inputs <span class="hljs-built_in">test</span>-mongo \
--name pulsar-mongo-sink \
--sink-config-file mongo-sink-config.yaml \
--parallelism 1
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="use-connector-log"></a><a href="#use-connector-log" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Use connector log</h3>
<p>Use one of the following methods to get a connector log in localrun mode:</p>
<ul>
<li><p>After executing the <code>localrun</code> command, the <strong>log is automatically printed on the console</strong>.</p></li>
<li><p>The log is located at:</p>
<pre><code class="hljs css language-bash">logs/<span class="hljs-built_in">functions</span>/tenant/namespace/<span class="hljs-keyword">function</span>-name/<span class="hljs-keyword">function</span>-name-instance-id.log
</code></pre>
<p><strong>Example</strong></p>
<p>The path of the Mongo sink connector is:</p>
<pre><code class="hljs css language-bash">logs/<span class="hljs-built_in">functions</span>/public/default/pulsar-mongo-sink/pulsar-mongo-sink-0.log
</code></pre></li>
</ul>
<p>To clearly explain the log information, here breaks down the large block of information into small blocks and add descriptions for each block.</p>
<ul>
<li>This piece of log information shows the storage path of the nar package after decompression.
<pre><code class="hljs"><span class="hljs-number">08</span>:<span class="hljs-number">21</span>:<span class="hljs-number">54.132</span> [main] <span class="hljs-type">INFO</span> org.apache.pulsar.common.nar.<span class="hljs-type">NarClassLoader</span> - <span class="hljs-type">Created</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">loader</span> <span class="hljs-keyword">with</span> <span class="hljs-title">paths</span></span>: [file:/tmp/pulsar-nar/pulsar-io-mongo<span class="hljs-number">-2.4</span><span class="hljs-number">.0</span>.nar-unpacked/, file:/tmp/pulsar-nar/pulsar-io-mongo<span class="hljs-number">-2.4</span><span class="hljs-number">.0</span>.nar-unpacked/<span class="hljs-type">META</span>-<span class="hljs-type">INF</span>/bundled-dependencies/,
</code></pre>
<blockquote>
<h4><a class="anchor" aria-hidden="true" id="tip-1"></a><a href="#tip-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Tip</h4>
<p>If <code>class cannot be found</code> exception is thrown, check whether the nar file is decompressed in the folder <code>file:/tmp/pulsar-nar/pulsar-io-mongo-2.4.0.nar-unpacked/META-INF/bundled-dependencies/</code> or not.</p>
</blockquote></li>
<li>This piece of log information illustrates the basic information about the Mongo sink connector, such as tenant, namespace, name, parallelism, resources, and so on, which can be used to <strong>check whether the Mongo sink connector is configured correctly or not</strong>.
<pre><code class="hljs css language-bash">08:21:55.390 [main] INFO org.apache.pulsar.functions.runtime.ThreadRuntime - ThreadContainer starting <span class="hljs-keyword">function</span> with instance config InstanceConfig(instanceId=0, functionId=853d60a1-0c48-44d5-9a5c-6917386476b2, functionVersion=c2ce1458-b69e-4175-88c0-a0a856a2be8c, functionDetails=tenant: <span class="hljs-string">"public"</span>
namespace: <span class="hljs-string">"default"</span>
name: <span class="hljs-string">"pulsar-mongo-sink"</span>
className: <span class="hljs-string">"org.apache.pulsar.functions.api.utils.IdentityFunction"</span>
autoAck: <span class="hljs-literal">true</span>
parallelism: 1
<span class="hljs-built_in">source</span> {
typeClassName: <span class="hljs-string">"[B"</span>
inputSpecs {
key: <span class="hljs-string">"test-mongo"</span>
value {
}
}
cleanupSubscription: <span class="hljs-literal">true</span>
}
sink {
className: <span class="hljs-string">"org.apache.pulsar.io.mongodb.MongoSink"</span>
configs: <span class="hljs-string">"{\"mongoUri\":\"mongodb://pulsar-mongo:27017\",\"database\":\"pulsar\",\"collection\":\"messages\",\"batchSize\":2,\"batchTimeMs\":500}"</span>
typeClassName: <span class="hljs-string">"[B"</span>
}
resources {
cpu: 1.0
ram: 1073741824
disk: 10737418240
}
componentType: SINK
, maxBufferedTuples=1024, functionAuthenticationSpec=null, port=38459, clusterName=<span class="hljs-built_in">local</span>)
</code></pre></li>
<li>This piece of log information demonstrates the status of the connections to Mongo and configuration information.
<pre><code class="hljs css language-bash">08:21:56.231 [cluster-ClusterId{value=<span class="hljs-string">'5d6396a3c9e77c0569ff00eb'</span>, description=<span class="hljs-string">'null'</span>}-pulsar-mongo:27017] INFO org.mongodb.driver.connection - Opened connection [connectionId{localValue:1, serverValue:8}] to pulsar-mongo:27017
08:21:56.326 [cluster-ClusterId{value=<span class="hljs-string">'5d6396a3c9e77c0569ff00eb'</span>, description=<span class="hljs-string">'null'</span>}-pulsar-mongo:27017] INFO org.mongodb.driver.cluster - Monitor thread successfully connected to server with description ServerDescription{address=pulsar-mongo:27017, <span class="hljs-built_in">type</span>=STANDALONE, state=CONNECTED, ok=<span class="hljs-literal">true</span>, version=ServerVersion{versionList=[4, 2, 0]}, minWireVersion=0, maxWireVersion=8, maxDocumentSize=16777216, logicalSessionTimeoutMinutes=30, roundTripTimeNanos=89058800}
</code></pre></li>
<li>This piece of log information explains the configuration of consumers and clients, including the topic name, subscription name, subscription type, and so on.
<pre><code class="hljs css language-bash">08:21:56.719 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.ConsumerStatsRecorderImpl - Starting Pulsar consumer status recorder with config: {
<span class="hljs-string">"topicNames"</span> : [ <span class="hljs-string">"test-mongo"</span> ],
<span class="hljs-string">"topicsPattern"</span> : null,
<span class="hljs-string">"subscriptionName"</span> : <span class="hljs-string">"public/default/pulsar-mongo-sink"</span>,
<span class="hljs-string">"subscriptionType"</span> : <span class="hljs-string">"Shared"</span>,
<span class="hljs-string">"receiverQueueSize"</span> : 1000,
<span class="hljs-string">"acknowledgementsGroupTimeMicros"</span> : 100000,
<span class="hljs-string">"negativeAckRedeliveryDelayMicros"</span> : 60000000,
<span class="hljs-string">"maxTotalReceiverQueueSizeAcrossPartitions"</span> : 50000,
<span class="hljs-string">"consumerName"</span> : null,
<span class="hljs-string">"ackTimeoutMillis"</span> : 0,
<span class="hljs-string">"tickDurationMillis"</span> : 1000,
<span class="hljs-string">"priorityLevel"</span> : 0,
<span class="hljs-string">"cryptoFailureAction"</span> : <span class="hljs-string">"CONSUME"</span>,
<span class="hljs-string">"properties"</span> : {
<span class="hljs-string">"application"</span> : <span class="hljs-string">"pulsar-sink"</span>,
<span class="hljs-string">"id"</span> : <span class="hljs-string">"public/default/pulsar-mongo-sink"</span>,
<span class="hljs-string">"instance_id"</span> : <span class="hljs-string">"0"</span>
},
<span class="hljs-string">"readCompacted"</span> : <span class="hljs-literal">false</span>,
<span class="hljs-string">"subscriptionInitialPosition"</span> : <span class="hljs-string">"Latest"</span>,
<span class="hljs-string">"patternAutoDiscoveryPeriod"</span> : 1,
<span class="hljs-string">"regexSubscriptionMode"</span> : <span class="hljs-string">"PersistentOnly"</span>,
<span class="hljs-string">"deadLetterPolicy"</span> : null,
<span class="hljs-string">"autoUpdatePartitions"</span> : <span class="hljs-literal">true</span>,
<span class="hljs-string">"replicateSubscriptionState"</span> : <span class="hljs-literal">false</span>,
<span class="hljs-string">"resetIncludeHead"</span> : <span class="hljs-literal">false</span>
}
08:21:56.726 [pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.ConsumerStatsRecorderImpl - Pulsar client config: {
<span class="hljs-string">"serviceUrl"</span> : <span class="hljs-string">"pulsar://localhost:6650"</span>,
<span class="hljs-string">"authPluginClassName"</span> : null,
<span class="hljs-string">"authParams"</span> : null,
<span class="hljs-string">"operationTimeoutMs"</span> : 30000,
<span class="hljs-string">"statsIntervalSeconds"</span> : 60,
<span class="hljs-string">"numIoThreads"</span> : 1,
<span class="hljs-string">"numListenerThreads"</span> : 1,
<span class="hljs-string">"connectionsPerBroker"</span> : 1,
<span class="hljs-string">"useTcpNoDelay"</span> : <span class="hljs-literal">true</span>,
<span class="hljs-string">"useTls"</span> : <span class="hljs-literal">false</span>,
<span class="hljs-string">"tlsTrustCertsFilePath"</span> : null,
<span class="hljs-string">"tlsAllowInsecureConnection"</span> : <span class="hljs-literal">false</span>,
<span class="hljs-string">"tlsHostnameVerificationEnable"</span> : <span class="hljs-literal">false</span>,
<span class="hljs-string">"concurrentLookupRequest"</span> : 5000,
<span class="hljs-string">"maxLookupRequest"</span> : 50000,
<span class="hljs-string">"maxNumberOfRejectedRequestPerConnection"</span> : 50,
<span class="hljs-string">"keepAliveIntervalSeconds"</span> : 30,
<span class="hljs-string">"connectionTimeoutMs"</span> : 10000,
<span class="hljs-string">"requestTimeoutMs"</span> : 60000,
<span class="hljs-string">"defaultBackoffIntervalNanos"</span> : 100000000,
<span class="hljs-string">"maxBackoffIntervalNanos"</span> : 30000000000
}
</code></pre></li>
</ul>
<h2><a class="anchor" aria-hidden="true" id="debug-in-cluster-mode"></a><a href="#debug-in-cluster-mode" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Debug in cluster mode</h2>
<p>You can use the following methods to debug a connector in cluster mode:</p>
<ul>
<li><a href="#use-connector-log">Use connector log</a></li>
<li><a href="#use-admin-cli">Use admin CLI</a></li>
</ul>
<h3><a class="anchor" aria-hidden="true" id="use-connector-log-1"></a><a href="#use-connector-log-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Use connector log</h3>
<p>In cluster mode, multiple connectors can run on a worker. To find the log path of a specified connector, use the <code>workerId</code> to locate the connector log.</p>
<h3><a class="anchor" aria-hidden="true" id="use-admin-cli"></a><a href="#use-admin-cli" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Use admin CLI</h3>
<p>Pulsar admin CLI helps you debug Pulsar connectors with the following subcommands:</p>
<ul>
<li><p><a href="#get"><code>get</code></a></p></li>
<li><p><a href="#status"><code>status</code></a></p></li>
<li><p><a href="#topics-stats"><code>topics stats</code></a></p></li>
</ul>
<p><strong>Create a Mongo sink</strong></p>
<pre><code class="hljs css language-bash">./bin/pulsar-admin sinks create \
--archive pulsar-io-mongo-2.4.0.nar \
--tenant public \
--namespace default \
--inputs <span class="hljs-built_in">test</span>-mongo \
--name pulsar-mongo-sink \
--sink-config-file mongo-sink-config.yaml \
--parallelism 1
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="get"></a><a href="#get" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get</code></h3>
<p>Use the <code>get</code> command to get the basic information about the Mongo sink connector, such as tenant, namespace, name, parallelism, and so on.</p>
<pre><code class="hljs css language-bash">./bin/pulsar-admin sinks get --tenant public --namespace default --name pulsar-mongo-sink
{
<span class="hljs-string">"tenant"</span>: <span class="hljs-string">"public"</span>,
<span class="hljs-string">"namespace"</span>: <span class="hljs-string">"default"</span>,
<span class="hljs-string">"name"</span>: <span class="hljs-string">"pulsar-mongo-sink"</span>,
<span class="hljs-string">"className"</span>: <span class="hljs-string">"org.apache.pulsar.io.mongodb.MongoSink"</span>,
<span class="hljs-string">"inputSpecs"</span>: {
<span class="hljs-string">"test-mongo"</span>: {
<span class="hljs-string">"isRegexPattern"</span>: <span class="hljs-literal">false</span>
}
},
<span class="hljs-string">"configs"</span>: {
<span class="hljs-string">"mongoUri"</span>: <span class="hljs-string">"mongodb://pulsar-mongo:27017"</span>,
<span class="hljs-string">"database"</span>: <span class="hljs-string">"pulsar"</span>,
<span class="hljs-string">"collection"</span>: <span class="hljs-string">"messages"</span>,
<span class="hljs-string">"batchSize"</span>: 2.0,
<span class="hljs-string">"batchTimeMs"</span>: 500.0
},
<span class="hljs-string">"parallelism"</span>: 1,
<span class="hljs-string">"processingGuarantees"</span>: <span class="hljs-string">"ATLEAST_ONCE"</span>,
<span class="hljs-string">"retainOrdering"</span>: <span class="hljs-literal">false</span>,
<span class="hljs-string">"autoAck"</span>: <span class="hljs-literal">true</span>
}
</code></pre>
<blockquote>
<h4><a class="anchor" aria-hidden="true" id="tip-2"></a><a href="#tip-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Tip</h4>
<p>For more information about the <code>get</code> command, see <a href="/docs/en/2.8.1/reference-connector-admin/#get-1"><code>get</code></a>.</p>
</blockquote>
<h3><a class="anchor" aria-hidden="true" id="status"></a><a href="#status" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>status</code></h3>
<p>Use the <code>status</code> command to get the current status about the Mongo sink connector, such as the number of instance, the number of running instance, instanceId, workerId and so on.</p>
<pre><code class="hljs css language-bash">./bin/pulsar-admin sinks status
--tenant public \
--namespace default \
--name pulsar-mongo-sink
{
<span class="hljs-string">"numInstances"</span> : 1,
<span class="hljs-string">"numRunning"</span> : 1,
<span class="hljs-string">"instances"</span> : [ {
<span class="hljs-string">"instanceId"</span> : 0,
<span class="hljs-string">"status"</span> : {
<span class="hljs-string">"running"</span> : <span class="hljs-literal">true</span>,
<span class="hljs-string">"error"</span> : <span class="hljs-string">""</span>,
<span class="hljs-string">"numRestarts"</span> : 0,
<span class="hljs-string">"numReadFromPulsar"</span> : 0,
<span class="hljs-string">"numSystemExceptions"</span> : 0,
<span class="hljs-string">"latestSystemExceptions"</span> : [ ],
<span class="hljs-string">"numSinkExceptions"</span> : 0,
<span class="hljs-string">"latestSinkExceptions"</span> : [ ],
<span class="hljs-string">"numWrittenToSink"</span> : 0,
<span class="hljs-string">"lastReceivedTime"</span> : 0,
<span class="hljs-string">"workerId"</span> : <span class="hljs-string">"c-standalone-fw-5d202832fd18-8080"</span>
}
} ]
}
</code></pre>
<blockquote>
<h4><a class="anchor" aria-hidden="true" id="tip-3"></a><a href="#tip-3" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Tip</h4>
<p>For more information about the <code>status</code> command, see <a href="/docs/en/2.8.1/reference-connector-admin/#stauts-1"><code>status</code></a>.</p>
<p>If there are multiple connectors running on a worker, <code>workerId</code> can locate the worker on which the specified connector is running.</p>
</blockquote>
<h3><a class="anchor" aria-hidden="true" id="topics-stats"></a><a href="#topics-stats" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>topics stats</code></h3>
<p>Use the <code>topics stats</code> command to get the stats for a topic and its connected producer and consumer, such as whether the topic has received messages or not, whether there is a backlog of messages or not, the available permits and other key information. All rates are computed over a 1-minute window and are relative to the last completed 1-minute period.</p>
<pre><code class="hljs css language-bash">./bin/pulsar-admin topics stats <span class="hljs-built_in">test</span>-mongo
{
<span class="hljs-string">"msgRateIn"</span> : 0.0,
<span class="hljs-string">"msgThroughputIn"</span> : 0.0,
<span class="hljs-string">"msgRateOut"</span> : 0.0,
<span class="hljs-string">"msgThroughputOut"</span> : 0.0,
<span class="hljs-string">"averageMsgSize"</span> : 0.0,
<span class="hljs-string">"storageSize"</span> : 1,
<span class="hljs-string">"publishers"</span> : [ ],
<span class="hljs-string">"subscriptions"</span> : {
<span class="hljs-string">"public/default/pulsar-mongo-sink"</span> : {
<span class="hljs-string">"msgRateOut"</span> : 0.0,
<span class="hljs-string">"msgThroughputOut"</span> : 0.0,
<span class="hljs-string">"msgRateRedeliver"</span> : 0.0,
<span class="hljs-string">"msgBacklog"</span> : 0,
<span class="hljs-string">"blockedSubscriptionOnUnackedMsgs"</span> : <span class="hljs-literal">false</span>,
<span class="hljs-string">"msgDelayed"</span> : 0,
<span class="hljs-string">"unackedMessages"</span> : 0,
<span class="hljs-string">"type"</span> : <span class="hljs-string">"Shared"</span>,
<span class="hljs-string">"msgRateExpired"</span> : 0.0,
<span class="hljs-string">"consumers"</span> : [ {
<span class="hljs-string">"msgRateOut"</span> : 0.0,
<span class="hljs-string">"msgThroughputOut"</span> : 0.0,
<span class="hljs-string">"msgRateRedeliver"</span> : 0.0,
<span class="hljs-string">"consumerName"</span> : <span class="hljs-string">"dffdd"</span>,
<span class="hljs-string">"availablePermits"</span> : 999,
<span class="hljs-string">"unackedMessages"</span> : 0,
<span class="hljs-string">"blockedConsumerOnUnackedMsgs"</span> : <span class="hljs-literal">false</span>,
<span class="hljs-string">"metadata"</span> : {
<span class="hljs-string">"instance_id"</span> : <span class="hljs-string">"0"</span>,
<span class="hljs-string">"application"</span> : <span class="hljs-string">"pulsar-sink"</span>,
<span class="hljs-string">"id"</span> : <span class="hljs-string">"public/default/pulsar-mongo-sink"</span>
},
<span class="hljs-string">"connectedSince"</span> : <span class="hljs-string">"2019-08-26T08:48:07.582Z"</span>,
<span class="hljs-string">"clientVersion"</span> : <span class="hljs-string">"2.4.0"</span>,
<span class="hljs-string">"address"</span> : <span class="hljs-string">"/172.17.0.3:57790"</span>
} ],
<span class="hljs-string">"isReplicated"</span> : <span class="hljs-literal">false</span>
}
},
<span class="hljs-string">"replication"</span> : { },
<span class="hljs-string">"deduplicationStatus"</span> : <span class="hljs-string">"Disabled"</span>
}
</code></pre>
<blockquote>
<h4><a class="anchor" aria-hidden="true" id="tip-4"></a><a href="#tip-4" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Tip</h4>
<p>For more information about the <code>topic stats</code> command, see <a href="http://pulsar.apache.org/docs/en/pulsar-admin/#stats-1"><code>topic stats</code></a>.</p>
</blockquote>
<h2><a class="anchor" aria-hidden="true" id="checklist"></a><a href="#checklist" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Checklist</h2>
<p>This checklist indicates the major areas to check when you debug connectors. It is a reminder of what to look for to ensure a thorough review and an evaluation tool to get the status of connectors.</p>
<ul>
<li><p>Does Pulsar start successfully?</p></li>
<li><p>Does the external service run normally?</p></li>
<li><p>Is the nar package complete?</p></li>
<li><p>Is the connector configuration file correct?</p></li>
<li><p>In localrun mode, run a connector and check the printed information (connector log) on the console.</p></li>
<li><p>In cluster mode：</p>
<ul>
<li><p>Use the <code>get</code> command to get the basic information.</p></li>
<li><p>Use the <code>status</code> command to get the current status.</p></li>
<li><p>Use the <code>topics stats</code> command to get the stats for a specified topic and its connected producers and consumers.</p></li>
<li><p>Check the connector log.</p></li>
</ul></li>
<li><p>Enter into the external system and verify the result.</p></li>
</ul>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/2.8.1/io-use"><span class="arrow-prev">← </span><span>Use</span></a><a class="docs-next button" href="/docs/en/2.8.1/io-connectors"><span>Built-in connector</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#debug-in-localrun-mode">Debug in localrun mode</a><ul class="toc-headings"><li><a href="#use-connector-log">Use connector log</a></li></ul></li><li><a href="#debug-in-cluster-mode">Debug in cluster mode</a><ul class="toc-headings"><li><a href="#use-connector-log-1">Use connector log</a></li><li><a href="#use-admin-cli">Use admin CLI</a></li><li><a href="#get"><code>get</code></a></li><li><a href="#status"><code>status</code></a></li><li><a href="#topics-stats"><code>topics stats</code></a></li></ul></li><li><a href="#checklist">Checklist</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2022 The Apache Software Foundation. All Rights Reserved. Apache, Apache Pulsar and the Apache feather logo are trademarks of The Apache Software Foundation.</section><span><script>
const community = document.querySelector("a[href='#community']").parentNode;
const communityMenu =
'<li>' +
'<a id="community-menu" href="#">Community <span style="font-size: 0.75em">&nbsp;▼</span></a>' +
'<div id="community-dropdown" class="hide">' +
'<ul id="community-dropdown-items">' +
'<li><a href="/en/contact">Contact</a></li>' +
'<li><a href="/en/contributing">Contributing</a></li>' +
'<li><a href="/en/coding-guide">Coding guide</a></li>' +
'<li><a href="/en/events">Events</a></li>' +
'<li><a href="https://twitter.com/Apache_Pulsar" target="_blank">Twitter &#x2750</a></li>' +
'<li><a href="https://github.com/apache/pulsar/wiki" target="_blank">Wiki &#x2750</a></li>' +
'<li><a href="https://github.com/apache/pulsar/issues" target="_blank">Issue tracking &#x2750</a></li>' +
'<li><a href="https://pulsar-summit.org/" target="_blank">Pulsar Summit &#x2750</a></li>' +
'<li>&nbsp;</li>' +
'<li><a href="/en/resources">Resources</a></li>' +
'<li><a href="/en/team">Team</a></li>' +
'<li><a href="/en/powered-by">Powered By</a></li>' +
'</ul>' +
'</div>' +
'</li>';
community.innerHTML = communityMenu;
const communityMenuItem = document.getElementById("community-menu");
const communityDropDown = document.getElementById("community-dropdown");
communityMenuItem.addEventListener("click", function(event) {
event.preventDefault();
if (communityDropDown.className == 'hide') {
communityDropDown.className = 'visible';
} else {
communityDropDown.className = 'hide';
}
});
</script></span></footer></div><script>window.twttr=(function(d,s, id){var js,fjs=d.getElementsByTagName(s)[0],t=window.twttr||{};if(d.getElementById(id))return t;js=d.createElement(s);js.id=id;js.src='https://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js, fjs);t._e = [];t.ready = function(f) {t._e.push(f);};return t;}(document, 'script', 'twitter-wjs'));</script></body></html>