Skip to content

asecurityteam/component-expvar

Repository files navigation

component-expvar - Settings component for sending expvar metrics

GoDoc

Overview

This is a settings that enables sending metrics for the values usually provided through the Expvar HTTP endpoints. We have extended the set of metrics to also include the current goroutine count.

Quick Start

package main

import (
    "context"
    "net/http"

    stat "github.com/asecurityteam/component-stat"
    expvar "github.com/asecurityteam/component-expvar"
    "github.com/asecurityteam/settings/v2"
)

func main() {
    ctx := context.Background()
    envSource := settings.NewEnvSource(os.Environ())

    s, _ := stat.New(ctx, envSource)
    exp, _ := expvar.Load(ctx, envSource, expvar.NewComponent().WithStat(s))
    defer exp.Close()
    go exp.Report()
}

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.