django-netjsongraph 0.6.3.post1

update_topology

在管理界面中添加拓扑 URL（暴露网络拓扑文件的 URL）后，可以使用 update_topology 管理命令收集数据并开始使用网络图

./manage.py update_topology

管理命令接受一个 --label 参数，该参数将用于在拓扑标签中搜索，例如

./manage.py update_topology --label mytopology

save_snapshot

可以使用 save_snapshot 管理命令保存拓扑图数据，这些数据可以在将来某个时间用于查看网络拓扑图

./manage.py save_snapshot

管理命令接受一个 --label 参数，该参数将用于在拓扑标签中搜索，例如

./manage.py save_snapshot --label mytopology

FETCH策略

拓扑数据将从 URL 获取。

当某些链接不再检测到时，它们将立即标记为“down”。

RECEIVE策略

拓扑数据直接从网络的一个或多个节点发送。

收集器等待接收POST HTTP请求负载中的数据；当接收到此类请求时，首先检查其key参数是否与Topology键匹配。

如果请求被授权，收集器将继续更新拓扑。

如果数据仅从一个节点发送，强烈建议将Topology实例的expiration_time设置为0（秒），这样系统的工作方式就与FETCH策略一样，唯一的区别是数据是由一个节点发送而不是由收集器获取。

如果数据是从多个节点发送的，您必须将Topology实例的expiration_time设置为比节点发送拓扑的间隔略高的值，这样只有在一段时间内未检测到链路时，链路才会被标记为“down”。这种机制允许在网络被分成几个部分的情况下可视化拓扑，缺点是检测下线链路将花费更多时间。

NETJSONGRAPH_PARSERS

额外的自定义netdiff解析器。

NETJSONGRAPH_SIGNALS

表示在初始化时导入的python模块的字符串。

用于加载django信号或定义自定义行为。

NETJSONGRAPH_TIMEOUT

获取拓扑URL的超时时间。

NETJSONGRAPH_LINK_EXPIRATION

如果链路下线超过这个天数，它将被update_topology管理命令删除。

将此设置为False将禁用此功能。

NETJSONGRAPH_VISUALIZER_CSS

可视化器CSS文件的路径。允许根据用户的偏好自定义CSS。

NETJSONGRAPH_NODE_EXPIRATION

如果一个节点自指定天数以来没有修改，并且它没有链路，它将被update_topology管理命令删除。这取决于是否启用了NETJSONGRAPH_LINK_EXPIRATION。将False替换为一个整数以启用此功能。

TOPOLOGY_API_URLCONF

使用urlconf选项更改接收API URL以指向另一个模块，例如，myapp.urls。

TOPOLOGY_API_BASEURL

如果您在另一个域上有单独的django-netjsongraph实例，可以使用此选项更改URL的基础，这样就可以将所有API URL指向您的django-netjsongraph API服务器的域，例如值：https://mytopology.myapp.com。

示例：覆盖 <script> 标签

以下是如何更改传递给netjsongraph.js的javascript选项的逐步指南，请记住用您的项目的绝对文件系统路径替换<project_path>。

步骤1：在<project_path>/templates/netjsongraph中创建一个目录

步骤2：打开您的settings.py并编辑TEMPLATES['DIRS']设置，使其看起来像以下示例

# settings.py
TEMPLATES = [
    {
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
        # ... all other lines have been omitted for brevity ...
    }
]

步骤 3：在新的 <项目路径>/templates/netjsongraph/ 目录中创建一个名为 netjsongraph-script.html 的新文件，例如

<!-- <project_path>/templates/netjsongraph/netjsongraph-script.html -->
<script>
    window.__njg_el__ = window.__njg_el__ || "body";
    window.__njg_default_url__ = "{{ graph_url }}";
    window.loadNetJsonGraph = function(graph){
        graph = graph || window.__njg_default_url__;
        d3.select("svg").remove();
        d3.select(".njg-overlay").remove();
        d3.select(".njg-metadata").remove();
        return d3.netJsonGraph(graph, {
            el: window.__njg_el__,
            // customizations of netjsongraph.js
            linkClassProperty: "status",
            defaultStyle: false,
            labelDy: "-1.4em",
            circleRadius: 8,
            charge: -100,
            gravity: 0.3,
            linkDistance: 100,
            linkStrength: 0.2,
        });
    };
    window.graph = window.loadNetJsonGraph();
    window.initTopologyHistory(jQuery);
</script>

扩展模型

本示例提供了一个如何扩展 django-netjsongraph 基础模型的例子。

