New opc ua client plugin #7213

fdamador · 2020-03-22T21:44:09Z

related #3041

Required for all PRs:

Signed CLA.
Associated README.md updated.
Has appropriate unit tests.

fdamador · 2020-03-26T20:18:01Z

cannot run dep ensure -add github.com/gopcua/opcua because during dep init throws error on conflicts with github.com/influxdata/go-syslog/v2 packages having problematic subpackages.

Can someone help?

danielnelson · 2020-03-26T21:04:10Z

Looks like you have it figured out? For that last failing test you need to add github.com/gopcua/opcua to docs/LICENSE_OF_DEPENDENCIES.md

fdamador · 2020-04-07T17:15:59Z

Did you need me to delete the .vscode/launch.json file? I forgot to do that prior to doing a pull request. Also, at what telegraf version will you release this plugin?

jaketimothy · 2020-04-24T21:48:45Z

Very excited for this. Will see serious use in factory settings. Thank you @fdamador and everyone @gopcua

MoritzLaut · 2020-04-25T07:02:02Z

very excited about this too. seems like a lot of users waiting for this plugin!

qzheng527 · 2020-04-28T07:21:36Z

Yes, looking forward to the final merge to the next release.

chrishayles · 2020-05-07T19:58:53Z

Currently seeing the following error

panic: runtime error: invalid memory address or nil pointer dereference
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x28 pc=0x178b0a9]

goroutine 66 [running]:
github.com/gopcua/opcua/uasc.(*SecureChannel).setState(0x0, 0x2)
/go/pkg/mod/github.com/gopcua/[email protected]/uasc/secure_channel.go:145 +0x9
panic(0x246b040, 0x4556890)
/usr/local/go/src/runtime/panic.go:679 +0x1b2
github.com/gopcua/opcua/uasc.(*SecureChannel).hasState(...)
/go/pkg/mod/github.com/gopcua/[email protected]/uasc/secure_channel.go:149
github.com/gopcua/opcua/uasc.(*SecureChannel).closeSecureChannel(0x0, 0x0, 0x0)
/go/pkg/mod/github.com/gopcua/[email protected]/uasc/secure_channel.go:744 +0x9e
github.com/gopcua/opcua/uasc.(*SecureChannel).Close(0x0, 0x0, 0x0)
/go/pkg/mod/github.com/gopcua/[email protected]/uasc/secure_channel.go:665 +0x32
github.com/gopcua/opcua.(*Client).Close(0xc000140a00, 0x1b, 0xc000140b00)
/go/pkg/mod/github.com/gopcua/[email protected]/client.go:234 +0x46
github.com/influxdata/telegraf/plugins/inputs/opcua_client.disconnect(0xc00015c000, 0x2ec0bc0, 0xc00004e6a0)
/go/src/github.com/influxdata/telegraf/plugins/inputs/opcua_client/opcua_client.go:352 +0xe7
github.com/influxdata/telegraf/plugins/inputs/opcua_client.(*OpcUA).Gather(0xc00015c000, 0x2f370c0, 0xc0003f7600, 0x0, 0x8)
/go/src/github.com/influxdata/telegraf/plugins/inputs/opcua_client/opcua_client.go:367 +0x37a
github.com/influxdata/telegraf/internal/models.(*RunningInput).Gather(0xc000158320, 0x2f370c0, 0xc0003f7600, 0x2f18020, 0xc0000b4e40)
/go/src/github.com/influxdata/telegraf/internal/models/running_input.go:115 +0x6d
github.com/influxdata/telegraf/agent.(*Agent).gatherOnce.func1(0xc0000b61e0, 0xc000158320, 0x2f370c0, 0xc0003f7600)
/go/src/github.com/influxdata/telegraf/agent/agent.go:336 +0x3f
created by github.com/influxdata/telegraf/agent.(*Agent).gatherOnce
/go/src/github.com/influxdata/telegraf/agent/agent.go:335 +0xf5

When trying to connect to an opc server.

Using OPC simulator:
docker run -dt --name plc -p 50000:50000 mcr.microsoft.com/iotedge/opc-plc:1.0.0-linux-amd64 --autoaccept --unsecuretransport

With Telegraf config:

[global_tags]
dc = "iotedge"

[agent]
interval = "10s"
debug = true

[[outputs.file]]
files = ["stdout"]

