Azure App Service için Node.js uygulamasını yapılandırma

Makale
09/13/2024

Node.js uygulamalar tüm gerekli npm bağımlılıklarıyla dağıtılmalıdır. App Service dağıtım altyapısı, Git deposu dağıttığınızda veya derleme otomasyonu etkin bir Zip paketi dağıttığınızda sizin için otomatik olarak çalışırnpm install --production. Ancak dosyalarınızı FTP/S kullanarak dağıtırsanız gerekli paketleri el ile karşıya yüklemeniz gerekir.

Bu kılavuz, App Service'e dağıtım yapan Node.js geliştiriciler için önemli kavramlar ve yönergeler sağlar. Azure Uygulaması Hizmeti'ni hiç kullanmadıysanız önce Node.js hızlı başlangıcı izleyin ve mongoDB ile Node.js öğreticisini izleyin.

Node.js sürümünü göster

Geçerli Node.js sürümünü göstermek için Cloud Shell'de aşağıdaki komutu çalıştırın:

az webapp config appsettings list --name <app-name> --resource-group <resource-group-name> --query "[?name=='WEBSITE_NODE_DEFAULT_VERSION'].value"

Desteklenen tüm Node.js sürümlerini göstermek için https://<sitename>.scm.azurewebsites.net/api/diagnostics/runtime Cloud Shell'de aşağıdaki komuta gidin veya komutunu çalıştırın:

az webapp list-runtimes --os windows | grep NODE

Geçerli Node.js sürümünü göstermek için Cloud Shell'de aşağıdaki komutu çalıştırın:

az webapp config show --resource-group <resource-group-name> --name <app-name> --query linuxFxVersion

Desteklenen tüm Node.js sürümlerini göstermek için Cloud Shell'de aşağıdaki komutu çalıştırın:

az webapp list-runtimes --os linux | grep NODE

Node.js sürümünü ayarlama

Uygulamanızı desteklenen bir Node.js sürümüne ayarlamak için Cloud Shell'de aşağıdaki komutu çalıştırarak desteklenen bir sürüme ayarlayınWEBSITE_NODE_DEFAULT_VERSION:

az webapp config appsettings set --name <app-name> --resource-group <resource-group-name> --settings WEBSITE_NODE_DEFAULT_VERSION="~16"

Not

Bu örnekte, App Service'te Node.js 16 çalışma zamanının en son kullanılabilir sürümünü hedeflemek için önerilen "tilde söz dizimi" kullanılır.

Çalışma zamanı platform tarafından düzenli olarak düzeltme eki uygulandığından ve güncelleştirildiğinden, olası güvenlik risklerine bağlı olarak bunların kullanılabilir olacağı garanti edilmediğinden belirli bir ikincil sürümü/düzeltme ekini hedeflemenizi önermeyiz.

Not

Projenizin package.jsonsürümünde Node.js sürümünü ayarlamanız gerekir. Dağıtım altyapısı, desteklenen tüm Node.js sürümlerini içeren ayrı bir işlemde çalışır.

Uygulamanızı desteklenen bir Node.js sürümüne ayarlamak için Cloud Shell'de aşağıdaki komutu çalıştırın:

az webapp config set --resource-group <resource-group-name> --name <app-name> --linux-fx-version "NODE|14-lts"

Bu ayar, hem çalışma zamanında hem de Kudu'da otomatik paket geri yükleme sırasında kullanılacak Node.js sürümünü belirtir.

Not

Projenizin package.jsonsürümünde Node.js sürümünü ayarlamanız gerekir. Dağıtım altyapısı, desteklenen tüm Node.js sürümlerini içeren ayrı bir kapsayıcıda çalışır.

Bağlantı noktası numarasını al

Node.js uygulamanızın gelen istekleri almak için doğru bağlantı noktasını dinlemesi gerekir.

Windows üzerinde App Service'te Node.js uygulamalar IISNode ile barındırılır ve Node.js uygulamanız değişkende process.env.PORT belirtilen bağlantı noktasını dinlemelidir. Aşağıdaki örnek, basit bir Express uygulamasında bunun nasıl yapılacağını gösterir:

App Service, Node.js kapsayıcısında ortam değişkenini PORT ayarlar ve gelen istekleri kapsayıcınıza bu bağlantı noktası numarasından iletir. İstekleri almak için uygulamanızın kullanarak process.env.PORTbu bağlantı noktasını dinlemesi gerekir. Aşağıdaki örnek, basit bir Express uygulamasında bunun nasıl yapılacağını gösterir:

