package telemetry

Import Path
	github.com/pancsta/asyncmachine-go/pkg/telemetry (on go.dev)

Dependency Relation
	imports 28 packages, and imported by 15 packages

Involved Source Files

	  d dbg.go
		Package telemetry provides telemetry exporters for asyncmachine: am-dbg,
		Prometheus, and OpenTelemetry.

	    otel.go
	    telemetry.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type DbgMsg (interface)
		DbgMsg is the interface for the messages to be sent to the am-dbg server.

		Methods (total 2)
			( DbgMsg) Clock(statesIndex am.S, state string) uint64
				Clock returns the state's clock, using the passed index

			( DbgMsg) Is(statesIndex am.S, states am.S) bool
				Is returns true if the state is active, using the passed index

		Implemented By (at least 2)
			*DbgMsgStruct
			*DbgMsgTx

	 type DbgMsgStruct (struct)
		DbgMsgStruct contains the state and relations data.

		Fields (total 7)
			Groups map[string][]int
				list of group names and state indexes

			GroupsOrder []string
				order of groups

			ID string
				Machine ID

			Parent string
				parent machine ID

			States am.Schema
				all the states with relations
				TODO refac: Schema

			StatesIndex am.S
				state names defining the indexes for diffs

			Tags []string
				machine tags

		Methods (total 2)
			(*DbgMsgStruct) Clock(_ am.S, _ string) uint64
			(*DbgMsgStruct) Is(_ am.S, _ am.S) bool
		Implements (at least one exported)
			*DbgMsgStruct : DbgMsg
		As Inputs Of (at least 2)
			func github.com/pancsta/asyncmachine-go/pkg/graph.(*Graph).AddClient(msg *DbgMsgStruct) error
			func github.com/pancsta/asyncmachine-go/tools/debugger/server.(*RPCServer).DbgMsgSchema(msgSchema *DbgMsgStruct, _ *string) error

	 type DbgMsgTx (struct)
		DbgMsgTx contains transition data.

		Fields (total 20)
			Accepted bool
				result of the transition
				TODO rename to IsAccepted

			Args map[string]string
			CalledStates []string
				called states
				TODO remove. Deprecated use CalledStateNames(index)

			CalledStatesIdxs []int
				TODO rename to CalledStates, re-gen all assets

			Clocks am.Time
				Clocks is represents the machine time [am.Time] from after the current
				transition.
				TODO refac to TimeAfter, re-gen all the assets

			ID string
				Transition ID
				TODO refac: Id

			IsAuto bool
				transition was triggered by an auto state

			IsCheck bool
				is this a check (Can*) tx or mutation?

			IsQueued bool
				is this a queued mutation?

			LogEntries []*am.LogEntry
				log entries created during the transition

			MachineID string
			MutQueueTick uint64
				MutQueueTick is the assigned queue tick when the tx will be executed.
				Only for IsQueued.

			MutQueueToken uint64
				TODO QueueDebug with all string entries for comparison
				MutQueueToken is the token of a prepended mutation, can be scheduled or
				executed, depending on IsQueued.

			PreLogEntries []*am.LogEntry
				log entries before the transition, which happened after the prev one

			Queue int
				queue length at the start of the transition
				TODO rename to QueueLen
				TODO change to int32

			QueueDump []string
			QueueTick uint64
				QueueTick is the current queue tick in the machine.
				transition.

			Steps []*am.Step
				all the transition steps

			Time *time.Time
				Time is human time. Don't send this over the wire.
				TODO remove or skip in msgpack
				TODO rename to HTime

			Type am.MutationType
				mutation type

		Methods (total 9)
			(*DbgMsgTx) ActiveStates(statesIndex am.S) am.S
			(*DbgMsgTx) CalledStateNames(statesIndex am.S) am.S
			(*DbgMsgTx) Clock(statesIndex am.S, state string) uint64
			(*DbgMsgTx) Index(statesIndex am.S, state string) int
			(*DbgMsgTx) Is(statesIndex am.S, states am.S) bool
			(*DbgMsgTx) Is1(statesIndex am.S, state string) bool
			(*DbgMsgTx) MutString(statesIndex am.S) string
				TODO unify with Mut String

			(*DbgMsgTx) TimeSum() uint64
				TODO Sum() and TimeSum(idxs []int)

			(*DbgMsgTx) TxString(statesIndex am.S) string
				TODO unify with Tx String

		Implements (at least one exported)
			*DbgMsgTx : DbgMsg
		As Outputs Of (at least 4)
			func github.com/pancsta/asyncmachine-go/tools/debugger.(*Debugger).CurrentTx() *DbgMsgTx
			func github.com/pancsta/asyncmachine-go/tools/debugger.(*Debugger).NextTx() *DbgMsgTx
			func github.com/pancsta/asyncmachine-go/tools/debugger.(*Debugger).PrevTx() *DbgMsgTx
			func github.com/pancsta/asyncmachine-go/tools/debugger/server.(*Client).Tx(idx int) *DbgMsgTx
		As Inputs Of (at least 2)
			func github.com/pancsta/asyncmachine-go/pkg/graph.(*Graph).ParseMsg(id string, msgTx *DbgMsgTx)
			func github.com/pancsta/asyncmachine-go/tools/debugger/server.(*RPCServer).DbgMsgTx(msgTx *DbgMsgTx, _ *string) error

	 type DbgTracer (struct)

		Fields (total 3)
			Addr string
			Mach am.Api
			NoOpTracer *am.NoOpTracer
		Methods (total 13)
			( DbgTracer) HandlerEnd(transition *machine.Transition, emitter string, handler string)
			( DbgTracer) HandlerStart(transition *machine.Transition, emitter string, handler string)
			( DbgTracer) Inheritable() bool
			(*DbgTracer) MachineDispose(id string)
			(*DbgTracer) MachineInit(mach am.Api) context.Context
			(*DbgTracer) MutationQueued(mach am.Api, mut *am.Mutation)
			( DbgTracer) NewSubmachine(parent, machine machine.Api)
			( DbgTracer) QueueEnd(machine machine.Api)
			(*DbgTracer) SchemaChange(mach am.Api, _ am.Schema)
			(*DbgTracer) TransitionEnd(tx *am.Transition)
			( DbgTracer) TransitionInit(transition *machine.Transition)
			( DbgTracer) TransitionStart(transition *machine.Transition)
			( DbgTracer) VerifyStates(machine machine.Api)
		Implements (at least one exported)
			*DbgTracer : github.com/pancsta/asyncmachine-go/pkg/machine.Tracer
		As Outputs Of (at least one exported)
			func NewDbgTracer(mach am.Api, addr string) *DbgTracer

	 type OtelMachineData (struct)

		Fields (total 3)
			Ended bool
			ID string
			Index int
				Index is a unique number for this machine withing the Otel tracer.


	 type OtelMachTracer (struct)
		OtelMachTracer implements machine.Tracer for OpenTelemetry. Supports tracing
		of multiple state machines, resulting in a single trace. This tracer is
		automatically bound to new sub-machines.

		Fields (total 8)
			Logf func(format string, args ...any)
				TODO bind to env var

			Machines map[string]*OtelMachineData
			MachinesMx sync.Mutex
			MachinesOrder []string
			NextIndex int
			NoOpTracer *am.NoOpTracer
			RootSpan trace.Span
			Tracer trace.Tracer
		Methods (total 14)
			(*OtelMachTracer) End()
			(*OtelMachTracer) HandlerEnd(tx *am.Transition, emitter string, handler string)
			( OtelMachTracer) HandlerStart(transition *machine.Transition, emitter string, handler string)
			( OtelMachTracer) Inheritable() bool
			(*OtelMachTracer) MachineDispose(id string)
			(*OtelMachTracer) MachineInit(mach am.Api) context.Context
			( OtelMachTracer) MutationQueued(machine machine.Api, mutation *machine.Mutation)
			(*OtelMachTracer) NewSubmachine(parent, mach am.Api)
				NewSubmachine links 2 machines with a parent-child relationship.

			(*OtelMachTracer) QueueEnd(mach am.Api)
			( OtelMachTracer) SchemaChange(machine machine.Api, old machine.Schema)
			(*OtelMachTracer) TransitionEnd(tx *am.Transition)
			(*OtelMachTracer) TransitionInit(tx *am.Transition)
			( OtelMachTracer) TransitionStart(transition *machine.Transition)
			( OtelMachTracer) VerifyStates(machine machine.Api)
		Implements (at least one exported)
			*OtelMachTracer : github.com/pancsta/asyncmachine-go/pkg/machine.Tracer
		As Outputs Of (at least one exported)
			func NewOtelMachTracer(rootMach am.Api, rootSpan trace.Span, otelTracer trace.Tracer, opts *OtelMachTracerOpts) *OtelMachTracer

	 type OtelMachTracerOpts (struct)

		Fields (total 7)
			BlacklistStates am.S
				TODO

			IncludeHealth bool
				if true, only Healthcheck and Heartbeat will be skipped

			Logf func(format string, args ...any)
			SkipAuto bool
				if true, auto transitions won't be traced

			SkipLogArgs bool
				if true, transition traces won't include [am.Machine.GetLogArgs]

			SkipTransitions bool
				if true, only state changes will be traced

			WhitelistStates am.S
				TODO

		As Inputs Of (at least one exported)
			func NewOtelMachTracer(rootMach am.Api, rootSpan trace.Span, otelTracer trace.Tracer, opts *OtelMachTracerOpts) *OtelMachTracer

	 type OtelTxHist (struct)

		Fields (total 2)
			Ctx context.Context
			Id string


