googleapis/google-cloud-java

[java-logging] Sample: update quickstart snippet

Open

#11 924 ouverte le 9 déc. 2020

Voir sur GitHub
 (1 commentaire) (0 réactions) (1 assigné)Java (1 082 forks)batch import
api: logginggood first issuepriority: p3samplestype: feature request

Métriques du dépôt

Stars
 (1 763 stars)
Métriques de merge PR
 (Merge moyen 2j 21h) (145 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le problème consiste à mettre à jour l'exemple de démarrage rapide de journalisation Java. L'exemple actuel se trouve à l'adresse https://cloud.google.com/logging/docs/samples/logging quickstart#logging quickstart java. La mise à jour doit ajouter des commentaires sur les méthodes d'authentification, encourager l'utilisation de l'appender Logback et inclure un lien vers l'écriture d'entrées de journal personnalisées. Un test peut être ajouté si applicable. L'assigné n'a pas encore soumis de PR, donc vérifiez s'il existe des travaux existants dans la branche ou les forks du dépôt.
Stack technique
java
Domaine
backendclouddocumentation
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 JavaFamiliarity with Google Cloud LoggingUnderstanding of GitHub workflow
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60