Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 124 additions & 0 deletions api/formance.com/v1beta1/otelexporterendpoint_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
/*
Copyright 2023.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1beta1

import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// OtelAuthConfig configures per-signal authentication.
// Auth is per-signal so traces and metrics can use different credentials if needed.
type OtelAuthConfig struct {
// Type is the authentication type.
// +kubebuilder:validation:Enum=bearer
Type string `json:"type"`
// FromSecret references a Secret name (expected key is "token").
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should not hardcode the key and should add a FromSecretKey property.

// The controller creates a ResourceReference to replicate the secret into each target stack namespace.
// The source secret must have a "formance.com/stack" label set to "any" or a specific stack name.
// +kubebuilder:validation:MinLength=1
FromSecret string `json:"fromSecret"`
}

// OtelSignalConfig configures a single signal type (traces or metrics).
// Each signal type has its own endpoint and authentication block, allowing
// different destinations or credentials per signal.
// Protocol is inferred from the URL scheme: grpc:// for gRPC, http:// or https:// for HTTP/protobuf (default).
type OtelSignalConfig struct {
// Endpoint URL for the signal (e.g., "http://my-collector:4318", "grpc://my-collector:4317").
// Protocol is inferred from the URL scheme. HTTP/protobuf is the default for firewall compatibility.
// +kubebuilder:validation:MinLength=1
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MinLength still allows unsupported or ambiguous endpoint schemes. The config builder treats only grpc:// as gRPC and sends everything else through the HTTP exporter, so values like ftp://collector, typos, or bare host:port can be accepted at admission and fail later in the collector. Please validate allowed schemes (http, https, grpc) or explicitly normalize/document bare host:port before generating the collector config.

Endpoint string `json:"endpoint"`
Comment thread
flemzord marked this conversation as resolved.

// Auth is the optional per-signal authentication configuration.
// +optional
Auth *OtelAuthConfig `json:"auth,omitempty"`
}

// +kubebuilder:validation:XValidation:rule="has(self.traces) || has(self.metrics)",message="at least one signal (traces or metrics) must be configured"
type OtelExporterEndpointSpec struct {
// StackSelector is a standard Kubernetes LabelSelector (matchLabels/matchExpressions).
// One CRD can target all current and future stacks with a single selector.
// Matches the pattern established by Settings.
StackSelector *metav1.LabelSelector `json:"stackSelector"`

// Traces configures the traces signal. At least one of traces or metrics must be set.
// Logs are intentionally out of scope.
// +optional
Traces *OtelSignalConfig `json:"traces,omitempty"`

// Metrics configures the metrics signal. At least one of traces or metrics must be set.
// Logs are intentionally out of scope.
// +optional
Metrics *OtelSignalConfig `json:"metrics,omitempty"`

// ResourceAttributes are injected into outgoing telemetry via a collector processor.
// +optional
ResourceAttributes map[string]string `json:"resourceAttributes,omitempty"`
}

// OtelExporterEndpointStatus represents the observed state of an OtelExporterEndpoint.
type OtelExporterEndpointStatus struct {
Status `json:",inline"`
// Stacks is a sorted list of stack names currently targeted by this endpoint.
// Includes stacks with successful reconciliation and stacks with transient errors or pending cleanup.
// Used by the finalizer to find previously matched stacks during deletion.
// +optional
Stacks []string `json:"stacks,omitempty"`
}

// OtelExporterEndpoint configures an OpenTelemetry collector proxy for exporting traces and metrics.
// Multiple OtelExporterEndpoints can target the same stacks — the collector fans out to all matching destinations.
//
// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:resource:scope=Cluster
// +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Is ready"
// +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info"
type OtelExporterEndpoint struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec OtelExporterEndpointSpec `json:"spec,omitempty"`
Status OtelExporterEndpointStatus `json:"status,omitempty"`
}

func (in *OtelExporterEndpoint) IsReady() bool {
return in.Status.Ready
}

func (in *OtelExporterEndpoint) SetReady(b bool) {
in.Status.Ready = b
}

func (in *OtelExporterEndpoint) SetError(s string) {
in.Status.Info = s
}

func (in *OtelExporterEndpoint) GetConditions() *Conditions {
return &in.Status.Conditions
}

// +kubebuilder:object:root=true
type OtelExporterEndpointList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []OtelExporterEndpoint `json:"items"`
}

func init() {
SchemeBuilder.Register(&OtelExporterEndpoint{}, &OtelExporterEndpointList{})
}
152 changes: 152 additions & 0 deletions api/formance.com/v1beta1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ func main() {
licenceSecret string
licenceNamespace string
utilsVersion string
collectorImage string
)
flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
Expand All @@ -74,6 +75,7 @@ func main() {
flag.StringVar(&licenceSecret, "licence-secret", "", "The licence secret that contains the token and the issuer")
flag.StringVar(&licenceNamespace, "licence-namespace", "", "The namespace where the licence secret lives (defaults to operator namespace)")
flag.StringVar(&utilsVersion, "utils-version", "latest", "The version of the operator utils image")
flag.StringVar(&collectorImage, "collector-image", core.DefaultCollectorImage, "The OTel Collector image for OtelExporterEndpoint resources")
opts := zap.Options{
Development: false,
}
Expand Down Expand Up @@ -125,6 +127,7 @@ func main() {
LicenceSecret: licenceSecret,
LicenceNamespace: licenceNamespace,
UtilsVersion: utilsVersion,
CollectorImage: collectorImage,
}

if licenceSecret != "" {
Expand Down
Loading