ZenPacks : 2NMS PrinterMIB : Comments

RE: 2NMS PrinterMIB

community@zenoss.org — Thu, 27 Oct 2011 08:02:35 GMT

Looks real good but modelling breaks down with our printers (2 tried so far - HP & Canon).

In investigating deeper by uncommenting the two debug lines in 'PrinterMap.py' (line 113 & 114) the following is output:

2011-10-27 16:24:13,482 WARNING zen.ZenModeler: Get Data= {}

2011-10-27 16:24:13,483 WARNING zen.ZenModeler: Table Data= {'prtMarkerSupplies': {'1': {'PrtMarkerSuppliesTypeTC': 3, 'prtMarkerSuppliesLevel': 2500, 'PrtMarkerSuppliesSupplyUnitTC': 13, 'prtMarkerSuppliesDescription': 'Canon Cartridge 323/323 II Black', 'prtMarkerSuppliesMaxCapacity': 2500}, '3': {'PrtMarkerSuppliesTypeTC': 3, 'prtMarkerSuppliesLevel': 1510, 'PrtMarkerSuppliesSupplyUnitTC': 13, 'prtMarkerSuppliesDescription': 'Canon Cartridge 323 Magenta', 'prtMarkerSuppliesMaxCapacity': 1510}, '2': {'PrtMarkerSuppliesTypeTC': 3, 'prtMarkerSuppliesLevel': 1510, 'PrtMarkerSuppliesSupplyUnitTC': 13, 'prtMarkerSuppliesDescription': 'Canon Cartridge 323 Yellow', 'prtMarkerSuppliesMaxCapacity': 1510}, '5': {'PrtMarkerSuppliesTypeTC': 4, 'prtMarkerSuppliesLevel': -3, 'PrtMarkerSuppliesSupplyUnitTC': 13, 'prtMarkerSuppliesDescription': 'Waste Toner', 'prtMarkerSuppliesMaxCapacity': 1700}, '4': {'PrtMarkerSuppliesTypeTC': 3, 'prtMarkerSuppliesLevel': 1510, 'PrtMarkerSuppliesSupplyUnitTC': 13, 'prtMarkerSuppliesDescription': 'Canon Cartridge 323 Cyan', 'prtMarkerSuppliesMaxCapacity': 1510}}, 'prtMarkerColorant': {'1': {'prtMarkerColorantValue': 'black', 'prtMarkerColorantIndex': 1}, '3': {'prtMarkerColorantValue': 'magenta', 'prtMarkerColorantIndex': 1}, '2': {'prtMarkerColorantValue': 'yellow', 'prtMarkerColorantIndex': 1}, '4': {'prtMarkerColorantValue': 'cyan', 'prtMarkerColorantIndex': 1}}}

2011-10-27 16:24:13,484 ERROR zen.ZenModeler: Problem while executing plugin TwoNMS.snmp.PrinterMap

2011-10-27 16:24:13,486 ERROR zen.ZenModeler: Traceback (most recent call last):

File "/usr/local/zenoss/zenoss/Products/DataCollector/zenmodeler.py", line 623, in processClient

datamaps = plugin.process(device, results, self.log)

File "/usr/local/zenoss/zenoss/ZenPacks/ZenPacks.TwoNMS.PrinterMIB-1.0-py2.6.egg/ZenPacks/TwoNMS/PrinterMIB/modeler/plugins/TwoNMS/snmp/PrinterMap.py", line 136, in process

omcolor = self.objectMap(colors[oid])

KeyError: '5'

The problem seems to stem from that "prtMarkerSupplies" is an array of size 5 listing values in the order of 1, 3, 2, 5, 4. These values are then used to parse the "prtMarkerColorant" array that only has 4 values. Natrually the array goes out of bounds when it tries to reference colors[5].

I am not a Python boy so cannot reliably suggest the fix to this, however it seems a simple IF statement should enable skipping any invalid entries for color.

eg.

for oid,data in supplies.iteritems():

omsupply = self.objectMap(data)

if oid <= colors.iteritems() then

omcolor = self.objectMap(colors[oid])

{process more color code if needed}

{next code}

I'm not sure the split should be for the end of the IF statement or even if this would break later code.

Is this resonable?

RE: 2NMS PrinterMIB

