Membuat log dan melihat log di Cloud Run

Halaman ini berisi penjelasan mengenai log yang tersedia saat menggunakan Cloud Run, serta bagaimana cara melihat dan menulis log.

Cloud Run memiliki beberapa jenis log yang dikirim secara otomatis ke Cloud Logging:

• Log permintaan (khusus layanan): log permintaan yang dikirim ke layanan Cloud Run. Log ini dibuat secara otomatis.
• Log container (semua resource): log yang dikeluarkan dari instance, biasanya dari kode Anda sendiri, yang ditulis ke lokasi yang didukung seperti yang dijelaskan dalam Menulis log container.
• Log sistem (semua resource): log yang dibuat platform yang berisi informasi tentang workload Anda. Log ini ditulis ke varlog/system.

Melihat log

Anda dapat melihat log untuk resource Cloud Run dengan beberapa cara:

• Gunakan halaman Cloud Run di konsol Cloud de Confiance
• Menggunakan Cloud Logging
• Gunakan Google Cloud CLI untuk melihat log menggunakan gcloud (khusus layanan)

Kedua metode konsol tersebut memeriksa log yang sama yang disimpan di Cloud Logging. Namun, Cloud Logging, misalnya seperti Logs Explorer, menyediakan detail yang lebih lengkap dan kemampuan pemfilteran yang lebih baik.

Melihat log di Cloud Run

Anda dapat melihat log di halaman Cloud Run untuk resource berikut:

Format dan isi log penskalaan instance

Saat instance baru dimulai untuk layanan Cloud Run Anda, Cloud Logging menyertakan entri log dengan nama log varlog/system yang menjelaskan alasan setiap instance dibuat. Entri log mengikuti format ini:

Starting new instance. Reason: REASON - DESCRIPTION

Tabel berikut memberikan perincian deskripsi instance:

Menulis log container

Saat Anda menulis log dari layanan, tugas, atau kumpulan worker, log tersebut akan diambil secara otomatis oleh Cloud Logging. Hal ini berlaku selama log tersebut ditulis ke salah satu lokasi berikut:

• Aliran data output standar (stdout) atau error standar (stderr)
• Semua file yang ada dalam direktori /var/log
• syslog (/dev/log)
• Log yang tersedia dalam berbagai bahasa populer yang ditulis menggunakan library klien Cloud Logging

Sebagian besar developer diharapkan untuk menggunakan output standar dan error standar saat menulis log.

Log container yang ditulis ke lokasi yang didukung ini akan otomatis dikaitkan dengan layanan, revisi, dan lokasi Cloud Run, kumpulan pekerja, revisi, dan lokasi Cloud Run, atau dengan tugas Cloud Run. Pengecualian yang terdapat dalam log ini direkam dan dilaporkan dalam Error Reporting.

Logging terintegrasi menyeimbangkan keandalan dan penggunaan resource, serta akan berfungsi untuk sebagian besar aplikasi. Menulis entri log menggunakan logging terintegrasi tidak menggunakan kuota untuk jumlah permintaan entries.write per menit dari Cloud Logging API.

Jika aplikasi Anda memiliki persyaratan untuk volume atau keandalan yang lebih tinggi, sebaiknya gunakan Cloud Logging API secara langsung, baik sebagai library dalam aplikasi Anda atau sebagai container sidecar terpisah.

Menggunakan teks sederhana vs JSON terstruktur dalam log

Saat menulis log, Anda dapat mengirim string teks sederhana atau mengirim satu baris JSON yang di-serialisasi. Teks ini juga disebut data "terstruktur". Teks string ini diambil dan diurai oleh Cloud Logging dan ditempatkan ke jsonPayload. Sebaliknya, pesan teks sederhana ditempatkan di textPayload.

Menulis log terstruktur

Cuplikan berikut menunjukkan bagaimana cara menulis entri log yang terstruktur. Cuplikan ini juga menunjukkan bagaimana cara menghubungkan pesan log dengan log permintaan yang sesuai.

// Uncomment and populate this variable in your code:
// const project = 'The project ID of your function or Cloud Run service';

// Build structured log messages as an object.
const globalLogFields = {};

// Add log correlation to nest all log messages beneath request log in Log Viewer.
// (This only works for HTTP-based invocations where `req` is defined.)
if (typeof req !== 'undefined') {
  const traceHeader = req.header('X-Cloud-Trace-Context');
  if (traceHeader && project) {
    const [trace] = traceHeader.split('/');
    globalLogFields['logging.googleapis.com/trace'] =
      `projects/${project}/traces/${trace}`;
  }
}

