[openTelemetry-audit] Adds plugin of OpenTelemetry Audit Logs #556

olandr · 2024-12-16T15:27:54Z

This adds a plugin for OpenTelemetry ingestion of audit relevant signals. This will be a separate plugin from the 'OpenTelemetry' plugin, because it will most likely have different requirements.

This is an initial pull to create the foundation of the plugin.

This is an initial commit which just copies over the already existing otel plugin. Simply because the foundation for this otel-audit plugin will be based on the otel plugin. --------- Signed off by: Simon Olander ([email protected])

…specifics - Defines a name opentelemetry-audit for the plugin - Adds the substring 'audit' to various resource to not conflict with other resources. - Adds architecture diagram --------- Signed off by: Simon Olander ([email protected])

timojohlo · 2024-12-20T08:12:05Z

audit-opentelemetry/plugindefinition.yaml

+metadata:
+    name: opentelemetry-audit
+spec:
+    version: 0.6.1


Start with a new versioning, instead of following the original OTel plugin versioning, the same is true for the helmChart.version

timojohlo · 2024-12-20T08:15:00Z

audit-opentelemetry/plugindefinition.yaml

+    version: 0.6.1
+    displayName: OpenTelemetry for Audit Logs
+    description: Audit Logs relevant Observability framework for instrumenting, generating, collecting, and exporting telemetry data such as traces, metrics, and logs.
+    icon: https://raw.githubusercontent.com/cloudoperators/greenhouse-extensions/main/opentelemetry/logo.png


Maybe we can change the icon so the difference between the two plugins becomes recognizable? Could be just include a simple writing "audit"

timojohlo · 2024-12-20T08:18:06Z

audit-opentelemetry/chart/Chart.yaml

+apiVersion: v2
+appVersion: v0.114.0
+name: opentelemetry-audit-operator
+version: 0.6.1


same as in the PluginDefinition: Start with a new versioning, instead of following the original OTel plugin versioning

timojohlo · 2024-12-20T08:31:43Z

audit-opentelemetry/chart/templates/metrics-collector.yaml

+apiVersion: opentelemetry.io/v1beta1
+kind: OpenTelemetryCollector
+metadata:
+  name: metrics


Rename this to audit-logs-metrics or something unique

timojohlo · 2024-12-20T08:35:34Z

audit-opentelemetry/chart/templates/_helpers.tpl

+
+{{/* Generate plugin specific labels */}}
+{{- define "plugin.labels" -}}
+plugindefinition: opentelemetry


the value should be referring to the audit plugin

timojohlo · 2024-12-20T08:43:12Z

audit-opentelemetry/chart/templates/tests/test-opentelemetry-config.yaml

