Archived community.zenoss.org | full text search
Skip navigation
Up to Discussions in zenoss-dev
1 2 3 ... 8 Previous Next 449971 Views 107 Replies Latest reply: Oct 23, 2012 10:56 PM by Gowrish SS RSS
rians Rank: White Belt
rians
52 posts since
Jun 23, 2009
Currently Being Moderated

Nov 16, 2009 1:23 PM

Help with Custom Map Zenpack

I have been working on a zenpack that will allow a user to create arbitrary custom maps somewhat in the style of zabbix. Some of the features I have been aiming for:
  • Maps can have arbitrary images as backgrounds.
  • Maps can contain devices or submaps
  • ZenPack contains drag and drop editor
  • Nodes images can be set to user icons, and their labels can be positioned on any side of the icon, or ommitted entirely
  • Portlet allows you to navigate through the maps, and updates itself
  • A map's status is dependant on the status of any nodes or submaps on it.
  • Edges can be plain lines, or arrows showing the amount of bandwidth on the interface they represent

 

The actual implementation of the portlet and the map editor is fairly solid right now. We are currently monitoring about 1800 devices, most of which have placed into these hand-drawn maps. The individual maps load very quickly, and the portlet updates the map image seamlessly every 30 seconds.

 

I am not very familiar with zope, and the more I try to learn, the less it makes sense to me. There are a number of issues I am trying to solve that I would love some help with:

  • The map editor is implemented as a tab in the Locations section. Each Location has a custom_map property that contains all the information needed to draw a map. I seem unable to make the tab show up consistently though. When I set a recursive function to add it to all the Location objects, it works on some and not the others.
  • I would like to find a way to make the tab show up for new Locations as well. I have tried monkey patching the base Location as well as the class it derives from, but neither seems to work.
  • The map drawing code relies on PIL. There is a namespace conflict between one of the PIL modules (ImageFile) and zenoss. I had to modify PIL slightly to avoid the conflict. Is there some way I can include this with the zenpack? Or is there some other api I should be using to draw the images.
