Programmatic Loki access

[tylergraff]

Documentation Demonstrating Loki Programmatic Access

Summary

I propose adding documentation to this repo which demonstrates how to programmatically access Loki logs from within Nebari (e.g. from a Nebari jupyter notebook). I have linked a PR in the comments which adds this documentation via an example Python program.

Shout-out to @aktech for creating the implementation; I only cleaned it up a bit and re-validated that it works.

User benefit

Users can use this example to create their own log analysis and introspection capabilities. These capabilities can help Nebari app creators and users debug their own apps, and can also help Nebari administrators and advanced users debug Nebari itself.
Release notes headline could be: Added example demonstrating programmatic introspection of Nebari logs.

Design Proposal

I propose updating nebari-docs to include a section on Programmatic Log Access, along with a working Python example implementation (user must set their own Nebari URL and Grafana token). In the comments I have linked my PR which adds this documentation.

Alternatives or approaches considered (if any)

Best practices

User impact

Documentation change only, no user-facing functionality changes.

Unresolved questions

[tylergraff]

PR implementing the above proposal:
#518

[Adam-D-Lewis]

Hi @tylergraff, I think adding these docs are reasonable. RFDs are put in the https://github.com/nebari-dev/governance repo. BTW, RFDs are typically only for major changes that would affect a majority of end users as described in https://www.nebari.dev/docs/community/decision-making#major-updates---request-for-discussion-rfd-process

Updating docs usually doesn't require an RFD. We don't want to make contributors go through the hassle of an RFD for smaller changes. Thanks for opening the issue!