googleapis/google-cloud-python

Improve the Write logEntry sample

Closed

#15,426 opened on Dec 10, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (1,481 forks)batch import
api: logginggood first issuepriority: p3samplestype: feature request

Repository metrics

Stars
 (4,304 stars)
PR merge metrics
 (Avg merge 4d) (158 merged PRs in 30d)

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

Contributor guide

Research direction
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
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic PythonGoogle Cloud accountFamiliarity with Cloud Logging
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60