PageSourceSearch

https://docs.streamdal.com/en/guides/instrumentation/

html streamdal.com collected 2026-09-25 20:16:42 UTC 71,436 bytes, 405 lines download raw bytes

1<!DOCTYPE html>
2<html dir="ltr" lang="en-us" class="initial astro-OUAMJN2I">
3  <head>
4    <!-- Global Metadata --><meta charset="utf-8">
5<meta name="viewport" content="width=device-width">
6<meta name="generator" content="Astro v2.2.3">
7
8<link rel="icon" type="image/svg+xml" sizes="32x32" href="/favicon-dark.svg" media="(prefers-color-scheme: dark)">
9<link rel="icon" type="image/svg+xml" sizes="32x32" href="/favicon-light.svg" media="(prefers-color-scheme: light)">
10
11<link rel="sitemap" href="/sitemap.xml">
12
13<!-- Preload Fonts -->
14
15
16<style type="text/css">@font-face {font-family:'IBM Plex Mono';font-style:normal;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/latin/400/normal.woff2);unicode-range:U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD;font-display:swap;}@font-face {font-family:'IBM Plex Mono';font-style:normal;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/latin-ext/400/normal.woff2);unicode-range:U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF;font-display:swap;}@font-face {font-family:'IBM Plex Mono';font-style:normal;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/cyrillic-ext/400/normal.woff2);unicode-range:U+0460-052F,U+1C80-1C8A,U+20B4,U+2DE0-2DFF,U+A640-A69F,U+FE2E-FE2F;font-display:swap;}@font-face {font-family:'IBM Plex Mono';font-style:normal;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/vietnamese/400/normal.woff2);unicode-range:U+0102-0103,U+0110-0111,U+0128-0129,U+0168-0169,U+01A0-01A1,U+01AF-01B0,U+0300-0301,U+0303-0304,U+0308-0309,U+0323,U+0329,U+1EA0-1EF9,U+20AB;font-display:swap;}@font-face {font-family:'IBM Plex Mono';font-style:normal;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/cyrillic/400/normal.woff2);unicode-range:U+0301,U+0400-045F,U+0490-0491,U+04B0-04B1,U+2116;font-display:swap;}@font-face {font-family:'IBM Plex Mono';font-style:italic;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/cyrillic/400/italic.woff2);unicode-range:U+0301,U+0400-045F,U+0490-0491,U+04B0-04B1,U+2116;font-display:swap;}@font-face {font-family:'IBM Plex Mono';font-style:italic;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/latin-ext/400/italic.woff2);unicode-range:U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF;font-display:swap;}@font-face {font-family:'IBM Plex Mono';font-style:italic;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/vietnamese/400/italic.woff2);unicode-range:U+0102-0103,U+0110-0111,U+0128-0129,U+0168-0169,U+01A0-01A1,U+01AF-01B0,U+0300-0301,U+0303-0304,U+0308-0309,U+0323,U+0329,U+1EA0-1EF9,U+20AB;font-display:swap;}@font-face {font-family:'IBM Plex Mono';font-style:italic;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/cyrillic-ext/400/italic.woff2);unicode-range:U+0460-052F,U+1C80-1C8A,U+20B4,U+2DE0-2DFF,U+A640-A69F,U+FE2E-FE2F;font-display:swap;}@font-face {font-family:'IBM Plex Mono';font-style:italic;font-weight:400;src:url(/cf-fonts/s/ibm-plex-mono/5.2.7/latin/400/italic.woff2);unicode-range:U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD;font-display:swap;}</style>
17
18<!-- Scrollable a11y code helper -->
19<script src="/make-scrollable-code-focusable.js" type="95dbc2103aee66d9a880ee38-text/javascript"></script>
19
20
21<!-- This is intentionally inlined to avoid FOUC -->
22<script type="95dbc2103aee66d9a880ee38-text/javascript">
23  const root = document.documentElement;
24  const theme = localStorage.getItem("theme");
25  if (
26    theme === "dark" ||
27    (!theme && window.matchMedia("(prefers-color-scheme: dark)").matches)
28  ) {
29    root.classList.add("theme-dark");
30  } else {
31    root.classList.remove("theme-dark");
32  }
33</script>
33
34
35<!-- Google Tag Manager -->
36
37<!-- End Google Tag Manager -->
38    <!-- Page Metadata --><link rel="canonical" href="https://docs.streamdal.com/en/guides/instrumentation/">
39
40<!-- OpenGraph Tags -->
41<meta property="og:title" content="Instrumentation Guide 🚀 Streamdal Documentation">
42<meta property="og:type" content="article">
43<meta property="og:url" content="https://docs.streamdal.com/en/guides/instrumentation/">
44<meta property="og:locale" content="en_US">
45<meta property="og:image" content="https://github.com/withastro/astro/blob/main/assets/social/banner.jpg?raw=true">
46<meta property="og:image:alt" content="astro logo on a starry expanse of space, with a purple saturn-like planet floating in the right foreground">
47<meta name="description" property="og:description" content="Step-by-step instructions on integrating and instrumenting your code using the Streamdal SDK for a seamless data experience.">
48<meta property="og:site_name" content="Streamdal Documentation">
49
50<!-- Twitter Tags -->
51<meta name="twitter:card" content="summary_large_image">
52<meta name="twitter:site" content="astrodotbuild">
53<meta name="twitter:title" content="Instrumentation Guide 🚀 Streamdal Documentation">
54<meta name="twitter:description" content="Step-by-step instructions on integrating and instrumenting your code using the Streamdal SDK for a seamless data experience.">
55<meta name="twitter:image" content="https://github.com/withastro/astro/blob/main/assets/social/banner.jpg?raw=true">
56<meta name="twitter:image:alt" content="astro logo on a starry expanse of space, with a purple saturn-like planet floating in the right foreground">
57
58<!--
59  TODO: Add json+ld data, maybe https://schema.org/APIReference makes sense?
60  Docs: https://developers.google.com/search/docs/advanced/structured-data/intro-structured-data
61  https://www.npmjs.com/package/schema-dts seems like a great resource for implementing this.
62  Even better, there's a React component that integrates with `schema-dts`: https://github.com/google/react-schemaorg
63-->
64    <title>
65      Instrumenting Your Code with the Streamdal SDK | Streamdal Documentation
66    </title>
67  <link rel="stylesheet" href="/_astro/404.f0ec2e4d.css" />
68<link rel="stylesheet" href="/_astro/components.18f5cc91.css" />
69<link rel="stylesheet" href="/_astro/components.3eb4017f.css" />
70<link rel="stylesheet" href="/_astro/404.43279ec5.css" />
70<script type="95dbc2103aee66d9a880ee38-module" src="/_astro/hoisted.6d45a0e8.js"></script>
70</head>
71
72  <body class="bg-purple-background-light astro-OUAMJN2I">
73    <header class="bg-purple-background-light astro-2W66RQV5">
74  <a href="#article" class="sr-only focus:not-sr-only skiplink astro-DMGOOZ7Y"><span class="astro-DMGOOZ7Y">Skip to Content</span></a>
75  <nav class="nav-wrapper astro-2W66RQV5" title="Top Navigation">
76    <div class="menu-toggle astro-2W66RQV5">
77      <style>astro-island,astro-slot{display:contents}</style>
77<script type="95dbc2103aee66d9a880ee38-text/javascript">(self.Astro=self.Astro||{}).idle=t=>{const e=async()=>{await(await t())()};"requestIdleCallback"in window?window.requestIdleCallback(e):setTimeout(e,200)},window.dispatchEvent(new Event("astro:idle"));var l;{const c={0:t=>t,1:t=>JSON.parse(t,o),2:t=>new RegExp(t),3:t=>new Date(t),4:t=>new Map(JSON.parse(t,o)),5:t=>new Set(JSON.parse(t,o)),6:t=>BigInt(t),7:t=>new URL(t),8:t=>new Uint8Array(JSON.parse(t)),9:t=>new Uint16Array(JSON.parse(t)),10:t=>new Uint32Array(JSON.parse(t))},o=(t,s)=>{if(t===""||!Array.isArray(s))return s;const[e,n]=s;return e in c?c[e](n):void 0};customElements.get("astro-island")||customElements.define("astro-island",(l=class extends HTMLElement{constructor(){super(...arguments);this.hydrate=()=>{if(!this.hydrator||this.parentElement&&this.parentElement.closest("astro-island[ssr]"))return;const s=this.querySelectorAll("astro-slot"),e={},n=this.querySelectorAll("template[data-astro-template]");for(const r of n){const i=r.closest(this.tagName);!i||!i.isSameNode(this)||(e[r.getAttribute("data-astro-template")||"default"]=r.innerHTML,r.remove())}for(const r of s){const i=r.closest(this.tagName);!i||!i.isSameNode(this)||(e[r.getAttribute("name")||"default"]=r.innerHTML)}const a=this.hasAttribute("props")?JSON.parse(this.getAttribute("props"),o):{};this.hydrator(this)(this.Component,a,e,{client:this.getAttribute("client")}),this.removeAttribute("ssr"),window.removeEventListener("astro:hydrate",this.hydrate),window.dispatchEvent(new CustomEvent("astro:hydrate"))}}connectedCallback(){!this.hasAttribute("await-children")||this.firstChild?this.childrenConnectedCallback():new MutationObserver((s,e)=>{e.disconnect(),this.childrenConnectedCallback()}).observe(this,{childList:!0})}async childrenConnectedCallback(){window.addEventListener("astro:hydrate",this.hydrate);let s=this.getAttribute("before-hydration-url");s&&await import(s),this.start()}start(){const s=JSON.parse(this.getAttribute("opts")),e=this.getAttribute("client");if(Astro[e]===void 0){window.addEventListener(`astro:${e}`,()=>this.start(),{once:!0});return}Astro[e](async()=>{const n=this.getAttribute("renderer-url"),[a,{default:r}]=await Promise.all([import(this.getAttribute("component-url")),n?import(n):()=>()=>{}]),i=this.getAttribute("component-export")||"default";if(!i.includes("."))this.Component=a[i];else{this.Component=a;for(const d of i.split("."))this.Component=this.Component[d]}return this.hydrator=r,this.hydrate},s,this)}attributeChangedCallback(){this.hydrator&&this.hydrate()}},l.observedAttributes=["props"],l))}</script>
77<astro-island uid="1W3YGn" component-url="/_astro/SidebarToggle.415edc66.js" component-export="default" renderer-url="/_astro/client.7a4f1478.js" props="{&quot;class&quot;:[0,&quot;astro-2W66RQV5&quot;]}" ssr="" client="idle" opts="{&quot;name&quot;:&quot;SidebarToggle&quot;,&quot;value&quot;:true}" await-children=""><button type="button" aria-pressed="false" id="menu-toggle" style="background-color: transparent; padding: 0px; border: none;" class="hamburger "><span class="bar"></span><span class="sr-only">Toggle sidebar</span></button></astro-island>
78    </div>
79    <div class="logo flex astro-2W66RQV5">
80      <a href="/" class="astro-2W66RQV5">
81        <svg id="lg-header-logo" height="50" viewBox="0 -10 200 50" fill="none" xmlns="http://www.w3.org/2000/svg" class="lg-logo astro-3FGDBQYQ">
82<title>Streamdal Logo</title>
83<path d="M52.1297 24.6173C51.081 24.6173 50.0783 24.5253 49.1216 24.3413C48.1833 24.1573 47.3461 23.8814 46.6102 23.5134C45.8927 23.1454 45.3223 22.6855 44.8991 22.1335C44.4944 21.5632 44.292 20.9008 44.292 20.1465C44.292 20.0545 44.292 19.9717 44.292 19.8981C44.3104 19.8245 44.3288 19.7601 44.3472 19.7049H48.5696C48.5696 19.7417 48.5604 19.7877 48.542 19.8429C48.542 19.8797 48.542 19.9165 48.542 19.9533C48.5604 20.3949 48.7352 20.7536 49.0664 21.0296C49.416 21.2872 49.8667 21.4804 50.4187 21.6092C50.9706 21.7195 51.5594 21.7747 52.1849 21.7747C52.7737 21.7747 53.344 21.7379 53.896 21.6644C54.4663 21.5724 54.9355 21.4252 55.3035 21.2228C55.6714 21.002 55.8554 20.6892 55.8554 20.2845C55.8554 19.8245 55.6346 19.4933 55.1931 19.291C54.7515 19.0886 54.1444 18.9322 53.3716 18.8218C52.5989 18.693 51.6974 18.5458 50.6671 18.3802C49.8759 18.2514 49.1216 18.0859 48.404 17.8835C47.7049 17.6811 47.0794 17.4235 46.5274 17.1107C45.9754 16.7796 45.5431 16.3564 45.2303 15.8412C44.9175 15.3261 44.7612 14.7005 44.7612 13.9646C44.7612 13.1551 44.9451 12.4651 45.3131 11.8948C45.6995 11.306 46.2238 10.8369 46.8862 10.4873C47.5669 10.1193 48.3672 9.85255 49.2872 9.68696C50.2255 9.50298 51.2466 9.41099 52.3505 9.41099C53.3624 9.41099 54.3007 9.50298 55.1655 9.68696C56.0302 9.85255 56.7937 10.1101 57.4561 10.4597C58.1184 10.7909 58.6428 11.214 59.0291 11.7292C59.4155 12.2443 59.6087 12.8423 59.6087 13.523C59.6087 13.5966 59.5995 13.6794 59.5811 13.7714C59.5811 13.845 59.5811 13.9094 59.5811 13.9646H55.3587V13.799C55.3587 13.4494 55.2115 13.1643 54.9171 12.9435C54.6411 12.7043 54.2731 12.5295 53.8132 12.4191C53.3532 12.3087 52.8473 12.2535 52.2953 12.2535C52.0377 12.2535 51.7158 12.2719 51.3294 12.3087C50.9614 12.3271 50.5935 12.3823 50.2255 12.4743C49.8575 12.5663 49.5447 12.6951 49.2872 12.8607C49.048 13.0079 48.9284 13.2287 48.9284 13.523C48.9284 13.891 49.1308 14.167 49.5355 14.351C49.9403 14.535 50.4739 14.6821 51.1362 14.7925C51.7986 14.8845 52.5161 14.9949 53.2888 15.1237C54.1352 15.2525 54.9631 15.3997 55.7726 15.5653C56.5821 15.7309 57.2997 15.97 57.9252 16.2828C58.5692 16.5956 59.0843 17.0279 59.4707 17.5799C59.8571 18.1318 60.0503 18.8586 60.0503 19.7601C60.0503 20.6616 59.8571 21.4252 59.4707 22.0507C59.1027 22.6763 58.5692 23.1822 57.87 23.5686C57.1709 23.9366 56.3338 24.2033 55.3587 24.3689C54.4019 24.5345 53.3256 24.6173 52.1297 24.6173Z" fill="white" class="astro-3FGDBQYQ"></path>
84<path d="M68.8936 24.6173C67.8265 24.6173 66.9525 24.4701 66.2718 24.1757C65.5911 23.8814 65.0851 23.4122 64.7539 22.7683C64.4228 22.1059 64.2572 21.2412 64.2572 20.1741V12.8331H61.7458V9.74216H64.3952L65.2231 5.49212H68.452V9.74216H72.0673V12.8331H68.452V19.6221C68.452 20.2293 68.5716 20.6984 68.8108 21.0296C69.0684 21.3608 69.5835 21.5264 70.3563 21.5264H72.0673V24.1481C71.8281 24.2401 71.5154 24.3229 71.129 24.3965C70.7426 24.4701 70.3471 24.5253 69.9423 24.5621C69.5375 24.5989 69.188 24.6173 68.8936 24.6173Z" fill="white" class="astro-3FGDBQYQ"></path>
85<path d="M74.9539 24.2861V9.74216H78.376L78.6795 12.1984H78.8727C79.1119 11.6648 79.4155 11.1864 79.7834 10.7633C80.1698 10.3401 80.6298 10.0089 81.1633 9.76976C81.6969 9.53058 82.304 9.41099 82.9848 9.41099C83.3159 9.41099 83.6287 9.43858 83.9231 9.49378C84.2359 9.53058 84.5118 9.59497 84.751 9.68696V13.2747
85H82.902C82.2396 13.2747 81.6693 13.3851 81.1909 13.6058C80.7126 13.8082 80.3262 14.1026 80.0318 14.489C79.7374 14.8569 79.5167 15.2801 79.3695 15.7584C79.2223 16.2368 79.1487 16.7612 79.1487 17.3315V24.2861H74.9539Z" fill="white" class="astro-3FGDBQYQ"></path>
86<path d="M94.7116 24.6173C92.8902 24.6173 91.3171 24.3505 89.9924 23.817C88.6861 23.265 87.6834 22.4279 86.9843 21.3056C86.2851 20.1833 85.9356 18.7574 85.9356 17.0279C85.9356 15.3169 86.2759 13.9002 86.9567 12.7779C87.6558 11.6372 88.6493 10.7909 89.9372 10.2389C91.2435 9.68696 92.789 9.41099 94.5736 9.41099C96.4135 9.41099 97.9589 9.68696 99.21 10.2389C100.48 10.7909 101.436 11.6096 102.08 12.6951C102.724 13.7806 103.046 15.1421 103.046 16.7796V17.9663H90.2684C90.3236 18.8126 90.526 19.5117 90.8755 20.0637C91.2435 20.5972 91.7495 20.9928 92.3934 21.2504C93.0558 21.4896 93.8561 21.6092 94.7944 21.6092C95.236 21.6092 95.6775 21.5632 96.1191 21.4712C96.5791 21.3608 97.0022 21.2136 97.3886 21.0296C97.775 20.8272 98.0877 20.5788 98.3269 20.2845C98.5845 19.9717 98.7225 19.6129 98.7409 19.2082H102.991C102.991 20.0177 102.798 20.7628 102.411 21.4436C102.025 22.1059 101.464 22.6763 100.728 23.1546C100.01 23.6146 99.1364 23.9734 98.1061 24.2309C97.0942 24.4885 95.9627 24.6173 94.7116 24.6173ZM90.296 15.3997H98.6305C98.6305 14.9029 98.5293 14.4706 98.3269 14.1026C98.1429 13.7162 97.867 13.4034 97.499 13.1643C97.131 12.9067 96.7079 12.7227 96.2295 12.6123C95.7511 12.4835 95.2268 12.4191 94.6564 12.4191C93.8101 12.4191 93.0742 12.5387 92.4486 12.7779C91.8231 12.9987 91.3263 13.3299 90.9583 13.7714C90.6088 14.213 90.388 14.7557 90.296 15.3997Z" fill="white" class="astro-3FGDBQYQ"></path>
87<path d="M111.214 24.6173C110.46 24.6173 109.733 24.5529 109.034 24.4241C108.335 24.2953 107.709 24.0745 107.157 23.7618C106.605 23.449 106.173 23.0166 105.86 22.4647C105.547 21.9127 105.391 21.2136 105.391 20.3673C105.391 19.245 105.685 18.3526 106.274 17.6903C106.863 17.0279 
87107.691 16.5404 108.758 16.2276C109.825 15.8964 111.085 15.6849 112.539 15.5929C113.992 15.4825 115.584 15.4273 117.313 15.4273V14.7373C117.313 14.2038 117.184 13.7622 116.927 13.4126C116.687 13.0631 116.301 12.8147 115.768 12.6675C115.252 12.5019 114.562 12.4191 113.698 12.4191C112.999 12.4191 112.382 12.4743 111.849 12.5847C111.315 12.6951 110.901 12.8607 110.607 13.0815C110.312 13.3023 110.165 13.569 110.165 13.8818V14.1854H105.998C105.98 14.0934 105.961 14.0198 105.943 13.9646C105.943 13.891 105.943 13.799 105.943 13.6886C105.943 12.8423 106.246 12.0972 106.854 11.4532C107.479 10.8093 108.381 10.3125 109.558 9.96294C110.736 9.59497 112.189 9.41099 113.919 9.41099C115.556 9.41099 116.936 9.57657 118.058 9.90775C119.18 10.2205 120.036 10.7357 120.625 11.4532C121.213 12.1524 121.508 13.0815 121.508 14.2406V20.4501C121.508 20.7996 121.581 21.0664 121.729 21.2504C121.876 21.4344 122.106 21.5264 122.419 21.5264H123.716V24.1481C123.513 24.2217 123.164 24.3137 122.667 24.4241C122.189 24.5529 121.655 24.6173 121.066 24.6173C120.294 24.6173 119.677 24.5253 119.217 24.3413C118.757 24.1573 118.408 23.8998 118.169 23.5686C117.929 23.2374 117.755 22.8694 117.644 22.4647H117.451C116.991 22.9062 116.439 23.2926 115.795 23.6238C115.17 23.955 114.47 24.2033 113.698 24.3689C112.943 24.5345 112.115 24.6173 111.214 24.6173ZM112.401 21.6092C112.916 21.6092 113.459 21.5448 114.029 21.416C114.599 21.2872 115.133 21.1032 115.63 20.864C116.126 20.6248 116.531 20.3213 116.844 19.9533C117.157 19.5853 117.313 19.1622 117.313 18.6838V17.9111C115.62 17.9111 114.194 17.9847 113.035 18.1318C111.895 18.2606 111.03 18.4906 110.441 18.8218C109.871 19.1346 109.586 19.5761 109.586 20.1465C109.586 20.5328 109.714 20.8272 109.972 21.0296C110.248 21.232 110.598 21.3792 111.021 21.4712C111.462 21.5632 111.922 21.6092 112.401 21.6092Z" fill="white" class="astro-3FGDBQYQ"></path>
88<path d="M125.594 24.2861V9.74216H129.017L129.32 12.0604H129.541C130.001 11.4348 130.525 10.9289 131.114 10.5425C131.703 10.1561 132.338 9.87095 133.018 9.68696C133.717 9.50298 134.417 9.41099 135.116 9.41099C136.348 9.41099 137.379 9.63177 138.207 10.0733C139.053 10.4965 139.678 11.1588 140.083 12.0604H140.332C140.792 11.4348 141.325 10.9289 141.932 10.5425C142.539 10.1561 143.183 9.87095 143.864 9.68696C144.563 9.50298 145.262 9.41099 145.962 9.41099C147.176 9.41099 148.197 9.61337 149.025 10.0181C149.853 10.4229 150.478 11.0484 150.902 11.8948C151.325 12.7411 151.536 13.8174 151.536 15.1237V24.2861H147.369V15.786C147.369 15.2525 147.295 14.7925 147.148 14.4062C147.019 14.0198 146.826 13.707 146.569 13.4678C146.311 13.2287 145.998 13.0539 145.63 12.9435C145.281 12.8331 144.876 12.7779 144.416 12.7779C143.754 12.7779 143.137 12.9343 142.567 13.2471C141.997 13.5414 141.537 13.9646 141.187 14.5166C140.838 15.0501 140.663 15.6757 140.663 16.3932V24.2861H136.496V15.786C136.496 15.2525 136.422 14.7925 136.275 14.4062C136.146 14.0198 135.953 13.707 135.695 13.4678C135.438 13.2287 135.125 13.0539 134.757 12.9435C134.407 12.8331 134.003 12.7779 133.543 12.7779C132.862 12.7779 132.236 12.9343 131.666 13.2471C131.096 13.5414 130.636 13.9646 130.286 14.5166C129.955 15.0501 129.789 15.6757 129.789 16.3932V24.2861H125.594Z" fill="white" class="astro-3FGDBQYQ"></path>
89<path d="M161.59 24.6173C160.173 24.6173 158.94 24.3505 157.892 23.817C156.843 23.265 156.024 22.4279 155.436 21.3056C154.847 20.1649 154.552 18.739 154.552 17.0279C154.552 15.2801 154.838 13.845 155.408 12.7227C155.997 11.6004 156.806 10.7725 157.837 10.2389C158.867 9.68696 160.063 9.41099 161.424 9.41099C162.123 9.41099 162.786 9.48458 163.411 9.63177C164.055 9.77896 164.644 10.0089 165.177 10.3217C165.711 10.6345 166.162 11.0209 166.53 11.4808H166.751V4.30542H170.918V24.2861H167.523L167.192 22.0783H166.971C166.327 22.9982 165.545 23.6514 164.626 24.0378C163.706 24.4241 162.694 24.6173 161.59 24.6173ZM162.777 21.2504C163.641 21.2504 164.368 21.094 164.957 20.7812C165.545 20.4501 165.987 19.9809 166.281 19.3737C166.594 18.7666 166.751 18.0307 166.751 17.1659V16.89C166.751 16.246 166.668 15.6757 166.502 15.1789C166.337 14.6637 166.079 14.2314 165.729 13.8818C165.38 13.5138 164.957 13.2379 164.46 13.0539C163.963 12.8699 163.393 12.7779 162.749 12.7779C161.884 12.7779 161.157 12.9343 160.569 13.2471C159.98 13.5598 159.538 14.0198 159.244 14.6269C158.95 15.2157 158.802 15.9332 
89158.802 16.7796V17.2763C158.802 18.1226 158.95 18.8494 159.244 19.4565C159.557 20.0453 160.008 20.496 160.596 20.8088C161.185 21.1032 161.912 21.2504 162.777 21.2504Z" fill="white" class="astro-3FGDBQYQ"></path>
90<path d="M179.723 24.6173C178.969 24.6173 178.242 24.5529 177.543 24.4241C176.844 24.2953 176.218 24.0745 175.666 23.7618C175.114 23.449 174.682 23.0166 174.369 22.4647C174.056 21.9127 173.9 21.2136 173.9 20.3673C173.9 19.245 174.194 18.3526 174.783 17.6903C175.372 17.0279 176.2 16.5404 177.267 16.2276C178.334 15.8964 179.594 15.6849 181.048 15.5929C182.501 15.4825 184.093 15.4273 185.822 15.4273V14.7373C185.822 14.2038 185.693 13.7622 185.436 13.4126C185.197 13.0631 184.81 12.8147 184.277 12.6675C183.761 12.5019 183.071 12.4191 182.207 12.4191C181.508 12.4191 180.891 12.4743 180.358 12.5847C179.824 12.6951 179.41 12.8607 179.116 13.0815C178.821 13.3023 178.674 13.569 178.674 13.8818V14.1854H174.507C174.489 14.0934 174.47 14.0198 174.452 13.9646C174.452 13.891 174.452 13.799 174.452 13.6886C174.452 12.8423 174.755 12.0972 175.363 11.4532C175.988 10.8093 176.89 10.3125 178.067 9.96294C179.245 9.59497 180.698 9.41099 182.428 9.41099C184.065 9.41099 185.445 9.57657 186.567 9.90775C187.689 10.2205 188.545 10.7357 189.134 11.4532C189.723 12.1524 190.017 13.0815 190.017 14.2406V20.4501C190.017 20.7996 190.09 21.0664 190.238 21.2504C190.385 21.4344 190.615 21.5264 190.928 21.5264H192.225V24.1481C192.022 24.2217 191.673 24.3137 191.176 24.4241C190.698 24.5529 190.164 24.6173 189.575 24.6173C188.803 24.6173 188.186 24.5253 187.726 24.3413C187.266 24.1573 186.917 23.8998 186.678 23.5686C186.438 23.2374 186.264 22.8694 186.153 22.4647H185.96C185.5 22.9062 184.948 23.2926 184.304 23.6238C183.679 23.955 182.979 24.2033 182.207 24.3689C181.452 24.5345 180.624 24.6173 179.723 24.6173ZM180.91 21.6092C181.425 21.6092 181.968 21.5448 182.538 21.416C183.108 21.2872 183.642 21.1032 184.139 20.864C184.635 20.6248 185.04 20.3213 185.353 19.9533C185.666 19.5853 185.822 19.1622 185.822 18.6838V17.9111C184.129 17.9111 182.704 17.9847 181.544 18.1318C180.404 18.2606 179.539 18.4906 178.95 18.8218C178.38 19.1346 178.095 19.5761 178.095 20.1465C178.095 20.5328 178.223 20.8272 178.481 21.0296C178.757 21.232 179.107 21.3792 179.53 21.4712C179.971 21.5632 180.431 21.6092 180.91 21.6092Z" fill="white" class="astro-3FGDBQYQ"></path>
91<path d="M194.104 24.2861V4.30542H198.298V24.2861H194.104Z" fill="white" class="astro-3FGDBQYQ"></path>
92<path class="logo_bvec astro-3FGDBQYQ" d="M28.6108 25.5896L31.4929 28.4716L34.345 25.6195V25.5596L31.4929 22.7075L28.6108 25.5896Z"></path>
93<path class="logo_tvec astro-3FGDBQYQ" d="M7.77051 2.8621C7.77051 4.4577 9.05696 5.74414 10.6526 5.74414C12.2481 5.74414 13.5346 4.44772 13.5346 2.8621C13.5346 1.38617 12.4376 0.179504 11.0116 0H10.2935C8.86748 0.179504 7.77051 1.38617 7.77051 2.8621Z"></path>
94<path d="M34.0959 8.30707C33.9862 7.71869 33.8366 7.14029 33.6471 6.58183C33.4975 6.13307 33.318 5.71423 33.1186 5.29538C32.1014 3.33081 30.446 1.76513 28.4216 0.84766C28.2919 0.787825 28.1623 0.737963 28.0326 0.678128C27.9528 0.648211 27.8631 0.608321 27.7833 0.578403C27.5739 0.498624 27.3545 0.428816 27.1351 0.368981C27.0852 0.349037 27.0354 0.339064 26.9855 0.329092C26.7462 0.269257 26.5068 0.209422 26.2575 0.15956C26.2176 0.149587 26.1777 0.139615 26.1379 0.139615C25.8885 0.0897522 25.6293 0.0598348 25.37 0.0398899C25.3401 0.0398899 25.3002 0.0398899 25.2702 0.0299174C24.991 0.0199449 24.7118 0 24.4326 0C24.2331 0 24.0436 0.00997247 23.8442 0.0199449C23.7744 0.0199449 23.7145 0.0299174 23.6447 0.0398899C23.5251 0.0498624 23.3954 0.0598348 23.2758 0.0797798C23.196 0.0897523 23.1062 0.0997247 23.0264 0.109697C22.9367 0.11967 22.837 0.139615 22.7472 0.15956C19.9749 0.638238 17.6114 2.2837 16.1654 4.57736H23.904L15.2679 13.2135C15.2679 13.2135 13.9116 14.5698 12.6551 15.8263C11.5681 16.9133 10.5509 17.9305 10.5509 17.9305L0 28.4614H4.87654L9.61347 23.7245H11.6379L6.85109 28.5113H11.7276L16.5144 23.7245H17.6912L21.4807 27.5141H18.7682V28.5113H28.631V27.5141H26.5567L23.4453 24.4126L23.8542 23.5051C29.8277 22.3483 34.3452 17.0928 34.3452 10.7802C34.3452 9.93258 34.2554 9.11484 34.0959 8.30707ZM25.0209 27.5141H23.0165L19.9449 24.4425L20.2641 23.7245L21.2414 23.7345L25.0209 27.5141ZM24.3727 2.92193C24.0237 2.92193 23.7445 2.64271 23.7445 2.29367C23.7445 1.94463 24.0237 1.6654 24.3727 1.6654C24.7218 1.6654 25.001 1.94463 25.001 2.29367C25.011 2.64271 24.7218 2.92193 24.3727 2.92193Z" fill="white" class="astro-3FGDBQYQ"></path>
95</svg>
96        <svg id="lg-header-logo" height="40" viewBox="0 0 605 527" fill="none" xmlns="http://www.w3.org/2000/svg" style="width: auto;" class="mobile-logo astro-YHH6LI4U">
97<title>Streamdal Logo</title>
98  <path class="logo_bvec astro-YHH6LI4U" d="M453.14 413.431L491.2 451.492L528.865 413.826V413.036L491.2 375.371L453.14 413.431Z"></path>
99  <path class="logo_tvec astro-YHH6LI4U" d="M177.9 113.292C177.9 134.364 194.889 151.353 215.96 151.353C237.032 151.353 254.02 134.232 254.02 113.292C254.02 93.8012 239.534 77.8659 220.701 75.4954H211.219C192.386 77.8659 177.9 93.8012 177.9 113.292Z"></path>
100  <path fill="white" d="M525.575 185.199C524.126 177.429 522.151 169.79 519.648 162.415C517.673 156.489 515.302 150.958 512.668 145.426C499.235 119.482 477.374 98.8057 450.639 86.6896C448.927 85.8994 447.215 85.2409 445.503 84.4507C444.45 84.0556 443.264 83.5289 442.211 83.1338C439.445 82.0802 436.548 81.1583 433.651 80.3681C432.992 80.1047 432.334 79.973 431.675 79.8413C428.514 79.0512 425.354 78.261 422.061 77.6025C421.534 77.4708 421.008 77.3391 420.481 77.3391C417.188 76.6806 413.764 76.2855 410.34 76.0221C409.945 76.0221 409.418 76.0221 409.023 75.8905C405.336 75.7588 401.648 75.4954 397.961 75.4954C395.327 75.4954 392.825 75.6271 390.191 75.7588C389.269 75.7588 388.479 75.8905 387.557 76.0221C385.976 76.1538 384.264 76.2855 382.684 76.5489C381.63 76.6806 380.445 76.8123 379.392 76.944C378.206 77.0757 376.889 77.3391 375.704 77.6025C339.092 83.9239 307.88 105.654 288.784 135.944H390.981L276.932 249.993C276.932 249.993 259.021 267.904 242.427 284.498C228.072 298.853 214.639 312.286 214.639 312.286L75.3041 451.357H139.704L202.26 388.802H228.994L165.78 452.016H230.179L293.394 388.802H308.934L358.979 438.846H323.157V452.016H453.405V438.846H426.012L384.923 397.889L390.322 385.904C469.209 370.627 528.867 301.223 528.867 217.859C528.867 206.665 527.682 195.866 525.575 185.199ZM405.731 438.846H379.26L338.697 398.284L342.912 388.802L355.818 388.933L405.731 438.846ZM397.171 114.082C392.561 114.082 388.874 110.395 388.874 105.786C388.874 101.176 392.561 97.4887 397.171 97.4887C401.78 97.4887 405.467 101.176 405.467 105.786C405.599 110.395 401.78 114.082 397.171 114.082Z" class="astro-YHH6LI4U"></path>
101</svg>
102      </a>
103    </div>
104    <div style="flex-grow: 1;" class="astro-2W66RQV5"></div>
105    
106    <div class="absolute w-fit grow z-10 astro-2W66RQV5">
107      <button class="header-button search-input px-4 py-1 w-80 astro-F4DDINW2" type="button" aria-label="Search" id="docsearch-search-button">
108  <svg width="25" height="25" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg" focusable="false" aria-hidden="true" role="img" class="astro-F4DDINW2">
109    <path d="M17.7473 16.4825L14.4102 13.17C15.7056 11.5537 16.3329 9.50215 16.1631 7.43721C15.9934 5.37227 15.0396 3.45088 13.4978 2.06813C11.9559 0.685379 9.94333 -0.0536394 7.87376 0.00303437C5.80419 0.0597081 3.83498 0.907766 2.37103 2.37283C0.907077 3.83789 0.0596628 5.8086 0.00303206 7.87974C-0.0535986 9.95088 0.684859 11.965 2.06656 13.508C3.44826 15.051 5.36819 16.0056 7.43156 16.1754C9.49493 16.3453 11.5449 15.7175 13.16 14.4212L16.47 17.7337C16.5536 17.8181 16.6531 17.8851 16.7627 17.9308C16.8723 17.9765 16.9899 18 17.1086 18C17.2274 18 17.3449 17.9765 17.4546 17.9308C17.5642 17.8851 17.6636 17.8181 17.7473 17.7337C17.9094 17.5659 18 17.3416 18 17.1081C18 16.8747 17.9094 16.6504 17.7473 16.4825ZM8.11399 14.4212C6.8687 14.4212 5.65139 14.0516 4.61597 13.3593C3.58056 12.6669 2.77355 11.6828 2.297 10.5315C1.82045 9.38009 1.69577 8.11316 1.93871 6.89088C2.18165 5.6686 2.78131 4.54586 3.66186 3.66464C4.54241 2.78343 5.66429 2.18331 6.88565 1.94018C8.107 1.69706 9.37297 1.82184 10.5235 2.29875C11.674 2.77566 12.6573 3.58328 13.3491 4.61948C14.041 5.65568 14.4102 6.87392 14.4102 8.12015C14.4102 9.79129 13.7469 11.394 12.5661 12.5757C11.3853 13.7573 9.78386 14.4212 8.11399 14.4212Z" fill="white" class="astro-F4DDINW2"></path>
110  </svg>
111  <span class="search-placeholder astro-F4DDINW2">
112    Search
113    <span class="sr-only astro-F4DDINW2">(Press / to search)</span>
114  </span>
115  <div class="flex w-full justify-end astro-F4DDINW2">
116    <span class="relative end-0 py-1 px-1.5 rounded m-1 bg-gradient-to-r from-yellow-lightGradient to-yellow-darkGradient astro-F4DDINW2">
117      <kbd aria-hidden="true" class="py-1.5 px-0.5 text-purple-darkText astro-F4DDINW2">
118        <svg width="10" height="11" viewBox="0 0 10 11" fill="none" xmlns="http://www.w3.org/2000/svg" class="astro-F4DDINW2">
119          <path d="M2.17962 10.2042C1.82747 10.2042 1.50491 10.1184 1.21194 9.94673C0.918968 9.77214 0.685184 9.53835 0.510587 9.24538C0.338949 8.95241 0.253129 8.62985 0.253129 8.2777C0.253129 7.92259 0.338949 7.59854 0.510587 7.30558C0.685184 7.01261 0.918968 6.77882 1.21194 6.60423C1.50491 6.42963 1.82747 6.34233 2.17962 6.34233H3.20945V4.55788H2.17962C1.82747 4.55788 1.50491 4.47206 1.21194 4.30043C0.918968 4.12583 0.685184 3.89353 0.510587 3.60352C0.338949 3.31055 0.253129 2.98651 0.253129 2.63139C0.253129 2.27628 0.338949 1.95372 0.510587 1.66371C0.685184 1.37074 0.918968 1.13843 1.21194 0.966797C1.50491 0.792199 1.82747 0.7049 2.17962 0.7049C2.53473 0.7049 2.85878 0.792199 3.15174 0.966797C3.44471 1.13843 3.6785 1.37074 3.85309 1.66371C4.02769 1.95372 4.11499 2.27628 4.11499 2.63139V3.65234H5.89944V2.63139C5.89944 2.27628 5.98526 1.95372 6.15689 1.66371C6.33149 1.37074 6.56379 1.13843 6.8538 0.966797C7.14677 0.792199 7.47081 0.7049 7.82593 0.7049C8.18104 0.7049 8.5036 0.792199 8.79361 0.966797C9.08658 1.13843 9.31889 1.37074 9.49052 1.66371C9.66512 1.95372 9.75242 2.27628 9.75242 2.63139C9.75242 2.98651 9.66512 3.31055 9.49052 3.60352C9.31889 3.89353 9.08658 4.12583 8.79361 4.30043C8.5036 4.47206 8.18104 4.55788 7.82593 4.55788H6.80498V6.34233H7.82593C8.18104 6.34233 8.5036 6.42963 8.79361 6.60423C9.08658 6.77882 9.31889 7.01261 9.49052 7.30558C9.66512 7.59854 9.75242 7.92259 9.75242 8.2777C9.75242 8.62985 9.66512 8.95241 9.49052 9.24538C9.31889 9.53835 9.08658 9.77214 8.79361 9.94673C8.5036 10.1184 8.18104 10.2042 7.82593 10.2042C7.47081 10.2042 7.14677 10.1184 6.8538 9.94673C6.56379 9.77214 6.33149 9.53835 6.15689 9.24538C5.98526 8.95241 5.89944 8.62985 5.89944 8.2777V7.24787H4.11499V8.2777C4.11499 8.62985 4.02769 8.95241 3.85309 9.24538C3.6785 9.53835 3.44471 9.77214 3.15174 9.94673C2.85878 10.1184 2.53473 10.2042 2.17962 10.2042ZM2.17962 9.29865C2.36902 9.29865 2.54065 9.25278 2.69454 9.16104C2.85138 9.06931 2.97567 8.9465 3.06741 8.79261C3.1621 8.63577 3.20945 8.46413 3.20945 8.2777V7.24787H2.17962C1.99319 7.24787 1.82155 7.29522 1.66471 7.38991C1.51082 7.48165 1.38801 7.60594 1.29628 7.76278C1.20454 7.91667 1.15867 8.0883 1.15867 8.2777C1.15867 8.46413 1.20454 8.63577 1.29628 8.79261C1.38801 8.9465 1.51082 9.06931 1.66471 9.16104C1.82155 9.25278 1.99319 9.29865 2.17962 9.29865ZM2.17962 3.65234H3.20945V2.63139C3.20945 2.442 3.1621 2.27036 3.06741 2.11648C2.97567 1.96259 2.85138 1.83978 2.69454 1.74805C2.54065 1.65631 2.36902 1.61044 2.17962 1.61044C1.99319 1.61044 1.82155 1.65631 1.66471 1.74805C1.51082 1.83978 1.38801 1.96259 1.29628 2.11648C1.20454 2.27036 1.15867 2.442 1.15867 2.63139C1.15867 2.82079 1.20454 2.9939 1.29628 3.15075C1.38801 3.30463 1.51082 3.42744 1.66471 3.51918C1.82155 3.60795 1.99319 3.65234 2.17962 3.65234ZM6.80498 3.65234H7.82593C8.01532 3.65234 8.18696 3.60795 8.34084 3.51918C8.49473 3.42744 8.61754 3.30463 8.70927 3.15075C8.80101 2.9939 8.84688 2.82079 8.84688 2.63139C8.84688 2.442 8.80101 2.27036 8.70927 2.11648C8.61754 1.96259 8.49473 1.83978 8.34084 1.74805C8.18696 1.65631 8.01532 1.61044 7.82593 1.61044C7.63653 1.61044 7.46342 1.65631 7.30657 1.74805C7.15269 1.83978 7.02988 1.96259 6.93814 2.11648C6.84937 2.27036 6.80498 2.442 6.80498 2.63139V3.65234ZM7.82593 9.29865C8.01532 9.29865 8.18696 9.25278 8.34084 9.16104C8.49473 9.06931 8.61754 8.9465 8.70927 8.79261C8.80101 8.63577 8.84688 8.46413 8.84688 8.2777C8.84688 8.0883 8.80101 7.91667 8.70927 7.76278C8.61754 7.60594 8.49473 7.48165 8.34084 7.38991C8.18696 7.29522 8.01532 7.24787 7.82593 7.24787H6.80498V8.2777C6.80498 8.46413 6.84937 8.63577 6.93814 8.79261C7.02988 8.9465 7.15269 9.06931 7.30657 9.16104C7.46342 9.25278 7.63653 9.29865 7.82593 9.29865ZM4.11499 6.34233H5.89944V4.55788H4.11499V6.34233Z" fill="#1E182F" class="astro-F4DDINW2"></path>
120        </svg>
121      </kbd>
122    </span>
123    <span class="relative end-0 py-0.5 px-1.5 rounded m-1 bg-gradient-to-r from-yellow-lightGradient to-yellow-darkGradient astro-F4DDINW2">
124      <kbd aria-hidden="true" class="py-1.5 px-0.5 text-sm text-purple-darkText astro-F4DDINW2">k
125      </kbd>
126    </span>
127  </div>
128</button>
129<script type="95dbc2103aee66d9a880ee38-text/javascript">(self.Astro=self.Astro||{}).only=t=>{(async()=>await(await t())())()},window.dispatchEvent(new Event("astro:only"));</script>
129<astro-island uid="Zg9gpA" component-url="/_astro/DocSearch.66163b2a.js" component-export="default" renderer-url="/_astro/client.7a4f1478.js" props="{&quot;lang&quot;:[0,null],&quot;labels&quot;:[0,{&quot;modal&quot;:[0,{}],&quot;placeholder&quot;:[0,&quot;Search docs&quot;]}],&quot;class&quot;:[0,&quot;astro-F4DDINW2&quot;]}" ssr="" client="only" opts="{&quot;name&quot;:&quot;DocSearch&quot;,&quot;value&quot;:&quot;preact&quot;}"></astro-island>
130    </div>
131  </nav>
132</header>
133    <main class="layout astro-OUAMJN2I">
134      <aside id="left-sidebar" class="sidebar astro-OUAMJN2I" title="Site Navigation">
135        <nav aria-labelledby="grid-left" class="astro-KQNE5HRN">
136  
136<script type="95dbc2103aee66d9a880ee38-text/javascript">(self.Astro=self.Astro||{}).load=a=>{(async()=>await(await a())())()},window.dispatchEvent(new Event("astro:load"));</script>
136<astro-island uid="Zam34G" component-url="/_astro/SidebarToggleTabGroup.af91e10a.js" component-export="default" renderer-url="/_astro/client.7a4f1478.js" props="{&quot;defaultActiveTab&quot;:[0,&quot;learn&quot;],&quot;labels&quot;:[0,{&quot;learn&quot;:[0,&quot;Developer Docs&quot;],&quot;api&quot;:[0,&quot;Resources&quot;]}],&quot;class&quot;:[0,&quot;astro-KQNE5HRN&quot;]}" ssr="" client="load" opts="{&quot;name&quot;:&quot;SidebarToggleTabGroup&quot;,&quot;value&quot;:true}" await-children=""><div class="TabGroup"><button class="active">Developer Docs</button><button class>Resources</button></div></astro-island>
137  <ul class="nav-groups astro-KQNE5HRN">
138    <li class="nav-group nav-group-top learn active"><details open><summary class="nav-group-title nav-group-title-top"><h2>Getting Started<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 1 16 16" width="20" height="20" aria-hidden="true"><path fill-rule="evenodd" d="M6.22 3.22a.75.75 0 011.06 0l4.25 4.25a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06-1.06L9.94 8 6.22 4.28a.75.75 0 010-1.06z"></path></svg></h2></summary><ul style="padding-left: 5px;"><li class="nav-link"><a href="/en/what-is-streamdal/" aria-current="false" data-current-parent="false">What is Streamdal?</a></li><li class="nav-link"><a href="/en/getting-started/how-streamdal-works/" aria-current="false" data-current-parent="false">How Streamdal Works</a></li><li class="nav-link"><a href="/en/getting-started/use-cases/" aria-current="false" data-current-parent="false">Use Cases</a></li><li class="nav-link"><a href="/en/getting-started/quickstart/" aria-current="false" data-current-parent="false">Quickstart</a></li></ul></details></li><li class="nav-group nav-group-top learn active"><details open><summary class="nav-group-title nav-group-title-top"><h2>Guides<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 1 16 16" width="20" height="20" aria-hidden="true"><path fill-rule="evenodd" d="M6.22 3.22a.75.75 0 011.06 0l4.25 4.25a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06-1.06L9.94 8 6.22 4.28a.75.75 0 010-1.06z"></path></svg></h2></summary><ul style="padding-left: 5px;"><li class="nav-link"><a href="/en/guides/deployment/" aria-current="false" data-current-parent="false">Deployment</a></li><li class="nav-link"><a href="/en/guides/instrumentation/" aria-current="page" data-current-parent="false">Instrumentation</a></li><li class="nav-link"><a href="/en/guides/pipelines/" aria-current="false" data-current-parent="false">Pipelines</a></li><li class="nav-link"><a href="/en/guides/tail/" aria-current="false" data-current-parent="false">Tail</a></li><li class="nav-link"><a href="/en/guides/terraform/" aria-current="false" data-current-parent="false">Terraform</a></li><li class="nav-link"><a href="/en/guides/notifications/" aria-current="false" data-current-parent="false">Notifications</a></li></ul></details></li><li class="nav-group nav-group-top learn active"><details open><summary class="nav-group-title nav-group-title-top"><h2>Core Components<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 1 16 16" width="20" height="20" aria-hidden="true"><path fill-rule="evenodd" d="M6.22 3.22a.75.75 0 011.06 0l4.25 4.25a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06-1.06L9.94 8 6.22 4.28a.75.75 0 010-1.06z"></path></svg></h2></summary><ul style="padding-left: 5px;"><li class="nav-link"><a href="/en/core-components/overview/" aria-current="false" data-current-parent="false">Overview</a></li><li class="nav-link"><a href="/en/core-components/console-ui/" aria-current="false" data-current-parent="false">Console UI</a></li><li class="nav-link"><a href="/en/core-components/server/" aria-current="false" data-current-parent="false">Server</a></li><li class="nav-link"><a href="/en/core-components/sdk/" aria-current="false" data-current-parent="false">SDK</a></li><li class="nav-link"><a href="/en/core-components/libraries-shims/" aria-current="false" data-current-parent="false">Libraries/Shims</a></li></ul></details></li><li class="nav-group nav-group-top learn active"><details open><summary class="nav-group-title nav-group-title-top"><h2>SDKs<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 1 16 16" width="20" height="20" aria-hidden="true"><path fill-rule="evenodd" d="M6.22 3.22a.75.75 0 011.06 0l4.25 4.25a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06-1.06L9.94 8 6.22 4.28a.75.75 0 010-1.06z"></path></svg></h2></summary><ul style="padding-left: 5px;"><li class="nav-link"><a href="/en/sdks/go/" aria-current="false" data-current-parent="false">Go</a></li><li class="nav-link"><a href="/en/sdks/node/" aria-current="false" data-current-parent="false">Node</a></li><li class="nav-link"><a href="/en/sdks/python/" aria-current="false" data-current-parent="false">Python</a></li><li class="nav-link"><a href="/en/sdks/ruby/" aria-current="false" data-current-parent="false">Ruby</a></li><li class="nav-link"><a href="/en/sdks/java/" aria-current="false" data-current-parent="false">Java (TBA)</a></li><li class="nav-link"><a href="/en/sdks/scala/" aria-current="false" data-current-parent="false">Scala (TBA)</a></li><li class="nav-link"><a href="/en/sdks/rust/" aria-current="false" data-current-parent="false">Rust (TBA)</a></li><li class="nav-link"><a href="/en/sdks/dotnet/" aria-current="false" data-current-parent="false">.NET (TBA)</a></li></ul></details></li>
139
140
141    <li class="nav-group nav-group-top api "><details open><summary class="nav-group-title nav-group-title-top"><h2>Data Governance (Beta)<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 1 16 16" width="20" height="20" aria-hidden="true"><path fill-rule="evenodd" d="M6.22 3.22a.75.75 0 011.06 0l4.25 4.25a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06-1.06L9.94 8 6.22 4.28a.75.75 0 010-1.06z"></path></svg></h2></summary><ul style="padding-left: 5px;"><li class="nav-link"><a href="/en/data-governance/overview/" aria-current="false" data-current-parent="false">Overview</a></li><li class="nav-link"><a href="/en/data-governance/data-quality/" aria-current="false" data-current-parent="false">Data Quality</a></li><li class="nav-group  api "><details><summary class="nav-group-title "><h2>Data Law<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 1 16 16" width="20" height="20" aria-hidden="true"><path fill-rule="evenodd" d="M6.22 3.22a.75.75 0 011.06 0l4.25 4.25a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06-1.06L9.94 8 6.22 4.28a.75.75 0 010-1.06z"></path></svg></h2></summary><ul style="padding-left: 5px;"><li class="nav-link"><a href="/en/data-governance/compliance/ccpa-cpra/" aria-current="false" data-current-parent="false">CCPA</a></li><li class="nav-link"><a href="/en/data-governance/compliance/fed-ramp/" aria-current="false" data-current-parent="false">FED RAMP</a></li><li class="nav-link"><a href="/en/data-governance/compliance/gdpr/" aria-current="false" data-current-parent="false">GDPR</a></li><li class="nav-link"><a href="/en/data-governance/compliance/glba/" aria-current="false" data-current-parent="false">GLBA</a></li><li class="nav-link"><a href="/en/data-governance/compliance/hipaa/" aria-current="false" data-current-parent="false">HIPAA</a></li><li class="nav-link"><a href="/en/data-governance/compliance/iso-iec/" aria-current="false" data-current-parent="false">ISO/IEC</a></li><li class="nav-link"><a href="/en/data-governance/compliance/ny-state-shield/" aria-current="false" data-current-parent="false">NY State S.H.I.E.L.D</a></li><li class="nav-link"><a href="/en/data-governance/compliance/nycrr-500/" aria-current="false" data-current-parent="false">NYCRR 500</a></li><li class="nav-link"><a href="/en/data-governance/compliance/pci-dss/" aria-current="false" data-current-parent="false">PCI DSS</a></li><li class="nav-link"><a href="/en/data-governance/compliance/pipeda/" aria-current="false" data-current-parent="false">PIPEDA</a></li><li class="nav-link"><a href="/en/data-governance/compliance/tdpsa/" aria-current="false" data-current-parent="false">
141TDPSA</a></li><li class="nav-link"><a href="/en/data-governance/compliance/vcdpa/" aria-current="false" data-current-parent="false">VCDPA</a></li></ul></details></li></ul></details></li><li class="nav-group nav-group-top api "><details open><summary class="nav-group-title nav-group-title-top"><h2>Resources &amp; Support<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 1 16 16" width="20" height="20" aria-hidden="true"><path fill-rule="evenodd" d="M6.22 3.22a.75.75 0 011.06 0l4.25 4.25a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06-1.06L9.94 8 6.22 4.28a.75.75 0 010-1.06z"></path></svg></h2></summary><ul style="padding-left: 5px;"><li class="nav-link"><a href="/en/resources-support/get-support/" aria-current="false" data-current-parent="false">Get Support</a></li><li class="nav-link"><a href="/en/resources-support/community/" aria-current="false" data-current-parent="false">Community</a></li><li class="nav-link"><a href="/en/resources-support/contributing/" aria-current="false" data-current-parent="false">Contributing</a></li><li class="nav-link"><a href="/en/resources-support/faq/" aria-current="false" data-current-parent="false">FAQ</a></li><li class="nav-link"><a href="/en/resources-support/glossary/" aria-current="false" data-current-parent="false">Glossary</a></li><li class="nav-link"><a href="/en/resources-support/open-source/" aria-current="false" data-current-parent="false">Open Source</a></li><li class="nav-link"><a href="/en/resources-support/roadmap/" aria-current="false" data-current-parent="false">Roadmap</a></li></ul></details></li><li class="nav-group nav-group-top api "><details open><summary class="nav-group-title nav-group-title-top"><h2>Engineering<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 1 16 16" width="20" height="20" aria-hidden="true"><path fill-rule="evenodd" d="M6.22 3.22a.75.75 0 011.06 0l4.25 4.25a.75.75 0 010 1.06l-4.25 4.25a.75.75 0 01-1.06-1.06L9.94 8 6.22 4.28a.75.75 0 010-1.06z"></path></svg></h2></summary><ul style="padding-left: 5px;"><li class="nav-link"><a href="/en/engineering/overview/" aria-current="false" data-current-parent="false">Overview</a></li><li class="nav-link"><a href="/en/engineering/grpc/" aria-current="false" data-current-parent="false">gRPC</a></li><li class="nav-link"><a href="/en/engineering/metrics/" aria-current="false" data-current-parent="false">Metrics</a></li><li class="nav-link"><a href="/en/engineering/observability/" aria-current="false" data-current-parent="false">Observability</a></li><li class="nav-link"><a href="/en/engineering/quarantine/" aria-current="false" data-current-parent="false">Quarantine</a></li></ul></details></li>
142
143
144  </ul>
145</nav>
146
147<script type="95dbc2103aee66d9a880ee38-text/javascript">
148  window.addEventListener("DOMContentLoaded", () => {
149    const target = document.querySelector('[aria-current="page"]');
150    if (target && target.offsetTop > window.innerHeight - 100) {
151      document.querySelector(".nav-groups").scrollTop = target.offsetTop;
152    }
153  });
154</script>
154
155      </aside>
156      <div id="main-content" class="astro-OUAMJN2I">
157        <article id="article" class="content astro-J75B3YUS">
158  <section class="main-section astro-J75B3YUS">
159    <h1 class="content-title astro-J75B3YUS" id="overview">Instrumentation Guide</h1>
160    <nav class="block sm:hidden astro-J75B3YUS">
161      
161<script type="95dbc2103aee66d9a880ee38-text/javascript">(self.Astro=self.Astro||{}).media=(s,a)=>{const t=async()=>{await(await s())()};if(a.value){const e=matchMedia(a.value);e.matches?t():e.addEventListener("change",t,{once:!0})}},window.dispatchEvent(new Event("astro:media"));</script>
161<astro-island uid="ZIVs9J" component-url="/_astro/TableOfContents.2495ec14.js" component-export="default" renderer-url="/_astro/client.7a4f1478.js" props="{&quot;headings&quot;:[1,&quot;[[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;sdk-flow\&quot;],\&quot;text\&quot;:[0,\&quot;SDK flow\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;streamdal-client-configuration\&quot;],\&quot;text\&quot;:[0,\&quot;Streamdal Client Configuration\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;authentication\&quot;],\&quot;text\&quot;:[0,\&quot;Authentication\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;process-parameters\&quot;],\&quot;text\&quot;:[0,\&quot;Process() Parameters\&quot;]}],[0,{\&quot;depth\&quot;:[0,3],\&quot;slug\&quot;:[0,\&quot;how-the-sdk-parameters-defines-the-data-graph\&quot;],\&quot;text\&quot;:[0,\&quot;How the SDK parameters defines the Data Graph\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;golang-sdk-example\&quot;],\&quot;text\&quot;:[0,\&quot;Golang SDK Example\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;available-sdks\&quot;],\&quot;text\&quot;:[0,\&quot;Available SDKs\&quot;]}]]&quot;],&quot;class&quot;:[0,&quot;astro-J75B3YUS&quot;]}" ssr="" client="media" opts="{&quot;name&quot;:&quot;TableOfContents&quot;,&quot;value&quot;:&quot;(max-width: 50em)&quot;}" await-children=""><div><h2 class="heading">On this page</h2><ul><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
162              pl-4
163              "><a href="#overview" class="hover:no-underline hover:text-purple-bright 
164                text-white">Overview</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
165              pl-4
166              "><a href="#sdk-flow" class="hover:no-underline hover:text-purple-bright 
167                text-white">SDK flow</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
168              pl-4
169              "><a href="#streamdal-client-configuration" class="hover:no-underline hover:text-purple-bright 
170                text-white">Streamdal Client Configuration</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
171              pl-4
172              "><a href="#authentication" class="hover:no-underline hover:text-purple-bright 
173                text-white">Authentication</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
174              pl-4
175              "><a href="#process-parameters" class="hover:no-underline hover:text-purple-bright 
176                text-white">Process() Parameters</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
177              pl-8
178              "><a href="#how-the-sdk-parameters-defines-the-data-graph" class="hover:no-underline hover:text-purple-bright 
179                text-white">How the SDK parameters defines the Data Graph</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
180              pl-4
181              "><a href="#golang-sdk-example" class="hover:no-underline hover:text-purple-bright 
182                text-white">Golang SDK Example</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
183              pl-4
184              "><a href="#available-sdks" class="hover:no-underline hover:text-purple-bright 
185                text-white">Available SDKs</a></li></ul></div></astro-island>
186    </nav>
187    
188          
189
190<div class="addl-wrapper astro-3YLTYVKT">
191    <div class="addl astro-3YLTYVKT">
192    <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADUAAABBCAYAAABxVeynAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAu5SURBVHgB7VoLcFTVGf7u3s1uNg+yJATyAN1UQITEJNXaqK1smM4oSIcww8OpOgnWVggqQWvVztQm2g4405Z0EHDGKYQZ6tDOdNCpUKzigtpKgCaB4IOAyQbCIzFhNw/2fe/pf+7dXTbZV17KdsZv5uSce+69Z893v///zysCJgFbaphR9KBC1KBEAG5mDCVMgJHKxuBDDFYIlICTAkOzW8KRja8LVnwNEDBOcCLJPmyQATPUNB60EMH6ySY4ZlIBMhJQM0yJiYKhwSOhbjLIjYnUjifZbyadzAhogNp1rwl1mABGRWrLWmbSabGPiiX4JkD+R6qVj1c1TbwHtq9nlUlaNOObIsQhgH/E5q1PsgqMAzFJbSNzoyjW8HWaWwwYqXP7uMljjIhqftvUxmqRABirn0VU6hHzLi57LRIENGzUcjcY7fMRlDKatCJrfmrZO8bZeT9AAsHu8aF0NMEjTKkkkVm4D735QTWc7n4kEIz+CBwXw0hpNVO4H5l4+ergebxpqUaCoYR8vTbeQyHmZzSRSh0jH1h+7yYsvH0dEgh2jxYFG
192+sFe7QHgkoliZEDw8ETmxXVEghGnQ81sR7wkzKaaBiPGF24X+3794tIMGzgc9BoNxVSpJIZMdDasR/nLn2MBEJMtVSlBGxAHCRgNFwY7YZGMT3G4s7ruF8dObUDCQRzNBPUxDO9UBxp3ZFQaokSIk54NWR6YSoJQuQpISfEiSUKRBZ55aAh0ysOreCEGG0yRAM3wYQJ8UydKIwE+ZQw7EYsQhxcrYPHNyMhoEFxxGpR1Ji4OkLI5EKIsyDmIT4hfItFXudp5sy9BQZD8rAJE0MctTyxfUsg/UWRUhLNJ5PUMq8b/95VVEQkJXR397Cap5/D4cMfwWazQ5IkjAYGfQZeeviUkvO4wjudpAd0BiAzh1IulZPVZ71u+hDXgCtfAm4nJQeg/AzDhLH+tfCoptWKSfY39zYY9+zZi9++8iounO+C1+uN25jLM4APT+/A0ntegCEdmDkXmHUbkHcLlGuXyw23y6M8y/tuNKbDR5dXaMp8phHoaiOiQ7QAHN03HBO069bU2lc9vMS4YsVyFBcX4cVfvoRPGo9haHAoatDgPpicnAzrwAHMK3sB8+8FUqe6cfxoK97d2YazZzpx6WIPPERKpja0tHNjMBhQdPtszJlnQvnSuzC3OwNN7wHdVsDnw/hUU3d8w6vvLl69Ly0tpaLkjvl4/tePUydop/Kp5/D++xb02/vD/Eur1WLqVCOWVSzF+vU/R15ePg69+wkOvPMRLnX1wOlwkdI+5Vn+UXgKjHsUlKDX6zAlIw0P/PiHWPzA/fj0kBEXzkBRcRw4TOZXPrJSzM+ef7fH6y27fPErHH6/ETNyslHzzFqFyqlTrXC71V8LqFNYtACbNtWhev0T+PjISfz+dztxxHIC3Zd74SJCPnKWAJmRkGWmEL425MTnp7/EB4c+xneKNcieMgdDNvoIMsaKtw8cqzsYRipvxoIcYlAhSTKGhq6hpelzOBxuVD9VhWnTsnD06DF4PB6kp6dh0aL7sOcvf0ZGehY21b2BA//4EH29dgoEqpkNh4S+/k44XANISQ4PUj6fRKq6cbr1DL4aakWmvhBaIQVjAe3Dv77/eN3JMFLT8+ZatUz7ArcQ5Ut6vDjbdh6ftZ7DE9WPIi8/B2fPnsPadY9j0+ZXyNQ
192a8YfNu3CurVMJBJEU4apesjXhR/eXofGEBX32LmRPLRh2n4O/6yPlenv7cL63CfNmlVEnkjFaaCRs3H+iLmwFrLT+/cKVFvolc6CS/xi3/aLiOXj51Q0U6vswc2Y+tv9pL947+B/ytUH6AOG2whvjFD0+JxxyG7Zu3YrVq1fT+zaU3LoUet1wJdJTNFi1NBulRdkoLqIxQEzF4OA08s08tLXOwpXzUxADLeRPpZFuKKTKClfV0k5s2E4oDwqFFLGeffEx7N2zH5b3jsHpdCIgTrR5oiR58VnHv2i6IlBod0EU9CiZ9+CwZ366IhWrHsxGWno6mCaVPnuqkjOR52mUUjDUn47mj/Jw9lRWeMcZqqq3CbujkiopqTDqJF1HYHs58MV5nqRLQmqaQbF/HjTizQ0DcHuu4cuu46BxEDOnz0eKYapSn54i4NVnklG6IC2ERAgpgcqi/55GNcVzRKrpw1wiqQ+2r/GhYF2UPUCR/7ly5QvXrJwFNBcIX1vxAOJyuhXHjoWRyxWtqCM/MiHLeBOSkgzB+ucf02HhnfxntXw1R+/RPIonKtMnpLJOLSv1Wt4ysnJcuPlWOzrPGOFxa5WzrOodkVVSCAcKLo2nnjSIuu0Uj1CogsoE2U8ylOyD92mVpNbL/hjuT/6yELyWELBz3nZahgdLHmmj3M0DRMx9dTFQUNSaTmoJ4zvqjLawDCAtORuLSpZiWoYAnc4BUSupKgUUUlTTkQhav0qBdH2/VZcsYdZsW535sZy3YvZlZMVdt69sFpgwqrOoSIEiUt1t+UtQbFoBnTY1WJeVdYHGwcvIm3kBWdPtyJw+GOJL15NC7HrrVkPuHQVx+zWyoqzkIZMsyc1jOZOKtVq+99Zq3JKzMG4ber0bmdlXkTWjH7k39dNM34tUfkKlUYMDdw0BYqkht9Qar62INlNWtLKKZmy7MEEU37xSUWi84P6TmeMkkoMourNnuT7/zrdG854YqbKr57MWioacsBnjRCr5UHnhLzAR8EjX35eMi+0ZdXc/lP/6aN8To93o6v70MAUOIVrgiBcY7ppdhcw0EyYBdTRzqB3LCzHPfI+e/lstg7Qc/lAfSiTqIOyvnpExHxOBMrzIWDNWQhxxT+ePtf79LUHUlBIjaywigXt8/cXDN0+RoKdxOD0T8dAi0qnh+u1CA8aBuKQ4jrbstTae+msBzbfqVClYyJqJ01Ant4wGUH6Vqp8WtS2+h7H4Z5GJcXWopbrqrShfu8NrZF6nmXkHzYzZgpGY2S4jHsa8v6OGfF8t9b8y2BUML+UaF+CB0uiD/qO1an78n8AXjSqZVCN2r3wWjPJldKuAfyDIPj6zoKKX51Ym+Y6IHullnyhZtZKXCVMLJodUkNy8CpOk0ZgZPzHh27/KLFillWMsxOLvvhz13e8tprRELXucisAn9anKbmvo2EgG4BMYEZM5Kb5DQ2WVoFxPpPgP2CIRm5SduBIiSHZsFtR9+eIphlzTinu2m673jgZORo4voIUuO425aPnJrxA4Xw4sCAJ5CC0+ByRSks9PiCvno4/AyXqtSTJb5AI6DCOITf724ihB/miizAJE3A/3EyQPVRVinBwnRSbICfkJSlaJYRGR6gh9eVSB4usADQ9Wynhi/gSr1crWrFmD3bt3+z82n+1rlIeZoKELnngmMp74OYAIttNjO4eEAFeKDYdsNpsDBFlzc7NSx2jjhJQht3IwyT3AfM6rzHeth3mHLjHvwHnmsbfLRKoytO0bphTU/0obNvBlZGQEy0ajughXWWq4UsoyRAjk/BRKObQh9aCpYrbrFnijSQUChOJDDQ0NbNeuXbBYLDCZTGhvb8fGjRtB9QoZQSCT85NiyrWgUCCHMyOyb36zINOqUcxrhAmGXlRWVgbN0WI5RJvHbiZ7hsgM+2Wfo5dM8AqZYBfz9ndyE6wKtH0jleLhPTT6hoZ0hUhgW0A9P1MUYjb7ADo6OoWAKSoBg+7TQdsknKFMECSEkZKNhSOoFu0Xsvr6elLJolw3N/03qNzON7YxydEr+0gtz8AF5hu4uAyJAOrnlhASckiKiC1btgRJPf3kOjUSOnpk7+Al2Wm7bEIiwK/WVRYd8kjlysvNrNy8kLW3fcokl535fasJiQTqa1UEhSIpFlRSlihgeB2yzMctRx8p1l2JRAN1tJbFMLsw+WjaJHmdPBLKXqetFokK6utCSu2UpBHqRCAl0dTPLUtexx+R6GCqj9X4yckjCDL/NU8fMK/XHK2dGzZLjwfquJky/s8fJkp8/sT/ccNK6W3/ZPhb/N/jf3GNg9mm/rW3AAAAAElFTkSuQmCC" class="uimage astro-3YLTYVKT">
193        <div class="addlcontent astro-3YLTYVKT">
194        We're updating our documentation, so the presented info might not be the
195        most recent.
196        </div>
197    </div>
198</div>
199<p>The <a href="/en/core-components/sdk/">SDK</a> should initiliazed in your application
200where data consumption or production takes place. The SDK is responsible for
201sending data to the Streamdal <a href="/en/core-components/server/">server</a>, which then
202processes it and returns a response.</p>
203<h2 id="sdk-flow">SDK flow</h2>
204<ol>
205<li><strong>Initializing Streamdal Client:</strong> The SDK’s streamdal.New() method is invoked with a configuration object, initializing a new Streamdal client.</li>
206<li><strong>Processing a Request:</strong> The sc.Process() method processes a request using the Streamdal client, detailing operation specifics and data to be handled.</li>
207<li><strong>Error Handling (Again):</strong> Errors from the processing method are checked similarly.</li>
208</ol>
209<h2 id="streamdal-client-configuration">Streamdal Client Configuration</h2>
210<div class="notification type-note astro-HKT2ATHB">
211  <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAYAAAA6/NlyAAAC/ElEQVR4Xu2bvW7bMBDH/Qh9hO76gKbIVBMgQLLHo8V2yNCsad4gBgp0bNwHKNqxS5G+AYG+QB/Be5c8gsqjrCY6UrVlkUdKzQE/ILAoi3/zdLo7MbOZIzvNFi9OsnLB0tc3RcS/sLT8xVK+YXFZtag/Eyzm90XKV8fZm1M4F39fkAYTnafL21oAEtYfAT/WPFu+xNfxbrAqaoL6pG0h4Br4uuRGILRNVG5YUi7wPJwbuBmjFIqAmEDm6jLIvMvj8gFPghy52kWyvMTzs2YQkGSkvdMu7Jk8Ke/wXAebEhvLx4rhgkEgH3nWXFzdr5Hh+Rka0sUHix6N2AYpelDSwkJ24y6kex8kOsQAtS+9A1mR8Ev8JaNDpqVYl9FGd99287BXEFOVjX7yWBFYX8uOoJzTTxo1x/E/io6JuDLGvMrbygcPtsrF2XX16cP3FjdXH7VxtjGuMiOofq74++r3pmrx7fNPbZwD2qu8LffwIOt4FFy1khF4ZuEBLvApeJ7y1aNgAncGfApmjVtndemHDzrBs+DarSmic4NvwaofBr1g7YAjvAuG/Fr+ca8dcIRvwZA2kwUswLfgXNbKpOmkb8HQEYEV1g84wrtgybNglzwL9iL4vwta8KIaH3DIxfl1i/P8rTbGIQIEfzUcmCYR/0FWGoYApNEzSKjxgamiWj2U5aFv/nY9GFE+7TlKP/a1qEpEr4KfvnqhcmufgrXXLozArT0K1pvxEMEMA60CSQaIfgo0
2115/E42xgb8WCMYJXJSWU62WUUq0zNya6NbGxCq6x6WLsMolkQG8+GkvbY1fNqAvl171168qQ1/pIRscZ6dppKRohrZStAK/ZQq0XTdUQG0+e+7TL17ngMom2IbawWHbB7H7r7bpexMAPZ2onYxtQuvQBcPE9lrhDtudtuqCkXT7w2/4S1+7WPqX4Y7WqLzsqH0rZFhzBM0BZhCMVWR3OVlgrDpPsiipivnAYkmwYThVWp+2UcdhkIo/vDZ/KxUv+7nvyx5G3iUuQfLKQ9+sH09+IAAAAASUVORK5CYII=" alt="Note" width="30px" height="30px"/><div class="prose-md prose-p:my-2 prose-a:text-purple-dark prose-a:underline"><p>This example uses the Golang SDK.</p><p style="font-weight: normal">The configuration parameters are similar across all SDKs, but the syntax may vary slightly.</p></div>
212</div>
213<p>When initializing the Streamdal client with <code>streamdal.New()</code>, you pass a configuration object to customize its behavior. Here’s a breakdown of the parameters in that configuration:</p>
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267<table><thead><tr><th>Parameter</th><th>Description</th><th>Example</th><th>Required?</th></tr></thead><tbody><tr><td><strong>StreamdalURL</strong></td><td>The URL of the Streamdal server instance.</td><td><code>&quot;localhost:8082&quot;</code></td><td>✅</td></tr><tr><td><strong>StreamdalToken</strong></td><td>The authentication token for the Streamdal server.</td><td><code>&quot;streamdal&quot;</code></td><td>✅</td></tr><tr><td><strong>ServiceName</strong></td><td>A name that represents the specific service in your infrastructure using this client.</td><td><code>&quot;billing-svc&quot;</code></td><td>✅</td></tr><tr><td><strong>StepTimeout</strong></td><td>Sets the maximum duration for Wasm execution in each step.</td><td><code>time.Millisecond * 10</code></td><td>❌</td></tr><tr><td><strong>PipelineTimeout</strong></td><td>Defines the total allowable execution time for the entire <a href="/en/guides/pipelines/">pipeline</a>.</td><td><code>time.Millisecond * 100</code></td><td>❌</td></tr><tr><td><strong>DryRun</strong></td><td>A switch to toggle between actual execution and a logging-only mode. If set to true, it won’t actually execute but will only log.</td><td><code>false</code></td><td>❌</td></tr><tr><td><strong>ShutdownCtx</strong></td><td>Context used to manage the lifecycle and potential shutdown of the Streamdal client.</td><td><code>context.Background()</code></td><td>❌</td></tr></tbody></table>
268<p>Alternatively, you can also configure many of these settings via environment variables. Refer to the <a href="https://github.com/streamdal/streamdal/blob/main/sdks/go/README.md">Go SDK README</a> for more details.</p>
269<h2 id="authentication">Authentication</h2>
270<p>All of the SDKs will require you to provide a “Streamdal (Auth) Token” as one of the parameters in the configuration object.
271This token is used to authenticate the SDK in your app with the Streamdal server.</p>
272<p>This is the same token as the <code>STREAMDAL_SERVER_AUTH_TOKEN</code> environment variable that you set when running the Streamdal server.</p>
273<h2 id="process-parameters">Process() Parameters</h2>
274<p>Let’s delve into the specifics of the <code>Process()</code> method:</p>
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310<table><thead><tr><th>Attribute</th><th>Description</th><th>Type</th><th>Required?</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>A descriptive name related to the producer or consumer in focus. For instance: <code>billing-processor</code>, <code>db-flusher</code>, or <code>doc-handler</code>.</td><td>String</td><td>✅ Yes</td></tr><tr><td><strong>Operation</strong></td><td>Specifies the nature of the operation, whether it’s a consumer or producer.</td><td>Enum</td><td>✅ Yes</td></tr><tr><td><strong>Component</strong></td><td>Represents the data source or destination. Examples include <code>main-kafka</code>, <code>slow-db</code>, or <code>salesforce-api</code>.</td><td>String</td><td>✅ Yes</td></tr><tr><td><strong>Data</strong></td><td>The actual data payload that’s being consumed or produced.</td><td>Byte array</td><td>✅ Yes</td></tr></tbody></table>
311<h3 id="how-the-sdk-parameters-defines-the-data-graph">How the SDK parameters defines the <a href="/en/resources-support/glossary#data-graph" class="pkeyword">Data Graph</a></h3>
312<center><img src="/_astro/DataGraphSdk.d939bda8.png" alt="Audience"/></center>
313<h2 id="golang-sdk-example">Golang SDK Example</h2>
314<p>Using the <a href="/en/core-components/sdk/">SDK</a> in your Golang applications is
315straightforward. Here’s a simple example to get you started:</p>
316<pre class="astro-code" style="background-color:#0d1117;overflow-x:auto"><code><span class="line"><span style="color:#FF7B72">package</span><span style="color:#C9D1D9"> </span><span style="color:#FFA657">main</span></span>
317<span class="line"></span>
318<span class="line"><span style="color:#FF7B72">
318import</span><span style="color:#C9D1D9"> (</span></span>
319<span class="line"><span style="color:#C9D1D9">	</span><span style="color:#A5D6FF">&quot;</span><span style="color:#FFA657">context</span><span style="color:#A5D6FF">&quot;</span></span>
320<span class="line"><span style="color:#C9D1D9">	</span><span style="color:#A5D6FF">&quot;</span><span style="color:#FFA657">fmt</span><span style="color:#A5D6FF">&quot;</span></span>
321<span class="line"><span style="color:#C9D1D9">	</span><span style="color:#A5D6FF">&quot;</span><span style="color:#FFA657">time</span><span style="color:#A5D6FF">&quot;</span></span>
322<span class="line"></span>
323<span class="line"><span style="color:#C9D1D9">	</span><span style="color:#A5D6FF">&quot;</span><span style="color:#FFA657">github.com/streamdal-go-client</span><span style="color:#A5D6FF">&quot;</span></span>
324<span class="line"><span style="color:#C9D1D9">)</span></span>
325<span class="line"></span>
326<span class="line"><span style="color:#FF7B72">func</span><span style="color:#C9D1D9"> </span><span style="color:#D2A8FF">main</span><span style="color:#C9D1D9">() {</span></span>
327<span class="line"><span style="color:#C9D1D9">	ctx, cancel </span><span style="color:#FF7B72">:=</span><span style="color:#C9D1D9"> context.</span><span style="color:#79C0FF">WithCancel</span><span style="color:#C9D1D9">(context.</span><span style="color:#79C0FF">Background</span><span style="color:#C9D1D9">())</span></span>
328<span class="line"><span style="color:#C9D1D9">	</span><span style="color:#FF7B72">defer</span><span style="color:#C9D1D9"> </span><span style="color:#79C0FF">cancel</span><span style="color:#C9D1D9">()</span></span>
329<span class="line"></span>
330<span class="line"><span style="color:#C9D1D9">	sc, err </span><span style="color:#FF7B72">:=</span><span style="color:#C9D1D9"> streamdal.</span><span style="color:#79C0FF">New</span><span style="color:#C9D1D9">(</span><span style="color:#FF7B72">&amp;</span><span style="color:#C9D1D9">streamdal.Config{</span></span>
331<span class="line"><span style="color:#C9D1D9">		StreamdalURL:     </span><span style="color:#A5D6FF">&quot;localhost:8082&quot;</span><span style="color:#C9D1D9">,</span></span>
332<span class="line"><span style="color:#C9D1D9">		StreamdalToken:   </span><span style="color:#A5D6FF">&quot;streamdal&quot;</span><span style="color:#C9D1D9">,</span></span>
333<span class="line"><span style="color:#C9D1D9">		ServiceName:     </span><span style="color:#A5D6FF">&quot;billing-svc&quot;</span><span style="color:#C9D1D9">,</span></span>
334<span class="line"><span style="color:#C9D1D9">		ShutdownCtx:     ctx,</span></span>
335<span class="line"><span style="color:#C9D1D9">	})</span></span>
336<span class="line"><span style="color:#C9D1D9">	</span><span style="color:#FF7B72">if</span><span style="color:#C9D1D9"> err </span><span style="color:#FF7B72">!=</span><span style="color:#C9D1D9"> </span><span style="color:#79C0FF">nil</span><span style="color:#C9D1D9"> {</span></span>
337<span class="line"><span style="color:#C9D1D9">		</span><span style="color:#79C0FF">panic</span><span style="color:#C9D1D9">(err)</span></span>
338<span class="line"><span style="color:#C9D1D9">	}</span></span>
339<span class="line"></span>
340<span class="line"><span style="color:#C9D1D9">	resp, err </span><span style="color:#FF7B72">:=</span><span style="color:#C9D1D9"> sc.</span><span style="color:#79C0FF">Process</span><span style="color:#C9D1D9">(ctx, </span><span style="color:#FF7B72">&amp;</span><span style="color:#C9D1D9">streamdal.ProcessRequest{</span></span>
341<span class="line"><span style="color:#C9D1D9">		OperationType: streamdal.OperationTypeConsumer,</span></span>
342<span class="line"><span style="color:#C9D1D9">		OperationName: </span><span style="color:#A5D6FF">&quot;new-order-topic&quot;</span><span style="color:#C9D1D9">,</span></span>
343<span class="line"><span style="color:#C9D1D9">		ComponentName: </span><span style="color:#A5D6FF">&quot;kafka&quot;</span><span style="color:#C9D1D9">,</span></span>
344<span class="line"><span style="color:#C9D1D9">		Data:          []</span><span style="color:#79C0FF">byte</span><span style="color:#C9D1D9">(</span><span style="color:#A5D6FF">`{&quot;object&quot;: {&quot;field&quot;: true}}
344`</span><span style="color:#C9D1D9">),</span></span>
345<span class="line"><span style="color:#C9D1D9">	})</span></span>
346<span class="line"><span style="color:#C9D1D9">	</span><span style="color:#FF7B72">if</span><span style="color:#C9D1D9"> err </span><span style="color:#FF7B72">!=</span><span style="color:#C9D1D9"> </span><span style="color:#79C0FF">nil</span><span style="color:#C9D1D9"> {</span></span>
347<span class="line"><span style="color:#C9D1D9">		</span><span style="color:#79C0FF">panic</span><span style="color:#C9D1D9">(err)</span></span>
348<span class="line"><span style="color:#C9D1D9">	}</span></span>
349<span class="line"></span>
350<span class="line"><span style="color:#C9D1D9">	fmt.</span><span style="color:#79C0FF">Printf</span><span style="color:#C9D1D9">(</span><span style="color:#A5D6FF">&quot;</span><span style="color:#79C0FF">%#v\n</span><span style="color:#A5D6FF">&quot;</span><span style="color:#C9D1D9">, resp)</span></span>
351<span class="line"><span style="color:#C9D1D9">}</span></span></code></pre>
352<h2 id="available-sdks">Available SDKs</h2>
353<p>The SDK is currently available in the following languages:</p>
354<ul>
355<li><strong><a href="https://github.com/streamdal/streamdal/tree/main/sdks/go">Go</a></strong></li>
356<li><strong><a href="https://github.com/streamdal/streamdal/tree/main/sdks/node">Node</a></strong></li>
357<li><strong><a href="https://github.com/streamdal/streamdal/tree/main/sdks/python">Python</a></strong></li>
358<li><strong><a href="https://github.com/streamdal/streamdal/tree/main/sdks/ruby">Ruby</a></strong></li>
359</ul>
360<hr/>
361<p>With this guide at your side, integrating Streamdal into your operations
362becomes a piece of cake. Remember, the true magic unfolds when Streamdal’s
363capabilities meld seamlessly with your application’s data flows. So, jump in,
364integrate, and watch your data operations transform!</p>
365        
366  </section>
367  
368</article>
369      </div>
370      <aside id="right-sidebar" class="sidebar astro-OUAMJN2I" title="Table of Contents">
371        <nav class="sidebar-nav astro-ROIVMLUZ" aria-labelledby="grid-right">
372  <div class="sidebar-nav-inner astro-ROIVMLUZ">
373    <astro-island uid="20uclY" component-url="/_astro/TableOfContents.2495ec14.js" component-export="default" renderer-url="/_astro/client.7a4f1478.js" props="{&quot;headings&quot;:[1,&quot;[[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;sdk-flow\&quot;],\&quot;text\&quot;:[0,\&quot;SDK flow\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;streamdal-client-configuration\&quot;],\&quot;text\&quot;:[0,\&quot;Streamdal Client Configuration\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;authentication\&quot;],\&quot;text\&quot;:[0,\&quot;Authentication\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;process-parameters\&quot;],\&quot;text\&quot;:[0,\&quot;Process() Parameters\&quot;]}],[0,{\&quot;depth\&quot;:[0,3],\&quot;slug\&quot;:[0,\&quot;how-the-sdk-parameters-defines-the-data-graph\&quot;],\&quot;text\&quot;:[0,\&quot;How the SDK parameters defines the Data Graph\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;golang-sdk-example\&quot;],\&quot;text\&quot;:[0,\&quot;Golang SDK Example\&quot;]}],[0,{\&quot;depth\&quot;:[0,2],\&quot;slug\&quot;:[0,\&quot;available-sdks\&quot;],\&quot;text\&quot;:[0,\&quot;Available SDKs\&quot;]}]]&quot;],&quot;class&quot;:[0,&quot;astro-ROIVMLUZ&quot;]}" ssr="" client="media" opts="{&quot;name&quot;:&quot;TableOfContents&quot;,&quot;value&quot;:&quot;(min-width: 50em)&quot;}" await-children=""><div><h2 class="heading">On this page</h2><ul><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
374              pl-4
375              "><a href="#overview" class="hover:no-underline hover:text-purple-bright 
376                text-white">Overview</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
377              pl-4
378              "><a href="#sdk-flow" class="hover:no-underline hover:text-purple-bright 
379                text-white">SDK flow</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
380              pl-4
381              "><a href="#streamdal-client-configuration" class="hover:no-underline hover:text-purple-bright 
382                text-white">Streamdal Client Configuration</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
383              pl-4
384              "><a href="#authentication" class="hover:no-underline hover:text-purple-bright 
385                text-white">Authentication</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
386              pl-4
387              "><a href="#process-parameters" class="hover:no-underline hover:text-purple-bright 
388                text-white">Process() Parameters</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
389              pl-8
390              "><a href="#how-the-sdk-parameters-defines-the-data-graph" class="hover:no-underline hover:text-purple-bright 
391                text-white">How the SDK parameters defines the Data Graph</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
392              pl-4
393              "><a href="#golang-sdk-example" class="hover:no-underline hover:text-purple-bright 
394                text-white">Golang SDK Example</a></li><li class="list-none pt-1 pb-1 pr-4 border-l-4 border-purple-divider hover:border-purple-bright active:border-purple-bright
395              pl-4
396              "><a href="#available-sdks" class="hover:no-underline hover:text-purple-bright 
397                text-white">Available SDKs</a></li></ul></div></astro-island>
398  </div>
399</nav>
400      </aside>
401    </main>
vendor: 150 bytes, lines 401-403
401
402    
403  <script src="/cdn-cgi/scripts/7d0fa10a/cloudflare-static/rocket-loader.min.js" data-cf-settings="95dbc2103aee66d9a880ee38-|49" defer></script>
403<script type="module" src="https://static.cloudflareinsights.com/beacon.min.js/v31edd6df95cf4e85bb4c19e7a9bdbcba1788362987495" integrity="sha512-iIg7k2xntmwu6/uSb5tpc/hySgZc4eoL31yB29W6tJFo2akwjPWcEqnCEdJvGexCL0KEQwVYv5BlowfhVz26hg==" data-cf-beacon='{"version":"2024.11.0","token":"809c58bfcb6149aa9a09d6f11b367de9","r":1,"spa":2}' crossorigin="anonymous"></script>
403
404</body>
405</html>

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.