googleapis/google-cloud-python

Improve the Write logEntry sample

Geschlossen

#15.426 geöffnet am 10.12.2020

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (1.481 Forks)batch import
api: logginggood first issuepriority: p3samplestype: feature request

Repository-Metriken

Stars
 (4.304 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 4T) (158 gemergte PRs in 30 T)

Beschreibung

Improve the Write logEntry sample on this page

This page is referenced by docs that explicitly talk about LogEntries. So we should demo this “advanced” logging technique, even though we do recommend the standard log wrapper approach in the quickstarts.

Criteria:

  • Demo how to write a text logEntry (textPayload)
  • Demo how to write a struct logEntry (jsonPayload)
  • Include: severity level, labels, resource type (“global”)
  • Demo: batch logging vs writing one log at a time
  • Update accompanying tests

Region tag: logging_write_log_entry

Contributor Guide

Research-Richtung
The issue requires improving the 'Write logEntry' sample at https://cloud.google.com/logging/docs/samples/logging write log entry. The criteria include demonstrating textPayload, jsonPayload, severity, labels, resource type, batch vs single logging, and updating tests. The region tag is 'logging write log entry'. Start by exploring the existing sample in the google cloud python repository, likely under the logging directory. Review the current test suite for that sample and understand how the Google Cloud Logging client library handles log entries. Ensure the new sample follows the established patterns and passes all tests.
Tech Stack
python
Domain
documentationtesting
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic PythonGoogle Cloud accountFamiliarity with Cloud Logging
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60