README
¶
component-log - Settings component for generating a log client
Overview
This is a settings that enables
constructing a log client. The resulting client is powered by
logevent.
Quick Start
package main
import (
"context"
log "github.com/asecurityteam/component-log"
"github.com/asecurityteam/settings/v2"
)
type AnEventToLog struct {
Message string `logevent:"message,default=an-event"`
}
func main() {
ctx := context.Background()
envSource := settings.NewEnvSource(os.Environ())
logger := log.New(ctx, envSource)
logger.Info(AnEventToLog{})
}
Status
This project is in incubation which means we are not yet operating this tool in production and the interfaces are subject to change.
Contributing
Building And Testing
We publish a docker image called SDCLI that bundles all of our build dependencies. It is used by the included Makefile to help make building and testing a bit easier. The following actions are available through the Makefile:
-
make dep
Install the project dependencies into a vendor directory
-
make lint
Run our static analysis suite
-
make test
Run unit tests and generate a coverage artifact
-
make integration
Run integration tests and generate a coverage artifact
-
make coverage
Report the combined coverage for unit and integration tests
License
This project is licensed under Apache 2.0. See LICENSE.txt for details.
Contributing Agreement
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.
Documentation
¶
Index ¶
Constants ¶
const ( // OutputStdout sends logs to stdout. OutputStdout = "STDOUT" // OutputNull sends logs to /dev/null. OutputNull = "NULL" )
Variables ¶
var LoggerFromContext = logevent.FromContext
LoggerFromContext is the concrete implementation of LogFn that should be used at runtime.
Functions ¶
This section is empty.
Types ¶
type Component ¶
type Component struct{}
Component enables creating configured loggers.
type Config ¶
type Config struct {
Level string `description:"The minimum level of logs to emit. One of DEBUG, INFO, WARN, ERROR."`
Output string `description:"Destination stream of the logs. One of STDOUT, NULL."`
}
Config contains all configuration values for creating a system logger.
type LogFn ¶
LogFn is the type that should be accepted by components that intend to log content using the context logger.
Source Files