Merge pull request #110 from Kuadrant/authorino-tracing-opts

feat: add support for authorino tracing options
Kuadrant · Mar 21, 2023 · 96576c2 · 96576c2
2 parents a137f07 + 1262f28
commit 96576c2
Show file tree

Hide file tree

Showing 11 changed files with 109 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -127,6 +127,7 @@ Each [`Authorino`](https://github.com/Kuadrant/authorino-operator/tree/main/conf
 | logMode                  | String                      | Defines the log mode in Authorino (`development` or `production`). | Default: `production` |
 | listener                 | [Listener](#listener)       | Specification of the authorization service (gRPC interface). | Required |
 | oidcServer               | [OIDCServer](#oidcserver)   | Specification of the OIDC service. | Required |
+| tracing                  | [Tracing](#tracing)         | Configuration of the OpenTelemetry tracing exporter. | Optional |
 | metrics                  | [Metrics](#metrics)         | Configuration of the metrics server (port, level). | Optional |
 | healthz                  | [Healthz](#healthz)         | Configuration of the health/readiness probe (port). | Optional |
 | volumes                  | [VolumesSpec](#volumesspec) | Additional volumes to be mounted in the Authorino pods. | Optional |
@@ -169,6 +170,15 @@ Port numbers of the authorization server.
 | grpc  | Integer | Port number of the gRPC interface of the authorization server. Set to 0 to disable this interface. | Default: `50001` |
 | http  | Integer | Port number of the raw HTTP interface of the authorization server. Set to 0 to disable this interface. | Default: `5001` |
 
+#### Tracing
+
+Configuration of the OpenTelemetry tracing exporter.
+
+| Field    | Type   | Description | Required/Default |
+|----------|:------:|-------------|------------------|
+| endpoint | String | Full endpoint of the OpenTelemetry tracing collector service (e.g. http://jaeger:14268/api/traces). | Required |
+| tags     | Map    | Key-value map of fixed tags to add to all OpenTelemetry traces emitted by Authorino. | Optional |
+
 #### Metrics
 
 Configuration of the metrics server.

diff --git a/api/v1beta1/authorino_types.go b/api/v1beta1/authorino_types.go
@@ -72,6 +72,7 @@ type AuthorinoSpec struct {
 	AuthConfigLabelSelectors string      `json:"authConfigLabelSelectors,omitempty"`
 	SecretLabelSelectors     string      `json:"secretLabelSelectors,omitempty"`
 	EvaluatorCacheSize       *int        `json:"evaluatorCacheSize,omitempty"`
+	Tracing                  Tracing     `json:"tracing,omitempty"`
 	Metrics                  Metrics     `json:"metrics,omitempty"`
 	Healthz                  Healthz     `json:"healthz,omitempty"`
 }
@@ -100,6 +101,11 @@ type Ports struct {
 	HTTP *int32 `json:"http,omitempty"`
 }
 
+type Tracing struct {
+	Endpoint string            `json:"endpoint"`
+	Tags     map[string]string `json:"tags,omitempty"`
+}
+
 type Metrics struct {
 	Port               *int32 `json:"port,omitempty"`
 	DeepMetricsEnabled *bool  `json:"deep,omitempty"`

diff --git a/api/v1beta1/groupversion_info.go b/api/v1beta1/groupversion_info.go
@@ -15,8 +15,8 @@ limitations under the License.
 */
 
 // Package v1beta1 contains API Schema definitions for the authorino-operator v1beta1 API group
-//+kubebuilder:object:generate=true
-//+groupName=operator.authorino.kuadrant.io
+// +kubebuilder:object:generate=true
+// +groupName=operator.authorino.kuadrant.io
 package v1beta1
 
 import (

diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/bundle/manifests/operator.authorino.kuadrant.io_authorinos.yaml b/bundle/manifests/operator.authorino.kuadrant.io_authorinos.yaml
@@ -136,6 +136,17 @@ spec:
                 type: integer
               secretLabelSelectors:
                 type: string
+              tracing:
+                properties:
+                  endpoint:
+                    type: string
+                  tags:
+                    additionalProperties:
+                      type: string
+                    type: object
+                required:
+                - endpoint
+                type: object
               volumes:
                 properties:
                   defaultMode:

diff --git a/config/crd/bases/operator.authorino.kuadrant.io_authorinos.yaml b/config/crd/bases/operator.authorino.kuadrant.io_authorinos.yaml
@@ -138,6 +138,17 @@ spec:
                 type: integer
               secretLabelSelectors:
                 type: string
+              tracing:
+                properties:
+                  endpoint:
+                    type: string
+                  tags:
+                    additionalProperties:
+                      type: string
+                    type: object
+                required:
+                - endpoint
+                type: object
               volumes:
                 properties:
                   defaultMode:

diff --git a/config/deploy/manifests.yaml b/config/deploy/manifests.yaml
@@ -2564,6 +2564,17 @@ spec:
                 type: integer
               secretLabelSelectors:
                 type: string
+              tracing:
+                properties:
+                  endpoint:
+                    type: string
+                  tags:
+                    additionalProperties:
+                      type: string
+                    type: object
+                required:
+                - endpoint
+                type: object
               volumes:
                 properties:
                   defaultMode:

diff --git a/config/install/manifests.yaml b/config/install/manifests.yaml
@@ -136,6 +136,17 @@ spec:
                 type: integer
               secretLabelSelectors:
                 type: string
+              tracing:
+                properties:
+                  endpoint:
+                    type: string
+                  tags:
+                    additionalProperties:
+                      type: string
+                    type: object
+                required:
+                - endpoint
+                type: object
               volumes:
                 properties:
                   defaultMode:

diff --git a/controllers/authorino_controller.go b/controllers/authorino_controller.go
@@ -375,6 +375,14 @@ func (r *AuthorinoReconciler) buildAuthorinoArgs(authorino *api.Authorino) []str
 		args = append(args, fmt.Sprintf("--%s=%d", flagEvaluatorCacheSize, *evaluatorCacheSize))
 	}
 
+	// tracing-service-endpoint and tracing-service-tag
+	if tracingServiceEndpoint := authorino.Spec.Tracing.Endpoint; tracingServiceEndpoint != "" {
+		args = append(args, fmt.Sprintf("--%s=%s", flagTracingServiceEndpoint, tracingServiceEndpoint))
+		for key, value := range authorino.Spec.Tracing.Tags {
+			args = append(args, fmt.Sprintf(`--%s="%s=%s"`, flagTracingServiceTag, key, value))
+		}
+	}
+
 	// deep-metrics-enabled
 	if enabled := authorino.Spec.Metrics.DeepMetricsEnabled; enabled != nil && *enabled {
 		args = append(args, fmt.Sprintf("--%s", flagDeepMetricsEnabled))

diff --git a/controllers/authorino_controller_test.go b/controllers/authorino_controller_test.go
@@ -296,6 +296,13 @@ func newFullAuthorinoInstance() *api.Authorino {
 					},
 				},
 			},
+			Tracing: api.Tracing{
+				Endpoint: "http://tracing/authorino",
+				Tags: map[string]string{
+					"env":     "test",
+					"version": "1.0.0",
+				},
+			},
 		},
 	}
 }
@@ -308,7 +315,7 @@ func checkAuthorinoArgs(authorinoInstance *api.Authorino, args []string) {
 		flag := flagAndValue[0]
 		var value string
 		if len(flagAndValue) > 1 {
-			value = flagAndValue[1]
+			value = strings.Join(flagAndValue[1:], "=")
 		}
 
 		switch flag {
@@ -339,6 +346,12 @@ func checkAuthorinoArgs(authorinoInstance *api.Authorino, args []string) {
 			Expect(value).Should(SatisfyAny(Equal(defaultOidcTlsCertPath), Equal(defaultOidcTlsCertKeyPath)))
 		case flagEvaluatorCacheSize:
 			Expect(value).Should(Equal(fmt.Sprintf("%v", *authorinoInstance.Spec.EvaluatorCacheSize)))
+		case flagTracingServiceEndpoint:
+			Expect(value).Should(Equal(authorinoInstance.Spec.Tracing.Endpoint))
+		case flagTracingServiceTag:
+			kv := strings.Split(strings.TrimPrefix(strings.TrimSuffix(value, `"`), `"`), "=")
+			Expect(len(kv)).Should(Equal(2))
+			Expect(kv[1]).Should(Equal(authorinoInstance.Spec.Tracing.Tags[kv[0]]))
 		case flagDeepMetricsEnabled:
 			Expect(authorinoInstance.Spec.Metrics.DeepMetricsEnabled).ShouldNot(BeNil())
 			Expect(*authorinoInstance.Spec.Metrics.DeepMetricsEnabled).Should(BeTrue())

diff --git a/controllers/constants.go b/controllers/constants.go
@@ -44,6 +44,8 @@ const (
 	flagOidcTLSCertPath                string = "oidc-tls-cert"
 	flagOidcTLSCertKeyPath             string = "oidc-tls-cert-key"
 	flagEvaluatorCacheSize             string = "evaluator-cache-size"
+	flagTracingServiceEndpoint         string = "tracing-service-endpoint"
+	flagTracingServiceTag              string = "tracing-service-tag"
 	flagDeepMetricsEnabled             string = "deep-metrics-enabled"
 	flagMetricsAddr                    string = "metrics-addr"
 	flagHealthProbeAddr                string = "health-probe-addr"