https://github.com/trek10inc/serverless-graph

Outputs your serverless architecture and resources as a Graphviz dot compatible output
https://github.com/trek10inc/serverless-graph

Last synced: about 2 months ago
JSON representation

Outputs your serverless architecture and resources as a Graphviz dot compatible output

• Host: GitHub
• URL: https://github.com/trek10inc/serverless-graph
• Owner: trek10inc
• License: mit
• Created: 2017-06-05T21:44:39.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-29T19:09:19.000Z (over 6 years ago)
• Last Synced: 2024-07-22T10:48:46.640Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 418 KB
• Stars: 61
• Watchers: 16
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Serverless Graph

This project was adapted from [CFVIZ](https://github.com/benbc/cloud-formation-viz/blob/master/cfviz). Serverless Graph outputs your serverless architecture and resources as a [Graphviz](http://www.graphviz.org/) dot compatible output. Currently only supports the AWS provider.

**Note:** Serverless *v1.x.x* or higher is required.

### Example Output

![Example Generated Graph](https://user-images.githubusercontent.com/1689118/27201203-d700053a-51ea-11e7-8aae-91de39820e41.png)

#### Clarity Mode Graph

We built in a "clarity" mode, that attempts to remove a lot of boilerplate serverless stuff (permissions, lambda versions, etc) in order to increase understanding. The above graph is show here in clarity mode.

![Example Clarity Mode Generated Graph](https://user-images.githubusercontent.com/1689118/27201314-394b0226-51eb-11e7-9595-0577107fb4a0.png)

### Why?

Sometimes this is the fastest way to just visualize everything going on, it can also be extremely helpful in debugging circular dependency issues in CloudFormation templates.

### Get Started

* `npm install --save serverless-graph`

* Install graphviz

  * Homebrew - brew install graphviz

* Add serverless-graph to the plugins section of your serverless.yml

### Run

If you have any commandline params that don't have defaults you will have to pass in any opt variables as this plugin hooks into the package step and then reads the output.

* `sls graph {--opts}`

* Output SVG

  * `cat graph.out | dot -Tsvg -oexample.svg`

* Output PNG

  * `cat graph.out | dot -Tpng -oexample.png`

* See [Graphviz](http://www.graphviz.org/pdf/dot.1.pdf) for more information.

### Options (--help)

```

Plugin: ServerlessGraph

graph ......................... Creates graphviz compatible graph output of nodes and edges. Saves to graph.out file.

    --vertical ......................... Graph nodes from top down instead of left to right.

    --edgelabels / -e .................. Display edgelabels in graph.

    --clarity / -c ..................... By default we show everything, clarity mode will attempt to remove implied nodes and edges for a better graph

    --outFile / -o ..................... Output file, defaults to graph.out

```