+
+    {{- if .Values.openTelemetry.metricsCollector.enabled }}
+    @test "Verify successful deployment and running status of the metrics-collector" {
+        try "at most 5 times every 10s to get pods named 'metrics-collector' and verify that '.status.phase' is 'running'"


See other comment in metrics-collector.yaml: Rename this to audit-logs-metrics or something unique

timojohlo · 2024-12-20T08:44:57Z

audit-opentelemetry/chart/alerts/collector-alerts.yaml

+        for: 5m
+        labels:
+          severity: warning
+          runbook_url: https://github.com/cloudoperators/greenhouse-extensions/tree/main/opentelemetry/playbooks/FilelogRefusedLogs.md


even if its just a boilerplate for now, you can change it to referring to audit-opentelemetry, same for the other alerts here and in operator-alerts.yaml

timojohlo · 2024-12-20T08:45:51Z

audit-opentelemetry/chart/alerts/collector-alerts.yaml

@@ -0,0 +1,41 @@
+groups:
+  - name: collector-alerts


Rename it to audit-collector-alerts

timojohlo · 2024-12-20T08:46:28Z

audit-opentelemetry/chart/alerts/operator-alerts.yaml

@@ -0,0 +1,28 @@
+groups:
+  - name: operator-alerts


Rename it to audit-operator-alerts

timojohlo · 2024-12-20T08:48:29Z

audit-opentelemetry/chart/values.yaml

+    enabled: false
+
+# Empty variables will fail during rollout
+openTelemetry:


I would suggest to change the name to audit-openTelemetry (or similar) so we can dinstinguish it a bit better. This should then be done for all entries, including the PluginDefinition

timojohlo · 2024-12-20T08:53:40Z

audit-opentelemetry/plugindefinition.yaml

+apiVersion: greenhouse.sap/v1alpha1
+kind: PluginDefinition
+metadata:
+    name: opentelemetry-audit


The directory for this Plugin is called audit-opentelemetry while the Plugin is called opentelemetry-audit. I would suggest to make it consistent and name the directory opentelemetry-audit.

timojohlo · 2024-12-20T08:59:03Z

audit-opentelemetry/plugindefinition.yaml

+    helmChart:
+        name: opentelemetry-operator
+        repository: oci://ghcr.io/cloudoperators/greenhouse-extensions/charts
+        version: 0.6.1


see comment about versioning

timojohlo · 2024-12-20T09:01:41Z

audit-opentelemetry/chart/templates/pmon-filelog.yaml

+      port: prometheus
+  selector:
+    matchLabels:
+      app.kubernetes.io/component: opentelemetry-collector


Rename it to opentelemetry-audit-collector or similar

timojohlo

Hi,

Overall it looks good. Most of the comments are about naming.

I still would prefer to add each component successively when needed but I am fine with this approach as well.

I like the architecture image!

Small addition: You can also include the directory-path here: https://github.com/cloudoperators/greenhouse-extensions/blob/main/.github/licenserc.yaml (as done with opentelemetry). This will then ignore automatically adding license headers and fix the failing check (see below).

olandr changed the title ~~feature/audit otel~~ [open-telemetry-audit] Adds plugin for auditing using open-telemetry Dec 16, 2024

olandr changed the title ~~[open-telemetry-audit] Adds plugin for auditing using open-telemetry~~ [openTelemetry-audit] Adds plugin for auditing using open-telemetry Dec 16, 2024

olandr force-pushed the feature/audit-otel branch from 941e4ee to 97213c7 Compare December 19, 2024 15:50

olandr changed the title ~~[openTelemetry-audit] Adds plugin for auditing using open-telemetry~~ [openTelemetry-audit] Adds plugin of OpenTelemetry Audit Logs Dec 19, 2024

olandr force-pushed the feature/audit-otel branch 2 times, most recently from 8bd7f02 to 58a1375 Compare December 19, 2024 16:13

olandr force-pushed the feature/audit-otel branch from 58a1375 to 87f627e Compare December 19, 2024 16:15

olandr marked this pull request as ready for review December 19, 2024 16:16

olandr requested a review from a team as a code owner December 19, 2024 16:16

timojohlo reviewed Dec 20, 2024

View reviewed changes

timojohlo requested changes Dec 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[openTelemetry-audit] Adds plugin of OpenTelemetry Audit Logs #556

[openTelemetry-audit] Adds plugin of OpenTelemetry Audit Logs #556

olandr commented Dec 16, 2024 •

edited

Loading

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024 •

edited

Loading

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024 •

edited

Loading

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024

timojohlo Dec 20, 2024 •

edited

Loading

timojohlo left a comment •

edited

Loading

[openTelemetry-audit] Adds plugin of OpenTelemetry Audit Logs #556

Are you sure you want to change the base?

[openTelemetry-audit] Adds plugin of OpenTelemetry Audit Logs #556

Conversation

olandr commented Dec 16, 2024 • edited Loading

Choose a reason for hiding this comment

timojohlo Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timojohlo Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timojohlo Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

timojohlo left a comment • edited Loading

Choose a reason for hiding this comment

olandr commented Dec 16, 2024 •

edited

Loading

timojohlo Dec 20, 2024 •

edited

Loading

timojohlo Dec 20, 2024 •

edited

Loading

timojohlo Dec 20, 2024 •

edited

Loading

timojohlo left a comment •

edited

Loading