Skip to content

docs(logging): update quickstart guidance #12975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MukundaKatta wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(logging): update quickstart guidance #12975

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5650c7
docs(logging): update quickstart guidance
MukundaKatta Apr 30, 2026
29b6da8
docs(logging): use Javadoc tags instead of Markdown in QuickstartSample
MukundaKatta May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions java-logging/samples/snippets/src/main/java/com/example/logging/QuickstartSample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,24 @@
import java.util.Collections;

/**
* This sample demonstrates writing logs using the Cloud Logging API. The library also offers a
* java.util.logging Handler `com.google.cloud.logging.LoggingHandler` Logback integration is also
* available :
* https://github.com/googleapis/google-cloud-java/tree/master/google-cloud-clients/google-cloud-contrib/google-cloud-logging-logback
* Using the java.util.logging handler / Logback appender should be preferred to using the API
* directly.
* This sample demonstrates writing logs directly with the Cloud Logging API.
*
* <p>Authenticate by running {@code gcloud auth application-default login}, by setting the
* {@code GOOGLE_APPLICATION_CREDENTIALS} environment variable to a service account key path, or by
* running this sample on Google Cloud where Application Default Credentials are available
* automatically.
*
* <p>For production applications, prefer using a standard logging framework with Cloud Logging
* integration, such as Logback with <a
* href="https://github.com/googleapis/java-logging-logback">https://github.com/googleapis/java-logging-logback</a>.
* If you need more customizable {@code LogEntry} fields, see the {@code WriteLogEntry} sample.
*/
public class QuickstartSample {

/** Expects a new or existing Cloud log name as the first argument. */
public static void main(String... args) throws Exception {
// The name of the log to write to
String logName = args[0]; // "my-log";
String logName = args.length > 0 ? args[0] : "my-log";
String textPayload = "Hello, world!";

// Instantiates a client
Expand Down
Loading