Feature Overview (aka. Goal Summary)  

Observability team is providing an OpenTelemetry (otel) collector package for RHEL/RHDE. Same package can be used to also observe MicroShift, but needs some extra config and handling.

Goals (aka. expected user outcomes)

Provide the necessary config so that microshift specifc observability data (kublet, api, etcd, pod metrics, stats, pod logs, events etc) are exported via the collector. 

Requirements (aka. Acceptance Criteria):

1. Observability must be opt-in, i.e. customers can add it if wanted (e.g. “dnf install microshift-observability”)
2. Observability must be configurable, to control the resource usage it induces. Configuration should be possible locally on the edge device, or centrally (e.g. through gitops).
3. Configuration pre-sets should be provided:
   1. Minimum (just the bare minimum, e.g. CPU, RAM, DISK, total pod usage, fatal log messages)
   2. Medium (a bit more details)
   3. Maximum (everything)
4. Log forwarding
   1. log forwarding of system logs 
   2. Log forwarding of application logs
5. Event forwarding
   1. Events are like logs, but with a high priority, i.e. they should not be lost and transmitted first. Events are conditions e.g. running out of disk space, audit events etc.

Questions to Answer (Optional):

none

Out of Scope

1. This is focusing on the otel collector specifics for microshift only. The otel backend  config (e.g. Dashboards etc) is out of scope.

Background

We see more and more adaption of IP V6, hence we have to ensure MicroShift is ready for this.

Customer Considerations

Wanted urgently by MicroShift early adopter customers.

Documentation Considerations

Minimum documentation only required: how to install, where the config files are, if we provide different profiles, how to switch to those. 

Interoperability Considerations

1. This relies on the base otel collector of RHDE/RHEL. See the linked Jira for details.