docs: update catalog error eventing/logging

[codingdiaz]

Hey, I just made a Pull Request!

This updates the documentation to reflect the changes around catalog error logging. #23022

I wasn’t sure if adding this guide here made sense or not but I wasn’t quite sure the best place to put this content. i.e. should this section be updated and linked out to a guide.

I also feel like there is a much cleaner way (with generics) to define the shape of the catalog event. I was getting type errors when trying something like this:

    params: EventParams<{
      entity: string;
      location?: string;
      errors: Array<Error>;
    }>,

I also didn’t know if a simple module would help for users that want to turn these logs on rather than creating their own? I’m happy to contribute that!

✔️ Checklist

• A changeset describing the change and affected packages. (more info)
• Added or updated documentation
• Tests for new functionality and regression tests for bug fixes
• Screenshots attached (for UI changes)
• All your commits have a Signed-off-by line in the message. (more info)

[awanlin]

Thanks for this @codingdiaz, really appreciate it 🚀

Left a few comments, nothing major, I do think that maybe this should be somewhere else though. This page is great as an overview and I like that it's very focused on the specific topic only. Could we move this here: https://backstage.io/docs/features/software-catalog/configuration

[codingdiaz]

Thanks for this @codingdiaz, really appreciate it 🚀

Left a few comments, nothing major, I do think that maybe this should be somewhere else though. This page is great as an overview and I like that it's very focused on the specific topic only. Could we move this here: https://backstage.io/docs/features/software-catalog/configuration

Any time! I just updated the docs, I agree with you and I linked to the configuration section.

[backstage-goalie]

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
@backstage/plugin-catalog-backend-module-logs	plugins/catalog-backend-module-logs	patch	v0.0.0

[awanlin]

Just gave the docs parts a look. Left some comments, should be pretty easy to address.

Did not look at the code. I was mostly suggesting it should be a module, was hoping the maintainers would give us a quick heads up on if that's the right direction.

[freben]

Nice! Approving just to unblock a bit, I'll self-commit these suggestions to expedite. I hope that's OK. Remember to pull these changes first to your local if you continue working on the branch.

[codingdiaz]

@freben / @ahhhndre. I’m getting some errors checking the API reports but locally I’m running yarn build:api-reports & then yarn build:api-reports:only --ci —docs & echo $ with an output of 0.

Am I missing something to get the api report checks passing in CI?

[awanlin]

Thanks again for this @codingdiaz 🚀

[freben]

Funky - i think it needed a bit of a rebase and massage. Managed to generate the report properly now and pushed. Let's see how it goes.

[freben]

UNLESS I PRESS THE WRONG BUTTON ACCIDENTALLY FIRST

[codingdiaz]

Funky - i think it needed a bit of a rebase and massage. Managed to generate the report properly now and pushed. Let's see how it goes.

Thank you for helping get this passing.

[codingdiaz]

@freben I’m all set with changes on this one (I don’t have the ability to merge).

[awanlin]

@vinzscam looks like we need your approval here too ;)

[github-actions]

Thank you for contributing to Backstage! The changes in this pull request will be part of the 1.29.0 release, scheduled for Tue, 16 Jul 2024.