odigos.io/v1alpha1

No description provided. Refer to the Kubernetes API documentation for the fields of the metadata field.

No description provided. Refer to the Kubernetes API documentation for the fields of the metadata field.

No description provided. Refer to the Kubernetes API documentation for the fields of the metadata field.

No description provided. Refer to the Kubernetes API documentation for the fields of the metadata field.

No description provided. Refer to the Kubernetes API documentation for the fields of the metadata field.

No description provided. Refer to the Kubernetes API documentation for the fields of the metadata field.

No description provided. Refer to the Kubernetes API documentation for the fields of the metadata field.

No description provided. Refer to the Kubernetes API documentation for the fields of the metadata field.

attribute key (e.g. “url.path”)

currently only string values are supported.

The operator to use to compare the attribute value.

The fraction of spans to sample, in the range [0, 1]. If the fraction is 0, no spans are sampled. If the fraction is 1, all spans are sampled.

Minumum + Maximum number of replicas for the collector - these relevant only for gateway.

MemoryRequestMiB is the memory resource request to be used on the pod template. it will be embedded in the as a resource request of the form memory: <value>Mi

This option sets the limit on the memory usage of the collector. since the memory limiter mechanism is heuristic, and operates on fixed intervals, while it cannot fully prevent OOMs, it can help in reducing the chances of OOMs in edge cases. the settings should prevent the collector from exceeding the memory request, so one can set this to the same value as the memory request or higher to allow for some buffer for bursts.

CPU resource request to be used on the pod template. it will be embedded in the as a resource request of the form cpu: <value>m

CPU resource limit to be used on the pod template. it will be embedded in the as a resource limit of the form cpu: <value>m

this parameter sets the “limit_mib” parameter in the memory limiter configuration for the collector. it is the hard limit after which a force garbage collection will be performed. this value will end up comparing against the go runtime reported heap Alloc value. According to the memory limiter docs:

this parameter sets the “spike_limit_mib” parameter in the memory limiter configuration for the collector memory limiter. note that this is not the processor soft limit itself, but the diff in Mib between the hard limit and the soft limit. according to the memory limiter docs, it is recommended to set this to 20% of the hard limit. changing this value allows trade-offs between memory usage and resiliency to bursts.

the GOMEMLIMIT environment variable value for the collector pod. this is when go runtime will start garbage collection. it is recommended to be set to 80% of the hard limit of the memory limiter.

The port to use for exposing the collector’s own metrics as a prometheus endpoint. This can be used to resolve conflicting ports when a collector is using the host network.

Resources [memory/cpu] settings for the collectors group. these settings are used to protect the collectors instances from:

• running out of memory and being killed by the k8s OOM killer
• consuming all available memory on the node which can lead to node instability
• pushing back pressure to the instrumented applications

Receiver Signals are the signals (trace, metrics, logs) that the collector has setup an otlp receiver for, thus it can accept data from an upstream component. this is used to determine if a workload should export each signal or not. this list is calculated based on the odigos destinations that were configured

Represents the observations of a collectorsroup’s current state. Known .status.conditions.type are: “Available”, “Progressing”

The name of the container to which this configuration applies.

boolean flag to indicate if the agent should be enabled for this container.

An enum reason for the agent injection decision.

free text message to provide more information about the instrumentation decision. can be left empty if reason is self-explanatory.

The name of the otel distribution to use for this container. if the name is empty, this container should not be instrumented.

Additional parameters to the distro that controls how it’s being applied. Keys are parameter names (like “libc”) and values are the value to use for that parameter (glibc / musl)

SourceSelector defines which sources can send data to this destination. If not specified, defaults to “all”.

Represents the observations of a destination’s current state.

Used as a fallback if all rules evaluate to false, it may be empty - in this case the default value will be 1 - all spans are sampled. it should be a float value in the range [0, 1] - the fraction of spans to sample. a value of 0 means no spans are sampled if none of the rules evaluate to true.

the service.name property is used to populate the service.name resource attribute in the telemetry generated by this workload

determines if odigos should inject agents to pods of this workload.

configuration for each instrumented container in the workload

this hash is used to determine the deployment of the agents. e.g. when the distro for container changes, or it’s compatibility version, or something else that requires rollout, the hash change will indicate that. if the hash is empty, it means that no agent should be enabled in any pod container.

Configuration for the OpenTelemetry SDKs that this workload should use. The SDKs are identified by the programming language they are written in. TODO: consider adding more granular control over the SDKs, such as community/enterprise, native/ebpf.

Capture Runtime Details for the workloads that this CR applies to.

Represents the observations of a InstrumentationConfig’s current state.

This hash is recorded only after the rollout took place. it allows us to determine if the workload needs to be rollout based on previous rollout and the current config. if this field is different than the spec.AgentsDeploymentHash it means rollout is needed or not yet updated.

stores the name of the container in the pod where the SDK is running. The pod details can be found as the owner reference on the CR.

