Invert logic of dropping source labels.

Merge the if_mib example modules into one. Use only the mibs we download. Signed-off-by: Brian Brazil <[email protected]>
prometheus · Feb 5, 2019 · 94e3002 · 94e3002
1 parent bafb43b
commit 94e3002
Show file tree

Hide file tree

Showing 7 changed files with 431 additions and 1,980 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -50,7 +50,7 @@ jobs:
       working_dir: ~/project/generator
 
     environment:
-      MIBDIRS: mibs:/usr/share/snmp/mibs
+      MIBDIRS: mibs
     steps:
     - checkout:
         path: ~/project

diff --git a/generator/README.md b/generator/README.md
@@ -94,8 +94,8 @@ modules:
       # with that value.
       - source_indexes: [bsnDot11EssIndex]
         lookup: bsnDot11EssSsid
-        keep_source_indexes: false  # If true, don't delete source index labels for this lookup.
-                                    # This is useful when the new index has duplicates.
+        drop_source_indexes: false  # If true, delete source index labels for this lookup.
+                                    # This avoids label clutter when the new index is unique.
 
      overrides: # Allows for per-module overrides of bits of MIBs
        metricName:

diff --git a/generator/config.go b/generator/config.go
@@ -55,5 +55,5 @@ type ModuleConfig struct {
 type Lookup struct {
 	SourceIndexes     []string `yaml:"source_indexes"`
 	Lookup            string   `yaml:"lookup"`
-	KeepSourceIndexes bool     `yaml:"keep_source_indexes,omitempty"`
+	DropSourceIndexes bool     `yaml:"drop_source_indexes,omitempty"`
 }
diff --git a/generator/generator.yml b/generator/generator.yml
@@ -2,22 +2,11 @@ modules:
   # Default IF-MIB interfaces table with ifIndex.
   if_mib:
     walk: [sysUpTime, interfaces, ifXTable]
-  # Interfaces if ifAlias is unique.
-  if_mib_ifalias:
-    walk: [sysUpTime, interfaces, ifXTable]
     lookups:
       - source_indexes: [ifIndex]
         lookup: ifAlias
-  # Interfaces if ifDescr is unique.
-  if_mib_ifdescr:
-    walk: [sysUpTime, interfaces, ifXTable]
-    lookups:
       - source_indexes: [ifIndex]
         lookup: ifDescr
-  # Interfaces if ifName is unique.
-  if_mib_ifname:
-    walk: [sysUpTime, interfaces, ifXTable]
-    lookups:
       - source_indexes: [ifIndex]
         # Use OID to avoid conflict with Netscaler NS-ROOT-MIB.
         lookup: 1.3.6.1.2.1.31.1.1.1.1 # ifName
@@ -37,8 +26,10 @@ modules:
     lookups:
       - source_indexes: [bsnDot11EssIndex]
         lookup: bsnDot11EssSsid
+        drop_source_indexes: true
       - source_indexes: [bsnAPDot3MacAddress]
         lookup: bsnAPName
+        drop_source_indexes: true
 
 # APC/Schneider UPS Network Management Cards
 #
@@ -70,8 +61,10 @@ modules:
     lookups:
       - source_indexes: [upsOutletGroupStatusIndex]
         lookup: upsOutletGroupStatusName
+        drop_source_indexes: true
       - source_indexes: [iemStatusProbeIndex]
         lookup: iemStatusProbeName
+        drop_source_indexes: true
 
 # ServerTech Sentry 3 MIB
 #
@@ -161,21 +154,29 @@ modules:
     lookups:
       - source_indexes: [spaceIOIndex]
         lookup: spaceIODevice
+        drop_source_indexes: true
       - source_indexes: [storageIOIndex]
         lookup: storageIODevice
+        drop_source_indexes: true
       - source_indexes: [serviceInfoIndex]
         lookup: serviceName
+        drop_source_indexes: true
       - source_indexes: [ifIndex]
         # Use OID to avoid conflict with Netscaler NS-ROOT-MIB.
         lookup: 1.3.6.1.2.1.31.1.1.1.1 # ifName
+        drop_source_indexes: true
       - source_indexes: [diskIndex]
         lookup: diskID
+        drop_source_indexes: true
       - source_indexes: [raidIndex]
         lookup: raidName
+        drop_source_indexes: true
       - source_indexes: [laIndex]
         lookup: laNames
+        drop_source_indexes: true
       - source_indexes: [hrStorageIndex]
         lookup: hrStorageDescr
+        drop_source_indexes: true
 
 # DD-WRT
 #
@@ -197,8 +198,10 @@ modules:
     lookups:
     - source_indexes: [ifIndex]
       lookup: ifDescr
+      drop_source_indexes: true
     - source_indexes: [laIndex]
       lookup: laNames
+      drop_source_indexes: true
 
 # Ubiquiti / AirMAX
 #

diff --git a/generator/tree.go b/generator/tree.go
@@ -407,7 +407,7 @@ func generateConfigModule(cfg *ModuleConfig, node *Node, nameToNode map[string]*
 				} else {
 					needToWalk[indexNode.Oid] = struct{}{}
 				}
-				if !lookup.KeepSourceIndexes {
+				if lookup.DropSourceIndexes {
 					// Avoid leaving the old labelname around.
 					toDelete = append(toDelete, lookup.SourceIndexes...)
 				}

diff --git a/generator/tree_test.go b/generator/tree_test.go
@@ -955,9 +955,8 @@ func TestGenerateConfigModule(t *testing.T) {
 				Walk: []string{"octetFoo"},
 				Lookups: []*Lookup{
 					{
-						SourceIndexes:     []string{"octetIndex"},
-						Lookup:            "octetDesc",
-						KeepSourceIndexes: true,
+						SourceIndexes: []string{"octetIndex"},
+						Lookup:        "octetDesc",
 					},
 				},
 			},
@@ -1003,8 +1002,9 @@ func TestGenerateConfigModule(t *testing.T) {
 				Walk: []string{"octetFoo"},
 				Lookups: []*Lookup{
 					{
-						SourceIndexes: []string{"octetIndex"},
-						Lookup:        "octetDesc",
+						SourceIndexes:     []string{"octetIndex"},
+						Lookup:            "octetDesc",
+						DropSourceIndexes: true,
 					},
 				},
 			},
@@ -1053,8 +1053,9 @@ func TestGenerateConfigModule(t *testing.T) {
 				Walk: []string{"octetFoo"},
 				Lookups: []*Lookup{
 					{
-						SourceIndexes: []string{"octetIndex"},
-						Lookup:        "1.1.1.2",
+						SourceIndexes:     []string{"octetIndex"},
+						Lookup:            "1.1.1.2",
+						DropSourceIndexes: true,
 					},
 				},
 			},
@@ -1104,8 +1105,9 @@ func TestGenerateConfigModule(t *testing.T) {
 				Walk: []string{"octetFoo"},
 				Lookups: []*Lookup{
 					{
-						SourceIndexes: []string{"octetIndex", "octetIndex2"},
-						Lookup:        "octetDesc",
+						SourceIndexes:     []string{"octetIndex", "octetIndex2"},
+						Lookup:            "octetDesc",
+						DropSourceIndexes: true,
 					},
 				},
 			},
@@ -1184,8 +1186,9 @@ func TestGenerateConfigModule(t *testing.T) {
 				Walk: []string{"octet^Foo"},
 				Lookups: []*Lookup{
 					{
-						SourceIndexes: []string{"octet&Index"},
-						Lookup:        "1.1.1.2",
+						SourceIndexes:     []string{"octet&Index"},
+						Lookup:            "1.1.1.2",
+						DropSourceIndexes: true,
 					},
 				},
 			},
@@ -1346,8 +1349,9 @@ func TestGenerateConfigModule(t *testing.T) {
 				Walk: []string{"1.1.1.2.100", "1.1.1.4.100", "1.1.1.2.200"},
 				Lookups: []*Lookup{
 					{
-						SourceIndexes: []string{"tableIndex"},
-						Lookup:        "tableDesc",
+						SourceIndexes:     []string{"tableIndex"},
+						Lookup:            "tableDesc",
+						DropSourceIndexes: true,
 					},
 				},
 			},
@@ -1419,8 +1423,9 @@ func TestGenerateConfigModule(t *testing.T) {
 				Walk: []string{"1.1.1.2.100", "1.1.1.3"},
 				Lookups: []*Lookup{
 					{
-						SourceIndexes: []string{"tableIndex"},
-						Lookup:        "tableDesc",
+						SourceIndexes:     []string{"tableIndex"},
+						Lookup:            "tableDesc",
+						DropSourceIndexes: true,
 					},
 				},
 			},