Match an architecture to the running system

Live match compares an architecture with the code readings and what API Tester saw live, gives it a score, and adds what is missing.

In short

Live match tells you whether the drawing still matches what was built. It compares each part of an architecture with the latest code reading and with what API Tester saw live in the last 30 days. Then it shows a score, such as "Matches the live system: 92%". You can add what is missing in one step, or decide row by row.

Before you start

• Who: reading the match needs View. Deciding on rows needs Edit; adding parts needs you to be the one editing the design.
• Plan: Designer is part of every plan, Free included. The Free plan limits how many designs a workspace keeps; Plan & usage shows the limit and what you hold. Code readings come from a code source (see /help/designer/connect-your-code).
• First: connect your code, or let API Tester see the API live.

Steps

1. Open an architecture and press "Check against code" in the toolbar. The "Code check" panel opens on the live match. On a workflow the same panel compares it with the code and shows "API drift".
2. Read the score and "What the match is based on": the code source, its commit and what was seen live.
3. Work down the rows. Press "Show" to select a part on the canvas.
4. Tick the rows that belong in this design, or press "Tick all", then press "Add N ticked". The live system is everything the workspace runs, so nothing starts ticked. Tick "Also add them to the catalog" to add them there too.
5. Check the preview and keep it. A Code revision is kept, so you can go back.

Result: the score is kept on the design and shown in the Designer list. "Score over time" shows the last points.

What each row says

Good to know

• A part is called missing only when there is a code reading. Without one it is "Not seen live", never red.
• Calls between services cannot be seen from outside, so connections are matched only against a code reading.
• On an empty architecture with a reading, "Draw from the code" draws the whole system; check each part before you keep it.
• "This may be Orders API in the design." offers a likely name; "Yes, it is" maps the row to it.
• When the code changes after "Mark as designed", the row counts as a difference again.
• Deciding on rows needs edit rights on the design. Adding parts needs you to be the one editing it.
• Choose "Show" and then "Match with the code" to paint the match on the canvas. Press "Download" in the panel for the evidence as Excel or PDF.
• To undo: adding keeps a Code revision, so you can go back. "Undo the decision" reopens an ignored row.

If something goes wrong

• "No score yet: there is no code reading and nothing was seen live to match the design with." - connect your code. See /help/designer/connect-your-code.
• "Someone else is editing this design, so nothing can be added to it now." - you can still decide on each row.
• "The design changed meanwhile. Ask again to get changes that fit it."

Related

• /help/designer/connect-your-code
• /help/designer/design-drift
• /help/designer/start-a-design