Archium’s ‘Quick Peek’ videos give you a demo of a single feature of Archium in just 2 minutes. and how it can help your team. Watch the Quick Peek about Component Details below:
Component Details
The Architecture Directory – which we looked at in the Components Directory and Flows Directory quick peeks – shows you everything your system is made of, and everything it can do.
Component Details allows you to look deeper at one part. Let’s look at the details of the ‘Royalties’ service:
Here you’ll see this Component’s name, its slug, its type, a description, and its owners – a team called ‘The Royals’. You’ll see the code repositories containing its source code, and external links to other info, like design docs, dashboards, and runbooks. We can update any of this simply by clicking on it.
This is obviously all pretty basic info, but it’s so important to collect this stuff somewhere that’s easy to find. It’s invaluable in helping new people to quickly build a working knowledge of your system. And when incidents happen, finding the relevant people, metrics, and instructions quickly is critical to both fast resolution and reducing stress.
Component API and Architecture Details
Next you’ll see detailed information about how this service interacts with the rest of the system.
This isn’t info that anyone has typed into Archium. It extracts these details automatically from your distributed tracing.
You can see the API Entrypoints of this Service: two Kafka topics, a REST route, and an SQS queue. You see it has one Trigger Event – a weekly scheduled task that starts a Flow from inside this service.
Then, under ‘Supported Flows’, you’ll see which features of the system this service is involved in.
There’s two Flows called ‘Play Song’ starting at different components. The little green queue icon tells us those Flows make use of this service asynchronously – so someone playing a song doesn’t wait for the Royalties service to do its work.
The ‘View Royalty Reports’ Flow, however, has a synchronous dependency on this service.
Details like this show you exactly how the features of your system relate to the Components. That can help to inform decisions around Service Levels, deployments, and even how to refactor the system.
Lastly you’ll see Inbound and Outbound Dependencies, and details about when the Service has been seen in your tracing.
We hope you enjoyed that quick peek at the Component Details feature of the Archium service catalog.
What Next?
Want to see more of Archium’s unique capabilities? Check out our Quick Peek videos playlist on YouTube.
Got questions about what Archium is and how it works? You’ll probably enjoy our Frequently Asked Questions.
Want to try Archium for your team? Get in touch so we can set you up with a free trial.