OpenNMS

split snmp-graph.properties

Details

  • Type: Enhancement Enhancement
  • Status: Resolved Resolved
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 1.1.2
  • Fix Version/s: 1.11.90
  • Component/s: Architecture
  • Security Level: Default (Default Security Scheme)
  • Labels:
    None
  • Environment:
    Operating System: All
    Platform: All
  • Bugzilla Id:
    763

Description

I suggest that some sort of "split" configuration be used to aid upgrades. By
this, I mean that some configuration files (snmp-graph.properties for example)
should check two locations - the "base" distributed file, and a second
"customised" file. Items in the second override the base file, if they
conflict. Otherwise the result is the union of those two files. This will not
work for all config files (the semantics aren't there), but for the ones it will
work on, it would significantly decrease the burden of upgrading. New
distributed files can be dropped into place over the old, and any customisations
will still exist without having to manually merge them together.
  1. Text File
    cvsdiff.txt
    27/Jan/06 5:50 PM
    10 kB
    Craig Miskell
  2. Text File
    datacollection-config.xml.patch
    14/Oct/05 10:23 AM
    1 kB
    wes hall

Issue Links

blocks

Bug - A problem which impairs or prevents the functions of the product. NMS-3517 Try to avoid upgrade conflicts with config file changes

  • Major - Major loss of function.
  • Open - The issue is open and ready for the assignee to start work on it.

Bug - A problem which impairs or prevents the functions of the product. NMS-2100 Tracking ticket for OpenNMS 1.8.0 (the "Fix Capsd" release)

  • Blocker - Blocks development and/or testing work, production could not run.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.
depends on

Bug - A problem which impairs or prevents the functions of the product. NMS-5652 missing datacollection definitions in snmp graphs

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Open - The issue is open and ready for the assignee to start work on it.
is duplicated by

Enhancement - An improvement or enhancement to an existing feature or task. NMS-992 Include files for all file in etc

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Resolved - A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.

Enhancement - An improvement or enhancement to an existing feature or task. NMS-5664 Splitting RRD graph definitions in dedicated files

  • Minor - Minor loss of function, or other problem where easy workaround is present.
  • Resolved - A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
wes hall added a comment -

Created an attachment (id=244)
Patch to allow local configuration of datacollection-config info

This requires an AASU (our college initials) be created and local file are
placed in the AASU directory. With minimal changes you could define a LOCAL
directory under etc for this info.

Show
wes hall added a comment - Created an attachment (id=244) Patch to allow local configuration of datacollection-config info This requires an AASU (our college initials) be created and local file are placed in the AASU directory. With minimal changes you could define a LOCAL directory under etc for this info.
Hide
Permalink
Craig Miskell added a comment -

I have a patch (attached shortly) to do this for snmp-graph.properties (and the
other graph.properties files that go through PrefabGraph). It checks for a
directory with the same name and .d suffix (c.f. /etc/cron.d etc), parses all
the .properties files within it, and merges their contents into the in-memory
graph configuration object. It currently handles two different scenarios:
1) The sub .properties file contains a "reports" property. In this, the
sub-file is considered to potentially contain multiple report definitions. the
"reports" property is merged into the main "reports" property, and all remaining
properties are copied into the main properties (in memory). This can be used to
implement new graphs, or even to override all or parts of existing graphs

2) The sub .properties file does not contain a "reports" property. In this
case, the file is considered to contain only one report. The base of the
filename is used to add an entry to the main "reports" property, and the
remaining properties in the sub-file are added to the main properties , with
names prepended with the calculated report name. Thus, one of these graph
definition files (say mygraph.properties) need only contain "name", "title",
"command", and "columns" properties (not mygraph.name, mygraph.title etc).

So, users can just leave the main snmp-graph.properties alone, add their
customisations and additions into the snmp-graph.properties.d subdirectory, and
then an upgrade will not touch their changes.

Show
Craig Miskell added a comment - I have a patch (attached shortly) to do this for snmp-graph.properties (and the other graph.properties files that go through PrefabGraph). It checks for a directory with the same name and .d suffix (c.f. /etc/cron.d etc), parses all the .properties files within it, and merges their contents into the in-memory graph configuration object. It currently handles two different scenarios: 1) The sub .properties file contains a "reports" property. In this, the sub-file is considered to potentially contain multiple report definitions. the "reports" property is merged into the main "reports" property, and all remaining properties are copied into the main properties (in memory). This can be used to implement new graphs, or even to override all or parts of existing graphs 2) The sub .properties file does not contain a "reports" property. In this case, the file is considered to contain only one report. The base of the filename is used to add an entry to the main "reports" property, and the remaining properties in the sub-file are added to the main properties , with names prepended with the calculated report name. Thus, one of these graph definition files (say mygraph.properties) need only contain "name", "title", "command", and "columns" properties (not mygraph.name, mygraph.title etc). So, users can just leave the main snmp-graph.properties alone, add their customisations and additions into the snmp-graph.properties.d subdirectory, and then an upgrade will not touch their changes.
Hide
Permalink
Craig Miskell added a comment -

