[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.

audit-opentelemetry/plugindefinition.yaml

audit-opentelemetry/chart/Chart.yaml

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

audit-opentelemetry/chart/templates/_helpers.tpl

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

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

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

audit-opentelemetry/chart/values.yaml

audit-opentelemetry/plugindefinition.yaml

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

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).

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

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

timojohlo · 2025-01-16T08:29:59Z

Nothing to add from my side. A second pair of eyes would help, then I would say lets ship it!

This adds a custom PluginDefinition that implements with the otel plugin. It has custom values that are specific for handling auditing. --------- Signed off by: Simon Olander ([email protected])

This adds a skeleton for the audit logs tpl files. At the moment there is no concrete processing of the data. --------- Signed off by: Simon Olander ([email protected])

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])

- edits logo - changes names to be more consistent otel-audit -> audit-otel - fixme: add playbook urls --------- Signed off by: Simon Olander ([email protected])

--------- Signed off by: Simon Olander ([email protected])

…n fields --------- Signed off by: Simon Olander ([email protected])

This adds a skeleton for the audit logs tpl files. At the moment there is no concrete processing of the data. --------- Signed off by: Simon Olander ([email protected])

…of reusing existing plugin --------- Signed off by: Simon Olander ([email protected])

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 3 times, most recently 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