const express = require('express')
const app = express()
const port = process.env.PORT || 3000

app.get('/', (req, res) => {
  res.send('Hello World!')
})

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`)
})

Derleme otomasyonunu özelleştirme

Uygulamanızı Git kullanarak veya derleme otomasyonu etkinleştirilmiş zip paketlerini kullanarak dağıtırsanız App Service derleme otomasyonu aşağıdaki sırayla ilerler:

tarafından PRE_BUILD_SCRIPT_PATHbelirtilmişse özel betiği çalıştırın.
npm preinstall ve betikler içeren ve postinstall ayrıca 'yi yükleyen bayraklar devDependenciesolmadan çalıştırınnpm install.
package.json bir derleme betiği belirtilirse komutunu çalıştırınnpm run build.
package.json bir build:azure betiği belirtilirse komutunu çalıştırınnpm run build:azure.
tarafından POST_BUILD_SCRIPT_PATHbelirtilirse özel betiği çalıştırın.

Not

npm belgelerinde belirtildiği gibi, betikler belirtilirse sırasıyla önce ve sonra buildadlı prebuild ve postbuild çalıştırılır. preinstall ve postinstall önce ve sonra installsırasıyla çalıştırın.

PRE_BUILD_COMMAND ve POST_BUILD_COMMAND varsayılan olarak boş olan ortam değişkenleridir. Derleme öncesi komutları çalıştırmak için tanımlayın PRE_BUILD_COMMAND. Derleme sonrası komutları çalıştırmak için tanımlayın POST_BUILD_COMMAND.

Aşağıdaki örnek, virgülle ayrılmış bir dizi komut belirtmek için iki değişkeni kullanır.

az webapp config appsettings set --name <app-name> --resource-group <resource-group-name> --settings PRE_BUILD_COMMAND="echo foo, scripts/prebuild.sh"
az webapp config appsettings set --name <app-name> --resource-group <resource-group-name> --settings POST_BUILD_COMMAND="echo foo, scripts/postbuild.sh"

Derleme otomasyonlarını özelleştirmeye yönelik ek ortam değişkenleri hakkında bilgi için bkz . Oryx yapılandırması.

App Service'in Linux'ta Node.js uygulamaları nasıl çalıştırıp oluşturduğu hakkında daha fazla bilgi için Oryx belgelerine bakın : Node.js uygulamaları nasıl algılanıp oluşturulur?

Node.js sunucusunu yapılandırma

Node.js kapsayıcıları, bir üretim süreci yöneticisi olan PM2 ile birlikte gelir. Uygulamanızı PM2 ile, npm start ile veya özel bir komutla başlayacak şekilde yapılandırabilirsiniz.

Araç	Purpose
PM2 ile çalıştırma	Önerilen - Üretim veya hazırlama kullanımı. PM2, tam hizmet uygulama yönetimi platformu sağlar.
npm start ile çalıştır	Yalnızca geliştirme kullanımı.
Özel komutla çalıştırma	Geliştirme veya hazırlama.

PM2 ile çalıştırma

Kapsayıcı, projenizde yaygın Node.js dosyalardan biri bulunduğunda uygulamanızı otomatik olarak PM2 ile başlatır:

bin/www
server.js
app.js
index.js
hostingstart.js
Aşağıdaki PM2 dosyalarından biri: process.json veya ecosystem.config.js

Aşağıdaki uzantılarla özel bir başlangıç dosyası da yapılandırabilirsiniz:

.js dosyası
.json, .config.js, .yaml veya .yml uzantılı bir PM2 dosyası

Not

Node 14 LTS'den başlayarak kapsayıcı, pm2 ile uygulamanızı otomatik olarak başlatmaz. Uygulamanızı PM2 ile başlatmak için başlangıç komutunu olarak pm2 start <.js-file-or-PM2-file> --no-daemonayarlayın. Kapsayıcının --no-daemon düzgün çalışması için PM2'nin ön planda çalışması gerektiğinden bağımsız değişkeni kullandığınızdan emin olun.

Özel başlangıç dosyası eklemek için Cloud Shell'de aşağıdaki komutu çalıştırın:

az webapp config set --resource-group <resource-group-name> --name <app-name> --startup-file "<filename-with-extension>"

Özel komutla çalıştırma

App Service, uygulamanızı run.sh gibi bir yürütülebilir dosya gibi özel bir komut kullanarak başlatabilir. Örneğin, komutunu çalıştırmak npm run start:prodiçin Cloud Shell'de aşağıdaki komutu çalıştırın:

az webapp config set --resource-group <resource-group-name> --name <app-name> --startup-file "npm run start:prod"

npm start ile çalıştır

uygulamanızı kullanarak npm startbaşlatmak için package.json dosyasında bir start betik olduğundan emin olun. Örneğin:

{
  ...
  "scripts": {
    "start": "gulp",
    ...
  },
  ...
}

Projenizde özel bir package.json kullanmak için Cloud Shell'de aşağıdaki komutu çalıştırın:

az webapp config set --resource-group <resource-group-name> --name <app-name> --startup-file "<filename>.json"

Uzaktan hata ayıklama

.config.js, .yml veya .yaml kullanarak çalıştırmanız dışında, Node.js uygulamanızı PM2 ile çalışacak şekilde yapılandırdığınızda Visual Studio Code'da uzaktan hata ayıklayabilirsiniz.

Çoğu durumda, uygulamanız için ek yapılandırma gerekmez. Uygulamanız bir process.json dosyasıyla (varsayılan veya özel) çalıştırılıyorsa, JSON kökünde bir script özelliği olmalıdır. Örneğin:

{
  "name"        : "worker",
  "script"      : "./index.js",
  ...
}

Visual Studio Code'u uzaktan hata ayıklama için ayarlamak için App Service uzantısını yükleyin. Uzantı sayfasındaki yönergeleri izleyin ve Visual Studio Code'da Azure'da oturum açın.

Azure gezgininde, hata ayıklamak istediğiniz uygulamayı bulun, sağ tıklayın ve Uzaktan Hata Ayıklamayı Başlat'ı seçin. Uygulamanız için uzaktan hata ayıklamayı etkinleştirmek için Evet'i seçin. App Service sizin için bir tünel ara sunucusu başlatır ve hata ayıklayıcısını ekler. Ardından uygulamaya istekte bulunabilir ve hata ayıklayıcının kesme noktalarında duraklatılmasıyla karşılaşırsınız.

Hata ayıklamayı bitirdikten sonra Bağlantıyı Kes'i seçerek hata ayıklayıcıyı durdurun. İstendiğinde, uzaktan hata ayıklamayı devre dışı bırakmak için Evet'i seçmeniz gerekir. Daha sonra devre dışı bırakmak için Azure gezgininde uygulamanıza yeniden sağ tıklayın ve Uzaktan Hata Ayıklamayı Devre Dışı Bırak'ı seçin.

Ortam değişkenlerine erişme

App Service'te uygulama kodunuzun dışında uygulama ayarlarını düzenleyebilirsiniz. Ardından standart Node.js desenini kullanarak bunlara erişebilirsiniz. Örneğin NODE_ENV adlı bir uygulama ayarına erişmek için şu kodu kullanabilirsiniz:

process.env.NODE_ENV

Grunt/Bower/Gulp çalıştırma

App Service derleme otomasyonu, bir Node.js uygulamasının Git aracılığıyla veya derleme otomasyonu etkin zip dağıtımı aracılığıyla dağıtıldığını algıladığında varsayılan olarak çalışırnpm install --production. Uygulamanız Grunt, Bower veya Gulp gibi popüler otomasyon araçlarından herhangi birini gerektiriyorsa, uygulamayı çalıştırmak için özel bir dağıtım betiği sağlamanız gerekir.

Deponuzun bu araçları çalıştırmasını sağlamak için bunları package.json'daki bağımlılıklara eklemeniz gerekir. Mesela:

"dependencies": {
  "bower": "^1.7.9",
  "grunt": "^1.0.1",
  "gulp": "^3.9.1",
  ...
}

Yerel terminal penceresinden dizini deponuzun köküyle değiştirin ve aşağıdaki komutları çalıştırın:

npm install kuduscript -g
kuduscript --node --scriptType bash --suppressPrompt

Depo kökünüzün artık iki ek dosyası vardır: .deployment ve deploy.sh.

deploy.sh açın ve şu şekilde görünen bölümü bulunDeployment:

##################################################################################################################################
# Deployment
# ----------

Bu bölüm, komutunun çalıştırılmasıyla npm install --productionsona erer. Bölümün sonuna Deployment gerekli aracı çalıştırmak için ihtiyacınız olan kod bölümünü ekleyin:

Bower
Gulp
Grunt

Dağıtım betiğinin özel bir komut da çalıştırdığı MEAN.js örneğindeki bir npm install örneğe bakın.

Bower

Bu kod parçacığı çalıştırır bower install.

if [ -e "$DEPLOYMENT_TARGET/bower.json" ]; then
  cd "$DEPLOYMENT_TARGET"
  eval ./node_modules/.bin/bower install
  exitWithMessageOnError "bower failed"
  cd - > /dev/null
fi

Gulp

Bu kod parçacığı çalıştırır gulp imagemin.

if [ -e "$DEPLOYMENT_TARGET/gulpfile.js" ]; then
  cd "$DEPLOYMENT_TARGET"
  eval ./node_modules/.bin/gulp imagemin
  exitWithMessageOnError "gulp failed"
  cd - > /dev/null
fi

Grunt

Bu kod parçacığı çalıştırır grunt.

if [ -e "$DEPLOYMENT_TARGET/Gruntfile.js" ]; then
  cd "$DEPLOYMENT_TARGET"
  eval ./node_modules/.bin/grunt
  exitWithMessageOnError "Grunt failed"
  cd - > /dev/null
fi

HTTPS oturumlarını algılama

App Service'te TLS/SSL sonlandırma ağ yük dengeleyicilerinde gerçekleşir, bu nedenle tüm HTTPS istekleri şifrelenmemiş HTTP istekleri olarak uygulamanıza ulaşır. Uygulama mantığınızın kullanıcı isteklerinin şifrelenip şifrelenmediğini denetlemesi gerekiyorsa üst bilgiyi inceleyin X-Forwarded-Proto .

Popüler web çerçeveleri, standart uygulama düzeninizdeki bilgilere erişmenizi X-Forwarded-* sağlar. Express'te güven proxy'lerini kullanabilirsiniz. Örneğin:

app.set('trust proxy', 1)
...
if (req.secure) {
  // Do something when HTTPS is used
}

Tanılama günlüklerine erişim

App Service’te uygulama kodunuzun içinden oluşturulan konsol günlüklerine erişmek için şu komutu Cloud Shell’de çalıştırarak tanılama günlüğüne kaydetmeyi açın:

az webapp log config --resource-group <resource-group-name> --name <app-name> --docker-container-logging filesystem --level Verbose

--level için olası değerler: Error, Warning, Info ve Verbose. Her düzey kendisinden önceki düzeyi içerir. Örneğin: Error yalnızca hata iletilerini içerir, Verbose ise tüm iletileri içerir.

Tanılama günlüğüne kaydetme açıldıktan sonra günlük akışını görmek için şu komutu çalıştırın:

az webapp log tail --resource-group <resource-group-name> --name <app-name>

Konsol günlüklerini hemen görmüyorsanız, 30 saniye içinde yeniden kontrol edin.

Not

Ayrıca, tarayıcıdan https://<app-name>.scm.azurewebsites.net/api/logs/docker adresine giderek günlük dosyalarını inceleyebilirsiniz.

Günlük akışını dilediğiniz zaman durdurmak için Ctrl+C yazın.

Kapsayıcının içinden oluşturulan konsol günlüklerine erişebilirsiniz.

İlk olarak, aşağıdaki komutu çalıştırarak kapsayıcı günlüğünü açın:

az webapp log config --name <app-name> --resource-group <resource-group-name> --docker-container-logging filesystem

ve <resource-group-name> öğesini web uygulamanız için uygun adlarla değiştirin<app-name>.

Kapsayıcı günlüğü açıldıktan sonra günlük akışını görmek için aşağıdaki komutu çalıştırın:

az webapp log tail --name <app-name> --resource-group <resource-group-name>

Konsol günlüklerini hemen görmüyorsanız, 30 saniye içinde yeniden kontrol edin.

Günlük akışını istediğiniz zaman durdurmak için Ctrl+C yazın.

Günlük dosyalarını tarayıcıdan https://<app-name>.scm.azurewebsites.net/api/logs/dockerda inceleyebilirsiniz.

URL yeniden yazmaları

Linux için Azure Uygulaması Hizmeti'ne Node.js uygulamaları dağıtırken, URL yeniden yazma işlemlerini doğrudan uygulamanızın içinde işlemeniz gerekebilir. Bu, özellikle web sunucusu yapılandırmalarına bağlı kalmadan belirli URL desenlerinin doğru uç noktalara yönlendirildiğinden emin olmak için kullanışlıdır. Node.js URL yeniden yazma işlemleri gerçekleştirmenin çeşitli yolları vardır. Örneklerden biri express-urlrewrite paketidir.

Application Insights ile izleme

Application Insights, kod değişikliği yapmadan uygulamanızın performansını, özel durumlarını ve kullanımını izlemenizi sağlar. Application Insights aracısını eklemek için portalda web uygulamanıza gidin, Ayarlar'ın altında Application Insights'ı seçin ve ardından Application Insights'ı aç'ı seçin. Ardından, mevcut bir Application Insights kaynağını seçin veya yeni bir kaynak oluşturun. Son olarak alttaki Uygula'yı seçin. PowerShell kullanarak web uygulamanızı izlemeniz için bu yönergelere bakın

Bu aracı, sunucu tarafı Node.js uygulamanızı izler. İstemci tarafı JavaScript'inizi izlemek için projenize JavaScript SDK'sını ekleyin.

Daha fazla bilgi için bkz . Application Insights uzantısı sürüm notları.

Sorun giderme

Çalışan bir Node.js uygulaması App Service'te farklı davrandığında veya hatalar olduğunda aşağıdakileri deneyin:

Günlük akışına erişin.
Uygulamayı üretim modunda yerel olarak test edin. App Service, Node.js uygulamalarınızı üretim modunda çalıştırdığından, projenizin yerel olarak üretim modunda beklendiği gibi çalıştığından emin olmanız gerekir. Örneğin:
- package.json bağlı olarak, üretim modudependencies ( vs. ) için farklı paketler yüklenebilir. devDependencies
- Bazı web çerçeveleri üretim modunda statik dosyaları farklı şekilde dağıtabilir.
- Bazı web çerçeveleri üretim modunda çalışırken özel başlangıç betikleri kullanabilir.
Uygulamanızı App Service'te geliştirme modunda çalıştırın. Örneğin, MEAN.js uygulama ayarını ayarlayarak NODE_ENV uygulamanızı çalışma zamanında geliştirme moduna ayarlayabilirsiniz.

Bu dizini veya sayfayı görüntüleme izniniz yok

Node.js kodunuzu App Service'teki yerel bir Windows uygulamasına dağıttığınızda, uygulamanızın URL'sine gittiğinizde iletiyi You do not have permission to view this directory or page tarayıcıda görebilirsiniz. Bunun nedeni büyük olasılıkla web.config dosyanız olmadığındandır. (Şablona ve örne bakın.)

Dosyalarınızı Git kullanarak veya derleme otomasyonu etkinken ZIP dağıtımı kullanarak dağıtırsanız, aşağıdaki koşullardan biri doğruysa dağıtım altyapısı uygulamanızın (%HOME%\site\wwwroot) web kökünde otomatik olarak bir web.config oluşturur:

Proje kökünüzün JavaScript dosyasının yolunu içeren bir start betiği tanımlayan bir package.json vardır.
Proje kökünüzün server.js veya app.js var.

Oluşturulan web.config , algılanan başlangıç betiğine uyarlanmıştır. Diğer dağıtım yöntemleri için bu web.config dosyasını el ile ekleyin. Dosyanın düzgün biçimlendirildiğinden emin olun.

ZIP dağıtımı kullanıyorsanız (örneğin Visual Studio Code aracılığıyla), derleme otomasyonlarını etkinleştirdiğinizden emin olun. Varsayılan olarak etkin değildir. az webapp up derleme otomasyonu etkin olarak ZIP dağıtımını kullanır.

Günlüklerde robots933456

Kapsayıcı günlüklerinde şu iletiyi görebilirsiniz:

2019-04-08T14:07:56.641002476Z "-" - - [08/Apr/2019:14:07:56 +0000] "GET /robots933456.txt HTTP/1.1" 404 415 "-" "-"

Bu iletiyi güvenle yoksayabilirsiniz. /robots933456.txt, App Service hizmetinin kapsayıcının istek sunmak için uygun olup olmadığını denetlemek için kullandığı işlevsiz bir URL'dir. 404 yanıtı, yolun var olmadığını belirtir ancak App Service bu sayede iyi ve isteklere yanıt vermeye uygun durumda olan kapsayıcıları belirler.

Sonraki adımlar

Öğretici: MongoDB ile uygulama Node.js

Linux’ta Azure App Service hakkında SSS

Veya ek kaynaklara bakın:

Ortam değişkenleri ve uygulama ayarları başvurusu

Aracılığıyla paylaş