8000 GitHub - asecurityteam/component-log: Settings component for generating a log client
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

asecurityteam/component-log

Repository files navigation

component-log - Settings component for generating a log client

GoDoc

Code Smells Coverage Duplicated Lines (%) Lines of Code Maintainability Rating Quality Gate Status Reliability Rating Security Rating Technical Debt Vulnerabilities

autoauto- [component-log - Settings component for generating a log client](#component-log---settings-component-for-generating-a-log-client)auto - [Overview](#overview)auto - [Quick Start](#quick-start)auto - [Status](#status)auto - [Contributing](#contributing)auto - [Building And Testing](#building-and-testing)auto - [License](#license)auto - [Contributing Agreement](#contributing-agreement)autoauto

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.

About

Settings component for generating a log client

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 15

0