servicegraph

README

Istio Servicegraph

Servicegraph is a small app that generates and visualizes graph representations of your Istio service mesh. Servicegraph is dependent on the Prometheus addon and the standard metrics configuration. The documentation for deploying and using Servicegraph is here.

Visualizations

• /force/forcegraph.html is an interactive D3.js visualization.

• /dotviz is a static Graphviz visualization.

Serializations

• /dotgraph provides a DOT serialization.

• /d3graph provides a JSON serialization for D3 visualization.

• /graph provides a JSON serialization.

Query Parameters

All endpoints take these query parameters:

• time_horizon controls the timespan to consider for graph generation. Format is a number plus a time unit. Example 15s or 1m. Default is 5m.

• filter_empty=true will restrict the nodes and edges shown to only those that reflect non-zero traffic levels during the specified time_horizon. Deafult is false.

Demosvc service

Defined in servicegraph/cmd/demosvc, this provides a simple HTTP endpoint that generates Prometheus metrics. This can be used to test the servicegraph service.

Documentation

Overview

Package servicegraph defines the core model for the servicegraph service.

Package servicegraph defines the core model for the servicegraph service.

Index

• func GenerateD3JSON(w io.Writer, g *Dynamic) error
• type Attributes
• type Dynamic
  • func (d *Dynamic) AddEdge(src, target string, lbls map[string]string)
  • func (d *Dynamic) Merge(static *Static)
• type Edge
• type SerializeFn
• type Static

Functions

func GenerateD3JSON

func GenerateD3JSON(w io.Writer, g *Dynamic) error

GenerateD3JSON converts the standard Dynamic graph to d3Graph, then serializes to JSON.

Types

type Attributes

type Attributes map[string]string

Attributes contain a set of annotations for an edge.

type Dynamic

type Dynamic struct {
	Nodes map[string]struct{} `json:"nodes"`
	Edges []*Edge             `json:"edges"`
}

Dynamic represents a service graph generated on the fly.

func (*Dynamic) AddEdge

func (d *Dynamic) AddEdge(src, target string, lbls map[string]string)

AddEdge adds a new edge to an existing dynamic graph.

func (*Dynamic) Merge

func (d *Dynamic) Merge(static *Static)

Merge adds all of the nodes in the static graph into the dynamic graph.

type Edge

type Edge struct {
	Source string     `json:"source"`
	Target string     `json:"target"`
	Labels Attributes `json:"labels"`
}

Edge represents an edge in a dynamic service graph.

type SerializeFn

type SerializeFn func(w io.Writer, g *Dynamic) error

SerializeFn provides a mechanism for writing out the service graph.

type Static

type Static struct {
	Nodes map[string]struct{}
}

Static represents a service graph generated by API calls that is meant to persist across generation requests. It must be merged with a Dynamic graph to provide a complete service graph for Istio.