# models.py of your custom ``network`` app
from django.db import models

from django_netjsongraph.base.link import AbstractLink
from django_netjsongraph.base.node import AbstractNode
from django_netjsongraph.base.snapshot import AbstractSnapshot
from django_netjsongraph.base.topology import AbstractTopology
# the model ``organizations.Organization`` is omitted for brevity
# if you are curious to see a real implementation, check out django-organizations
# https://github.com/bennylope/django-organizations

class OrganizationMixin(models.Model):
    organization = models.ForeignKey('organization.Organization')

    class Meta:
        abstract = True


class Topology(OrganizationMixin, AbstractTopology):
    def clean(self):
        # your own validation logic here
        pass

    class Meta(AbstractTopology.Meta):
        abstract = False


class Node(AbstractNode):
    topology = models.ForeignKey('Topology')

    class Meta:
        abstract = False


class Link(AbstractLink):
    topology = models.ForeignKey('Topology')
    source = models.ForeignKey('Node',
                               related_name='source_link_set')
    target = models.ForeignKey('Node',
                               related_name='source_target_set')

    class Meta:
        abstract = False

class Snapshot(OrgMixin, AbstractSnapshot):
    topology = models.ForeignKey('topology.Topology', on_delete=models.CASCADE)

    class Meta(AbstractSnapshot.Meta):
        abstract = False

扩展管理界面

按照上述示例，您可以通过导入基本管理类并使用 register 方法注册您的模型来避免重复 admin 代码。

# admin.py of your app
from django.contrib import admin
from django_netjsongraph.base.admin import (AbstractLinkAdmin,
                                            AbstractNodeAdmin,
                                            AbstractTopologyAdmin)
# these are you custom models
from .models import Link, Node, Topology


class TopologyAdmin(AbstractTopologyAdmin):
    model = Topology


class NodeAdmin(AbstractNodeAdmin):
    model = Node


class LinkAdmin(AbstractLinkAdmin):
    model = Link


admin.site.register(Link, LinkAdmin)
admin.site.register(Node, NodeAdmin)
admin.site.register(Topology, TopologyAdmin)

扩展 API 视图

如果您的用例与基本用例差异不大，您可能还希望尝试重用 API 视图

# your app.api.views
from ..models import Snapshot, Topology
from django_netjsongraph.api.generics import (BaseNetworkCollectionView, BaseNetworkGraphHistoryView,
                                              BaseNetworkGraphView, BaseReceiveTopologyView)


class NetworkCollectionView(BaseNetworkCollectionView):
    queryset = Topology.objects.filter(published=True)


class NetworkGraphView(BaseNetworkGraphView):
    queryset = Topology.objects.filter(published=True)


class ReceiveTopologyView(BaseReceiveTopologyView):
    model = Topology


class NetworkGraphHistoryView(BaseNetworkGraphHistoryView):
    topology_model = Topology
    snapshot_model = Snapshot

network_collection = NetworkCollectionView.as_view()
network_graph = NetworkGraphView.as_view()
network_graph_history = NetworkGraphHistoryView.as_view()
receive_topology = ReceiveTopologyView.as_view()

API URL

如果您对 API 视图没有进行重大更改，您可以通过使用 get_api_urls 函数来避免重复 URL 逻辑。将此放在您的 api urls.py 中

# your app.api.urls
from django_netjsongraph.utils import get_api_urls
from . import views

urlpatterns = get_api_urls(views)

扩展可视化视图

如果您的用例与基本用例差异不大，您可能还希望尝试重用 Visualizer 视图

# your app.visualizer.views
from ..models import Topology
from .generics import BaseTopologyDetailView, BaseTopologyListView


class TopologyListView(BaseTopologyListView):
    topology_model = Topology


class TopologyDetailView(BaseTopologyDetailView):
    topology_model = Topology


topology_list = TopologyListView.as_view()
topology_detail = TopologyDetailView.as_view()

可视化 URL

如果您对 visualizer 视图没有进行任何重大更改，您可以通过使用 get_visualizer_urls 函数来避免重复 URL 逻辑。将此放在您的 visualizer urls.py 中

# your app.visualizer.urls
from django_netjsongraph.utils import get_visualizer_urls
from . import views

urlpatterns = get_visualizer_urls(views)

扩展 AppConfig

您还可能想重用 django-netjsongraph 的 AppConfig 类

from django_netjsongraph.apps import DjangoNetjsongraphConfig

class MyOwnConfig(DjangoNetjsongraphConfig):
    name = 'yourapp'
    label = 'yourapp'