mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code
netbox-community-netbox/docs/additional-features/graphs.md
Jeremy Stretch 9399652dd0 Add template_language field to Graph
2020-01-10 11:28:50 -05:00

1.9 KiB
Raw Blame History

Graphs

NetBox does not have the ability to generate graphs natively, but this feature allows you to embed contextual graphs from an external resources (such as a monitoring system) inside the site, provider, and interface views. Each embedded graph must be defined with the following parameters:

  • Type: Site, device, provider, or interface. This determines in which view the graph will be displayed.
  • Weight: Determines the order in which graphs are displayed (lower weights are displayed first). Graphs with equal weights will be ordered alphabetically by name.
  • Name: The title to display above the graph.
  • Source URL: The source of the image to be embedded. The associated object will be available as a template variable named obj.
  • Link URL (optional): A URL to which the graph will be linked. The associated object will be available as a template variable named obj.

Graph names and links can be rendered using the Django or Jinja2 template languages.

!!! warning Support for the Django templating language will be removed in NetBox v2.8. Jinja2 is recommended.

Examples

You only need to define one graph object for each graph you want to include when viewing an object. For example, if you want to include a graph of traffic through an interface over the past five minutes, your graph source might looks like this:

https://my.nms.local/graphs/?node={{ obj.device.name }}&interface={{ obj.name }}&duration=5m

You can define several graphs to provide multiple contexts when viewing an object. For example:

https://my.nms.local/graphs/?type=throughput&node={{ obj.device.name }}&interface={{ obj.name }}&duration=60m
https://my.nms.local/graphs/?type=throughput&node={{ obj.device.name }}&interface={{ obj.name }}&duration=24h
https://my.nms.local/graphs/?type=errors&node={{ obj.device.name }}&interface={{ obj.name }}&duration=60m