Created an attachment (id=293)
Patch for snmp-graph.properties splitting

As per my comment

Show
Craig Miskell added a comment - Created an attachment (id=293) Patch for snmp-graph.properties splitting As per my comment
Hide
Permalink
Mike Huot added a comment -

Hey Craig! You are a comitter now, knock yourself out! :-P

Show
Mike Huot added a comment - Hey Craig! You are a comitter now, knock yourself out! :-P
Hide
Permalink
Tarus Balog added a comment -

Craig - does this work against trunk? If so, let me know and I'll test it.

Show
Tarus Balog added a comment - Craig - does this work against trunk? If so, let me know and I'll test it.
Hide
Permalink
Duncan Hill added a comment -

Is this patch live in the codebase? It'd make my life much easier if it is

Show
Duncan Hill added a comment - Is this patch live in the codebase? It'd make my life much easier if it is
Hide
Permalink
Seth Leger (community account) added a comment -

Alejandro was working on this for datacollection-config.xml for inclusion in 1.9. This code has already been merged there.

Show
Seth Leger (community account) added a comment - Alejandro was working on this for datacollection-config.xml for inclusion in 1.9. This code has already been merged there.
Benjamin Reed made changes -
Field Original Value New Value
issue.field.bugzillaimportkey 763 12002
Benjamin Reed made changes -
Workflow ScrumBan Stories [ 12102 ] jira [ 15597 ]
Benjamin Reed made changes -
Workflow jira [ 15597 ] jira-copy [ 16597 ]
Seth Leger made changes -
Affects Version/s 1.7.91 [ 10261 ]
Affects Version/s 1.1.2 [ 10200 ]
Fix Version/s 1.7.10 [ 10251 ]
Fix Version/s Future 1.9 [ 10291 ]
Assignee Alejandro Galue [ agalue@sync.com.ve ]
Seth Leger made changes -
Assignee Alejandro Galue [ agalue@sync.com.ve ]
Hide
Permalink
Jeff Gehlbach added a comment -

To clarify, the work that Alejandro has done in 1.9 / master (now also branched for 1.10) does not include the splitting of the properties-based graph definitions.

Show
Jeff Gehlbach added a comment - To clarify, the work that Alejandro has done in 1.9 / master (now also branched for 1.10) does not include the splitting of the properties-based graph definitions.
Hide
Permalink
Craig Miskell added a comment -

Commit 9cb527ca99f206013856e541d1bc7a33b32c57bf has been made to master branch to support the split configuration of snmp-graph.properties. The main properties file now accepts an "include.directory" property that defines a directory in which to look for individual .properties files. Each of those can be a single graph defined in a short format, or multiple graphs in the same format as the root file. See the default snmp-graph.properties file for details - the wiki will be updated soon.

Show
Craig Miskell added a comment - Commit 9cb527ca99f206013856e541d1bc7a33b32c57bf has been made to master branch to support the split configuration of snmp-graph.properties. The main properties file now accepts an "include.directory" property that defines a directory in which to look for individual .properties files. Each of those can be a single graph defined in a short format, or multiple graphs in the same format as the root file. See the default snmp-graph.properties file for details - the wiki will be updated soon.
Hide
Permalink
Craig Miskell added a comment -

Sorry, the actual commit was b9822cb3069bb343c9253c642b19aef58b232dd4. I have also just cherry-picked that into 1.10 as well.

Show
Craig Miskell added a comment - Sorry, the actual commit was b9822cb3069bb343c9253c642b19aef58b232dd4. I have also just cherry-picked that into 1.10 as well.
Seth Leger made changes -
Fix Version/s Future 1.9 [ 10291 ]
Fix Version/s 1.9.90 [ 10421 ]
Seth Leger made changes -
Link This issue is duplicated by NMS-992 [ NMS-992 ]
Benjamin Reed made changes -
Fix Version/s 1.9.90 [ 10421 ]
Fix Version/s 1.9.91 [ 10521 ]
Hide
Permalink
Matt Brozowski added a comment -

Is this issue resolved?

