Note: this work is being done in collaboration with the monitoring team, https://issues.redhat.com/browse/MON-2341 is the "sister epic" in the MON project to track work there.

Goals

Add a logging view to the openshift console that can show logs from a Loki store.

• Must have: support store deployed by LokiStack operator.
• Nice to have: support for other Loki stores.

The log view must

• Provide a good out-of-box experience for common use cases.
• Be k8s/openshift aware and tightly integrated with the openshit console:
  •  good representation of k8s concepts: namespace, pod etc.
  • easy navigation to related console views (pods, containers, etc.)
• Be designed for flexibile re-use in  "correlation" views where we may:

• • display logs alongside metrics, alerts or other existing views.
  • embed clickable links in log views to other views.

Non-Goals

• Not competing with grafana or similar on features
• Not preventing the use of grafana or similar for customers who want that.
  • aim for useful co-existence rather than direct competation.
  • our strength is tight integration in openshift console.

Motivation

• Provide a complete out-of-box experience for openshift logging customers so they can view logs without setting up a grafana instance.
•  

Alternatives

• Require users to provide grafana to use our log aggreagation and storage.

Acceptance Criteria

Given:

• ClusterLogging.LogStore.Type = "lokistack", no ClusterLogForwarder instance
• Log in to openshift console as kubeadmin, open "Administrator" view.

Expect:

• Observe menu should have a Logging button that opens the log view, should show default logs.
• Query panel allows entering a Loki query to show different logs.  
  • TODO doc labels and JSON filters available for queries.
• Admin can select log types (audit, infrastructure and application) from the dropdown and view logs from all namespaces
• Query UI elements work as expected - hide/show details etc. (need list?)
  • Logs Query Input:
    • Is visible
    • When a query is typed the run query button is enabled
    • When the run query button is pressed it executes the typed query
  • Severity Dropdown:
    • Should be visible
    • When toggling any severity item in the list, it executes the current query including the severity filter
  • Tenant dropdown
    • Is visible
    • The `application` option is selected by default
    • When selecting any tenant from the list, it executes the current query filtering by tenant
  • Refresh Button
    • Is visible
    • When pressed, it executes the current query for the current time
  • Time Range Dropdown
    • Is visible
    • When a time range item is selected, it executes the current query filtered by the selected time range
  • Refresh Interval dropdown
    • Is visible
    • If a value different from "Refresh off" is selected it will continue to execute the query automatically on the selected interval
    • If "Refresh off" is selected it will not execute the query automatically
  • Show Resources Checkbox
    • Is visible
    • When toggled, the logs table will display a link to the resources contained in the log entry
• Pod/Container pages have a link to the logging view, following the link shows only the logs for that container.

Given:

• ClusterLogging.LogStore.Type = "lokistack", no ClusterLogForwarder instance
• Log in to openshift console as non-admin user.

Expect

• Query for "infrastructure" or "audit" logs shows nothing.
• Query for "application" logs shows only logs that the user has permission to see, i.e. logs for contains that the user can view using oc logs

Given:

• ClusterLogging.LogStore.Type not equal to "lokistack"
• Log in to openshift console as kubeadmin, open "Administrator" view.

Expect

• "Observe" menu has no "Logging" option.
• Pod/Container pages have no link to the logging view.

Risk and Assumptions

None special - the logging views don't require anything that isn't already present in other console views.

Documentation Considerations

Should be mostly self-documenting (intuitive layout, tooltips, links etc.)

Document like other UI components.