generate

Documentation

Index

• Constants
• func GenerateDocumentationAndInstrumentation(ctx internal.GeneratorContext, sourceCode, moduleName string) (string, error)
• func TransformFile(ctx internal.GeneratorContext, path, moduleName string) error
• type GenerateError
• type GenerateErrors
  • func (errs GenerateErrors) Error() string

Constants

const (
	SloNameArgument    = "--slo"
	SuccessObjArgument = "--success-target"
	LatencyMsArgument  = "--latency-ms"
	LatencyObjArgument = "--latency-target"
	NoDocArgument      = "--no-doc"

	AmPromPackage = "\"github.com/autometrics-dev/autometrics-go/prometheus/autometrics\""
	AmOtelPackage = "\"github.com/autometrics-dev/autometrics-go/otel/autometrics\""
)

Functions

func GenerateDocumentationAndInstrumentation

func GenerateDocumentationAndInstrumentation(ctx internal.GeneratorContext, sourceCode, moduleName string) (string, error)

GenerateDocumentationAndInstrumentation takes the raw source code from a file and generates the documentation for the `//autometrics:inst` functions.

It returns the new source code with augmented documentation.

func TransformFile

func TransformFile(ctx internal.GeneratorContext, path, moduleName string) error

TransformFile takes a file path and generates the documentation for the `//autometrics:inst` functions.

It also replaces the file in place.

Types

type GenerateError

type GenerateError struct {
	FunctionName string
	Detail       error
}

type GenerateErrors

type GenerateErrors []GenerateError

func (GenerateErrors) Error

func (errs GenerateErrors) Error() string