This repository has been archived by the owner on Dec 12, 2024. It is now read-only.
Stackdriver logging #68 #81
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,12 +33,5 @@ | |
| <exclude>**/META-INF/**</exclude> | ||
| </excludes> | ||
| </fileSet> | ||
| </fileSets> | ||
| </assembly> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| * Copyright (C) 2016 Google Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.runtimes.jetty9; | ||
|
|
||
| import com.google.cloud.logging.TraceLoggingEnhancer; | ||
|
|
||
| import org.eclipse.jetty.server.Request; | ||
| import org.eclipse.jetty.server.handler.ContextHandler; | ||
| import org.eclipse.jetty.server.handler.ContextHandler.Context; | ||
| import org.eclipse.jetty.server.handler.ContextHandler.ContextScopeListener; | ||
|
|
||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** | ||
| * A Jetty {@link ContextScopeListener} that is called whenever | ||
| * a container managed thread enters or exits the scope of a context and/or request. | ||
| * Used to maintain {@link ThreadLocal} references to the current request and | ||
| * Google traceID, primarily for logging. | ||
| * @see TracingLogHandler | ||
| */ | ||
| public class RequestContextScope implements ContextHandler.ContextScopeListener { | ||
|
There was a problem hiding this comment. Can you add some javadocs to explain the purpose of the class? |
||
| static final Logger logger = Logger.getLogger(RequestContextScope.class.getName()); | ||
|
|
||
| private static final String X_CLOUD_TRACE = "x-cloud-trace-context"; | ||
| private static final ThreadLocal<Integer> contextDepth = new ThreadLocal<>(); | ||
|
|
||
| @Override | ||
| public void enterScope(Context context, Request request, Object reason) { | ||
| if (logger.isLoggable(Level.FINE)) { | ||
| logger.fine("enterScope " + context); | ||
| } | ||
| if (request != null) { | ||
| Integer depth = contextDepth.get(); | ||
| if (depth == null || depth.intValue() == 0) { | ||
| depth = 1; | ||
| String traceId = (String) request.getAttribute(X_CLOUD_TRACE); | ||
| if (traceId == null) { | ||
| traceId = request.getHeader(X_CLOUD_TRACE); | ||
| if (traceId != null) { | ||
| int slash = traceId.indexOf('/'); | ||
| if (slash >= 0) { | ||
| traceId = traceId.substring(0, slash); | ||
| } | ||
| request.setAttribute(X_CLOUD_TRACE, traceId); | ||
| TraceLoggingEnhancer.setCurrentTraceId(traceId); | ||
| } | ||
| } else { | ||
| depth = depth + 1; | ||
| } | ||
| contextDepth.set(depth); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void exitScope(Context context, Request request) { | ||
| if (logger.isLoggable(Level.FINE)) { | ||
| logger.fine("exitScope " + context); | ||
| } | ||
| Integer depth = contextDepth.get(); | ||
| if (depth != null) { | ||
| if (depth > 1) { | ||
| contextDepth.set(depth - 1); | ||
| } else { | ||
| contextDepth.remove(); | ||
| TraceLoggingEnhancer.setCurrentTraceId(null); | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| --create-startd | ||
| --approve-all-licenses | ||
| --add-to-start=server,webapp,http,deploy,jsp,jstl,resources,logging-jul,jcl-slf4j | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| .level=INFO | ||
|
|
||
| handlers=java.util.logging.ConsoleHandler | ||
| java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter | ||
| java.util.logging.SimpleFormatter.format=%3$s: %5$s%6$s%n | ||
|
|
||
| ## To use Stackdriver Logging replace the configuration above with the configuration below: | ||
| # handlers=com.google.cloud.logging.LoggingHandler | ||
| # com.google.cloud.logging.LoggingHandler.level=FINE | ||
| # com.google.cloud.logging.LoggingHandler.log=gae_app.log | ||
| # com.google.cloud.logging.LoggingHandler.resourceType=gae_app | ||
| # com.google.cloud.logging.LoggingHandler.enhancers=com.google.cloud.logging.GaeFlexLoggingEnhancer | ||
| # com.google.cloud.logging.LoggingHandler.formatter=java.util.logging.SimpleFormatter | ||
| # java.util.logging.SimpleFormatter.format=%3$s: %5$s%6$s |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| /* | ||
| * Copyright (C) 2016 Google Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.cloud.runtimes.jetty9; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.logging.Logger; | ||
|
|
||
| import javax.annotation.PostConstruct; | ||
| import javax.servlet.ServletException; | ||
| import javax.servlet.annotation.WebServlet; | ||
| import javax.servlet.http.HttpServlet; | ||
| import javax.servlet.http.HttpServletRequest; | ||
| import javax.servlet.http.HttpServletResponse; | ||
|
|
||
|
|
||
| @SuppressWarnings("serial") | ||
| @WebServlet(urlPatterns = {"/", "/test/*"}, name = "TestServlet") | ||
| public class TestServlet extends HttpServlet { | ||
| static final Logger log = Logger.getLogger(TestServlet.class.getName()); | ||
|
|
||
| @PostConstruct | ||
| private void myPostConstructMethod() { | ||
| log.info("preconstructed"); | ||
| } | ||
|
|
||
| @Override | ||
| public void init() throws ServletException { | ||
| log.info("init info"); | ||
| getServletContext().log("init ServletContext.log"); | ||
| } | ||
|
|
||
| @Override | ||
| public void doGet(HttpServletRequest request, HttpServletResponse response) | ||
| throws ServletException, IOException { | ||
| log.info("doGet info"); | ||
| getServletContext().log("doGet ServletContext.log"); | ||
|
|
||
| if (request.getParameter("ex") != null) { | ||
| try { | ||
| throw (Throwable) Class.forName(request.getParameter("ex")).newInstance(); | ||
| } catch (ServletException | IOException ex) { | ||
| throw ex; | ||
| } catch (Throwable th) { | ||
| throw new ServletException(th); | ||
| } | ||
| } | ||
| response.getWriter().println("Log Test"); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to enable this handler conditionally based on environment in which the container is running. For example, it won't work locally.