# Functions
Convenience re-export of [hex.DecodeString] to allow generating code without touching imports in instrumented file.
ForceFlush forces a flush of the metrics, in the case autometrics is pushing metrics to a Prometheus Push Gateway.
Init sets up the metrics required for autometrics' decorated functions and registers them to the argument registry.
Instrument called in a defer statement wraps the body of a function with automatic instrumentation.
No description provided by the author
PreInstrument runs the "before wrappee" part of instrumentation.
No description provided by the author
No description provided by the author
WithBranch sets the name of the branch to export with the metrics.
No description provided by the author
WithCommit sets the commit of the codebase to export with the metrics.
No description provided by the author
WithHistogramBuckets sets the buckets to use for the latency histograms.
WithLogger sets the logger to use when initializing autometrics.
Convenience re-export of [autometrics.WithNewTraceId] to avoid needing multiple imports in instrumented file.
WithPushCollectorURL enables Pushing metrics to a remote location, and sets the URL of the collector to target.
WithPushJobName sets the name of job to use when pushing metrics.
WithRegistry sets the prometheus registry to use.
WithRepoProvider sets the provider of the repository containing the codebase being instrumented.
WithRepoURL sets the URL of the repository containing the codebase being instrumented.
WithService sets the name of the current service, to export with the metrics.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WithVersion sets the version of the codebase to export with the metrics.
# Constants
AutometricsSpecVersion is the version of the specification the library follows The specifications can be found in https://github.com/autometrics-dev/autometrics-shared/tree/main/specs.
AutometricsVersionLabel is the prometheus label that describes the version of the Autometrics specification the library follows.
BranchLabel is the prometheus label that describes the branch of the build of the monitored codebase.
BuildInfo is the name of the prometheus metric for the version of the monitored codebase.
CallerFunctionLabel is the prometheus label that describes the name of the function that called the current function.
CallerModuleLabel is the prometheus label that describes the module of the function that called the current function.
CommitLabel is the prometheus label that describes the commit of the monitored codebase.
FunctionCallsConcurrentName is the name of the prometheus metric for the number of simulateneously active calls to specific functions.
FunctionCallsCountName is the name of the prometheus metric for the counter of calls to specific functions.
FunctionCallsDurationName is the name of the prometheus metric for the duration histogram of calls to specific functions.
FunctionLabel is the prometheus label that describes the function name.
ModuleLabel is the prometheus label that describes the module name that contains the function.
RepositoryProviderLabel is the prometheus label that describes the service provider for the monitored service repository url.
RepositoryURLLabel is the prometheus label that describes the URL at which the repository containing the monitored service can be found.
ResultLabel is the prometheus label that describes whether a function call is successful.
ServiceNameLabel is the prometheus label that describes the name of the service being monitored.
SloNameLabel is the prometheus label that describes the name of the Service Level Objective.
TargetLatencyLabel is the prometheus label that describes the latency to respect to match the Service Level Objective.
TargetSuccessRateLabel is the prometheus label that describes the percentage of calls that must succeed to match the Service Level Objective.
VersionLabel is the prometheus label that describes the version of the monitored codebase.
# Variables
No description provided by the author
# Interfaces
No description provided by the author
# Type aliases
Logger is an interface for logging autometrics-related events.
This is a reexport to allow using only the current package at call site.
This is a reexport to allow using only the current package at call site.
No description provided by the author