[[inputs.opcua_client]]
name = "plc1"
endpoint = "opc.tcp://0.0.0.0:50000"
timeout = 30
security_policy = "None"
security_mode = "None"
nodes = [
{name="SpikeData", namespace="2", identifier_type="s", identifier="SpikeData", data_type="double", description="Randomly generated data"},
]

Telegraf code built and pushed to docker hub here:
chrishaylesnortal/telegraf-demo:1.0.1

fdamador · 2020-05-07T20:10:54Z

Chris,

I'm not sure your setup enpoint has a valid IP address. Can you try localhost or 127.0.0.1 or the IP address to the container running your OPC UA server.

[[inputs.opcua_client]]
name = "plc1"
> endpoint = "opc.tcp://0.0.0.0:50000"

chrishayles · 2020-05-07T20:49:53Z

@fdamador

Same result with localhost and 127.0.0.1.

To remove my simulator as a possibility, I tried configuring it to work with a separate KEPWare based simulator, too. Getting the same result there. The Telegraf config I'm using for that:

[global_tags]
dc = "iotedge"

[agent]
interval = "10s"
debug = true

[[outputs.file]]
files = ["stdout"]

[[inputs.opcua_client]]
name = "plc1"
endpoint = "opc.tcp://$IP:49320"
timeout = 60
security_policy = "None"
security_mode = "None"
nodes = [
{name="Tag1Double", namespace="2", identifier_type="s", identifier="SimulationPLC.plugintest.Tag1Double", data_type="double", description=""},
]

fdamador · 2020-05-07T21:04:58Z

@haylesnortal

Ok, let me review. I was able to replicate your original error. the good news is that I'm able to read the data point using the examples from the gopcua library...so will trace out the bug.

chrishayles · 2020-05-07T22:34:50Z

@fdamador think I've got it...

the error was to do with the disconnect() call before it was ever connected. Commented that out. I was then able to see the real error: regardless of what endpoint address I gave, the client was trying to connect on 127.0.0.1.
I checked the endpoints being returned by the OPC UA server and 127.0.0.1 is the first of a few. This is pretty common. And not every server will know it's own public facing endpoint.
You were then selecting an endpoint, building out client options from that endpoint (all good up to here) then sending that endpoint.EndpointURL to create the client: o.client = opcua.NewClient(ep.EndpointURL, opts...) ...this being the 127.0.0.1 endpoint.
So I replace this with the original endpoint supplied by the user: o.client = opcua.NewClient(o.Endpoint, opts...)

That seemed to fix it.

fdamador · 2020-05-07T23:44:13Z

Thanks for help, that did it. I've committed and pushed my changes.

chrishayles · 2020-05-07T23:44:57Z

@fdamador Thanks for taking a look and the quick response. Much appreciated.

chrishayles · 2020-05-08T00:24:22Z

Still seeing issues... this time, it reads the first value fine, but then it never updates. I can see the OPC sim values changing in my OPC browser, but Telegraf never sees updated values. I think it's because the only call to readvalues() is in the Connect() function. I'll play around with it, see what I can do.

fdamador · 2020-05-08T05:23:09Z

Understood, I made these modifications. Let me know if this is what you were thinking.

plugins/inputs/opcua_client/opcua_client.go

PWSys · 2020-07-08T00:40:43Z

It would be helpful to customize the incoming schema. Examples include adding custom tags and monitoring multiple fields per measurement. There won't always be a 1:1 relationship between a monitored OPC-UA node and the desired measuremnt in InfluxDB.

ssoroka

Thanks for the plugin! Have some feedback for you.

ssoroka · 2020-05-08T20:18:19Z

.vscode/launch.json

