Skip to content

[Update] Remove mentions of no-longer maintained or recommended observability tools and stacks. #273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

simskij
Copy link
Member

@simskij simskij commented May 26, 2025

Update the observability section to no longer talk about LMA, or mention outdated tooling. Instead, provide links to the COS documentation, and to the OpenTelemetry collector snap.

Copy link
Collaborator

@s-makin s-makin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @simskij for submitting these changes. I do have some suggestions which will need to be addressed before I can merge.

This is a good place to ...not advertise exactly, but rather to explain the benefits of COS/COS lite and OTC and what makes them so useful for a sysadmin. Most of our readers already have established setups with tools they've used before, so if we want them to switch we need to tell them why they should. We've done this a few times in the Server docs, for example with Netplan and cloud-init which mostly exists to link to the official documentation. This might be out of scope for this PR, but I would encourage you to think about it as a possible follow up - we can discuss in the next observability sync if you want.

My other suggestions are inline :)

Comment on lines -13 to -16
.. toctree::
:titlesonly:

Set up your LMA stack <observability/set-up-your-lma-stack>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy for us to take away the LMA stack, since this has been fully superseded by COS. However, I would ask you to also delete the lma stack page in question, otherwise the documentation will fail to build because of the page existing without being in a toctree.

Comment on lines -18 to -27
If you do not need a full LMA stack, there are some other supported tools that
can provide similar capabilities.

.. toctree::
:titlesonly:

Install Logwatch <observability/install-logwatch>
Install Munin <observability/install-munin>
Install Nagios Core 3 <observability/install-nagios>
Use Nagios with Munin <observability/use-nagios-with-munin>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please reinstate this content? These options need to still exist, even if COS the way we officially recommend people to handle observability. Towards 26.04 we can look at replacing this with more up-to-date options but for now I'd like us to keep it, for the benefit of users who can't (or don't want to) use COS.

Use Nagios with Munin <observability/use-nagios-with-munin>
- `Getting started with COS Lite <https://documentation.ubuntu.com/observability/tutorial/installation/getting-started-with-cos-lite/>`_
- `How to integrate COS Lite with uncharmed applications <https://documentation.ubuntu.com/observability/how-to/integrating-cos-lite-with-uncharmed-applications/>`_
- `The OpenTelemetry Collector snap <https://snapcraft.io/opentelemetry-collector>`_
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links are a really helpful addition, but if we want to tempt people to use COS we should provide a bit more context around these links.

I think if we can use this space to disambiguate the difference between the COS and COS lite use cases, and say what OTC does and what use case it is for, it will help our readers to understand which of the options they should use for their situation, which will in turn help increase the adoption.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants