googleapis/google-cloud-python

Improve the Write logEntry sample

Fermée

#15 426 ouverte le 10 déc. 2020

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Python (1 481 forks)batch import
api: logginggood first issuepriority: p3samplestype: feature request

Métriques du dépôt

Stars
 (4 304 étoiles)
Métriques de merge PR
 (Merge moyen 4j) (158 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
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.
Stack technique
python
Domaine
documentationtesting
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Basic PythonGoogle Cloud accountFamiliarity with Cloud Logging
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60