community@zenoss.org — Thu, 27 Oct 2011 12:32:32 GMT

HI,

I didn't realize there were printer supplies that don't have a color value.

Probably the best way to fix this is to add en eval and catch indexError statement. I need to look at the exact code, but it would be something like this:

for oid,data in supplies.iteritems():

omsupply = self.objectMap(data)

try:

omcolor = self.objectMap(colors[oid])

{process more color code if needed}

catch IndexError, e:

{do something, or ignore error}

{next code}

RE: 2NMS PrinterMIB

community@zenoss.org — Thu, 27 Oct 2011 13:06:20 GMT

Hi Maarten,

Yes the supplies in question would be things such as fuser, waste toner bin, paper transport, oil roll, and maybe others.

I'll try your code on the one line giving errors tomorrow and post results. Will post the full sub routine if further errors are beyond me.

Sent from my iPad

RE: 2NMS PrinterMIB

community@zenoss.org — Fri, 28 Oct 2011 01:53:14 GMT

I have had some success changing this code:

for oid,data in supplies.iteritems():

omsupply = self.objectMap(data)

omcolor = self.objectMap(colors[oid])

omsupply.id = self.prepId(omcolor.prtMarkerColorantValue)

omsupply.snmpindex = omcolor.prtMarkerColorantIndex

omsupply.prtMarkerColorantValue = omcolor.prtMarkerColorantValue

omsupply.prtMarkerColorantIndex = omcolor.prtMarkerColorantIndex

try:

omsupply.PrtMarkerSuppliesTypeTC = self.cartType[str(omsupply.PrtMarkerSuppliesTypeTC)]

omsupply.PrtMarkerSuppliesSupplyUnitTC = self.cartUnit[str(omsupply.PrtMarkerSuppliesSupplyUnitTC)]

omsupply.rgbColorCode = self.rgbColorCodes[omcolor.prtMarkerColorantValue]

except KeyError:

log.error("error occurred " )

omsupply.rgbColorCode = self.rgbColorCodes['unknown']

rm.append(omsupply)

to this:

for oid,data in supplies.iteritems():

omsupply = self.objectMap(data)

try:

omcolor = self.objectMap(colors[oid])

omsupply.id = self.prepId(omcolor.prtMarkerColorantValue)

omsupply.snmpindex = omcolor.prtMarkerColorantIndex

omsupply.prtMarkerColorantValue = omcolor.prtMarkerColorantValue

omsupply.prtMarkerColorantIndex = omcolor.prtMarkerColorantIndex

except KeyError:

omsupply.id = self.prepId(1)

omsupply.snmpindex = 1

omsupply.prtMarkerColorantValue = 'N/A'

omsupply.prtMarkerColorantIndex = 1

try:

omsupply.PrtMarkerSuppliesTypeTC = self.cartType[str(omsupply.PrtMarkerSuppliesTypeTC)]

omsupply.PrtMarkerSuppliesSupplyUnitTC = self.cartUnit[str(omsupply.PrtMarkerSuppliesSupplyUnitTC)]

omsupply.rgbColorCode = self.rgbColorCodes[omcolor.prtMarkerColorantValue]

except KeyError:

log.error("error occurred " )

omsupply.rgbColorCode = self.rgbColorCodes['unknown']

rm.append(omsupply)

The printers now model okay and the non-toner consumables are marked with a colorant of 'N/A'. I assigned other default values of '1' to id, snmpindex, prtMarkerColorantIndex, but I am unsure if this is correct or might cause other issues. Any feedback here?

RE: 2NMS PrinterMIB

community@zenoss.org — Fri, 28 Oct 2011 03:06:37 GMT

Another correction:

/usr/local/zenoss/zenoss/ZenPacks/ZenPacks.TwoNMS.PrinterMIB-1.0-py2.6.egg/ZenPacks/TwoNMS/PrinterMIB/reports/PrinterMIB/Inventory Report.rpt

Line 47 reads:

tableName,'inkused','Pct Ink Used')"/>

The logic is opposite as the values returned from snmp are ink remaining. So a quick fix for the UI is to change the line to:

tableName,'inkused','Pct Ink Rem')"/>

RE: 2NMS PrinterMIB

community@zenoss.org — Fri, 28 Oct 2011 03:57:13 GMT

