Add Observability page to docs

[itssimon]

Description

Adds a new page about Observability to the documentation under Topics.

Happy to evolve this further. Feedback is very welcome!

[ulgens]

+1 for the idea, and thanks for the content. My one note would be that it's a bit early to mention django-prometheus as the first example tool on that page. The package has just been migrated to django-commons, and it still requires a not-so-small amount of work to reach a properly functioning state.

[itssimon]

My one note would be that it's a bit early to mention django-prometheus as the first example tool on that page. The package has just been migrated to django-commons, and it still requires a not-so-small amount of work to reach a properly functioning state.

Fair point. As a first measure I've moved it below the OpenTelemetry section. Do you think we should add a note about the current state of django-prometheus, or remove it entirely?

Given that Prometheus is generally a go-to solution for metrics, and there doesn't seem to be a better alternative for Django, my vote would be to leave it in.

[itssimon]

Great content, thanks for taking the time to put this together, however I don't see a lot of it being DRF specific: it's 90% applicable to any Django projects (except maybe Apitally). Why should this be in the DRF docs?

Thanks for your review!

I get where you’re coming from. Some of what’s covered here does also apply to Django more broadly. But I’d suggest looking at it less in terms of "is this DRF-specific?" and more in terms of "is this relevant and useful to DRF users?"

My goal was to help developers using DRF understand how to approach observability in their projects. Even if the techniques and tools apply beyond DRF, the framing and examples are written with DRF users in mind, and the content meets a real need for guidance in this area (imo) – something the current docs don’t cover.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.