autometrics

const (
	// 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
	AutometricsSpecVersion = "1.0.0"

	// FunctionCallsCountName is the name of the openTelemetry metric for the counter of calls to specific functions.
	FunctionCallsCountName = "function.calls"
	// FunctionCallsDurationName is the name of the openTelemetry metric for the duration histogram of calls to specific functions.
	FunctionCallsDurationName = "function.calls.duration"
	// FunctionCallsConcurrentName is the name of the openTelemetry metric for the number of simulateneously active calls to specific functions.
	FunctionCallsConcurrentName = "function.calls.concurrent"
	// BuildInfo is the name of the openTelemetry metric for the version of the monitored codebase.
	BuildInfoName = "build_info"

	// FunctionLabel is the openTelemetry attribute that describes the function name.
	//
	// It is guaranteed that a (FunctionLabel, ModuleLabel) value pair is unique
	// and matches at most one function in the source code.
	FunctionLabel = "function"
	// ModuleLabel is the openTelemetry attribute that describes the module name that contains the function.
	//
	// It is guaranteed that a (FunctionLabel, ModuleLabel) value pair is unique
	// and matches at most one function in the source code.
	ModuleLabel = "module"
	// CallerFunctionLabel is the openTelemetry attribute that describes the name of the function that called
	// the current function.
	CallerFunctionLabel = "caller.function"
	// CallerModuleLabel is the openTelemetry attribute that describes the module of the function that called
	// the current function.
	CallerModuleLabel = "caller.module"
	// ResultLabel is the openTelemetry attribute that describes whether a function call is successful.
	ResultLabel = "result"
	// TargetLatencyLabel is the openTelemetry attribute that describes the latency to respect to match
	// the Service Level Objective.
	TargetLatencyLabel = "objective.latency_threshold"
	// TargetSuccessRateLabel is the openTelemetry attribute that describes the percentage of calls that
	// must succeed to match the Service Level Objective.
	//
	// In the case of latency objectives, it describes the percentage of
	// calls that must last less than the value in [TargetLatencyLabel].
	//
	// In the case of success objectives, it describes the percentage of calls
	// that must be successful (i.e. have their [ResultLabel] be 'ok').
	TargetSuccessRateLabel = "objective.percentile"
	// SloNameLabel is the openTelemetry attribute that describes the name of the Service Level Objective.
	SloNameLabel = "objective.name"

	// CommitLabel is the openTelemetry attribute that describes the commit of the monitored codebase.
	CommitLabel = "commit"
	// VersionLabel is the openTelemetry attribute that describes the version of the monitored codebase.
	VersionLabel = "version"
	// BranchLabel is the openTelemetry attribute that describes the branch of the build of the monitored codebase.
	BranchLabel = "branch"

	// RepositoryURLLabel is the openTelemetry attribute that describes the URL at which the repository containing
	// the monitored service can be found
	RepositoryURLLabel = "repository.url"
	// RepositoryProviderLabel is the openTelemetry attribute that describes the service provider for the monitored
	// service repository url
	RepositoryProviderLabel = "repository.provider"

	// AutometricsVersionLabel is the openTelemetry attribute that describes the version of the Autometrics specification
	// the library follows
	AutometricsVersionLabel = "autometrics.version"

	// ServiceNameLabel is the openTelemetry attribute that describes the name of the Service being monitored.
	ServiceNameLabel = "service.name"

	// JobNameLabel is the openTelemetry attribute that describes the job producing the metrics. It is
	// used when pushing OTLP metrics.
	JobNameLabel = "job"
)