googleapis/google-cloud-java

[java-logging] Improve the Write logEntry sample

Open

#11,923 opened on Dec 10, 2020

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Java (1,082 forks)batch import
api: logginggood first issuelang: javapriority: p3samplestype: feature request

Repository metrics

Stars
 (1,763 stars)
PR merge metrics
 (Avg merge 2d 21h) (145 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
Locate the sample file in the repository using the region tag 'logging write log entry'. Implement the five criteria: text payload, struct payload, severity, labels, resource type, and batch logging. Update the corresponding test file. Since the issue has an assignee, coordinate with them or check their progress before proceeding.
Tech stack
java
Domain
backenddocumentationobservability
Issue type
Feature
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-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaGoogle Cloud LoggingJUnit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40