N0Ball
commented
1 week ago I have walked through the code and find out two possiblitiy location that might cause this bug.
at hyperglass/models/directive.py:317 validate_plugins function
316 @field_validator("plugins")
317 def validate_plugins(cls: "Directive", plugins: t.List[str]) -> t.List[str]:
318 """Validate and register configured plugins."""
319 plugin_dir = Settings.app_path / "plugins"
320
321 if plugin_dir.exists():
322 # Path objects whose file names match configured file names, should work
323 # whether or not file extension is specified.
324 matching_plugins = (
325 f
326 for f in plugin_dir.iterdir()
327 if f.name.split(".")[0] in (p.split(".")[0] for p in plugins)
328 )
329 return [str(f) for f in matching_plugins]
330 return []- I think that () should be [], or else the results are always an empty array
- According to
plugin_dir, I think that currently it only reads from the file/etc/hyperglass/plugins. Instead of any location provided by the derivatives.
Therefore, the current solution is to
- Change () from line 324 to line 328 to []
- Put your plugin files in plugins directory which is
/etc/hyperglass/plugins
WalkerD243
Deployment Type
Docker
Version
v2.0.4
Steps to Reproduce
Create directives.yaml: juniper-bgp-route: name: BGP Route Custom plugins:
field: description: 'Your IPv4 or IPv6 BGP Peer Address' validation: '[0-9a-f.\:\/]+'
Create plugin based on https://hyperglass.dev/plugins from ipaddress import ip_network from hyperglass.plugins import InputPlugin
class TransformCIDR(InputPlugin): def transform(self, query): (target := query.query_target) target_network = ip_network(target) if target_network.version == 4: return f"{target_network.network_address!s} {target_network.netmask!s}" return target
put the transform_plugin.py in /etc/hyperglass/plugins and /etc/hyperglass/custom_plugins folder
check that the container can see the plugins: docker container exec hyperglass-hyperglass-1 cat /etc/hyperglass/plugins/transform_plugin.py docker container exec hyperglass-hyperglass-1 cat /etc/hyperglass/custom_plugins/transform_plugin.py
enable debug mode like in https://hyperglass.dev/installation/environment-variables
enter the hyperglass site and enter "192.0.2.0/24" in the query as in https://hyperglass.dev/plugins example
observe the live output from the container and look at the line: hyperglass-1 | [DEBUG] 20241030 14:26:43 |129 | queries → Constructed query {'type': 'juniper-bgp-route', 'target': ['192.0.2.0/24'], 'constructed_query': ['show route protocol bgp table inet.0 192.0.2.0/24 detail | display json']}
look at the result in the webinterface, as it should transform 192.0.2.0/24 to 192.0.2.0 255.255.255.0 and the query is executed on a juniper device it should return a syntax error at the 255.255.255.0
Expected Behavior
I would expect that the constructed_query line form step 7. above would be: hyperglass-1 | [DEBUG] 20241030 14:26:43 |129 | queries → Constructed query {'type': 'juniper-bgp-route', 'target': ['192.0.2.0/24'], 'constructed_query': ['show route protocol bgp table inet.0 192.0.2.0 255.255.255.0 detail | display json']}
and the result in the webinterface should return a syntax error at the 255.255.255.0 as it is executed on a juniper device in my case
Observed Behavior
I get the line: hyperglass-1 | [DEBUG] 20241030 14:26:43 |129 | queries → Constructed query {'type': 'juniper-bgp-route', 'target': ['192.0.2.0/24'], 'constructed_query': ['show route protocol bgp table inet.0 192.0.2.0 255.255.255.0 detail | display json']}
and a normal result in the webinterface as if the query wasn't changed by the plugin
For me it seems like the plugin is not applied at all, even if change the last line in the plugin config to "return 'test'" the query is still successfull. I tried different folders in /etc/hyperglass and giving 777 full rights to the folder and files inside.
The same thing happens with the output plugins, please have a look. this is ssuch a great platform!
Configuration
Devices
Logs