Also considering the above logic, the Ink threshold needs to be changed to a minimum. Presently it is a 95% max threshold.

Suggest changing this to 2 thresholds:

1 - a 5% minimum as a warning

2 - a 0% minimum as an error (actual value should be something like .001)

RE: 2NMS PrinterMIB

community@zenoss.org — Fri, 28 Oct 2011 05:28:56 GMT

Thanks for your suggestions! I only had 1 printer to test with so if you see other things that need to be changed, let me know and I'll release an updated version.

RE: 2NMS PrinterMIB

community@zenoss.org — Fri, 28 Oct 2011 07:24:06 GMT

Ok, I believe I have it working. The only issue remaining is the Reports > PinterMIB > Printer Usage Graphs is not showing all printers. It is showing 4 supplies from the 1st printer modeled and only 1 out of 6 supplies from the 2nd printer modeled. All other printers are not showing. However, with 11 printers and each having multiple supplies, this graph report needs restructuring.

For everything else, the code above was semi-working but not mapping the toner values properly. Below is the fix in two locations within the PrinterMap.py code:

Line #31

- #'.3': 'prtMarkerSuppliesColorantIndex', # snmp index

+ '.3.1': 'prtMarkerSuppliesColorantIndex', # snmp index

From line 134 the FOR statement should read:

for oid,data in supplies.iteritems():

omsupply = self.objectMap(data)

try:

omcolor = self.objectMap(colors[oid])

omsupply.id = self.prepId(omcolor.prtMarkerColorantValue)

except KeyError: # colors[oid] is only valid for toner supplies

omsupply.id = self.cartType[str(omsupply.PrtMarkerSuppliesTypeTC)]

omcolor.prtMarkerColorantValue = 'other'

# Non-toner supplies have a ColorantIndex of 0 but we need the correct value for the snmpindex

if omsupply.prtMarkerSuppliesColorantIndex == 0:

omsupply.snmpindex = oid

else:

omsupply.snmpindex = omsupply.prtMarkerSuppliesColorantIndex

omsupply.prtMarkerColorantValue = omcolor.prtMarkerColorantValue

omsupply.prtMarkerColorantIndex = omsupply.prtMarkerSuppliesColorantIndex

try:

omsupply.PrtMarkerSuppliesTypeTC = self.cartType[str(omsupply.PrtMarkerSuppliesTypeTC)]

omsupply.PrtMarkerSuppliesSupplyUnitTC = self.cartUnit[str(omsupply.PrtMarkerSuppliesSupplyUnitTC)]

omsupply.rgbColorCode = self.rgbColorCodes[omcolor.prtMarkerColorantValue]

except KeyError:

log.error("error occurred " )

omsupply.rgbColorCode = self.rgbColorCodes['unknown']

# Uncomment next 2 lines for debugging when modeling

#log.info('-- SUPPLIES STORED --')

#log.info(omsupply)

rm.append(omsupply)

return rm

RE: 2NMS PrinterMIB

community@zenoss.org — Mon, 31 Oct 2011 07:50:21 GMT

It seems there is a problem with the above code as the model breaks after a number of hours and stops mapping the incoming values to the correct graphs/thresholds. I have made an update to the IF statement to map the oid to all colorant values for non-toner items.

Will let it run overnight to confirm issue is corrected.

RE: 2NMS PrinterMIB

community@zenoss.org — Tue, 01 Nov 2011 18:22:40 GMT

jaymunro, you could fork the PrinterMIB public code repository, toss in your edits, and toss a pull request back up to Maarten on github.

On https://github.com/zenoss/ZenPacks.TwoNMS.PrinterMIB click 'fork' button while logged in to github.
git clone git@github.com:jaymunro/ZenPacks.TwoNMS.PrinterMIB.git
Pull over edits you made / apply patch you made
Can use zenpack --link --install ZenPacks.TwoNMS.PrinterMIB to install in place and not copy to $ZENHOME/ZenPacks
git add -A; git status
git commit -m 'Fixed blah'
git push --tags origin master

This will allow others to see the new code in its entirety at your personal github space. Like http://github.com/jaymunro/ZenPacks.TwoNMS.PrinterMIB . If Maarten accepts, we can merge them over to the official location. I am promoting our new instructions for this at theZenPack Development Process doc.