// Complete a structured log entry.
const entry = Object.assign(
  {
    severity: 'NOTICE',
    message: 'This is the default display field.',
    // Log viewer accesses 'component' as 'jsonPayload.component'.
    component: 'arbitrary-property',
  },
  globalLogFields
);

// Serialize to a JSON string and output.
console.log(JSON.stringify(entry));

# Uncomment and populate this variable in your code:
# PROJECT = 'The project ID of your Cloud Run service';

# Build structured log messages as an object.
global_log_fields = {}

# Add log correlation to nest all log messages.
# This is only relevant in HTTP-based contexts, and is ignored elsewhere.
# (In particular, non-HTTP-based Cloud Functions.)
request_is_defined = "request" in globals() or "request" in locals()
if request_is_defined and request:
    trace_header = request.headers.get("X-Cloud-Trace-Context")

    if trace_header and PROJECT:
        trace = trace_header.split("/")
        global_log_fields[
            "logging.googleapis.com/trace"
        ] = f"projects/{PROJECT}/traces/{trace[0]}"

# Complete a structured log entry.
entry = dict(
    severity="NOTICE",
    message="This is the default display field.",
    # Log viewer accesses 'component' as jsonPayload.component'.
    component="arbitrary-property",
    **global_log_fields,
)

print(json.dumps(entry))

// Entry defines a log entry.
type Entry struct {
	Message  string `json:"message"`
	Severity string `json:"severity,omitempty"`
	Trace    string `json:"logging.googleapis.com/trace,omitempty"`

	// Logs Explorer allows filtering and display of this as `jsonPayload.component`.
	Component string `json:"component,omitempty"`
}

// String renders an entry structure to the JSON format expected by Cloud Logging.
func (e Entry) String() string {
	if e.Severity == "" {
		e.Severity = "INFO"
	}
	out, err := json.Marshal(e)
	if err != nil {
		log.Printf("json.Marshal: %v", err)
	}
	return string(out)
}

func init() {
	// Disable log prefixes such as the default timestamp.
	// Prefix text prevents the message from being parsed as JSON.
	// A timestamp is added when shipping logs to Cloud Logging.
	log.SetFlags(0)
}

func indexHandler(w http.ResponseWriter, r *http.Request) {
	// Uncomment and populate this variable in your code:
	// projectID = "The project ID of your Cloud Run service"

	// Derive the traceID associated with the current request.
	var trace string
	if projectID != "" {
		traceHeader := r.Header.Get("X-Cloud-Trace-Context")
		traceParts := strings.Split(traceHeader, "/")
		if len(traceParts) > 0 && len(traceParts[0]) > 0 {
			trace = fmt.Sprintf("projects/%s/traces/%s", projectID, traceParts[0])
		}
	}

	log.Println(Entry{
		Severity:  "NOTICE",
		Message:   "This is the default display field.",
		Component: "arbitrary-property",
		Trace:     trace,
	})

	fmt.Fprintln(w, "Hello Logger!")
}

// Add log correlation to nest all log messages beneath request log in Log Viewer.
// TODO(developer): delete this code if you're creating a Cloud
//                  Function and it is *NOT* triggered by HTTP.
String traceHeader = req.headers("x-cloud-trace-context");
if (traceHeader != null && project != null) {
  String trace = traceHeader.split("/")[0];
  MDC.put(
      "logging.googleapis.com/trace",
      String.format("projects/%s/traces/%s", project, trace));
}
// -- End log correlation code --

// Create a structured log entry using MDC (Mapped Diagnostic Context) keys.
// For instantiating the "logger" variable, see
// https://cloud.google.com/run/docs/logging#run_manual_logging-java
MDC.put("component", "arbitrary-property");

logger.info("This is the default display field.");

// Clear MDC at the end of the request to avoid resource leaks
MDC.clear();

<configuration>
  <appender name="CLOUD" class="com.google.cloud.logging.logback.LoggingAppender">
    <!-- Optional : filter logs at or above a level -->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>INFO</level>
    </filter>
    <log>application.log</log> <!-- Optional : default java.log -->
    <resourceType>gae_app</resourceType> <!-- Optional : default: auto-detected, fallback: global -->
    <enhancer>com.example.logging.logback.enhancers.ExampleEnhancer</enhancer> <!-- Optional -->
    <flushLevel>WARN</flushLevel> <!-- Optional : default ERROR -->
    <!-- Redirect logs to stdout in JSON format for Cloud Run to capture -->
    <redirectToStdout>true</redirectToStdout>
  </appender>
  <root level="INFO">
    <appender-ref ref="CLOUD"/>
  </root>
</configuration>

{"severity":"INFO","time":"YYYY-MM-DDTHH:MM:SS.SSSZ","logging.googleapis.com/labels":{"component":"arbitrary-property","levelName":"INFO","loggerName":"com.example.cloudrun.App","levelValue":"20000"},"logging.googleapis.com/trace_sampled":false,"message":"This is the default display field."}

Kolom JSON khusus dalam pesan

Apabila Anda menyediakan log yang terstruktur sebagai kamus JSON, beberapa kolom khusus akan dihapus dari jsonPayload dan ditulis ke kolom yang sesuai dalam LogEntry yang dibuat. Hal ini sebagaimana dijelaskan dalam dokumentasi untuk kolom khusus.

Misalnya, jika JSON Anda menyertakan properti severity, maka JSON tersebut akan dihapus dari jsonPayload dan muncul sebagai entri log milik severity. Properti message digunakan sebagai teks tampilan utama entri log jika ada. Untuk mengetahui informasi lebih lanjut tentang properti khusus, baca bagian Resource Logging di bawah ini.

Hubungkan log container Anda dengan log permintaan (khusus layanan)

Di Logs Explorer, log yang dikorelasikan dengan trace yang sama dapat dilihat dalam format "parent-child": jika Anda mengklik ikon segitiga di sebelah kiri entri log permintaan, maka log container yang berkaitan dengan permintaan tersebut akan muncul secara bertingkat.

Log container tidak secara otomatis berkorelasi dengan log permintaan, kecuali jika Anda menggunakan library klien Cloud Logging. Untuk menghubungkan log container dengan log permintaan tanpa menggunakan library klien, Anda dapat menggunakan baris log JSON terstruktur yang berisi kolom logging.googleapis.com/trace dengan ID trace yang diekstrak dari header X-Cloud-Trace-Context, seperti yang ditunjukkan pada contoh di atas untuk logging terstruktur.

Mengontrol permintaan penggunaan resource log (khusus layanan)

Log permintaan dibuat secara otomatis. Meskipun tidak dapat mengontrol jumlah log permintaan dari Cloud Run secara langsung, Anda dapat memanfaatkan fitur pengecualian log dari Cloud Logging.

Catatan tentang agen logging

Jika Anda telah menggunakan Cloud Logging dengan produk Cloud de Confiance by S3NS tertentu, seperti Compute Engine, Anda mungkin telah menggunakan agen logging Cloud Logging. Cloud Run tidak menggunakan agen logging karena memiliki dukungan bawaan untuk pengumpulan log.

Nama resource logging

Berikut nama resource logging untuk Cloud Run:

• Revisi Cloud Run (cloud_run_revision).
• Tugas Cloud Run (cloud_run_job).

Resource logging

Mengklik entri log di Logs Explorer akan membuka entri log berformat JSON sehingga Anda dapat melihat perincian detail yang diinginkan.

Semua kolom dalam entri log, seperti stempel waktu, tingkat keparahan, dan httpRequest merupakan hal standar dan dijelaskan dalam dokumentasi untuk suatu entri log.

Cloud Run menambahkan metadata tambahan agar Anda dapat mengidentifikasi sumber log. Metadata ini mencakup (label yang Anda tetapkan pada layanan Cloud Run) dan label resource yang khusus untuk Cloud Run.

Kolom entri log untuk layanan

Berikut adalah daftar kolom yang dapat ditemukan dalam entri log untuk layanan Cloud Run:

Berikut adalah contoh entri log permintaan untuk layanan Cloud Run:

{
 httpRequest: {…}
 insertId:  "5c82b3d1000ece0000000000"
 labels: {
  instanceId:  "00bf4bf00000fb59c906a00000c9e29c2c4e06dce91500000000056008d2b6460f163c0057b97b2345f2725fb2423ee5f0bafd36df887fdb1122371563cf1ff453717282afe000001"
  mylabel: "mylabelvalue"
  mysecondlabel: "mysecondlabelvalue"
 }
 logName:  "projects/my-project/logs/run.googleapis.com%2Frequests"
 receiveTimestamp:  "2019-03-08T18:26:25.981686167Z"
 resource: {
  labels: {
   configuration_name:  "myservice"
   location:  "europe-west1"
   project_id:  "my-project"
   revision_name:  "myservice-00002"
   service_name:  "myservice"
  }
  type:  "cloud_run_revision"
 }
 severity:  "INFO"
 timestamp:  "2019-03-08T18:26:25.970397Z"
}

Kolom entri log untuk tugas

Berikut adalah daftar kolom yang dapat ditemukan dalam entri log untuk tugas Cloud Run: