Skip to content

Commit 2174edf

Browse files
Freshness. Acrolinx.
1 parent 1935b36 commit 2174edf

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

articles/app-service/webjobs-execution.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ ms.collection: ce-skilling-ai-copilot
1212

1313
# How WebJobs run in Azure App Service
1414

15-
Azure WebJobs allow you to run background tasks within your App Service app, without needing separate infrastructure. These tasks are discovered and managed by the Kudu engine, the built-in App Service deployment and runtime management service. Kudu handles WebJob execution, file system access, diagnostics, and log collection behind the scenes.
15+
Azure WebJobs allow you to run background tasks within your App Service app, without needing separate infrastructure. The Kudu engine discovers and manages these tasks. The Kudu engine is the built-in App Service deployment and runtime management service. Kudu handles WebJob execution, file system access, diagnostics, and log collection behind the scenes.
1616

1717
This article explains how WebJobs are discovered, how the runtime decides what to execute, and how you can configure behavior using the optional `settings.job` file.
1818

1919
## Platform-specific notes
2020

21-
WebJobs support a variety of script and executable formats, depending on the App Service hosting environment. The types of files you can run—and the runtimes available—vary slightly based on whether you're using Windows code, Linux code, or custom containers. In general, built-in runtimes are available for common scripting languages, and additional file types are supported when they match the language runtime of your app or container.
21+
WebJobs support various script and executable formats, depending on the App Service hosting environment. The types of files you can run—and the runtimes available—vary slightly based on whether you're using Windows code, Linux code, or custom containers. In general, built-in runtimes are available for common scripting languages. Other file types are supported when they match the language runtime of your app or container.
2222

2323
[!INCLUDE [webjob-types](./includes/webjobs-create/webjob-types.md)]
2424

2525
>[!IMPORTANT]
26-
> WebJobs that are continuous, scheduled, or event-driven may stop running if the web app hosting them becomes idle. Web apps can time out after 20 minutes of inactivity, and only direct requests to the app reset this idle timer. Actions like viewing the portal or accessing the Kudu tools do not keep the app active.
26+
> WebJobs that are continuous, scheduled, or event-driven might stop running if the web app hosting them becomes idle. Web apps can time out after 20 minutes of inactivity, and only direct requests to the app reset this idle timer. Actions like viewing the portal or accessing the Kudu tools don't keep the app active.
2727
> To ensure WebJobs run reliably, enable the Always on setting in the Configuration pane of your App Service.
2828
> This setting is available only in the Basic, Standard, and Premium pricing tiers.
2929
@@ -47,14 +47,15 @@ Inside the job folder, the Kudu engine looks for a file to execute. This file ca
4747

4848
The WebJobs runtime uses a file named `run.*` (such as `run.py`, `run.sh`, or `run.js`) as the explicit entry point for a job. This file tells the platform which script or binary to execute first, ensuring consistent and predictable behavior across environments.
4949

50-
The filename must be exactly `run.*` to be autodetected. Files like `start.sh` or `job.py` will be ignored unless manually triggered. If no `run.*` file is found, the platform attempts to detect a fallback entry point by selecting the first supported file based on the language platform of the WebJob. For example:
51-
- A Python WebJob with multiple `.py` files (for example, `file1.py`, `file2.py`) will execute the first `.py` file it finds in the archive.
50+
The filename must be exactly `run.*` to be autodetected. Files like `start.sh` or `job.py` are ignored unless manually triggered. If no `run.*` file is found, the platform attempts to detect a fallback entry point by selecting the first supported file based on the language platform of the WebJob. For example:
51+
52+
- A Python WebJob with multiple `.py` files (for example, `file1.py`, `file2.py`) runs the first `.py` file it finds in the archive.
5253
- A Node.js WebJob looks for the first `.js` file.
5354
- A Bash-based WebJob looks for the first `.sh` script.
5455

55-
This fallback behavior can lead to unpredictable execution when multiple script files are present—especially in multi-file projects—so it's recommended to include a `run.*` file to define the entry point explicitly.
56+
This fallback behavior can lead to unpredictable execution when multiple script files are present—especially in multi-file projects. We recommended that you include a `run.*` file to define the entry point explicitly.
5657

57-
On Linux-based WebJobs, `.sh` scripts must include a shebang (#!) and must be marked as executable.
58+
On Linux-based WebJobs, `.sh` scripts must include a shebang (`#!`) and must be marked as executable.
5859

5960
## WebJob configuration with settings.job
6061

@@ -64,12 +65,12 @@ You can customize WebJob behavior using an optional `settings.job` file (JSON fo
6465
|----------|-------------|
6566
| `schedule` | (string) A CRON expression used to schedule a triggered job. Example: `"0 */15 * * * *"`. Only applicable to triggered jobs. |
6667
| `is_singleton` | (bool) Ensures only one instance of the job runs across all scaled-out instances. Default: `true` for continuous jobs, `false` for triggered/on-demand. |
67-
| `stopping_wait_time` | (number, seconds) Grace period (default 5s) given to the script before it's killed when the WebJob is stopped (for example, during site swaps or restarts). |
68+
| `stopping_wait_time` | (number, seconds) Grace period (default 5 seconds) given to the script before it's killed when the WebJob is stopped (for example, during site swaps or restarts). |
6869
| `shutdownGraceTimeLimit` | (number, seconds) Max time (default 0s, meaning no limit) given for the entire WebJob process shutdown, including the `stopping_wait_time`, before it's forcefully terminated. |
6970
| `run_mode` | (string) Values: `continuous`, `scheduled`, `on_demand`. Overrides job type detection based on the folder. |
7071

7172
> [!NOTE]
72-
> `stopping_wait_time` applies specifically to the running script's grace period, while `shutdownGraceTimeLimit` defines the overall process shutdown time-out. Consult the [Kudu documentation](https://github.com/projectkudu/kudu/wiki/WebJobs) for detailed behavior.
73+
> `stopping_wait_time` applies specifically to the running script's grace period, while `shutdownGraceTimeLimit` defines the overall process shutdown timeout. Consult the [Kudu documentation](https://github.com/projectkudu/kudu/wiki/WebJobs) for detailed behavior.
7374
7475
### Example
7576
```json
@@ -83,7 +84,7 @@ You can customize WebJob behavior using an optional `settings.job` file (JSON fo
8384

8485
## Logging and diagnostics
8586

86-
WebJob logs are handled by the Kudu engine and are available under the `App_Data/jobs/<type>/<jobname>` folder. Additionally, logs can be viewed in the Azure portal or accessed via the SCM (Kudu) endpoint:
87+
The Kudu engine handles WebJob logs. They're available under the `App_Data/jobs/<type>/<jobname>` folder. Additionally, logs can be viewed in the Azure portal or accessed via the SCM (Kudu) endpoint:
8788

8889
```
8990
https://<your-app>.scm.azurewebsites.net/api/triggeredwebjobs/<job>/history
@@ -95,7 +96,7 @@ Triggered WebJobs include a full history of executions. Continuous WebJobs strea
9596
## Troubleshooting tips
9697

9798
- **WebJob not starting:** Check for a missing or misnamed `run.*` file. Ensure it's in the correct job folder (`triggered` or `continuous`).
98-
- **Permissions error (Linux):** Ensure the script has execute permissions (`chmod +x run.sh`) and includes a valid shebang (e.g., `#!/bin/bash`).
99+
- **Permissions error (Linux):** Ensure the script has execute permissions (`chmod +x run.sh`) and includes a valid shebang (for example, `#!/bin/bash`).
99100
- **Job not stopping gracefully:** Use `settings.job` to define `stopping_wait_time` and potentially `shutdownGraceTimeLimit`.
100101
- **Scheduled job not running:** Verify the CRON expression in `settings.job` is correct and the App Service Plan has "Always On" enabled if needed.
101102
- **Check Kudu logs:** Examine the detailed execution logs and deployment logs available in the Kudu console (`https://<your-app>.scm.azurewebsites.net/`) under Tools > WebJobs and potentially Log stream.

0 commit comments

Comments
 (0)