Skip to content

Commit 29ccf71

Browse files
reordering troubleshooting
1 parent 79be8f3 commit 29ccf71

File tree

3 files changed

+80
-95
lines changed

3 files changed

+80
-95
lines changed

docs-v2/pages/troubleshooting/index.mdx renamed to docs-v2/pages/troubleshooting.mdx

Lines changed: 80 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ This doc describes some common solutions for fixing issues with [pipedream.com](
88

99
Start by filling out the request form at [https://pipedream.com/support](https://pipedream.com/support), providing detailed information about your issue.
1010

11+
### How do I share my workflow with Support?
12+
13+
First, navigate to your **Project Settings** and share your project with Pipedream Support.
14+
15+
If your workflow is _not_ part of a Project, go to the **Workflow Settings** to grant access to us.
16+
17+
When filling out the request form at [https://pipedream.com/support](https://pipedream.com/support), please provide detailed information along with the URL from your browser's address bar, which should look something like:
18+
19+
```
20+
https://pipedream.com/@yourworkspace/workflows/projects/yourproject/test-workflow-pabc123
21+
```
22+
1123
## A feature isn't working on pipedream.com
1224

1325
If you're seeing an issue with [pipedream.com](https://pipedream.com) (for example, the site won't load, or you think you've found a bug), try each of the following steps, checking to see if they fix the problem:
@@ -20,6 +32,10 @@ If you're seeing an issue with [pipedream.com](https://pipedream.com) (for examp
2032

2133
If you're still seeing the issue after trying these steps, please [report a bug](https://github.com/PipedreamHQ/pipedream/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D+).
2234

35+
## I need help with my GitHub Synced Project
36+
37+
[See FAQ here](/workflows/git/#faq).
38+
2339
## My workflow isn't working
2440

2541
If you're encountering a specific issue in a workflow, try the following steps, checking to see if they fix the problem:
@@ -30,9 +46,11 @@ If you're encountering a specific issue in a workflow, try the following steps,
3046

3147
If you're still seeing the issue after trying these steps, please reach out in [the community](https://pipedream.com/support).
3248

33-
## I need help with my GitHub Synced Project
49+
## How do I invoke another workflow?
3450

35-
[See FAQ here](/workflows/git/#faq).
51+
We provide a [Trigger Workflow](https://pipedream.com/apps/helper-functions/actions/trigger-workflow) action in the [Helper Functions](https://pipedream.com/apps/helper-functions) app. [See more here](/workflows/building-workflows/code/nodejs/#invoke-another-workflow).
52+
53+
Another option is to make an HTTP request to a Pipedream HTTP webhook trigger.
3654

3755
## Why is my trigger not emitting events?
3856

@@ -56,22 +74,6 @@ These sources will fetch new events on a regular interval, based on a schedule y
5674

5775
In most cases, Pipedream will automatically fetch recent historical events to help enable easier workflow development. Sources for apps like [Twitter](https://pipedream.com/apps/twitter/triggers/search-mentions) and [Spotify](https://pipedream.com/apps/spotify/triggers/new-playlist) require we poll their endpoints in order to fetch new events.
5876

59-
## Where do I find my workflow's ID?
60-
61-
Open [https://pipedream.com](https://pipedream.com) and visit your workflow. Copy the URL that appears in your browser's address bar. For example:
62-
63-
```
64-
https://pipedream.com/@dylburger/p_abc123/edit
65-
```
66-
67-
Your workflow's ID is the value that starts with `p_`. In this example: `p_abc123`.
68-
69-
## How do I invoke another workflow?
70-
71-
We provide a [Trigger Workflow](https://pipedream.com/apps/helper-functions/actions/trigger-workflow) action in the [Helper Functions](https://pipedream.com/apps/helper-functions) app. [See more here](/workflows/building-workflows/code/nodejs/#invoke-another-workflow).
72-
73-
Another option is to make an HTTP request to a Pipedream HTTP webhook trigger.
74-
7577
## Where do I find my event source's ID?
7678

7779
Open [https://pipedream.com/sources](https://pipedream.com/sources) and click on your event source. Copy the URL that appears in your browser's address bar. For example:
@@ -92,22 +94,37 @@ To troubleshoot, you can look at the errors in the [source](/workflows/building-
9294

9395
Pipedream displays warnings below steps in certain conditions. These warnings do not stop the execution of your workflow, but can signal an issue you should be aware of.
9496

95-
## Limit Exceeded Errors
97+
### Code was still running when the step ended
9698

97-
Pipedream sets [limits](/workflows/limits/) on runtime, memory, and other execution-related properties. If you exceed these limits, you'll receive one of the errors below. [See the limits doc](/workflows/limits/) for details on specific limits.
99+
This error occurs when Promises or asynchronous code is not properly finished before the next step begins execution.
100+
101+
See the [Asynchronous section of the Node.js documentation](/workflows/building-workflows/code/nodejs/async/#the-problem) for more details.
102+
103+
### Undeployed changes — You have made changes to this workflow. Deploy the latest version from the editor
104+
105+
On workflows that are not [synced with GitHub](/workflows/git/), you may notice the following warning at the top of your workflow:
106+
107+
> **Undeployed changes** — You have made changes to this workflow. Deploy the latest version from the editor
108+
109+
This means that you've made some changes to your workflow that you haven't yet deployed. To see a diff of what's changed, we recommend [enabling GitHub sync](/workflows/git/), where you'll get a full commit history of changes made to your workflows, synced to your own GitHub repo.
98110

111+
## Errors
99112

100-
## Quota Exceeded
113+
### Limit Exceeded Errors
114+
115+
Pipedream sets [limits](/workflows/limits/) on runtime, memory, and other execution-related properties. If you exceed these limits, you'll receive one of the errors below. [See the limits doc](/workflows/limits/) for details on specific limits.
116+
117+
### Quota Exceeded
101118

102119
On the Free tier, Pipedream imposes a limit on the [daily credits](/workflows/limits/#daily-credits-limit) across all workflows and sources. If you hit this limit, you'll see a **Quota Exceeded** error.
103120

104121
Paid plans have no credit limit. [Upgrade here](https://pipedream.com/pricing).
105122

106-
## Runtime Quota Exceeded
123+
### Runtime Quota Exceeded
107124

108125
You **do not** use credits testing workflows, but workspaces on the **Free** plan are limited to {process.env.DAILY_TESTING_LIMIT} of test runtime per day. If you exceed this limit when testing in the builder, you'll see a **Runtime Quota Exceeded** error.
109126

110-
## Timeout
127+
### Timeout
111128

112129
Event sources and workflows have a [default time limit on a given execution](/workflows/limits/#time-per-execution). If your code exceeds that limit, you may encounter a **Timeout** error.
113130

@@ -116,7 +133,7 @@ To address timeouts, you'll either need to:
116133
1. Figure out why your code is running for longer than expected. It's important to note that **timeouts are not an issue with Pipedream — they are specific to your workflow**. Often, you're making a request to a third party API that doesn't respond in the time you expect, or you're processing a large amount of data in your workflow, and it doesn't complete before you hit the execution limit.
117134
2. If it's expected that your code is taking a long time to run, you can raise the execution limit of a workflow in your [workflow's settings](/workflows/building-workflows/settings/#execution-timeout-limit). If you need to change the execution limit for an event source, please [reach out to our team](https://pipedream.com/support/).
118135

119-
## Out of Memory
136+
### Out of Memory
120137

121138
Pipedream [limits the default memory](/workflows/limits/#memory) available to workflows and event sources. If you exceed this memory, you'll see an **Out of Memory** error. **You can raise the memory of your workflow [in your workflow's Settings](/workflows/building-workflows/settings/#memory)**.
122139

@@ -125,13 +142,13 @@ This can happen for two main reasons:
125142
1. When you load a large file or object into the workflow's memory (e.g. when you save the content in a variable). Where possible, consider streaming the file to / from disk, instead of storing it in memory, using a [technique like this](/workflows/building-workflows/code/nodejs/http-requests/#download-a-file-to-the-tmp-directory).
126143
2. When you have many steps in your Pipedream workflow. When your workflow runs, Pipedream runs a separate process for each step in your workflow. That incurs some memory overhead. Typically this happens when you have more than 8-10 steps. When you see an OOM error on a workflow with many steps, try increasing the memory.
127144

128-
## Rate Limit Exceeded
145+
### Rate Limit Exceeded
129146

130147
Pipedream limits the number of events that can be processed by a given interface (e.g. HTTP endpoints) during a given interval. This limit is most commonly reached for HTTP interfaces - see the [QPS limits documentation](/workflows/limits/#qps-queries-per-second) for more information on that limit.
131148

132149
**This limit can be raised for HTTP endpoints**. [Reach out to our team](https://pipedream.com/support/) to request an increase.
133150

134-
## Request Entity Too Large
151+
### Request Entity Too Large
135152

136153
By default, Pipedream limits the size of incoming HTTP payloads. If you exceed this limit, you'll see a **Request Entity Too Large** error.
137154

@@ -140,35 +157,35 @@ Pipedream supports two different ways to bypass this limit. Both of these interf
140157
- You can send large HTTP payloads by passing the `pipedream_upload_body=1` query string or an `x-pd-upload-body: 1` HTTP header in your HTTP request. [Read more here](/workflows/building-workflows/triggers/#sending-large-payloads).
141158
- You can upload multiple large files, like images and videos, using the [large file upload interface](/workflows/building-workflows/triggers/#large-file-support).
142159

143-
## Function Payload Limit Exceeded
160+
### Function Payload Limit Exceeded
144161

145162
The total size of `console.log()` statements, [step exports](/workflows/#step-exports), and the original event data sent to workflows and sources cannot exceed a combined size of {process.env.FUNCTION_PAYLOAD_LIMIT}. If you produce logs or step exports larger than this - for example, passing around large API responses, CSVs, or other data - you may encounter a **Function Payload Limit Exceeded** in your workflow.
146163

147164
Often, this occurs when you pass large data between steps using [step exports](/workflows/#step-exports). You can avoid this error by [writing that data to the `/tmp` directory](/workflows/building-workflows/code/nodejs/working-with-files/#writing-a-file-to-tmp) in one step, and [reading the data into another step](/workflows/building-workflows/code/nodejs/working-with-files/#reading-a-file-from-tmp), which avoids the use of step exports and should keep you under the payload limit.
148165

149166
Pipedream also compresses the function payload from your workflow, which can yield roughly a 2x-3x increase in payload size (somewhere between `12MB` and `18MB`), depending on the data.
150167

151-
## JSON Nested Property Limit Exceeded
168+
### JSON Nested Property Limit Exceeded
152169

153170
Working with nested JavaScript objects that have more than 256 nested objects will trigger a **JSON Nested Property Limit Exceeded** error.
154171

155172
Often, objects with this many nested objects result from a programming error that explodes the object in an unexpected way. Please confirm the code you're using to convert data into an object is correctly parsing the object.
156173

157-
## Event Queue Full
174+
### Event Queue Full
158175

159176
Workflows have a maximum event queue size when using concurrency and throttling controls. If the number of unprocessed events exceeds the [maximum queue size](/workflows/building-workflows/settings/concurrency-and-throttling/#increasing-the-queue-size-for-a-workflow), you may encounter an **Event Queue Full** error.
160177

161178
[Paid plans](https://pipedream.com/pricing) can [increase their queue size up to {process.env.MAX_WORKFLOW_QUEUE_SIZE}](/workflows/building-workflows/settings/concurrency-and-throttling/#increasing-the-queue-size-for-a-workflow) for a given workflow.
162179

163-
## Credit Budget Exceeded
180+
### Credit Budget Exceeded
164181

165182
Credit Budgets are configurable limits on your credit usage at the account or workspace level.
166183

167184
If you're receiving this warning on a source or workflow, this means your allocated Credit Budget has been reached for the defined period.
168185

169186
You can increase this limit at any time in the [billing area of your settings](https://pipedream.com/settings/billing).
170187

171-
## Pipedream Internal Error
188+
### Pipedream Internal Error
172189

173190
A `Pipedream Internal Error` is thrown whenever there's an exception during the building or executing of a workflow that's outside the scope of the code for the individual components (steps or actions).
174191

@@ -220,20 +237,42 @@ Instead, use the specific package that exports the `pick` module alone:
220237
import pick from "lodash.pick"
221238
```
222239

223-
## Code was still running when the step ended
240+
## Is there a way to replay workflow events programmatically?
224241

225-
This error occurs when Promises or asynchronous code is not properly finished before the next step begins execution.
242+
Not via the API, but you can bulk select and replay failed events using the [Event History](/workflows/event-history/).
226243

227-
See the [Asynchronous section of the Node.js documentation](/workflows/building-workflows/code/nodejs/async/#the-problem) for more details.
244+
## How do I store and retrieve data across workflow executions?
228245

229-
### How do I share my workflow with Support?
246+
If you operate your own database or data store, you can connect to it directly in Pipedream.
230247

231-
First, navigate to your **Project Settings** and share your project with Pipedream Support.
248+
Pipedream also operates a [built-in key-value store](/workflows/data-management/data-stores/) that you can use to get and set data across workflow executions and different workflows.
232249

233-
If your workflow is _not_ part of a Project, go to the **Workflow Settings** to grant access to us.
250+
## How do I delay the execution of a workflow?
234251

235-
When filling out the request form at [https://pipedream.com/support](https://pipedream.com/support), please provide detailed information along with the URL from your browser's address bar, which should look something like:
252+
Use Pipedream's [built-in Delay actions](/workflows/building-workflows/control-flow/delay/) to delay a workflow at any step.
236253

237-
```
238-
https://pipedream.com/@yourworkspace/workflows/projects/yourproject/test-workflow-pabc123
239-
```
254+
## How can my workflow run faster?
255+
256+
Here are a few things that can help your workflow execute faster:
257+
258+
1. **Increase memory:** Increase your [workflow memory](/workflows/building-workflows/settings/#memory) to at least 512 MB. Raising the memory limit will proportionally increase CPU resources, leading to improved performance and reduced latency.
259+
260+
2. **Return static HTTP responses:** If your workflow is triggered by an HTTP source, return a [static HTTP response](/workflows/building-workflows/triggers/#http-responses) directly from the trigger configuration. This ensures the HTTP response is sent to the caller immediately, before the rest of the workflow steps are executed.
261+
262+
3. **Simplify your workflow:** Reduce the number of [steps](/workflows/#code-actions) and [segments](/workflows/building-workflows/control-flow/#workflow-segments) in your workflow, combining multiple steps into one, if possible. This lowers the overhead involved in managing step execution and exports.
263+
264+
4. **Activate warm workers:** Use [warm workers](/workflows/building-workflows/settings/#eliminate-cold-starts) to reduce the startup time of workflows. Set [as many warm workers](/workflows/building-workflows/settings/#how-many-workers-should-i-configure) as you want for high-volume traffic.
265+
266+
## How can I save common functions as steps?
267+
268+
You can create your own custom triggers and actions ("components") on Pipedream using [the Component API](/workflows/contributing/components/api/). These components are private to your account and can be used in any workflow.
269+
270+
You can also publish common functions in your own package on a public registry like [npm](https://www.npmjs.com/) or [PyPI](https://pypi.org/).
271+
272+
## Is Puppeteer supported in Pipedream?
273+
274+
Yes, see [our Puppeteer docs](/workflows/building-workflows/code/nodejs/browser-automation/#puppeteer) for more detail.
275+
276+
## Is Playwright supported in Pipedream?
277+
278+
Yes, see [our Playwright docs](/workflows/building-workflows/code/nodejs/browser-automation/#playwright) for more detail.

docs-v2/pages/troubleshooting/_meta.tsx

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs-v2/pages/troubleshooting/faq.mdx

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)