Günlük kaydı, kodda hata ayıklama ve kodu izleme için önemli bir araçtır.
Cloud Functions, web için geliştirme yaparken günlükçü SDK'sını, özel Google Cloud Logging veya console nesne standardını kullanma seçeneği sunar.
Günlük yazma
Çoğu durumda Cloud Functions logger SDK'sı önerilse de aşağıdaki nedenlerle diğer seçeneklerden birini tercih edebilirsiniz:
- Mevcut bir kod tabanınız varsa ve
console.logdilinden yeniden düzenleme yapmak istemiyorsanız - Cloud Logging (eski adıyla StackDriver Logging) hakkında bilgi sahibisiniz ve özel günlük kaydı için bu hizmeti kullanmayı tercih ediyorsunuz.
Cloud Functions günlükçü SDK'sını kullanma
Cloud Functions günlükçü SDK'sı, console.log ifadelerine benzer bir
API'ye sahip olan ve diğer günlük düzeylerini destekleyen standart bir arayüz sağlar.
Bu SDK'yı kullanarak etkinlikleri yapılandırılmış verilerle günlüğe kaydedebilir, böylece daha kolay analiz ve izleme yapabilirsiniz.
Günlükçü SDK'sı, joker karakter içe aktarma işleminin bir parçası olarak günlük girişlerini destekler. Örneğin:
const functions = require("firebase-functions/v1");
functions.logger.log("Hello from info. Here's an object:", someObj);
Alternatif olarak, ayrı ayrı dışa aktarma işlemlerini kullanabilirsiniz. Bu örnekte, günlüğe son bağımsız değişken olarak eklenen yapılandırılmış veriler gösterilmektedir:
const { warn } = require("firebase-functions/logger");
// Attach structured data to the log as the last argument.
warn("This is a 'WARNING' severity message with some metadata.", {
key1: 'val1',
key2: 'val2'
});
logger.log()komutlarının günlük düzeyi INFO'dur.logger.info()komutlarının günlük düzeyi INFO'dur.logger.warn()komutun günlük düzeyi WARNING.logger.error()komutun günlük düzeyi ERROR.- Dahili sistem mesajları DEBUG günlük düzeyine sahiptir.
logger.write() ile CRITICAL, ALERT ve EMERGENCY günlük önem derecesi seviyelerine ek olarak günlük girişleri yazabilirsiniz. LogSeverity bölümüne bakın.
Özel Cloud Logging günlükleri
Günlük kaydedici SDK'sı ile Cloud Functions günlükleri, Cloud Logging tarafından desteklenir. Etkinlikleri yapılandırılmış verilerle günlüğe kaydetmek için Node.js için Cloud Logging kitaplığını kullanarak daha kolay analiz ve izleme yapabilirsiniz.
const { Logging } = require('@google-cloud/logging');
// ...
// Instantiate the logging SDK. The project ID will
// be automatically inferred from the Cloud Functions environment.
const logging = new Logging();
const log = logging.log('my-custom-log-name');
// This metadata is attached to each log entry. This specifies a fake
// Cloud Function called 'Custom Metrics' in order to make your custom
// log entries appear in the Cloud Functions logs viewer.
const METADATA = {
resource: {
type: 'cloud_function',
labels: {
function_name: 'CustomMetrics',
region: 'us-central1'
}
}
};
// ...
// Data to write to the log. This can be a JSON object with any properties
// of the event you want to record.
const data = {
event: 'my-event',
value: 'foo-bar-baz',
// Optional 'message' property will show up in the Firebase
// console and other human-readable logging surfaces
message: 'my-event: foo-bar-baz'
};
// Write to the log. The log.write() call returns a Promise if you want to
// make sure that the log was written successfully.
const entry = log.entry(METADATA, data);
log.write(entry);
console.log uygulamasını kullanma
Bir işlevden günlük kaydı yapmak için platformunuzun günlükçü SDK'sını kullanmanız önerilir. Node.js ile console.log ve console.error gibi standart JavaScript günlük kaydı çağrılarını kullanabilirsiniz. Ancak öncelikle standart yöntemlerin doğru şekilde çalışması için özel bir modül gereklidir:
require("firebase-functions/logger/compat");
Günlükçü uyumluluk modülünü zorunlu kıldıktan sonra kodunuzda console.log() yöntemlerini normal şekilde kullanabilirsiniz:
exports.helloError = functions.https.onRequest((request, response) => {
console.log('I am a log entry!');
response.send('Hello World...');
});
console.log()komutlarının günlük düzeyi INFO'dur.console.info()komutlarının günlük düzeyi INFO'dur.console.warn()komutun günlük düzeyi ERROR.console.error()komutun günlük düzeyi ERROR.- Dahili sistem mesajları DEBUG günlük düzeyine sahiptir.
Günlükleri görüntüleme
Cloud Functions günlükleri Google Cloud konsolunda, Cloud Logging kullanıcı arayüzünde veya firebase komut satırı aracı aracılığıyla görüntülenebilir.
Firebase CLI'yı kullanma
Günlükleri firebase aracıyla görüntülemek için functions:log komutunu kullanın:
firebase functions:log
Belirli bir işlevin günlüklerini görüntülemek için işlev adını bağımsız değişken olarak girin:
firebase functions:log --only <FUNCTION_NAME>
Günlük görüntüleme seçeneklerinin tamamı için functions:log ile ilgili yardım sayfasını inceleyin:
firebase help functions:log
Google Cloud konsolunu kullanma
İşlevlerle ilgili günlükleri Google Cloud konsolunda görüntüleyebilirsiniz.
Cloud Logging kullanıcı arayüzünü kullanma
Cloud Logging kullanıcı arayüzünde Cloud Functions için günlükleri görüntüleyebilirsiniz.
Günlükleri analiz etme
Cloud Logging, Cloud Functions hizmetinizi izlemek için kullanabileceğiniz güçlü bir günlük analizi araçları paketi sunar.
Grafikler ve uyarılar
İşlevlerinizi izlemek için günlüğe dayalı metrikler oluşturduktan sonra bu metrikleri temel alan grafikler ve uyarılar oluşturabilirsiniz. Örneğin, gecikmeyi zaman içinde görselleştirmek için bir grafik oluşturabilir veya belirli bir hata çok sık meydana gelirse sizi bilgilendirecek bir uyarı oluşturabilirsiniz.
Günlük tabanlı metriklerin grafiklerde ve uyarı politikalarında nasıl kullanılacağı hakkında ayrıntılı bilgi için Grafik ve Uyarı Oluşturma başlıklı makaleyi inceleyin.