idgen

Documentation

Index

• Constants
• func NewEvaluationID() string
• func NewExecutionID() string
• func NewJobID() string
• func ShortNodeID(input string) string
• func ShortUUID(input string) string
• type AWSNodeNameProvider
  • func NewAWSNodeNameProvider() AWSNodeNameProvider
  • func (p AWSNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)
• type CachedNodeNameProvider
  • func NewCachedNodeNameProvider(provider NodeNameProvider) *CachedNodeNameProvider
  • func (c *CachedNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)
• type GCPNodeNameProvider
  • func NewGCPNodeNameProvider() GCPNodeNameProvider
  • func (p GCPNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)
• type HTTPNodeNameProvider
  • func (h HTTPNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)
• type HostnameProvider
  • func (HostnameProvider) GenerateNodeName(_ context.Context) (string, error)
• type NodeNameProvider
• type NodeNameProviderFunc
  • func (f NodeNameProviderFunc) GenerateNodeName(ctx context.Context) (string, error)
• type PUUIDNodeNameProvider
  • func (PUUIDNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)
• type UUIDNodeNameProvider
  • func (UUIDNodeNameProvider) GenerateNodeName(_ context.Context) (string, error)

Constants

const (
	// JobIDPrefix is the prefix of job ID.
	JobIDPrefix = "j-"

	// ExecutionIDPrefix is the prefix of execution ID.
	ExecutionIDPrefix = "e-"

	// EvaluationIDPrefix is the prefix of evaluation ID.
	EvaluationIDPrefix = "v-"

	// NodeIDPrefix is the prefix of node ID.
	NodeIDPrefix = "n-"
)

const ShortIDLength = 8

const ShortIDLengthWithPrefix = ShortIDLength + len(JobIDPrefix)

Functions

func NewEvaluationID

func NewEvaluationID() string

NewEvaluationID generates a new evaluation ID.

func NewExecutionID

func NewExecutionID() string

NewExecutionID generates a new execution ID.

func NewJobID

func NewJobID() string

NewJobID generates a new job ID.

func ShortNodeID

func ShortNodeID(input string) string

ShortNodeID takes a string in the format of a libp2p peer ID or UUID, and returns a shortened version of the input, or the input as is if it doesn't match. Mainly used for logging and printing the ID in a more human-readable format.

func ShortUUID

func ShortUUID(input string) string

ShortUUID takes a string in the format of "prefix-UUID" or just "UUID" and returns the prefix along with the first segment of the UUID. For example: - For "e-78faf114-6a45-457e-825c-40fd2fad768f", it returns "e-78faf114". - For "j-78faf114-6a45-457e-825c-40fd2fad768f", it returns "j-78faf114". - For "78faf114-6a45-457e-825c-40fd2fad768f", it returns "78faf114".

Types

type AWSNodeNameProvider

type AWSNodeNameProvider struct {
	// contains filtered or unexported fields
}

AWSNodeNameProvider retrieves the node name from AWS instance metadata.

func NewAWSNodeNameProvider

func NewAWSNodeNameProvider() AWSNodeNameProvider

func (AWSNodeNameProvider) GenerateNodeName

func (p AWSNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)

type CachedNodeNameProvider

type CachedNodeNameProvider struct {
	// contains filtered or unexported fields
}

CachedNodeNameProvider caches the node name for subsequent calls.

func NewCachedNodeNameProvider

func NewCachedNodeNameProvider(provider NodeNameProvider) *CachedNodeNameProvider

func (*CachedNodeNameProvider) GenerateNodeName

func (c *CachedNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)

type GCPNodeNameProvider

type GCPNodeNameProvider struct {
	// contains filtered or unexported fields
}

GCPNodeNameProvider retrieves the node name from GCP instance metadata.

func NewGCPNodeNameProvider

func NewGCPNodeNameProvider() GCPNodeNameProvider

func (GCPNodeNameProvider) GenerateNodeName

func (p GCPNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)

type HTTPNodeNameProvider

type HTTPNodeNameProvider struct {
	URL    string
	Header map[string]string
}

HTTPNodeNameProvider retrieves the node name from a URL, used by AWS and GCP.

func (HTTPNodeNameProvider) GenerateNodeName

func (h HTTPNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)

type HostnameProvider

type HostnameProvider struct{}

HostnameProvider retrieves the node name from the host's hostname.

func (HostnameProvider) GenerateNodeName

func (HostnameProvider) GenerateNodeName(_ context.Context) (string, error)

type NodeNameProvider

type NodeNameProvider interface {
	GenerateNodeName(ctx context.Context) (string, error)
}

NodeNameProvider defines an interface for generating node names.

type NodeNameProviderFunc

type NodeNameProviderFunc func(ctx context.Context) (string, error)

NodeNameProviderFunc type is an adapter to allow the use of ordinary functions as NodeNameProvider.

func (NodeNameProviderFunc) GenerateNodeName

func (f NodeNameProviderFunc) GenerateNodeName(ctx context.Context) (string, error)

GenerateNodeName allows NodeNameProviderFunc to implement NodeNameProvider.

type PUUIDNodeNameProvider

type PUUIDNodeNameProvider struct{}

PUUIDNodeNameProvider generates a random UUID as the node name, with "n-" prefix.

func (PUUIDNodeNameProvider) GenerateNodeName

func (PUUIDNodeNameProvider) GenerateNodeName(ctx context.Context) (string, error)

type UUIDNodeNameProvider

type UUIDNodeNameProvider struct{}

UUIDNodeNameProvider generates a random UUID as the node name.

func (UUIDNodeNameProvider) GenerateNodeName

func (UUIDNodeNameProvider) GenerateNodeName(_ context.Context) (string, error)