Attributes that identify the SDK and are reported as resource attributes in the generated telemetry. One can identify if an arbitrary telemetry is generated by this SDK by checking those resource attributes.

Attributes that are not reported as resource attributes but useful to describe characteristics of the SDK.

Healthy true means that the odigos agent has started the SDK, and there are no errors. User can expect telemetry to be generated. Healthy false means that the agent has stopped and telemetry data is not expected to be generated. Healthy nil means that the agent did not report any health status yet (prefer to always report health status).

message is a human readable message indicating details about the SDK general health. can be omitted if healthy is true

reason contains a programmatic identifier indicating the reason for the component status. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API.

code attributes configuration for a specific library. if not set, the default code attributes configuration for the workload will be used. if set, but internal fields are empty, those fields will be used from the default configuration.

Whether the instrumentation library is enabled to record traces. When false, it is expected that the instrumentation library does not produce any spans regardless of any other configuration. When true, the instrumentation library should produce spans according to the other configuration options. If not specified, the default value for this signal should be used (whether to enable libraries by default or not).

The name of the instrumentation library

• Node.js: The name of the npm package: @opentelemetry/instrumentation-<name>

SpanKind is only supported by Golang and will be ignored for any other SDK language. In Go, SpanKind is used because the same instrumentation library can be utilized for different span kinds (e.g., client/server).

for example (“net/http”, “@opentelemetry/instrumentation-redis”)

Attributes that identify the component. The combination of (Name, Type, IdentifyingAttributes) must be unique.

Attributes that do not necessarily identify the component but help describe its characteristics.

message is a human readable message indicating details about the component health. can be omitted if healthy is true

reason contains a programmatic identifier indicating the reason for the SDK status. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API.

Allows you to attach a meaningful name to the rule for convenience. Odigos does not use or assume any meaning from this field.

A free-form text field that allows you to attach notes regarding the rule for convenience. For example: why it was added. Odigos does not use or assume any meaning from this field.

A boolean field allowing to temporarily disable the rule, but keep it around for future use

An array of workload objects (name, namespace, kind) to which the rule should be applied. If not specified, the rule will be applied to all workloads. empty array will render the rule inactive.

For fine grained control, the user can specify the instrumentation library to use. One can specify same rule for multiple languages and libraries at the same time. If nil, all instrumentation libraries will be used. If empty, no instrumentation libraries will be used.

Allows to configure payload collection aspects for different types of payloads.

Deprecated: use OtelDistros instead.

Set the otel distros to use instead of the defaults.

Configure which code attributes should be recorded as span attributes.

Represents the observations of a instrumentationrule’s current state. Known .status.conditions.type are: “Available”, “Progressing”

Represents the observations of a nstrumentedApplication’s current state.

type of the processor (batch, attributes, etc). this field is only the type, not it’s instance name in the collector configuration yaml

this name is solely for the user convenience, to attach a meaningful name to the processor. odigos must not assume any semantics from this name. odigos cannot assume this name is unique, not empty, exclude spaces or dots, limited in length, etc.

user can attach notes to the processor, to document its purpose, usage, etc.

disable is a flag to enable or disable the processor. if the processor is disabled, it will not be included in the collector configuration yaml. this allows the user to keep the processor configuration in the CR, but disable it temporarily.

signals can be used to control which observability signals are processed by the processor.

control which collector roles in odigos pipeline this processor is attached to.

control the order of processors. a processor with lower order hint value will be placed before other processors with higher value. if 2 processors have the same value, the order is arbitrary. if the value is missing (or 0) the processor can be placed anywhere in the pipeline

this it the configuration of the opentelemetry collector processor component with the type specified in ‘type’.

Stores the error message from the CRI runtime if returned to prevent instrumenting the container if an error exists.

Holds the environment variables retrieved from the container runtime.

A temporary variable used during migration to track whether the new runtime detection process has been executed. If empty, it indicates the process has not yet been run. This field may be removed later.

The language of the SDK being configured

configurations for the instrumentation libraries the the SDK should use

HeadSamplingConfig is a set sampling rules. This config currently only applies to root spans. In the Future we might add another level of configuration base on the parent span (ParentBased Sampling)

default configuration for collecting code attributes, in case the instrumentation library does not provide a configuration.

If a namespace is specified, all workloads (sources) within that namespace are allowed to send data. Example: namespaces: [“default”, “production”] This means the destination will receive data from all sources in “default” and “production” namespaces.

Workloads (sources) are assigned to groups via labels (odigos.io/group-backend: true), allowing a more flexible selection mechanism. Example: groups: [“backend”, “monitoring”] This means the destination will receive data only from sources labeled with “backend” or “monitoring”.

Workload represents the workload or namespace to be instrumented. This field is required upon creation and cannot be modified.

DisableInstrumentation excludes this workload from auto-instrumentation.

OtelServiceName determines the “service.name” resource attribute which will be reported by the instrumentations of this source. If not set, the workload name will be used. It is not valid for namespace sources.

Represents the observations of a source’s current state. Known .status.conditions.type are: “Available”, “Progressing”