googleapis/google-cloud-java

[java-logging] Sample: update quickstart snippet

Open

#11.924 geöffnet am 9. Dez. 2020

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (1 zugewiesene Person)Java (1.082 Forks)batch import
api: logginggood first issuepriority: p3samplestype: feature request

Repository-Metriken

Stars
 (1.763 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 2T 21h) (145 gemergte PRs in 30 T)

Beschreibung

Improve the Logging quickstart in Java. Quickstart should work out of the box and contain all the instructions (in comments) so users can immediately see their logs.

Additional criteria:

  • include comments on various ways to authenticate
  • encourage users to log with standard log wrapper Logback rather than directly writing LogEntries. Context: In an ideal world, customers should be able to use existing logging frameworks native to their language. With some simple appender/handler to also ship logs to Cloud Logging. Customers aren't locked into logging library syntax, thus it's easier to both onboarding and offboard off of these client libraries.
  • comment that if users need more customizable logs, redirect to writing log entries
  • if applicable, a test for this sample

Contributor Guide

Research-Richtung
Das Problem besteht darin, das Java Logging Schnellstartbeispiel zu aktualisieren. Das aktuelle Beispiel befindet sich unter https://cloud.google.com/logging/docs/samples/logging quickstart#logging quickstart java. Das Update sollte Kommentare zu Authentifizierungsmethoden hinzufügen, die Verwendung des Logback Appenders empfehlen und einen Link zum Schreiben benutzerdefinierter Logeinträge enthalten. Falls zutreffend, kann ein Test hinzugefügt werden. Der Beauftragte hat noch keinen PR eingereicht, daher sollten Sie nach bestehenden Arbeiten im Branch oder in Forks des Repositorys suchen.
Tech Stack
java
Domain
backendclouddocumentation
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 JavaFamiliarity with Google Cloud LoggingUnderstanding of GitHub workflow
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60