feat: add telemetry information and opt-out options across SDKs (#560)

Author: CahidArda

qstash/sdks/ts/gettingstarted.mdx

@@ -45,3 +45,22 @@ const client = new Client({
   },
 });
 ```
+
+## Telemetry
+
+This sdk sends anonymous telemetry headers to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Cloudflare, AWS or Vercel)
+- Runtime version ([email protected])
+
+You can opt out by setting the `UPSTASH_DISABLE_TELEMETRY` environment variable
+to any truthy value. Or setting `enableTelemetry: false` in the client options.
+
+```ts
+const client = new Client({
+  token: "<QSTASH_TOKEN>",
+  enableTelemetry: false,
+});
+```

redis/sdks/py/features.mdx

@@ -95,3 +95,21 @@ result = pipeline.exec()
 print(result)
 # prints [True, 2, '2']
 ```
+
+# Telemetry
+
+This library sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Vercel, AWS)
+- Python Runtime version
+
+You can opt out by passing `allow_telemetry=False` when initializing the Redis client:
+
+```py
+redis = Redis(
+  # ...,
+  allow_telemetry=False,
+)
+```

redis/sdks/ts/advanced.mdx

@@ -53,3 +53,28 @@ try {
   }
 }
 ```
+
+## Telemetry
+
+This library sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Deno, Cloudflare, Vercel)
+- Runtime version ([email protected])
+
+You can opt out by setting the `UPSTASH_DISABLE_TELEMETRY` environment variable
+to any truthy value.
+
+```sh
+UPSTASH_DISABLE_TELEMETRY=1
+```
+
+Alternatively, you can pass `enableTelemetry: false` when initializing the Redis client:
+
+```ts
+const redis = new Redis({
+  // ...,
+  enableTelemetry: false,
+});
+```

search/sdks/py/gettingstarted.mdx

@@ -83,4 +83,23 @@ index.upsert(
         },
     ],
 )
-```
+```
+
+## Telemetry
+
+This sdk sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Cloudflare, AWS or Vercel)
+- Runtime version (python@vX)
+
+You can opt out using the allow_telemetry flag when creating the client:
+
+```ts
+client = Search(
+    url="UPSTASH_SEARCH_REST_URL",
+    token="UPSTASH_SEARCH_REST_TOKEN",
+    allow_telemetry=False,
+)
+```

search/sdks/ts/getting-started.mdx

@@ -123,3 +123,27 @@ const results = await index.upsert<Content>({
   content: { title: "Movie title", ... }
 });
 ```
+
+## Telemetry
+
+This sdk sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Cloudflare, AWS or Vercel)
+- Runtime version ([email protected])
+
+You can opt out by setting the `UPSTASH_DISABLE_TELEMETRY` environment variable
+to any truthy value.
+
+```sh
+UPSTASH_DISABLE_TELEMETRY=1
+```
+
+Alternatively, you can disable telemetry programmatically:
+
+```ts
+const index = client.index("movies", {
+  enableTelemetry: false,
+});
+```

vector/sdks/py/features.mdx

@@ -17,4 +17,19 @@ from upstash_vector import Index
 
 # Try 5 times with a 2-second interval between retries
 index = Index.from_env(retries=5, retry_interval=2.0)
-```
+```
+
+# Telemetry
+
+This library sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Vercel, AWS)
+- Python Runtime version
+
+You can opt out by passing `allow_telemetry=False` when initializing the Redis client:
+
+```py
+idx = Index("INDEX_URL", "INDEX_TOKEN", allow_telemetry=False)
+```

vector/sdks/ts/advanced.mdx

@@ -24,3 +24,19 @@ try {
   }
 }
 ```
+
+## Telemetry
+
+This sdk sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Cloudflare, AWS or Vercel)
+- Runtime version ([email protected])
+
+You can opt out by setting the `UPSTASH_DISABLE_TELEMETRY` environment variable
+to any truthy value.
+
+```sh
+UPSTASH_DISABLE_TELEMETRY=1
+```

workflow/basics/client/trigger.mdx

@@ -91,6 +91,13 @@ You can also trigger multiple workflow runs in a single call by passing an array
   This can be useful for identifying and filtering runs in the dashboard or logs.
 </ParamField>
 
+<ParamField body="disableTelemetry" type="boolean">
+  If set to true, telemetry data collection for this workflow run will be disabled.
+  By default, telemetry is enabled to help improve Upstash services.
+
+  See the [`disableTelemetry` parameter in serve options](/workflow/basics/serve/advanced#param-disable-telemetry) for more details.
+</ParamField>
+
 ## Usage
 <CodeGroup>
 ```ts Single Workflow

workflow/basics/serve/advanced.mdx

@@ -232,6 +232,33 @@ Advanced Options are intended to support edge cases or testing pipelines and are
 
 </ParamField>
 
+<ParamField path="schema" type="z.ZodType">
+    Alternative to `initialPayloadParser`, you can pass a `schema` in the TypeScript SDK.
+
+    The schema is used to validate and parse the initial request payload automatically using [Zod](https://zod.dev/).
+    
+    <CodeGroup>
+
+    ```typescript TypeScript
+
+    import { z } from "zod";
+
+    const parameters = z.object({ expression: z.string() });
+
+    export const { POST } = serve(
+      async (context) => {
+        // context.requestPayload is typed as `{ expression: string }`
+        const payload = context.requestPayload;
+      },
+      {
+        schema: parameters,
+      }
+    );
+    ```
+
+    </CodeGroup>
+</ParamField>
+
 <ParamField path="url" type="string">
     Specifies the full endpoint URL of the workflow, including the route path.
 
@@ -460,3 +487,38 @@ async def example(context: AsyncWorkflowContext[str]) -> None:
 </ParamField>
 
 
+<ParamField path="disableTelemetry" type="boolean">
+    Disables anonymous telemetry data collection for this workflow endpoint. Since we don't collect telemetry
+    in Python SDK, this option is only available in the TypeScript SDK.
+
+    By default, the Upstash Workflow SDK collects anonymous telemetry data to help improve the service.
+    The collected data includes:
+
+    - SDK version
+    - Platform (Vercel, AWS, etc.)
+    - Runtime version (Node.js, Python, etc.)
+
+    Set `disableTelemetry` to `true` to opt out of telemetry for this specific workflow endpoint.
+
+    <CodeGroup>
+
+        ```typescript TypeScript
+        export const { POST } = serve<string>(
+          async (context) => { ... },
+          {
+            disableTelemetry: true
+          }
+        );
+        ```
+
+        ```python Python
+        @serve.post("/api/example", disable_telemetry=True)
+        async def example(context: AsyncWorkflowContext[str]) -> None: ...
+        ```
+    </CodeGroup>
+
+    <Tip>
+        You should also
+        set [`disableTelemetry` when triggering workflow runs via `client.trigger()`](/workflow/basics/client/trigger#param-disable-telemetry) to fully disable telemetry
+    </Tip>
+</ParamField>

workflow/features/invoke.mdx

@@ -7,9 +7,6 @@ This allows to orchestrate multiple workflows together without external synchron
 
 When you use `context.invoke`, invoking workflow will wait until the invoked workflow finishes before running the next step.
 
-
-
-
 ```typescript
 const {
   body,      // response from the invoked workflow