@@ -0,0 +1,18 @@
+(


don't commit these dot-files.

ssoroka · 2020-05-08T20:19:37Z

telegraf.conf

@@ -0,0 +1,6525 @@
+# Telegraf Configuration


This should not be committed.

ssoroka · 2020-07-09T17:19:46Z

plugins/inputs/opcua_client/README.md

+#  # Time Inteval, default = 100 * time.Millisecond
+#  # interval = "10000000"
+#
+#  # Security policy: None, Basic128Rsa15, Basic256, Basic256Sha256. Default: auto


default says auto, but text says "None" these should match

ssoroka · 2020-07-09T17:21:10Z

plugins/inputs/opcua_client/README.md

+### Example Output:
+
+```
+$ ./telegraf -config telegraf.conf -input-filter opcua_client -test


this should be actual example output, not the command to run to get the output.

an example input/output would be very useful for this README

ssoroka · 2020-07-09T17:29:06Z

plugins/inputs/opcua_client/opcua_client_test.go

+	var err error
+
+	o.Name = "testing"
+	o.Endpoint = "opc.tcp://opcua.rocks:4840"


this is hitting a remote service on the internet? can we store and mock the response instead?

ssoroka · 2020-07-09T17:44:42Z

plugins/inputs/opcua_client/opcua_client.go

+			TimestampsToReturn: ua.TimestampsToReturnBoth,
+		}
+
+		err = o.getData()


Connect should not call getData, gather already does this.

ssoroka · 2020-07-09T17:45:49Z

plugins/inputs/opcua_client/opcua_client.go

+		return err
+	}
+
+	o.ReadError = 0


I don't think there's any reason to reset these.

ssoroka · 2020-07-09T17:46:34Z

plugins/inputs/opcua_client/opcua_client.go

+	switch u.Scheme {
+	case "opc.tcp":
+		o.state = Disconnected
+		o.client.Close()


unset o.client here so you know you need to reconnect. and you can drop o.state.

ssoroka · 2020-07-09T17:47:28Z

plugins/inputs/opcua_client/opcua_client.go

+}
+
+func disconnect(o *OpcUA) error {
+	u, err := url.Parse(o.Endpoint)


There's no reason to parse the endpoint or check the scheme here.

ssoroka · 2020-07-09T17:49:50Z

plugins/inputs/opcua_client/opcua_client.go

+		}
+		o.NodeData[i].Quality = d.Status
+		o.NodeData[i].TimeStamp = d.ServerTimestamp.String()
+		o.NodeData[i].Time = d.SourceTimestamp.String()


string timestamps are notoriously difficult to work with. Not sure why you'd convert to a string here.

sjwang90 · 2020-07-10T23:25:43Z

plugins/inputs/opcua_client/README.md

@@ -0,0 +1,57 @@
+# Telegraf Input Plugin: opcua_client
+
+The opcua_client plugin retrieves data from OPCUA slave devices


Please replace the term slave with replica, secondary or any of the following suggestions.

Thanks I’ll replace with server to match industry standards nomenclature

sjwang90 · 2020-07-15T22:28:22Z

Hey @fdamador, just checking in on the progress of @ssoroka's suggestions. We'd love to get others to start using this! Thanks again!

sjwang90 · 2020-07-30T16:13:38Z

@fdamador do you think you could test your plugin with the Prosys simulator? Was trying to troubleshoot with @haylesnortal last week and was getting various errors.

2020-07-21T22:16:05Z E! [inputs.opcua_client] Error in plugin: Endpoint Error: opcua: could not resolve address ip-192-168-1-2.ec2.internal:53530

sjwang90 · 2020-09-08T19:14:04Z

Hey @fdamador, we merged in #8009 last week. Wanted to give you a big thanks as your plugin was the base of the final plugin that was merged.

Feel free to test out that new plugin with master or the nightly build.

fdamador · 2020-09-08T20:08:39Z

Awesome! Glad I could be of service.

fdamador added 7 commits March 22, 2020 12:46

Update README.md

361331a

opc ua client

0f81b0a

Updated config template

fd19a8c

Merge branch 'master' of https://github.com/fdamador/telegraf

f87c2e4

cleanup

965c34f

Added opcu ua client plugin

55fb20f

Updated Main README file

6437ce9

danielnelson added the new plugin label Mar 23, 2020

Merge https://github.com/influxdata/telegraf

93a9ab0

fdamador added 2 commits March 26, 2020 12:50

updated base from master

390aa0a

go mod tidy

9899256

added MIT license reference

aeae416

fdamador mentioned this pull request Mar 28, 2020

Feature Request - examples for all examples. gopcua/opcua#310

Closed

sjwang90 added the area/iot New plugins or features relating to IoT monitoring label Apr 17, 2020

sjwang90 added this to the 1.15.0 milestone Apr 23, 2020

removed disconnect and updated enpoint

3cded57

continuous read

abd7d59

updated interval

2ef4c9f

russorat reviewed Jun 5, 2020

View reviewed changes

plugins/inputs/opcua_client/opcua_client.go Show resolved Hide resolved

danielnelson modified the milestones: 1.15.0, 1.16.0 Jul 7, 2020

ssoroka suggested changes Jul 9, 2020

View reviewed changes

sjwang90 reviewed Jul 10, 2020

View reviewed changes

chrishayles mentioned this pull request Aug 20, 2020

Opcua input plugin + authentication options #8009

Merged

3 tasks

gavioto mentioned this pull request Sep 8, 2020

Support for OPC-UA input and output plug-ins #3041

Closed

sjwang90 closed this Sep 8, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New opc ua client plugin #7213

New opc ua client plugin #7213

fdamador commented Mar 22, 2020 •

edited by danielnelson

Loading

fdamador commented Mar 26, 2020

danielnelson commented Mar 26, 2020

fdamador commented Apr 7, 2020

jaketimothy commented Apr 24, 2020

MoritzLaut commented Apr 25, 2020

qzheng527 commented Apr 28, 2020

chrishayles commented May 7, 2020 •

edited

Loading

fdamador commented May 7, 2020

chrishayles commented May 7, 2020 •

edited

Loading

fdamador commented May 7, 2020

chrishayles commented May 7, 2020 •

edited

Loading

fdamador commented May 7, 2020 •

edited

Loading

chrishayles commented May 7, 2020

chrishayles commented May 8, 2020

fdamador commented May 8, 2020

PWSys commented Jul 8, 2020

ssoroka left a comment

ssoroka May 8, 2020

ssoroka May 8, 2020

ssoroka Jul 9, 2020

ssoroka Jul 9, 2020

sjwang90 Jul 10, 2020

ssoroka Jul 9, 2020

ssoroka Jul 9, 2020

ssoroka Jul 9, 2020

ssoroka Jul 9, 2020

ssoroka Jul 9, 2020

ssoroka Jul 9, 2020

sjwang90 Jul 10, 2020

fdamador Jul 11, 2020

sjwang90 commented Jul 15, 2020

sjwang90 commented Jul 30, 2020

sjwang90 commented Sep 8, 2020

fdamador commented Sep 8, 2020

		@@ -0,0 +1,57 @@
		# Telegraf Input Plugin: opcua_client

		The opcua_client plugin retrieves data from OPCUA slave devices

New opc ua client plugin #7213

New opc ua client plugin #7213

Conversation

fdamador commented Mar 22, 2020 • edited by danielnelson Loading

Required for all PRs:

fdamador commented Mar 26, 2020

danielnelson commented Mar 26, 2020

fdamador commented Apr 7, 2020

jaketimothy commented Apr 24, 2020

MoritzLaut commented Apr 25, 2020

qzheng527 commented Apr 28, 2020

chrishayles commented May 7, 2020 • edited Loading

[[inputs.opcua_client]] name = "plc1" endpoint = "opc.tcp://0.0.0.0:50000" timeout = 30 security_policy = "None" security_mode = "None" nodes = [ {name="SpikeData", namespace="2", identifier_type="s", identifier="SpikeData", data_type="double", description="Randomly generated data"}, ]

fdamador commented May 7, 2020

chrishayles commented May 7, 2020 • edited Loading

fdamador commented May 7, 2020

chrishayles commented May 7, 2020 • edited Loading

fdamador commented May 7, 2020 • edited Loading

chrishayles commented May 7, 2020

chrishayles commented May 8, 2020

fdamador commented May 8, 2020

PWSys commented Jul 8, 2020

ssoroka left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sjwang90 commented Jul 15, 2020

sjwang90 commented Jul 30, 2020

sjwang90 commented Sep 8, 2020

fdamador commented Sep 8, 2020

fdamador commented Mar 22, 2020 •

edited by danielnelson

Loading

chrishayles commented May 7, 2020 •

edited

Loading

[[inputs.opcua_client]]
name = "plc1"
endpoint = "opc.tcp://0.0.0.0:50000"
timeout = 30
security_policy = "None"
security_mode = "None"
nodes = [
{name="SpikeData", namespace="2", identifier_type="s", identifier="SpikeData", data_type="double", description="Randomly generated data"},
]

chrishayles commented May 7, 2020 •

edited

Loading

chrishayles commented May 7, 2020 •

edited

Loading

fdamador commented May 7, 2020 •

edited

Loading