fix(inputs.opcua_listener): Parse namespace prefixes and nested browse paths in event fields (#18586)

Author: skartikey

plugins/common/opcua/input/input_client.go

@@ -752,15 +752,50 @@ func (node *EventNodeMetricMapping) createSelectClauses() ([]*ua.SimpleAttribute
 		return nil, err
 	}
 	for i, name := range node.Fields {
+		browsePath, err := parseBrowsePath(name)
+		if err != nil {
+			return nil, fmt.Errorf("parsing field %q failed: %w", name, err)
+		}
 		selects[i] = &ua.SimpleAttributeOperand{
 			TypeDefinitionID: typeDefinition,
-			BrowsePath:       []*ua.QualifiedName{{NamespaceIndex: 0, Name: name}},
+			BrowsePath:       browsePath,
 			AttributeID:      ua.AttributeIDValue,
 		}
 	}
 	return selects, nil
 }
 
+// parseBrowsePath parses a field name into a browse path of qualified names.
+// It supports namespace-qualified segments (e.g. "2:TEXT01") and multi-segment
+// paths separated by "/" (e.g. "AckedState/Id" or "2:AckedState/0:Id").
+func parseBrowsePath(field string) ([]*ua.QualifiedName, error) {
+	segments := strings.Split(field, "/")
+	path := make([]*ua.QualifiedName, 0, len(segments))
+	for _, seg := range segments {
+		if seg == "" {
+			return nil, fmt.Errorf("empty segment in browse path %q", field)
+		}
+		ns, name := parseQualifiedName(seg)
+		path = append(path, &ua.QualifiedName{NamespaceIndex: ns, Name: name})
+	}
+	return path, nil
+}
+
+// parseQualifiedName parses a single segment like "2:TEXT01" into a namespace
+// index and name. If no namespace prefix is present, namespace 0 is used.
+func parseQualifiedName(segment string) (uint16, string) {
+	prefix, name, found := strings.Cut(segment, ":")
+	if !found {
+		return 0, segment
+	}
+	ns, err := strconv.ParseUint(prefix, 10, 16)
+	if err != nil {
+		// Not a valid namespace prefix, treat the whole segment as the name
+		return 0, segment
+	}
+	return uint16(ns), name
+}
+
 func (node *EventNodeMetricMapping) createWhereClauses() (*ua.ContentFilter, error) {
 	if len(node.SourceNames) == 0 {
 		return &ua.ContentFilter{

plugins/common/opcua/input/input_client_test.go

@@ -1427,3 +1427,124 @@ func TestEventGroupWithNodeIDString(t *testing.T) {
 	require.Equal(t, "ns=2;s=EventSource1", eventGroup.NodeIDSettings[0].NodeID())
 	require.Equal(t, "nsu=http://example.org/;i=200", eventGroup.NodeIDSettings[1].NodeID())
 }
+
+func TestParseBrowsePath(t *testing.T) {
+	tests := []struct {
+		name     string
+		field    string
+		expected []*ua.QualifiedName
+	}{
+		{
+			name:  "simple field",
+			field: "Severity",
+			expected: []*ua.QualifiedName{
+				{NamespaceIndex: 0, Name: "Severity"},
+			},
+		},
+		{
+			name:  "namespace qualified field",
+			field: "2:TEXT01",
+			expected: []*ua.QualifiedName{
+				{NamespaceIndex: 2, Name: "TEXT01"},
+			},
+		},
+		{
+			name:  "nested browse path",
+			field: "AckedState/Id",
+			expected: []*ua.QualifiedName{
+				{NamespaceIndex: 0, Name: "AckedState"},
+				{NamespaceIndex: 0, Name: "Id"},
+			},
+		},
+		{
+			name:  "namespace qualified nested path",
+			field: "2:AckedState/0:Id",
+			expected: []*ua.QualifiedName{
+				{NamespaceIndex: 2, Name: "AckedState"},
+				{NamespaceIndex: 0, Name: "Id"},
+			},
+		},
+		{
+			name:  "non-numeric prefix treated as name",
+			field: "abc:def",
+			expected: []*ua.QualifiedName{
+				{NamespaceIndex: 0, Name: "abc:def"},
+			},
+		},
+		{
+			name:  "namespace zero explicit",
+			field: "0:Message",
+			expected: []*ua.QualifiedName{
+				{NamespaceIndex: 0, Name: "Message"},
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result, err := parseBrowsePath(tt.field)
+			require.NoError(t, err)
+			require.Equal(t, tt.expected, result)
+		})
+	}
+}
+
+func TestParseBrowsePathError(t *testing.T) {
+	tests := []struct {
+		name    string
+		field   string
+		errText string
+	}{
+		{
+			name:    "empty string",
+			field:   "",
+			errText: "empty segment",
+		},
+		{
+			name:    "leading slash",
+			field:   "/Severity",
+			errText: "empty segment",
+		},
+		{
+			name:    "trailing slash",
+			field:   "Severity/",
+			errText: "empty segment",
+		},
+		{
+			name:    "double slash",
+			field:   "AckedState//Id",
+			errText: "empty segment",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_, err := parseBrowsePath(tt.field)
+			require.ErrorContains(t, err, tt.errText)
+		})
+	}
+}
+
+func TestCreateSelectClausesWithNamespacedFields(t *testing.T) {
+	node := &EventNodeMetricMapping{
+		EventTypeNode: ua.NewNumericNodeID(0, 2041),
+		Fields:        []string{"Severity", "2:TEXT01", "AckedState/Id"},
+	}
+
+	selects, err := node.createSelectClauses()
+	require.NoError(t, err)
+	require.Len(t, selects, 3)
+
+	require.Equal(t, []*ua.QualifiedName{
+		{NamespaceIndex: 0, Name: "Severity"},
+	}, selects[0].BrowsePath)
+
+	require.Equal(t, []*ua.QualifiedName{
+		{NamespaceIndex: 2, Name: "TEXT01"},
+	}, selects[1].BrowsePath)
+
+	require.Equal(t, []*ua.QualifiedName{
+		{NamespaceIndex: 0, Name: "AckedState"},
+		{NamespaceIndex: 0, Name: "Id"},
+	}, selects[2].BrowsePath)
+}

plugins/inputs/opcua_listener/README.md

@@ -295,7 +295,10 @@ to use them.
   #   # identifier_type = ""
   #   ## Specifies OPCUA Event sources to filter on
   #   # source_names = ["SourceName1", "SourceName2"]
-  #   ## Fields to capture from event notifications
+  #   ## Fields to capture from event notifications.
+  #   ## Fields support namespace-qualified names using "ns:name" format
+  #   ## (e.g. "2:TEXT01") and nested browse paths using "/" as separator
+  #   ## (e.g. "AckedState/Id" or "2:AckedState/0:Id").
   #   fields = ["Severity", "Message", "Time"]
   #
   #   ## Type or level of events to capture from the monitored nodes.

plugins/inputs/opcua_listener/sample.conf

@@ -253,7 +253,10 @@
   #   # identifier_type = ""
   #   ## Specifies OPCUA Event sources to filter on
   #   # source_names = ["SourceName1", "SourceName2"]
-  #   ## Fields to capture from event notifications
+  #   ## Fields to capture from event notifications.
+  #   ## Fields support namespace-qualified names using "ns:name" format
+  #   ## (e.g. "2:TEXT01") and nested browse paths using "/" as separator
+  #   ## (e.g. "AckedState/Id" or "2:AckedState/0:Id").
   #   fields = ["Severity", "Message", "Time"]
   #
   #   ## Type or level of events to capture from the monitored nodes.