Status: Production
Atlassian development teams often operate multiple dozens of individual services spanning up to hundreds of instances. To help with operations, we've aligned with our company's global logging standard. This standard defines the structure of most logs in addition to defining the kinds of logs that should be emitted by services.
This packages exports several structs that represent the structured log events defined by Atlassian's specification:
-
httplog.BaseThis represents the minimum, common base of all log events. All events must contain the fields defined in this struct.
-
httplog.AccessThis defines the fields needed in all system access logs. These are modelled after HTTP request logs available from other systems like Apache or NGINX.
-
httplog.EventThis struct represents the base for all developer defined system events. This struct should be embedded in all logs emitted by a service.
This package is primarily focused on providing a logging harness around HTTP
services and exposes a wrapper for http.Handler that provides this feature.
var middleware = httplog.NewMiddleware()
http.ListenAndServer(":8080", middleware(http.DefaultServeMux))The default behaviour of the middleware is to provide Atlassian logging spec compliant access logs for your HTTP service. Quite a few default settings are selected which can be overridden with the available function arguments.
var middleware = httplog.NewMiddleware(
MiddlewareOptionTag("key", "value"), // Add arbitrary annotations to all logs.
MiddlewareOptionService("myService"), // Set the service name field to a custom value.
MiddlewareOptionHost("customHost"), // Set the host field to something other than the system hostname.
MiddlewareOptionVersion("1.2.3"), // Set the service version that is active.
MiddlewareOptionEnv("staging"), // Set the environment the service is running in.
// Set the function used to populate the request_id field in all log events.
MiddlewareOptionRequestID(func(r *http.Request) string { return httptrace.TraceIDFromContext(r.Context()) }),
// Set the function used to populate the transaction_id field in all developer events.
MiddlewareOptionTransactionID(func(r *http.Request) string { return httptrace.SpanIDFromContext(r.Context()) }),
MiddlewareOptionLevel("DEBUG"), // Set the minimum log level to be emitted.
MiddlewareOptionPatchSTDLib, // Reconfigure `log.Println`, etc., to use JSON format.
MiddlewareOptionConsole, // Disable JSON in favour of a human readable line format.
)This project is licensed under Apache 2.0. See LICENSE.txt for details.
Atlassian requires signing a contributor's agreement before we can accept a patch. If you are an individual you can fill out the individual CLA. If you are contributing on behalf of your company then please fill out the corporate CLA.