Show
Matt Brozowski added a comment - Is this issue resolved?
Matt Brozowski made changes -
Assignee Alejandro Galue [ agalue@sync.com.ve ] Craig Miskell [ cmiskell ]
Hide
Permalink
Matt Brozowski added a comment -

It looks like snmp-graph.properties is done...

We should break this file up for the different configurations rather than one bug that has them all

Show
Matt Brozowski added a comment - It looks like snmp-graph.properties is done... We should break this file up for the different configurations rather than one bug that has them all
Matt Brozowski made changes -
Assignee Craig Miskell [ cmiskell ]
Summary Split configuration for easier upgrades split snmp-graph.properties
Hide
Permalink
Alejandro Galue added a comment -

I did the work for datacollection-config.xml and Craig did the work for snmp-graph.properties

My work does not apply for jmx-datacollection-config.xml, http-datacollection-config.xml, nsclient-datacollection-config.xml, wmi-datacollection-config.xml, xmp-dtacollection-config.xml and jdbc-datacollection-config.xml

Craig's work (if I understood correctly) does not apply for response-graph.properties and/or *adhoc-graph.properties.

So, you could close it, and if someone require to apply something similar to the exceptions mentioned before, we could open new issues for them.

Show
Alejandro Galue added a comment - I did the work for datacollection-config.xml and Craig did the work for snmp-graph.properties My work does not apply for jmx-datacollection-config.xml, http-datacollection-config.xml, nsclient-datacollection-config.xml, wmi-datacollection-config.xml, xmp-dtacollection-config.xml and jdbc-datacollection-config.xml Craig's work (if I understood correctly) does not apply for response-graph.properties and/or *adhoc-graph.properties. So, you could close it, and if someone require to apply something similar to the exceptions mentioned before, we could open new issues for them.
Hide
Permalink
Matt Brozowski added a comment -

Sorry... I meant we should break this issue up into different bugs for different files we would like to break up.

Show
Matt Brozowski added a comment - Sorry... I meant we should break this issue up into different bugs for different files we would like to break up.
Benjamin Reed made changes -
Fix Version/s 1.9.91 [ 10521 ]
Fix Version/s 1.9.92 [ 10621 ]
Seth Leger made changes -
Link This issue blocks NMS-3517 [ NMS-3517 ]
Hide
Permalink
Alejandro Galue added a comment -

I'm completely agree with Matt on this.

Show
Alejandro Galue added a comment - I'm completely agree with Matt on this.
Seth Leger made changes -
Assignee Alejandro Galue [ agalue@sync.com.ve ]
Hide
Permalink
Seth Leger added a comment -

Deferring to 1.11, it is too late to put configuration file changes like this into the 1.10 release candidates.

Show
Seth Leger added a comment - Deferring to 1.11, it is too late to put configuration file changes like this into the 1.10 release candidates.
Seth Leger made changes -
Fix Version/s 1.9.92 [ 10621 ]
Fix Version/s 1.11.0 [ 10426 ]
Benjamin Reed made changes -
Fix Version/s 1.11.0 [ 10426 ]
Fix Version/s 1.11.1 [ 11123 ]
Benjamin Reed made changes -
Fix Version/s 1.11.1 [ 11123 ]
Fix Version/s 1.11.2 [ 11222 ]
Benjamin Reed made changes -
Fix Version/s 1.11.2 [ 11222 ]
Fix Version/s 1.11.3 [ 11323 ]
Benjamin Reed made changes -
Fix Version/s 1.11.3 [ 11323 ]
Fix Version/s 1.11.4 [ 11420 ]
Seth Leger made changes -
Link This issue is duplicated by NMS-5664 [ NMS-5664 ]
Hide
Permalink
Ronny Trommer added a comment -

Single commit in master with b7d0e084865fbeff805b8d928f5556ad270e7ff5

Tried to split as defensive as possible. Put reports=... entry in a single line to have the possibility to have a sanity check against report definitions.

Show
Ronny Trommer added a comment - Single commit in master with b7d0e084865fbeff805b8d928f5556ad270e7ff5 Tried to split as defensive as possible. Put reports=... entry in a single line to have the possibility to have a sanity check against report definitions.
Ronny Trommer made changes -
Resolution Fixed [ 1 ]
Status Open [ 1 ] Resolved [ 5 ]
Seth Leger made changes -
Link This issue depends on NMS-5652 [ NMS-5652 ]

People

  • Assignee:
    Alejandro Galue
    Reporter:
    Craig Miskell
Vote (7)
Watch (3)

Dates

  • Created:
    Updated:
    Resolved: