Fix your microservice architecture using graph analysis

© 2019 GraphAware Ltd. All rights reserved.
Fix your microservice architecture
Using graph analysis
Nicolas Mervaillie - Principal Consultant @ GraphAware
graphaware.com
@graph_aware, @nmervaillie
#neo4j and #jQAssistant

@nmervaillie
https://www.linkedin.com/in/nicolas-mervaillie-a2b9876/

Microservices…. theory vs reality
Photo by Alphacolor on Unsplash Photo by Rick Mason on Unsplash

Not everyone is etﬂi or
Photo by Tommy Lisbin on Unsplash

Code is a Graph!
• Detect anti-patterns
• Impact analysis
• Better data governance
• Improve communication between teams

Let’s try on an example application
https://github.com/sqshq/PiggyMetrics
./jqassistant.sh scan -f PiggyMetrics/account-service/target/account-service.jar,
PiggyMetrics/auth-service/target/auth-service.jar,
PiggyMetrics/notification-service/target/notification-service.jar,
PiggyMetrics/statistics-service/target/statistics-service.jar,
PiggyMetrics/config/target/config.jar

@RestController
@RequestMapping("/users")
public class UserController {
@Autowired
private UserService userService;
@RequestMapping(value = "/current", method = RequestMethod.GET)
public Principal getUser(Principal principal) {
return principal;
}
@PreAuthorize("#oauth2.hasScope('server')")
@RequestMapping(method = RequestMethod.POST)
public void createUser(@Valid @RequestBody User user) {
userService.create(user);
}
}
How does this translate into a graph ?

We can deﬁne higher level concepts
• APIs
• Software architecture
• Engineering practices
• …
OK, but what about my loosely coupled microservices?
Photo by ⻉贝莉⼉儿 NG on Unsplash

REST Endpoints
MATCH (cls:Class)-[:DECLARES]->(endpoint)-[:ANNOTATED_BY]->(ann:Annotation)-[:OF_TYPE]->(:Type{name:"RequestMapping"})
WHERE cls.fqn starts with 'com.'
OPTIONAL MATCH (ann)-[:HAS]->(:Value{name:"value"})-[:CONTAINS]->(url:Value)
OPTIONAL MATCH (ann)-[:HAS]->(:Value{name:"method"})-[:CONTAINS]->()-[:IS]->(httpMethod:Field)
SET endpoint:Endpoint
SET endpoint.method = split(httpMethod.signature, " ")[1]
SET endpoint.url = url.value
RETURN cls.fqn, endpoint.url, endpoint.method
@RequestMapping
Annotation
HTTP 
url/method

Feign (HTTP) clients
MATCH (client:Interface)-[:DECLARES]->(m:Method)
WHERE client.fqn STARTS WITH "com."
AND (client)-[:ANNOTATED_BY]->()-[:OF_TYPE]->(:Type{fqn:"org.springframework.cloud.openfeign.FeignClient"})
MATCH (m)-[:ANNOTATED_BY]->(ann:Annotation)-[:HAS]->(:Value{name:"value"})-[:CONTAINS]->(url:Value)
MATCH (m)-[:ANNOTATED_BY]->(ann:Annotation)-[:HAS]->(:Value{name:"method"})-[:CONTAINS]->()-[:IS]-
>(httpMethod:Field)
SET m:FeignClient
SET m.url = apoc.text.regreplace(url.value, '{.*}', '{}')
SET m.httpMethod = split(httpMethod.signature, ' ')[1]
return m.name, m.httpMethod, m.url

To materialize HTTP calls in the graph
MATCH (client:FeignClient), (endpoint:Endpoint)
WHERE client.url=endpoint.fullUrl and client.httpMethod=endpoint.method
MERGE (client)-[:INVOKES_REMOTE]->(endpoint)
RETURN client, endpoint

MATCH (callerService:Artifact)-[:CONTAINS]-(callerClass:Type)-[:DECLARES]-(caller)
MATCH (caller)-[:INVOKES_REMOTE]->(calledEndpoint)
MATCH (calledEndpoint)<-[:DECLARES]-(calledClass:Class)<-[:CONTAINS]-(calledService:Artifact)
RETURN *
To ﬁnd out cross service dependency chains

Microservices or distributed monolith ?
source: martinfowler.com

Data governance
Are my services (over)sharing data?
MATCH (jar:Artifact)--(entity:Type)-[:ANNOTATED_BY]->(ann:Annotation)
MATCH (ann)-[:OF_TYPE]-(:Type{fqn:'org.springframework.data.mongodb.core.mapping.Document'})
MATCH (ann)-[:HAS]->(collection:Value{name:"collection"})
SET entity:Entity:MongoDb
SET entity.collectionName=collection.value
RETURN entity.fqn as class, entity.collectionName as collection, jar.serviceName as usedBy
ORDER by collection
[ ]
Needs to be
investigated

More impact analysis
What’s the impact on endpoints of changing XYZ?
MATCH p=(ep:Endpoint)-[:INVOKES|VIRTUAL_INVOKES|INVOKES_REMOTE*]->(m)<--(r:Repository)
RETURN r.name, m.signature, collect(ep.method +' '+ ep.fullUrl) as usedBy
ORDER BY r.name

Is the documentation up to date?
openapi: 3.0.1
info:
title: Piggy bank sample app
description: 'a sample documentation for the statistics service'
version: 1.0.0
tags:
- name: statistics
description: Statistics service
paths:
/statistics/{accountName}:
put:
tags:
- statistics
summary: Update account stats
operationId: saveAccountStatistics
parameters:
- name: accountName
in: path
description: Name of the account to update
required: true
schema:
type: string
requestBody:
description: Account object that needs to be added to the store
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
required: true
MATCH (a:Artifact)
OPTIONAL MATCH (a)-[:CONTAINS]->(f:File)
--(doc:Document:YAML)--(key:Key{name:'openapi'})
RETURN distinct a.serviceName, f.fileName

Is the documentation up to date?
Code
Vs
ApiDoc

What about resilience?
MATCH (client:Interface)-[:ANNOTATED_BY]->(a)-[:OF_TYPE]->
(t:Type{fqn:”org.springframework.cloud.openfeign.FeignClient”})
OPTIONAL MATCH (a)-[:HAS]-(v:Value{name:'fallback'})--(fb:Type)
RETURN client.fqn as client, fb.fqn as fallback

Knowledge sharing
GraphML export => Visualisation tool

Knowledge sharing

A lot more to explore!
• Security
• What needs to be tested ?
• Runtime data
• SCM data
• Graph algos
• Front end code scanning
• Evolution over time
• …
Photo by Gaetano Cessati on Unsplash

Give it a try!
Code examples on
https://github.com/graphaware/ﬁx-your-microservicesjQAssistant.org

Thank you
For more information please contact:
Nicolas Mervaillie · 10/10/2019 
info@graphaware.com.
@nmervaillie
graphaware.com

Hunger Games Questions for
"Fix your microservice architecture using graph analysis"
1.Easy: jQAssistant is able to scan: 
1.JVM byte code
2.JSON / YAML / properties files
3.All of them, and more 
2.Medium: How many plugins are available jQA? 
1.Less than 10
2.Between 10 and 30
3.More than 30 
3.Hard: What is the API documentation format used in the examples? 
Answer here: r.neo4j.com/hunger-games

Fix your microservice architecture using graph analysis

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Mehr von GraphAware

Mehr von GraphAware (20)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

Fix your microservice architecture using graph analysis