RE: 2NMS PrinterMIB

community@zenoss.org — Wed, 02 Nov 2011 23:32:35 GMT

Thanks Nick. It is a good suggestion and is something new to me so will do my best.

I am still attempting to squash a bug where non-colorant supplies drop out of monitoring after a few hours and cause indexing on all the graphs and thresholds to get mixed up.

Will try the git fork once I clear this up or need more help.

RE: 2NMS PrinterMIB

community@zenoss.org — Fri, 04 Nov 2011 08:11:51 GMT

Ok, git done and pull request sent. Hope I did everything correctly.

RE: 2NMS PrinterMIB

community@zenoss.org — Fri, 04 Nov 2011 15:58:56 GMT

You did it perfectly! I have merged the changes, after reviewing them briefly, into the official repository.

If anyone wants to run on this latest code do following as zenoss user:

git clone git://github.com/zenoss/ZenPacks.TwoNMS.PrinterMIB.git

zenpack --link --install ZenPacks.TwoNMS.PrinterMIB

zopectl restart

Enjoy!

RE: 2NMS PrinterMIB

community@zenoss.org — Tue, 15 Nov 2011 22:15:41 GMT

Hi,

i'm trying to use it to check an Epson B-500DN.

I was able to install the zenpack on zenoss 3.2.1

i added a printer but if i try to open the graph section i have an error message:

-----------------------------------------------------------------------------------------------------------------------------------

The server reported the following error:

pythonThresholdException User-supplied Python expression ((0.05 * here.prtMarkerSuppliesMaxCapacity) if (here.prtMarkerSuppliesLevel >= 0) else -3) for minimum value caused error: ['InkUsage_prtMarkerSuppliesLevel']

The system has encountered an error. Please reload the page.

-----------------------------------------------------------------------------------------------------------------------------------

i'm trying it on zenoss 3.2.1 using centos 5.7 and a remote collector

thanks

Maurizio

RE: 2NMS PrinterMIB

community@zenoss.org — Wed, 16 Nov 2011 07:39:04 GMT

Hi Maurizio,

This is an error generated by one of the thresholds configured for the graphs, these thresholds were recently added by jaymunro - check his comment of October 28th.

The pack itself was only tested by mysefl for HP Laserjet printers so it's possible that your printer doesn't support all the OIDs of the default printer MIB. Maybe do an snmpwalk on your printer and check that you get some values for this part of the snmp tree : .1.3.6.1.2.1.43.11.1.1. The exact OIDs which are used by the pack can be found in the modeler file PrinterMap.py.

Alternatively you can just try and remove the thresholds for the graphs and see if that works.

Maarten

RE: 2NMS PrinterMIB

community@zenoss.org — Wed, 16 Nov 2011 07:39:28 GMT

Jay, thanks for your updates by the way!

RE: 2NMS PrinterMIB

community@zenoss.org — Wed, 16 Nov 2011 08:55:30 GMT

Hi Maurizo,

I was getting such errors or similar when I had some syntax errors in the min val expression, but I suspect the cause is that I changed the source code by hand rather than export from zenoss.

In the next few days, I will try snapshotting my machine and then remove the pack and add from git to see if I get the same as you. If so, I'll sort out a fix.

In the meantime, you can remove the offending threshold at Advanced > Monitoring Templates > Printer Supply > /Printer/PrinterMIB

If that fixes it for you and the other threshold works, then it's probably a simple typo from me.

RE: 2NMS PrinterMIB

community@zenoss.org — Mon, 21 Nov 2011 09:08:30 GMT

Removed , reinstalled and restarted services.

Now everything is working really fine.

thanks

Maurizio

________________________

Hi all,

i tried to remove the thresholds but without any luck.

also checked the device with anmpwalk from the command line :

snmpwalk -v 1 -c public 192.168.0.101 .1.3.6.1.2.1.43.11.1.1

SNMPv2-SMI::mib-2.43.11.1.1.2.1.1 = INTEGER: 1

SNMPv2-SMI::mib-2.43.11.1.1.2.1.2 = INTEGER: 1

SNMPv2-SMI::mib-2.43.11.1.1.2.1.3 = INTEGER: 1

SNMPv2-SMI::mib-2.43.11.1.1.2.1.4 = INTEGER: 1

