Skip to content

Commit 617663c

Browse files
Docs - troubleshooting (#15762)
* reordering troubleshooting * add workflows and triggers separation * link fixes * add section on trigger timeouts * fix workflow url example * fix another url
1 parent 79be8f3 commit 617663c

File tree

5 files changed

+110
-106
lines changed

5 files changed

+110
-106
lines changed

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

Lines changed: 108 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ import Callout from '@/components/Callout'
44

55
This doc describes some common solutions for fixing issues with [pipedream.com](https://pipedream.com) or with a specific workflow.
66

7-
## How do I contact Pipedream Support?
8-
9-
Start by filling out the request form at [https://pipedream.com/support](https://pipedream.com/support), providing detailed information about your issue.
10-
117
## A feature isn't working on pipedream.com
128

139
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,7 +16,34 @@ If you're seeing an issue with [pipedream.com](https://pipedream.com) (for examp
2016

2117
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+).
2218

23-
## My workflow isn't working
19+
## How do I contact Pipedream Support?
20+
21+
Start by filling out the request form at [https://pipedream.com/support](https://pipedream.com/support), providing detailed information about your issue.
22+
23+
### How do I share my workflow with Support?
24+
25+
First, navigate to your **Project Settings** and share your project with Pipedream Support.
26+
27+
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:
28+
29+
```
30+
https://pipedream.com/@yourworkspace/projects/proj_abc123/test-workflow-p_abc123/inspect
31+
```
32+
33+
## Workflows
34+
35+
### Where do I find my workflow's ID?
36+
37+
Open [https://pipedream.com](https://pipedream.com) and visit your workflow. Copy the URL that appears in your browser's address bar. For example:
38+
39+
```
40+
https://pipedream.com/@yourworkspace/projects/proj_abc123/test-workflow-p_abc123/inspect
41+
42+
```
43+
44+
Your workflow's ID is the value that starts with `p_`. In this example: `p_abc123`.
45+
46+
### My workflow isn't working
2447

2548
If you're encountering a specific issue in a workflow, try the following steps, checking to see if they fix the problem:
2649

@@ -30,15 +53,21 @@ If you're encountering a specific issue in a workflow, try the following steps,
3053

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

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

35-
[See FAQ here](/workflows/git/#faq).
58+
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).
3659

37-
## Why is my trigger not emitting events?
60+
Another option is to make an HTTP request to a Pipedream HTTP webhook trigger.
3861

39-
Most Pipedream sources fall into one of two categories: webhook-based or timer-based.
62+
## Triggers
4063

41-
### Webhook-based instant sources
64+
### Why is my trigger not emitting events?
65+
66+
First, look at your [trigger logs](/troubleshooting/#where-can-i-find-the-trigger-logs) and check for any errors there. Verify that it has been running, whether on a new webhook event or at the configured polling interval.
67+
68+
If your trigger operates on a large amount of data at once, it may fail to log the execution and you won't see any new events and logs. Try polling more frequently or limiting the number of records being fetched in the API request or Database query.
69+
70+
#### Webhook-based instant sources
4271

4372
These sources will get triggered immediately. But because events come in in real-time, most will **not** automatically fetch historical events upon creation. To surface test events in your workflow while building, you'll need to generate an eligible event in the selected app.
4473

@@ -48,41 +77,33 @@ For example, if you've configured the "[Message Updates (Instant)](https://piped
4877

4978
Sources for apps like [Telegram](https://pipedream.com/apps/telegram-bot-api/triggers/message-updates) and [Google Sheets](https://pipedream.com/apps/google-sheets/triggers/new-row-added) use webhooks and get triggered immediately.
5079

51-
### Timer-based polling sources
80+
#### Timer-based polling sources
5281

5382
These sources will fetch new events on a regular interval, based on a schedule you specify in the trigger configuration.
5483

5584
![Configure polling timer](https://res.cloudinary.com/pipedreamin/image/upload/v1653434591/docs/polling-triggers-timer_ooz26c.png)
5685

5786
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.
5887

59-
## Where do I find my workflow's ID?
88+
### Where do I find my event source's ID?
6089

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:
90+
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:
6291

6392
```
64-
https://pipedream.com/@dylburger/p_abc123/edit
93+
https://pipedream.com/sources/dc_abc123
6594
```
6695

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.
96+
Your source's ID is the value that starts with `dc_`. In this example: `dc_abc123`.
7497

75-
## Where do I find my event source's ID?
98+
### Where can I find the trigger logs?
7699

77-
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:
100+
Find your [source](/troubleshooting/#where-do-i-find-my-event-sources-id), then click on the logs or visit this URL:
78101

79102
```
80-
https://pipedream.com/sources/dc_abc123
103+
https://pipedream.com/sources/dc_abc123/logs
81104
```
82105

83-
Your source's ID is the value that starts with `dc_`. In this example: `dc_abc123`.
84-
85-
## Why is my trigger paused?
106+
### Why is my trigger paused?
86107

87108
Pipedream automatically disables sources with a 100% error rate in the past 5 days for accounts on the Free plan.
88109

@@ -92,22 +113,37 @@ To troubleshoot, you can look at the errors in the [source](/workflows/building-
92113

93114
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.
94115

95-
## Limit Exceeded Errors
116+
### Code was still running when the step ended
96117

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.
118+
This error occurs when Promises or asynchronous code is not properly finished before the next step begins execution.
98119

120+
See the [Asynchronous section of the Node.js documentation](/workflows/building-workflows/code/nodejs/async/#the-problem) for more details.
121+
122+
### Undeployed changes — You have made changes to this workflow. Deploy the latest version from the editor
123+
124+
On workflows that are not [synced with GitHub](/workflows/git/), you may notice the following warning at the top of your workflow:
125+
126+
> **Undeployed changes** — You have made changes to this workflow. Deploy the latest version from the editor
127+
128+
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.
129+
130+
## Errors
131+
132+
### Limit Exceeded Errors
133+
134+
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.
99135

100-
## Quota Exceeded
136+
### Quota Exceeded
101137

102138
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.
103139

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

106-
## Runtime Quota Exceeded
142+
### Runtime Quota Exceeded
107143

108144
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.
109145

110-
## Timeout
146+
### Timeout
111147

112148
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.
113149

@@ -116,7 +152,7 @@ To address timeouts, you'll either need to:
116152
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.
117153
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/).
118154

119-
## Out of Memory
155+
### Out of Memory
120156

121157
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)**.
122158

@@ -125,13 +161,13 @@ This can happen for two main reasons:
125161
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).
126162
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.
127163

128-
## Rate Limit Exceeded
164+
### Rate Limit Exceeded
129165

130166
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.
131167

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

134-
## Request Entity Too Large
170+
### Request Entity Too Large
135171

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

@@ -140,35 +176,35 @@ Pipedream supports two different ways to bypass this limit. Both of these interf
140176
- 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).
141177
- You can upload multiple large files, like images and videos, using the [large file upload interface](/workflows/building-workflows/triggers/#large-file-support).
142178

143-
## Function Payload Limit Exceeded
179+
### Function Payload Limit Exceeded
144180

145181
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.
146182

147183
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.
148184

149185
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.
150186

151-
## JSON Nested Property Limit Exceeded
187+
### JSON Nested Property Limit Exceeded
152188

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

155191
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.
156192

157-
## Event Queue Full
193+
### Event Queue Full
158194

159195
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.
160196

161197
[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.
162198

163-
## Credit Budget Exceeded
199+
### Credit Budget Exceeded
164200

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

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

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

171-
## Pipedream Internal Error
207+
### Pipedream Internal Error
172208

173209
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).
174210

@@ -220,20 +256,42 @@ Instead, use the specific package that exports the `pick` module alone:
220256
import pick from "lodash.pick"
221257
```
222258

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

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

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

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

231-
First, navigate to your **Project Settings** and share your project with Pipedream Support.
267+
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.
232268

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

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:
271+
Use Pipedream's [built-in Delay actions](/workflows/building-workflows/control-flow/delay/) to delay a workflow at any step.
236272

237-
```
238-
https://pipedream.com/@yourworkspace/workflows/projects/yourproject/test-workflow-pabc123
239-
```
273+
## How can my workflow run faster?
274+
275+
Here are a few things that can help your workflow execute faster:
276+
277+
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.
278+
279+
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.
280+
281+
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.
282+
283+
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.
284+
285+
## How can I save common functions as steps?
286+
287+
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.
288+
289+
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/).
290+
291+
## Is Puppeteer supported in Pipedream?
292+
293+
Yes, see [our Puppeteer docs](/workflows/building-workflows/code/nodejs/browser-automation/#puppeteer) for more detail.
294+
295+
## Is Playwright supported in Pipedream?
296+
297+
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.

0 commit comments

Comments
 (0)