distro

type EnvironmentVariables struct {

	// if this distribution runs an opamp client, add the environment variables that configures the server endpoint (local node)
	OpAmpClientEnvironments bool `yaml:"opAmpClientEnvironments,omitempty"`

	// set to true if this distribution uses the OTLP HTTP protocol to emit telemetry data to node collector.
	// if `true` the OTEL_EXPORTER_OTLP_ENDPOINT environment variable will be set to LocalTrafficOTLPHttpDataCollectionEndpoint
	OtlpHttpLocalNode bool `yaml:"otlpHttpLocalNode,omitempty"`

	// list of static environment variables that need to be set in the application runtime.
	StaticVariables []StaticEnvironmentVariable `yaml:"staticVariables,omitempty"`
}

type Framework struct {
	// the framework this distribution targets.
	FrameworkName string `yaml:"frameworkName"`

	// semconv range of the framework versions supported by this distribution.
	FrameworkVersion string `yaml:"frameworkVersion"`
}

type OtelDistro struct {

	// a human-friendly name for this distribution, which can be displayed in the UI and documentation.
	// may include spaces and special characters.
	DisplayName string `yaml:"displayName"`

	// a unique name for this distribution, which helps to identify it.
	// should be a single word, lowercase, and may include hyphens (nodejs-community, dotnet-legacy-instrumentation).
	Name string `yaml:"name"`

	// the programming language this distribution targets.
	// each distribution must target a single language.
	Language common.ProgrammingLanguage `yaml:"language"`

	// List of distribution parameters that are required to be set by the user.
	// for example: libc type.
	RequireParameters []string `yaml:"requireParameters,omitempty"`

	// the runtime environments this distribution targets.
	// examples: nodejs, JVM, CPython, etc.
	// while java-script can run in both nodejs and browser, the distribution should specify where it is intended to run.
	RuntimeEnvironments []RuntimeEnvironment `yaml:"runtimeEnvironments"`

	// A list of frameworks this distribution targets (can be left empty)
	Frameworks []Framework `yaml:"frameworks"`

	// Free text description of the distribution, what it includes, it's use cases, etc.
	Description string `yaml:"description"`

	// categories of environments variables that need to be set in the application runtime
	// to enable the distribution.
	EnvironmentVariables EnvironmentVariables `yaml:"environmentVariables,omitempty"`

	// Metadata and properties of the runtime agent that is used to enable the distribution.
	// Can be nil in case no runtime agent is required.
	RuntimeAgent *RuntimeAgent `yaml:"runtimeAgent,omitempty"`
}

type RuntimeAgent struct {
	// The name of a directory where odigos agent files can be found.
	// The special value {{ODIGOS_AGENTS_DIR}} is replaced with the actual value at this platform.
	// K8s will mount this directory from the node fs to the container. other platforms may have different ways to make the directory accessible.
	DirectoryNames []string `yaml:"directoryNames"`

	// This field indicates that the agent populates k8s resource attributes via environment variables.
	// It targets distros odigos uses without wrapper or customization.
	// For eBPF, the resource attributes are set in code.
	// For opamp distros, the resource attributes are set in the opamp server.
	// We will eventually remove this field once all distros upgrade to dynamic resource attributes.
	K8sAttrsViaEnvVars bool `yaml:"k8sAttrsViaEnvVars,omitempty"`

	// If mounting of agent directory is achieved via k8s virtual device,
	// this field specifies the name of the device to inject into the resources part of the pods container spec.
	Device *string `yaml:"device,omitempty"`

	// Some of the agents might require a specific file to loaded before we can start the instrumentation.
	// This list contains the full path of the files that need to be opened for the agent to properly start.
	// All these paths must be contained in one of the directoryNames.
	FileOpenTriggers []string `yaml:"fileOpenTriggers,omitempty"`

	// List of environment variables that need to be set in the application runtime to enable the distribution.
	// those are patched if exist in the manifest, and supplemented from runtime inspection when relevant (value from docker runtime).
	EnvironmentVariables []RuntimeAgentEnvironmentVariable `yaml:"environmentVariables,omitempty"`
}

type RuntimeAgentEnvironmentVariable struct {

	// The name of the environment variable to set or patch.
	EnvName string `yaml:"envName"`

	// The value of the environment variable to set or patch.
	// One special value can be used in this text which is substituted by the actual value at runtime.
	// The special value is: `{{ODIGOS_AGENTS_DIR}}` which is replaced by `/var/odigos`, for k8s and with other values for other platforms.
	EnvValue string `yaml:"envValue"`

	// In case the environment variable needs to be appended to an existing value,
	// this field specifies the delimiter to use.
	// e.g. `:` for PYTHONPATH=/path/to/lib1:/path/to/lib2
	Delimiter string `yaml:"delimiter"`
}

type RuntimeEnvironment struct {
	// the runtime environment this distribution targets.
	// examples: nodejs, JVM, CPython, etc.
	// while java-script can run in both nodejs and browser, the distribution should specify where it is intended to run.
	Name string `yaml:"name"`

	// semconv range of the runtime versions supported by this distribution.
	SupportedVersions string `yaml:"supportedVersions,omitempty"`
}

type StaticEnvironmentVariable struct {
	// The name of the environment variable to set.
	EnvName string `yaml:"envName"`

	// The value of the environment variable to set.
	EnvValue string `yaml:"envValue"`
}