generate

package

v1.1.0 Latest Latest Go to latest Published: Jan 25, 2024 License: Apache-2.0, MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/autometrics-dev/autometrics-go

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 ¶

View Source

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\""
)

Variables ¶

This section is empty.

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 ¶ added in v0.9.0

type GenerateError struct {
	FunctionName string
	Detail       error
}

type GenerateErrors ¶ added in v0.9.0

type GenerateErrors []GenerateError

func (GenerateErrors) Error ¶ added in v0.9.0

func (errs GenerateErrors) Error() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL