codeout/inet-henge codeout/inet-henge

  • Stars
    star
    248
  • Rank 163,560 (Top 4 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created over 8 years ago
  • Updated about 1 year ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
codeout/inet-henge
github

codeout

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Generate d3.js based Network Diagram from JSON data.

inet-henge.js

inet-henge.js generates d3.js based Auto Layout Network Diagram from JSON data.
inet-henge helps you draw it by calculating coordinates automatically, placing nodes and links in SVG format.

Each object is draggable and zoomable.

stone-henge

All you have to do are:

  1. Define nodes identified by name
  2. Define links by specifying both end nodes
  3. Show in a browser. That's it.

JSON example:

{
  "nodes": [
    { "name": "A" },
    { "name": "B" }
  ],

  "links": [
    { "source": "A", "target": "B" }
  ]
}

Getting Started

npm install inet-henge

# or

git clone https://github.com/codeout/inet-henge.git

Then host the root directory in your favorite web server.

ruby -run -e httpd . -p 8000

Now you can see http://localhost:8000/example.

python -m SimpleHTTPServer  # python2
python -m http.server       # python3

or

php -S 127.0.0.1:8000

are also available to start a web server.

Demo

Usage

In example here, load related assets at first:

  • d3.js v3
  • cola.js
    • ⚠️ It doesn't support d3.js v4 ⚠️
  • inet-henge.js
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />

    <!-- You can customize a style of network diagram by CSS -->
    <link href="style.css" rel="stylesheet" />

    <script src="https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.17/d3.js"></script>
    <script src="../vendor/cola.min.js"></script>
    <script src="../inet-henge.js"></script>
  </head>

define a blank container:

<body>
  <div id="diagram"></div>
</body>

and render your network diagram:

  <script>
   new Diagram("#diagram", "shownet.json").init("interface");
  </script>
</html>

Object is also acceptable:

  <script>
    const data = {
      "nodes": [{ "name": "A" }, { "name": "B" }],
      "links": [{ "source": "A", "target": "B" }]
    };
   new Diagram("#diagram", data).init("interface");
  </script>
</html>

inet-henge.js renders your network diagram as SVG within <div id="diagram"></div>. In the example above the diagram also displays metadata labelled "interface" which defined in JSON data.

Shownet2016 example

JSON Data

Minimal json looks like:

{
  "nodes": [
    { "name": "A" },
    { "name": "B" }
  ],

  "links": [
    { "source": "A", "target": "B" }
  ]
}

You can specify node icon by URL:

  "nodes": [
    { "name": "dceast-ne40e", "icon": "./images/router.png" }
  ]

Metadata to display on network diagrams:

new Diagram("#diagram", "index.json").init("interface");
  "links": [
    {
      "source": "noc-asr9904", "target": "noc-ax8616r",
      "meta": {
        "interface": { "source": "0-0-0-2", "target": "1-1" }
      }
    }
  ]

☝️ This will render metadata on both ends of links.

Node Group

Nodes get rendered in groups when you specify which node belongs to which group by regular expression.

When the first three characters describe POP name, you can group nodes by doing this:

const diagram = new Diagram("#diagram", "data.json", { pop: /^.{3}/ });

Labels

When init() API is called with arguments, inet-henge finds corresponding metadata and show them as labels.

To place a loopback address on nodes:

new Diagram("#diagram", "index.json").init("loopback");
{
  "nodes": [
    { "name": "Node 1", "meta": { "loopback": "10.0.0.1" } },
    ...
  ],
  ...
}

Label on node

To place link and interface names:

new Diagram("#diagram", "index.json").init("bandwidth", "intf-name");
{
  ...
  "links": [
    {
      "source": "Node 1", "target": "Node 2",
      "meta": {
        "bandwidth": "10G",
        "intf-name": { "source": "interface A", "target": "interface B" }
      }
    },
    ...
  ]

Label on link

Node Size

You can change node width and height:

const diagram = new Diagram("#diagram", "data.json", { nodeWidth: 120, nodeHeight: 30 });

Node Size

Width 60 and heigh 40 (px) by default.

Link Width

You can use linkWidth() API to customize link widths. The argument should be a function which calculates metadata and returns value for stroke-width of SVG.

const diagram = new Diagram("#diagram", "index.json");
diagram.linkWidth(function (link) {
  if (!link)
    return 1;  // px
  else if (link.bandwidth === "100G")
    return 10; // px
  else if (link.bandwidth === "10G")
    return 3;  // px
  else if (link.bandwidth === "1G")
    return 1;  // px
});
diagram.init("bandwidth");
  "links": [
    { "source": "Node 1", "target": "Node 2", "meta": { "bandwidth": "1G" }},
    { "source": "Node 1", "target": "Node 3", "meta": { "bandwidth": "10G" }},
    { "source": "Node 2", "target": "Node 3", "meta": { "bandwidth": "100G" }}
  ]

Link width

⚠️ Make sure no stylesheet overrides customized link widths. ⚠️

Group Size

You can specify padding to increase the size of groups (default: 1):

const diagram = new Diagram("#diagram", "data.json", { groupPadding: 30 });

Group Size

💡 Position calculation sometimes gets stuck when increasing groupPadding. initialTicks may help in such cases.

Ticks

You can specify the number of steps (called as ticks) to calculate with d3-force layout. Bigger ticks typically converge on a better layout, but it will take much longer until settlement. The default value is 1000.

const diagram = new Diagram("#diagram", "data.json", { ticks: 3000 });

For large scale network diagrams, you can also specify the number of initial unconstrained ticks.

const diagram = new Diagram("#diagram", "data.json", { initialTicks: 100, ticks: 100 });

inet-henge calculates the layout in two iteration phases:

  1. Initial iteration with no constraints. ( default: 0 tick )
  2. The main iteration with constraints that apply groups as bounding boxes, prevent nodes and groups from overlapping with each other, and so on. ( default: 1000 ticks )

If you increase initialTicks, inet-henge calculates faster in exchange for network diagram precision so that you can decrease ticks which is the number of main iteration steps.

20 ~ 100 initialTicks and 70 ~ 100 ticks should be good start for 800 nodes with 950 links for example. It takes 20 ~ 30 seconds to render in the benchmark environment.

Position Cache

inet-henge caches a calculated position of nodes, groups, and links for the next rendering. If you load the same JSON data, the cache will be used as a position hint. You can disable this behavior with positionCache option.

const diagram = new Diagram("#diagram", "data.json", { positionCache: false });

SVG viewport size

You can change svg's viewport size:

const diagram = new Diagram("#diagram", "data.json", { width: 1200, height: 600 });

This will generate:

<svg width="1200" height="600">

Style

inet-henge generates an SVG image, so you can customize the style by using CSS.

Display bundles

You can display multiple links between nodes by setting bundle: true in the constructor like:

<script>
  const diagram = new Diagram("#diagram", "index.json", { pop: /^([^\s-]+)-/, bundle: true });
  diagram.init("loopback", "interface");
</script>

Bundle example

Nodes are connected to each other with a single link by default.

Save positions after dragging nodes

You can save positions of all nodes in browser even after dragging them by setting positionCache: "fixed" in the constructor like:

<script>
  const diagram = new Diagram("#diagram", "index.json", { pop: /^([^\s-]+)-/, positionCache: "fixed" });
  diagram.init("loopback", "interface");
</script>

Position hinting

You can provide the coordinates of nodes as position hints to place them where you want. inet-henge calculates the layout by considering them. It always refers to position cache over hint when there is a cache.

💡 They are "hints". Nodes won't be strictly placed there.

const diagram = new Diagram("#diagram", "index.json", {
  pop: /^([^\s-]+)-/,
  bundle: true,
  positionHint: {
    nodeCallback: (node) => {
      const [_, pop] = node.name.match(/^([^\s-]+)-/);

      // specify the position of nodes in POP01
      if (pop === "POP01") {
        return { x: 600, y: 330 };
      }

      // unspecified
      return null;
    },
  },
});

diagram.init("loopback", "interface", "description", "type");
  • Use nodeCallback option to specify per node.
    • The Node object is passed as an argument.
    • Return value should be an object like {x: 600, y: 330}.
    • If the callback returns null, this means that the node position is unspecified.

Position hinting

💡 How position hinting works

The position hints are initial positions technically.

  1. inet-henge places nodes according to the hints.
    • When no hint is specified, the node will be placed in the center of the diagram.
  2. Then, it starts the ticks calculation.

Metadata tooltip

You can display node metadata in the tooltip, instead of always showing as node text, by setting tooltip: "click" in the constructor like:

<script>
  const diagram = new Diagram("#diagram", "index.json", { pop: /^([^\s-]+)-/, tooltip: "click" });
  diagram.init("description", "type");
</script>

In the example above, description and type will be displayed.

  "nodes": [
    { "name": "POP01-bb01", "meta": {"description": "This is a router", "type": "Backbone"}, "icon": "./images/router.png" },
    { "name": "POP01-bb02", "meta": {"description": "This is a router", "type": "Backbone"}, "icon": "./images/router.png" },
    { "name": "POP01-ag01", "meta": {"description": "This is a router", "type": "Aggregation"}, "icon": "./images/switch.png" },
    { "name": "POP01-ag02", "meta": {"description": "This is a router", "type": "Aggregation"}, "icon": "./images/switch.png" },

Metadata tooltip

💡 tooltip: "hover" is also available.

Hyperlink in tooltop

You can show <a href="...">...</a> in node metadata tooltips.

<script>
  const diagram = new Diagram("#diagram", "index.json", {
    pop: /^([^\s-]+)-/,
    tooltip: "click",
    href: (t) => `https://example.com/${t.node.name}`,
  });
  diagram.init("description", "type");
</script>

This example above will generate <a href="https://example.com/POP01-bb02">POP01-bb02</a>. Metadata are also available like href: (t) => `https://example.com/${t.node.meta?.type}/${t.node.name}`,.

💡 Use tooltip: "click" to make tooltips sticky.

Initial Position and Scale

You can specify initial position and scale of diagram.

<script>
  const diagram = new Diagram("#diagram", "index.json");
  diagram.init();

  // move 100px in both x and y, and show in 1/2 scale
  diagram.attr("transform", "translate(100, 100) scale(0.5)");
</script>

Experimental Features

⚠️ Those features may work, but still under development. The behavior might be changed ⚠️

Internal groups

You can display node type based groups in POP-based Node group by group definition in each node.

  "nodes": [
    { "name": "POP01-bb01", "group": "core", "icon": "./images/router.png" },
    { "name": "POP01-bb02", "group": "core", "icon": "./images/router.png" },
    ...

Internal group

Plugins

Name Note
Removable Node Plugin Hide and show nodes by key inputs
Arrows Link Plugin Make links bidirectional arrows

Contributing

Please report issues or enhancement requests to GitHub issues. For questions or feedbacks write to my twitter @codeout.

Or send a pull request to fix.

Copyright and License

Copyright (c) 2016-2023 Shintaro Kojima. Code released under the MIT license.

More Repositories

1

junoser

PEG parser for JUNOS configuration.
Ruby
64
star
2

gobgp-node

gobgp library - NodeJS client for gobgpd
JavaScript
17
star
3

vscode-junos

Junos Extension for Visual Studio Code
JavaScript
14
star
4

irrc

Multi-thread IRR / Whois client to expand as-set and route-set into a list of origin ASs and prefixes
Ruby
10
star
5

fluent-plugin-sflow

sFlow plugin for Fluentd
C
10
star
6

event-driven-bgpd

PoC: Event Driven BGPd
Go
6
star
7

sakura-cli

Command-line tool for Sakura's Rental Server.
Ruby
4
star
8

python-wireshark-dissector

Sample implementation of python native extension of wireshark's dissector
C
4
star
9

docker-xflow-collector

Dockerfiles to kickstart xflow collector
2
star
10

rails-peeringdb

Rails models to read peeringdb archives
Ruby
2
star
11

ruby-wireshark-dissector

Sample implementation of ruby native extension of wireshark's dissector
C
2
star
12

doneyo

Yo you when it's done
Ruby
2
star
13

rpatricia

This is a fork of git://bogomips.org/rpatricia.git. The original website is:
C
1
star
14

google_geolocator

Ruby
1
star
15

junos-ci

Demo repository for CI for Junos
Ruby
1
star
16

django-inethenge

django app example for https://github.com/codeout/inet-henge/issues/18
JavaScript
1
star
17

inetb

inetb is a benchmarking tool for BGP RIB / FIB convergence
Go
1
star
18

rancid

Shell
1
star
19

fluent-plugin-netflow-multiplier

Fluentd filter plugin to multiply sampled netflow counters by sampling rate.
Ruby
1
star