Tags: zenpack, custommap
  • Shane Scott ZenossMaster
    Shane Scott
    1,373 posts since
    Jul 6, 2009
    Currently Being Moderated
    1. Nov 16, 2009 3:38 PM (in response to rians)
    Re: Help with Custom Map Zenpack

    rians:

     

    The work sounds interesting. Is it possible for you to post the source?

  • rians Rank: White Belt
    rians
    52 posts since
    Jun 23, 2009
    Currently Being Moderated
    2. Nov 16, 2009 4:54 PM (in response to Shane Scott)
    Re: Help with Custom Map Zenpack
    Not so sure it will work as an egg yet. Here is a tarball of the zenpack directory
    Attachments:
  • Shane Scott ZenossMaster
    Shane Scott
    1,373 posts since
    Jul 6, 2009
    Currently Being Moderated
    3. Nov 23, 2009 3:04 PM (in response to rians)
    Re: Help with Custom Map Zenpack

    Rians:

     

    I'm making progrress, but would it be possible to post the source of .CustomMap.py.swo? There is some static pathing fopr /usr/local/zenoss... that will break the pack.

     

    Thanks!

  • Shane Scott ZenossMaster
    Shane Scott
    1,373 posts since
    Jul 6, 2009
    Currently Being Moderated
    4. Nov 23, 2009 3:09 PM (in response to Shane Scott)
    Re: Help with Custom Map Zenpack

    Rians:

     

    Acctually, what is the file?

  • rians Rank: White Belt
    rians
    52 posts since
    Jun 23, 2009
    Currently Being Moderated
    5. Nov 24, 2009 6:25 PM (in response to Shane Scott)
    Re: Help with Custom Map Zenpack
    thats just a vim swap file. I have no idea why there would be a reference to it anywhere.
  • Matt Ray Rank: Zen Master
    Matt Ray
    2,484 posts since
    Apr 5, 2008
    Currently Being Moderated
    6. Dec 4, 2009 3:29 PM (in response to rians)
    Re: Help with Custom Map Zenpack

    Feel free to email me when you're getting closer to having a ZenPack ready to post, or if you need some assistance.  I may be able to help you if you run into any blockers.

     

    Thanks,

    Matt Ray

    Zenoss Community Manager

  • mf2ng Newbie
    mf2ng
    4 posts since
    Oct 22, 2009
    Currently Being Moderated
    7. Dec 9, 2009 3:31 AM (in response to rians)
    Re: Help with Custom Map Zenpack

    Hi,

     

    I would be interested to help as an tester if You like.

  • rians Rank: White Belt
    rians
    52 posts since
    Jun 23, 2009
    Currently Being Moderated
    8. Dec 9, 2009 10:00 AM (in response to mf2ng)
    Re: Help with Custom Map Zenpack

    The code is posted above. The best way to make use of it is probably to create a zenpack called ZenPacks.USU.Map, unzip the tarball into it, and restart zope by executing zopectl restart. Currently, the most broken bits of my code are the ones that set everything up (in the __init__.py). You should be able to create the initial custom map tab by doing the following in zendmd:

     

    from ZenPacks.USU.Map import CustomMap

    dmd.Locations.custom_map = CustomMap.CustomMapObject(dmd.Locations)

    dmd.Locations.custom_map._registerCustomMapTab()

    commit()

     

    This should make it so that if you go to the Locations section, the root location should have an extra tab called Custom Map. From there you should be able to draw an arbitrary map.

     

    For some reason, the _registerCustomMapTab() function doesn't always work. You may need to restart zendmd and try it a couple of times.

  • mf2ng Newbie
    mf2ng
    4 posts since
    Oct 22, 2009
    Currently Being Moderated
    9. Dec 10, 2009 3:37 AM (in response to rians)
    Re: Help with Custom Map Zenpack

    Hi Rians and thanks for reply,

     

    I managed to install your code attached to thread yesterday after minor annoyances, but that _registerCustomMapTab() -function truly gave (and gives) me some headache

    On the whole code seems to work, but still I would like to ask some features and clarifications:

     

    - I was not able to figure any other way inserting an background image than creating/uploading an image (for example an floorplan) type of object directly to ZODB via Zope manage. Is there any better way to do this?

     

    - Would it be possible that custom maps could (optionally?) be seen as portlet at the locations status tab?

     

    - Automatically scaling background image (which is linked to full size map-page or submap) wouldn't hurt in that statuspage portlet.

     

    - Should "add link" button do something else than lightly change the backgroundcolor of the browser?

     

    - Adding objects confuses me, I have built my location hierarchy by the scheme "Locations/City/Factory/Server or network rack" and when I added Factory A floorplan map to level "Factory" I thought that it would be possible to add the server rooms / network racks as an sublocations/submaps, but it seems that it is not working that way because I can't see any other available nodes than "factory" level?

     

    - Could the previous problem be caused by error below what I get when I try to run dmd.Locations.custom_map = CustomMap.CustomMapObject(dmd.Locations.City.Factory.network.rack) at zendmd:

     

         >>> dmd.Locations.custom_map = CustomMap.CustomMapObject(dmd.Locations.City.Factory.81.6)
      File "<console>", line 1
        dmd.Locations.custom_map = CustomMap.CustomMapObject(dmd.Locations.City.Factory.81.6)

     

    (the name of the "outer" location is "81.6")

     

    - And referring to previous, is your code able to handle the location names that have an dot? I have lots of those because of networking racks and it seems that it's causing problems, which you probably noticed all ready... Just noticed this and dunno yet that if some escape char or equivalent input do the trick.

     

    Sorry my stupid questions, but my knowledge in www and python is marginal at most, but hey... Most of the other users are as stupid as I

  • mf2ng Newbie
    mf2ng
    4 posts since
    Oct 22, 2009
    Currently Being Moderated
    10. Dec 10, 2009 3:58 AM (in response to rians)
    Re: Help with Custom Map Zenpack

    Next thing that I noticed was that when I add map image to level /Locations/City1/FactoryA and then /Locations/City1/FactoryB, both of the factories shows same image, FactoryB.

     

    Any Idea why? Is this intented functionality?

  • rians Rank: White Belt
    rians
    52 posts since
    Jun 23, 2009
    Currently Being Moderated
    11. Dec 10, 2009 9:44 AM (in response to mf2ng)
    Re: Help with Custom Map Zenpack

    No problem. I'm glad somebody has taken an interest in this. It is always nice to have somebody else's eyes on the code.

     

    The _registerCustomMapTab() method is the biggest headache I've encountered thus far. Sometimes it works, sometimes it doesn't. If anybody can show me a better way to insert a tab into the Locations screen, please let me know.

     

    Uploading an image via zope manage, or by including the files in a zenpack are the only ways i know of to get map backgrounds into zope. If somebody knows how to upload files into zope interactively, please let me know.

     

    I'm not sure how to include a portlet under the status tab. I did create a portlet for the dashboard page, but, due to namespace conflicts, you will need a customized version of the python imaging library to use it. I have attached the version of PIL that i used. You should be able to install it by unzipping it, changing to the Imaging-1.1.6 directory, becoming the zenoss user, and running the python build script:

     

    sudo su zenoss

    tar -xzf Imaging-zope-1.1.6.tar.gz

    cd Imaging-1.1.6

    python setup.py build

    python setup.py install

    zopectl restart

     

    after that, you should be able to add the zenoss portlet to the dashboard page. One of the things I am working on is a way to include the Imaging library in a zenpack.

     

    I like the idea of scaling the background image, and it shouldn't be that hard to accomplish...

     

    Maybe the Add Link button needs a better name. It's not talking about html links. It's point is to specify a network link between two objects. If you click on it, and then drag the mouse from one object to another, it should draw a line to it. You can later specify properties of the line.

     

    It is possible to add child location objects, but then the child location objects need to be given a custom map object as well. Here is some code you can run in zendmd that should recursively add a blank custom_map attribute to every location:

     

    from ZenPacks.USU.Map import CustomMap
    def walkchildren(l):
        if not hasattr(l, "custom_map"):
            l.custom_map = CustomMap.CustomMapObject(l)
            l.custom_map._registerCustomMapTab()
            l.custom_map.create()
        for i in l.children():
            walkchildren(i)

     

    walkchildren(dmd.Locations)

     

    I have found that this code (which is in the zenpack __init__.py) seems to work to add the custom map object, but not always to add the custom_map tab. At this point, you go to the location you want and use its custom_map tab to edit the location specific map.

     

    One thing about zope that annoys me to no end is that if you create an attribute for an object, then its children have that attribute as well unless you override it. That would probably account for the bug you are seeing where two different locations appear to have the same map. The code I listed should assign a new unique custom map to every location.

     

    Please let me know how your experience goes. If anybody has any answers to any of the problems that I have listed, please feel free to chime in.

    Attachments:
  • rians Rank: White Belt
    rians
    52 posts since
    Jun 23, 2009
    Currently Being Moderated
    12. Dec 10, 2009 9:47 AM (in response to rians)
    Re: Help with Custom Map Zenpack
    One thing i forgot to mention about the edge drawing code for the Add Link button. It uses the canvas tag, so if you are using ie, you probably won't see the line being drawn. The portlet should still draw it though, since that drawing is handled by the python Imaging library.
  • Shane Scott ZenossMaster
    Shane Scott
    1,373 posts since
    Jul 6, 2009
    Currently Being Moderated
    13. Dec 10, 2009 2:45 PM (in response to mf2ng)
    Re: Help with Custom Map Zenpack

    mf2ng:

     

    Examples:

     

    For /Locations:

     

    from ZenPacks.USU.Map import CustomMap
    dmd.Locations.custom_map = CustomMap.CustomMapObject(dmd.Locations)
    dmd.Locations.custom_map._registerCustomMapTab()
    commit()

     

    For /Locations/SA40:

     

    from ZenPacks.USU.Map import CustomMap
    dmd.Locations.SA40.custom_map = CustomMap.CustomMapObject(dmd.Locations.SA40)
    dmd.Locations.SA40.custom_map._registerCustomMapTab()
    commit()

     

    For /Locations/SA40/Floor6:

     

    from ZenPacks.USU.Map import CustomMap
    dmd.Locations.SA40.Floor6.custom_map = CustomMap.CustomMapObject(dmd.Locations.SA40.Floor6)
    dmd.Locations.SA40.Floor6.custom_map._registerCustomMapTab()
    commit()

     

    Also, I have a working installable Egg if anyone wants it. I'm making some updates to the engine, IE doesnt like it at all. Wonderful in FF.

  • rians Rank: White Belt
    rians
    52 posts since
    Jun 23, 2009
    Currently Being Moderated
    14. Dec 10, 2009 3:04 PM (in response to Shane Scott)
    Re: Help with Custom Map Zenpack
    If you get it working in ie, please email the changes to me so that I can include it in my code.
1 2 3 ... 8 Previous Next

More Like This

  • Retrieving data ...

Legend

  • Correct Answers - 4 points
  • Helpful Answers - 2 points