https://mqtt2otel.org/docs/introduction/Recent content in Introduction on mqtt2otelHugoen-ushttps://mqtt2otel.org/docs/introduction/quickstart/Mon, 01 Jan 0001 00:00:00 +0000https://mqtt2otel.org/docs/introduction/quickstart/<h1 id="quick-start">Quick start<a class="anchor" href="#quick-start">#</a></h1> <h2 id="installation">Installation<a class="anchor" href="#installation">#</a></h2> <p>See <a href="../../installation">Installation</a> overview.</p> <h2 id="connect-to-the-mqtt-broker-and-otel-server">Connect to the MQTT Broker and Otel Server<a class="anchor" href="#connect-to-the-mqtt-broker-and-otel-server">#</a></h2> <p>The mapping between MQTT and Otel is configured via a file called <code>Manifest.yaml</code>. Here&rsquo;s an example of a simple configuration file that connects to an MQTT broker at <code>http://mymqtt-broker.net:32007</code> and an OpenTelemetry collector at <code>http://my-otel-collector.net:32014</code>:</p> <div class="highlight"><pre tabindex="0" style="background-color:#fff;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 1</span><span><span style="color:#2838b0">Version</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#444">1.0</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 2</span><span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 3</span><span><span style="color:#2838b0">MqttBroker</span><span style="color:#888">:</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 4</span><span><span style="color:#a89028"> </span>- <span style="color:#2838b0">Name</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#b83838">&#34;My broker&#34;</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 5</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">Endpoint</span><span style="color:#888">:</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 6</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">Port</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#444">32007</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 7</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">Address</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#b83838">&#34;mymqtt-broker.net&#34;</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 8</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">EnableTls</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#444;font-style:italic">false</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f"> 9</span><span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">10</span><span><span style="color:#2838b0">OtelServer</span><span style="color:#888">:</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">11</span><span><span style="color:#a89028"> </span>- <span style="color:#2838b0">Name</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#b83838">&#34;My Otel server&#34;</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">12</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">ServiceName</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#b83838">&#34;my-service&#34;</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">13</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">ServiceNamespace</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#b83838">&#34;my-service-namespace&#34;</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">14</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">Endpoint</span><span style="color:#888">:</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">15</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">Protocol</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#b83838">&#34;http&#34;</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">16</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">Port</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#444">32014</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">17</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">Address</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#b83838">&#34;my-otel-collector.net&#34;</span><span style="color:#a89028"> </span></span></span><span style="display:flex;"><span style="white-space:pre;-webkit-user-select:none;user-select:none;margin-right:0.4em;padding:0 0.4em 0 0.4em;color:#7f7f7f">18</span><span><span style="color:#a89028"> </span><span style="color:#2838b0">EnableTls</span><span style="color:#888">:</span><span style="color:#a89028"> </span><span style="color:#444;font-style:italic">false</span></span></span></code></pre></div><p>This assumes no credentials are required to log into the broker or the Otel collector. For further configuration options, see <a href="todo">Configure MQTT Broker</a> and <a href="todo">Configure Otel Server</a>.</p>