coopdatadog

README

Coop Datadog Go package

Plug and play package that wraps base functionally and initialization of Datadog Service.

• APM, StatsD Initialization
• StatsD metrics unification

Supported middleware to correlate/extend traceability and logs in Datadog.

• gRPC Server
• gRPC Client
• HTTP - Echo
• HTTP - Standard library Client
• Database - GORM
• Database - Standard library

Documentation

https://pkg.go.dev/github.com/coopnorge/go-datadog-lib/v2

Mocks

To generate or update mocks use gomockhandler. gomockhandler is provided by golang-devtools.

Check mocks

docker compose run --rm golang-devtools gomockhandler -config ./gomockhandler.json check

Generate / Update mocks

docker compose run --rm golang-devtools gomockhandler -config ./gomockhandler.json mockgen

Development workflow

Validate

docker compose run --rm golang-devtools validate

Other targets

docker compose run --rm golang-devtools help

User documentation

User documentation is build using TechDocs and published to Inventory.

To list the commands available for the TechDocs image:

docker compose run --rm help

For more information see the TechDocs Engineering Image.

Documentation validation

To Validate changed documentation:

docker compose run --rm techdocs validate

To validate all documentation:

docker compose run --rm techdocs validate MARKDOWN_FILES=docs/

Documentation preview

To preview the documentation:

docker compose up techdocs

Documentation

Index

• func GracefulDatadogShutdown()
• func StartDatadog(cfg config.DatadogParameters, connectionType ConnectionType) error
• type ConnectionType
• type Option
  • func WithErrorHandler(handler errors.ErrorHandler) Option
  • func WithMetricsOptions(metricOptions ...metrics.Option) Option
  • func WithNoStopTimeout() Option
  • func WithStopTimeout(timeout time.Duration) Option
• type StopFunc
  • func Start(ctx context.Context, opts ...Option) (StopFunc, error)

Examples

• Start

Functions

func GracefulDatadogShutdown

func GracefulDatadogShutdown()

GracefulDatadogShutdown of executed parallel processes

Deprecated: Use the StopFunc returned coopdatadog.Start() instead.

func StartDatadog

func StartDatadog(cfg config.DatadogParameters, connectionType ConnectionType) error

StartDatadog parallel process to collect data for Datadog. connectionType flag related to Datadog connection type, it supports HTTP or socket - values will be used from config.DatadogParameters

Deprecated: Use coopdatadog.Start() instead.

Types

type ConnectionType

type ConnectionType byte

ConnectionType enum type

Deprecated: Use coopdatadog.Start() instead.

const (
	// ConnectionTypeSocket sets the connection to Datadog to go through a UNIX socket
	//
	// Deprecated: ConnectionTypeSocket. ConnectionTypeAuto should be used.
	ConnectionTypeSocket ConnectionType = iota
	// ConnectionTypeHTTP sets the connection to Datadog to go over HTTP
	//
	// Deprecated: ConnectionTypeHTTP. ConnectionTypeAuto should be used.
	ConnectionTypeHTTP
	// ConnectionTypeAuto sets connection to HTTP or UNIX depending on supplied configuration of DD_TRACE_AGENT_URL
	//
	// Deprecated: Use coopdatadog.Start() instead.
	ConnectionTypeAuto
)

type Option

type Option func(*options) error

Option is used to configure the behaviour of the Datadog integration.

func WithErrorHandler

func WithErrorHandler(handler errors.ErrorHandler) Option

WithErrorHandler allows for setting a custom ErrorHandler to be called on function that may error but does not return an error

func WithMetricsOptions

func WithMetricsOptions(metricOptions ...metrics.Option) Option

WithMetricsOptions allows for passing the options for setting up metrics

func WithNoStopTimeout

func WithNoStopTimeout() Option

WithNoStopTimeout waits for graceful shutdown to complete regardless of how long.

func WithStopTimeout

func WithStopTimeout(timeout time.Duration) Option

WithStopTimeout sets the allowed time for graceful shutdown, defaults to 10 seconds.

type StopFunc

type StopFunc func() error

StopFunc is a function signature for functions that stops the Datadog integration.

func Start

func Start(ctx context.Context, opts ...Option) (StopFunc, error)

Start the Datadog integration, use the returned Cancel function to stop the Datadog integration. When calling the StopFunc function traces will be flushed and profiling will be stopped to Datadog.

Example

package main

import (
	"context"

	coopdatadog "github.com/coopnorge/go-datadog-lib/v2"
)

func main() {
	err := run()
	if err != nil {
		panic(err)
	}
}

func run() error {
	stop, err := coopdatadog.Start(context.Background())
	if err != nil {
		return err
	}
	defer func() {
		err := stop()
		if err != nil {
			panic(err)
		}
	}()

	// ...

	return nil
}