Package-Level Functions (total 10)

	 func BindLokiEnv(mach am.Api) error
		BindLokiEnv bind Loki logger to [mach], based on environment vars:
		- AM_SERVICE (required)
		- AM_LOKI_ADDR (required)
		This tracer is NOT inherited by submachines.

	 func BindLokiLogger(mach am.Api, client promtail.Client)
	 func BindOtelLogger(mach am.Api, provider *ologsdk.LoggerProvider, service string)
		BindOtelLogger binds an OpenTelemetry logger to a machine.

	 func MachBindOtelEnv(mach am.Api) error
		MachBindOtelEnv bind an OpenTelemetry tracer to [mach], based on environment
		variables:
		- AM_SERVICE (required)
		- AM_OTEL_TRACE (required)
		- AM_OTEL_TRACE_TXS
		- OTEL_EXPORTER_OTLP_ENDPOINT
		- OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
		
		This tracer is inherited by submachines, and this function applies only to
		top-level machines.

	 func NewDbgTracer(mach am.Api, addr string) *DbgTracer
	 func NewOtelLoggerProvider(exporter ologsdk.Exporter) *ologsdk.LoggerProvider
		NewOtelLoggerProvider creates a new OpenTelemetry logger provider bound to
		the given exporter.

	 func NewOtelMachTracer(rootMach am.Api, rootSpan trace.Span, otelTracer trace.Tracer, opts *OtelMachTracerOpts) *OtelMachTracer
		NewOtelMachTracer creates a new machine tracer from an OpenTelemetry tracer.
		Requires OtelMachTracer.Dispose to be called at the end.

	 func NewOtelProvider(source string, ctx context.Context) (trace.Tracer, *sdktrace.TracerProvider, error)
	 func NormalizeId(id string) string
	 func TransitionsToDbg(mach am.Api, addr string) error
		TransitionsToDbg sends transitions to the am-dbg server.


Package-Level Constants (total 8)

	const DbgAddr = "localhost:6831"
		DbgAddr is the default address of the am-dbg server.

	const EnvAmDbgAddr = "AM_DBG_ADDR"
		EnvAmDbgAddr is the address of a running am-dbg instance.
		"1" expands to "localhost:6831"

	const EnvLokiAddr = "AM_LOKI_ADDR"
	const EnvOtelTrace = "AM_OTEL_TRACE"
	const EnvOtelTraceArgs = "AM_OTEL_TRACE_ARGS"
	const EnvOtelTraceNoauto = "AM_OTEL_TRACE_NOAUTO"
	const EnvOtelTraceTxs = "AM_OTEL_TRACE_TXS"
	const EnvService = "AM_SERVICE"

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.