I submitted a patch that was committed as r5817.  No real change has been made in the behavior -- it's just more robust (unit tests!).  Type and Description are still required.  Speed, Circuit, and Notes can optionally follow the Description in any order.
--
Cameron Moore


-----Original Message-----

From: observium [mailto:observium-bounces@observium.org] On Behalf Of Adam Armstrong
Sent: Friday, September 19, 2014 4:49 PM
To: Observium Network Observation System
Subject: Re: [Observium] Documentation

They probably have to be in the correct order, but I'm pretty sure we don't require anything beyond type and description.

It's like that because I suck at writing parser code. Someone who actually knows how to do this properly should feel free! :)

adam.


On 2014-09-19 22:25, Moore, Cameron wrote:
> I don't believe this is correct.  The only required fields are Type
> and Description.  Speed, Circuit, and Notes can optionally follow the
> Description in any order.
>
> If you are seeing otherwise, then it's probably a bug.
> --
> Cameron Moore
>
>
> -----Original Message-----
> From: observium [mailto:observium-bounces@observium.org] On Behalf Of
> Spencer Gaw
> Sent: Friday, September 19, 2014 3:39 PM
> To: Observium Network Observation System
> Subject: Re: [Observium] Documentation
>
> To my knowledge, all 5 fields must be present in order for the parser
> to work. I've always used the following template for descriptions and
> never had any issues (angle brackets mine):
>
> <type>: <description> [<speed>] (<note/vendor_circuit_ID>)
> {<internal_circuit_ID>}
>
> In cases where I didn't have a vendor/internal circuit ID yet, I would
> just use a hyphen or placeholder. Ex:
>
> Transit: Level 3 Upstream [10Gbit] (-) {-}
> Peering: Any2/RMIX [1Gbit] (VCID) {ICID}
>
> Hope this helps.
>
> Regards,
>
> SG
>
> On 9/19/2014 1:53 PM, Hamilton, Kent wrote:
> Good point, sorry.
>
> This one works (This is on a JunOS device).
> Transit: Fubar Communications [50Mbit] (ASXXXX/CKT_ID_1/CKT_ID_2)
> {LOCAL_ISP_ID} None of these do (Note These are on older Juniper
> ScreenOS devices with a short character limit on descriptions).
> Transit: AC [45Mbit] (ASXXXXX)
> Transit: SA Comm (ASxxxxx)
> Cust: Cust1, NY4
> Cust: MCust Frankfurt
>
> Nor do these from a IBM Rackswitch
> Server: moslXXXXXX1.example.com [10Gbit] (eth3/VLANxxx)
> Server: moslXXXXXX2.example.com (igb0/VLANxxx)
> Core: moxlXXXXsw02-core.example.com [40Gbit] (ge-0/0/0 thru 3) (That's
> on the aggregate interface)
>
> Feel free to tell me I'm an idiot and "Do it this way".
>
>
> -----Original Message-----
> From: observium [mailto:observium-bounces@observium.org] On Behalf Of
> Spencer Gaw
> Sent: Friday, September 19, 2014 2:34 PM
> To: Observium Network Observation System
> Subject: Re: [Observium] Documentation
>
> It would also be helpful if you posted sanitized examples of the
> descriptions you have configured.
>
> Regards,
>
> SG
>
> On 9/19/2014 1:06 PM, Hamilton, Kent wrote:
> Hmmm, without even having to write parsers for new groups, I can't get
> the built in ones to work correctly.
>
> Maybe when I have an hour or two, I'll investigate why, but currently
> out of about 30 ports I've tried setting these on, I have a total of
> 1 that actually shows up as a Transit, zero Core, zero Cust.
>
> *From:*observium [mailto:observium-bounces@observium.org] *On Behalf
> Of *Pedersen, Sean
> *Sent:* Friday, September 19, 2014 10:57 AM
> *To:* Observium Network Observation System
> *Subject:* Re: [Observium] Documentation
>
> Correct! It has to follow the exact format, and use the same keywords
> listed (http://www.observium.org/wiki/Interface_Description_Parsing)
> or the default parser will not pick them up. However! You can write
> your own parser, and point to it in config.php.
>
> $config['port_descr_parser'] = "includes/your_parser_here.inc.php";
>
> I used the default port-descr-parser.inc.php in includes/ as a base
> template and went from there.
>
> Then you'll want to build some custom menu options to link back to
> those new categories, and drop them in
> html/includes/navbar-custom.inc.php. Example:
>
> $navbar['ports']['entries'][] = array('divider' => TRUE);
>
> $navbar['ports']['entries'][] = array('url' =>
> generate_url(array('page' => 'iftype', 'type' => 'xxx')), 'image' =>
> "images/16/group_link.png", 'title' => 'xxx'); $ifbreak = 1;
>
> Replace 'xxx' with whatever your keyword is, Core, Server, etc.
>
> *From:* observium [mailto:observium-bounces@observium.org] *On Behalf
> Of *Hamilton, Kent
> *Sent:* Friday, September 19, 2014 7:21 AM
> *To:* Observium Network Observation System
> *Subject:* Re: [Observium] Documentation
>
> I was trying to use this feature but the parser for it seems a bit
> picky.
>
> The examples in the docs seem to say I can use:
>
> Type: SomeText
>
> Type: SomeText [Speed/Service Type]
>
> Type: SomeText [Speed/Service Type] (Notes)
>
> Type: SomeText [Speed/Service Type] (Notes) {Circuit ID}
>
> It appears that they have to be in exactly the latter format and
> exactly in that order or it doesn't work at all.  Can someone confirm
> the others are supposed to work?
>
> I'd like to use things like
>
> Core: switchname [40Gbit] (Interface)
>
> Server: hostname here (Interface/Subnet)
>
> And those don't appear to get picked up.
>
> *From:*observium [mailto:observium-bounces@observium.org] *On Behalf
> Of *Søren Irbo
> *Sent:* Wednesday, September 17, 2014 8:42 AM
> *To:* observium@observium.org <mailto:observium@observium.org>
> *Subject:* [Observium] Documentation
>
> Hi!
>
> Stumbled upon this feature, are there other nice features, which are
> not documented?
>
> http://jira.observium.org/browse/OBSERVIUM-299
>
> Can't find it here:
>
> http://www.observium.org/wiki/Configuration_Options#Custom_traffic_gr
> aphs
>
> /Søren
>
> ---------------------------------------------------------------------
> ---
>
>