SNMPv2-SMI::mib-2.43.11.1.1.2.1.5 = INTEGER: 1

SNMPv2-SMI::mib-2.43.11.1.1.3.1.1 = INTEGER: 1

SNMPv2-SMI::mib-2.43.11.1.1.3.1.2 = INTEGER: 2

SNMPv2-SMI::mib-2.43.11.1.1.3.1.3 = INTEGER: 3

SNMPv2-SMI::mib-2.43.11.1.1.3.1.4 = INTEGER: 4

SNMPv2-SMI::mib-2.43.11.1.1.3.1.5 = INTEGER: 0

SNMPv2-SMI::mib-2.43.11.1.1.4.1.1 = INTEGER: 3

SNMPv2-SMI::mib-2.43.11.1.1.4.1.2 = INTEGER: 3

SNMPv2-SMI::mib-2.43.11.1.1.4.1.3 = INTEGER: 3

SNMPv2-SMI::mib-2.43.11.1.1.4.1.4 = INTEGER: 3

SNMPv2-SMI::mib-2.43.11.1.1.4.1.5 = INTEGER: 4

SNMPv2-SMI::mib-2.43.11.1.1.5.1.1 = INTEGER: 6

SNMPv2-SMI::mib-2.43.11.1.1.5.1.2 = INTEGER: 6

SNMPv2-SMI::mib-2.43.11.1.1.5.1.3 = INTEGER: 6

SNMPv2-SMI::mib-2.43.11.1.1.5.1.4 = INTEGER: 6

SNMPv2-SMI::mib-2.43.11.1.1.5.1.5 = INTEGER: 8

SNMPv2-SMI::mib-2.43.11.1.1.6.1.1 = STRING: "Black Ink Cartridge T6181/T6171/T6161"

SNMPv2-SMI::mib-2.43.11.1.1.6.1.2 = STRING: "Cyan Ink Cartridge T6172/T6162"

SNMPv2-SMI::mib-2.43.11.1.1.6.1.3 = STRING: "Magenta Ink Cartridge T6173/T6163"

SNMPv2-SMI::mib-2.43.11.1.1.6.1.4 = STRING: "Yellow Ink Cartridge T6174/T6164"

SNMPv2-SMI::mib-2.43.11.1.1.6.1.5 = STRING: "Maintenance Cartridge T6190"

SNMPv2-SMI::mib-2.43.11.1.1.7.1.1 = INTEGER: 4

SNMPv2-SMI::mib-2.43.11.1.1.7.1.2 = INTEGER: 4

SNMPv2-SMI::mib-2.43.11.1.1.7.1.3 = INTEGER: 4

SNMPv2-SMI::mib-2.43.11.1.1.7.1.4 = INTEGER: 4

SNMPv2-SMI::mib-2.43.11.1.1.7.1.5 = INTEGER: 4

SNMPv2-SMI::mib-2.43.11.1.1.8.1.1 = INTEGER: 100

SNMPv2-SMI::mib-2.43.11.1.1.8.1.2 = INTEGER: 100

SNMPv2-SMI::mib-2.43.11.1.1.8.1.3 = INTEGER: 100

SNMPv2-SMI::mib-2.43.11.1.1.8.1.4 = INTEGER: 100

SNMPv2-SMI::mib-2.43.11.1.1.8.1.5 = INTEGER: 100

SNMPv2-SMI::mib-2.43.11.1.1.9.1.1 = INTEGER: 34

SNMPv2-SMI::mib-2.43.11.1.1.9.1.2 = INTEGER: 10

SNMPv2-SMI::mib-2.43.11.1.1.9.1.3 = INTEGER: 61

SNMPv2-SMI::mib-2.43.11.1.1.9.1.4 = INTEGER: 86

SNMPv2-SMI::mib-2.43.11.1.1.9.1.5 = INTEGER: 17

i will try removing and reinstalling the zenpack .

Maurizio

---------------------------------------------------------------------------------

after removing the zenpack and reinstalling it, i found a new error :

2011-11-21 11:43:57,445 ERROR zen.ZenDisc: Problem while executing plugin TwoNMS.snmp.PrinterMap

2011-11-21 11:43:57,446 ERROR zen.ZenDisc: Traceback (most recent call last):

File "/opt/zenoss/Products/DataCollector/zenmodeler.py", line 623, in processClient

datamaps = plugin.process(device, results, self.log)

File "/opt/zenoss/ZenPacks/ZenPacks.TwoNMS.PrinterMIB-1.0-py2.6.egg/ZenPacks/TwoNMS/PrinterMIB/modeler/plugins/TwoNMS/snmp/PrinterMap.py", line 136, in process

omcolor = self.objectMap(colors[oid])

KeyError: '5'

2011-11-21 11:43:58,347 INFO zen.ZenDisc: Changes in configuration applied

RE: 2NMS PrinterMIB

community@zenoss.org — Mon, 12 Mar 2012 20:34:29 GMT

Not sure if I set everything up right... When I add a printer and make sure that its device class is /printer/printermib, the /printermib component never shows up under the device details. Is this because it only supports HP printers? Also, is there a specific version of the mib that needs to be installed? Right now I'm using Printer-Mib created by Harry Lewis IBM, language SMIv2.

Sorry if these are dumb questions, I'm new to snmp and zenoss...

RE: 2NMS PrinterMIB

community@zenoss.org — Fri, 15 Feb 2013 00:33:56 GMT

Gents,

I seem to be having an issue downloading the egg.zip file and uploading it to my zenoss core instance.. (latest version vmware workstation image - converted to ESXi).

The functionality this ZenPack should provide is very much desired; but as i'm having installation problems, I need a little guidence.

RE: 2NMS PrinterMIB

community@zenoss.org — Fri, 12 Apr 2013 10:39:16 GMT

I've got another issue.. blocked by allow-hosts...

[zenoss@localhost zenoss]$ zenpack --install ZenPacks.TwoNMS.PrinterMIB-1.0-py2.6.egg

Link to http://pypi.python.org/simple/ZenPacks.TwoNMS.PrinterMIB/ ***BLOCKED*** by --allow-hosts

Couldn't find index page for 'ZenPacks.TwoNMS.PrinterMIB' (maybe misspelled?)

Link to http://pypi.python.org/simple/ ***BLOCKED*** by --allow-hosts

No local packages or download links found for ZenPacks.TwoNMS.PrinterMIB==1.0

RE: 2NMS PrinterMIB

community@zenoss.org — Sun, 19 May 2013 20:49:58 GMT

Hi Simon,

Are you still having the same issue with this? What version of Zenoss are you using?

Can you try adding more debug info by running "zenpack --install ZenPacks.TwoNMS.PrinterMIB-1.0-py2.6.egg -v 10"

regards

Maarten

RE: 2NMS PrinterMIB

community@zenoss.org — Mon, 20 May 2013 13:59:22 GMT

Hello,

After some assistance from one of your coleagues.. I got this working..

http://community.zenoss.org/message/73211#73211

Massive thank you for checking back with me.

Love this zenpack!

RE: 2NMS PrinterMIB

community@zenoss.org — Thu, 30 May 2013 10:06:15 GMT

Tried this ZenPack with a Xerox ColorQube 8570 printer. I noticed that during modeling the message "Non-colorant supply logged" was logged for all supply components.

Investigation showed that this was caused by two problems, one in the unit values returned from the printer and one in handling the color values in the modeler:

1. For PrtMarkerSuppliesSupplyUnitTC the printer returned a value of '19' which is not a key in the 'cartUnit' map. However RFC3805 (printer mib v2) states that 19 is valid value to indicate that percentage is returned. I added the following lines to the 'cartUnit' map in the ./modeler/plugins/TwoNMS/snmp/PrinterMap.py file:
------------------------------------------------------------
'18': 'items',
'19': 'percent'
------------------------------------------------------------

2. The prtMarkerColorantValue returned by the printer starts with a capital character. As the keys in the the 'rgbColorCodes' map are all lowercase this did not work. A possible solution is to convert the returned value to lowercase before the lookup in the table. To do so I changed this line (note the .lower() method):
------------------------------------------------------------
omsupply.rgbColorCode = self.rgbColorCodes[omcolor.prtMarkerColorantValue.lower()]
------------------------------------------------------------

Now all is working fine for this printer. Nice colored graphs!

Maybe these changes can be used in the next version of this ZenPack