event-catalog / eventcatalog

An open source documentation tool to bring discoverability to your event-driven architectures
https://eventcatalog.dev
MIT License
1.71k stars 145 forks source link

Configuration - Service Labels #546

Open danielmackay opened 3 months ago

danielmackay commented 3 months ago

Context / Problem

Currently, Event Catalog is geared around Microservices. 'Services' being a key part of the system.

There is a large overlap with a Microservice system and a Modular Monolith. In this instance a 'Service' is very similar to a 'Module' in a Modular Monolith

Suggestion

I read in the documentation that 'Services' are a generic term, but it would be great to have some control over this.

It would be great if I could override this label to be called 'Modules' instead, which would save a lot of confusion when documenting a Modular Monolith application using Event Catalog.

black-snow commented 3 months ago

Do you have a modulith and other services at the same time? Do you need both?

danielmackay commented 3 months ago

Do you have a modulith and other services at the same time? Do you need both?

Yes, it is possible that you could have both. You might have a Modular Monolith with modules mostly communication together, but some modules could communicate with microservices

Perhaps 'Services' could be extended with a 'Type' field to allow to to be either a Module or a Service ?