[receiver/tcpcheck] New receiver #34458

yanfeng1992 · 2024-08-07T07:34:27Z

Signed-off-by: huangyanfeng huangyanfeng1992@gmail.com

Description:

To monitor the availability and performance of TCP endpoints.
Use case: TCP network detection plug-in, usually used to monitor whether a TCP port on the local machine is listening, or whether a remote port can be connected

Link to tracking Issue:

#34414

Testing:
(1) PR Includes coverage ~85% in the package with the scraper.
(2) Also includes coverage ~80% in the internal/tcpconfig package

Documentation:

The new receiver includes documentation in receiver/tcpcheckreceiver/README.md and receiver/tcpcheckreceiver/documentation.md.

The metric output looks like the following ...

Resource SchemaURL:
ScopeMetrics #0
ScopeMetrics SchemaURL:
InstrumentationScope otelcol/tcpcheckreceiver 1.0.0
Metric #0
Descriptor:
     -> Name: tcpcheck.duration
     -> Description: Measures the duration of TCP connection.
     -> Unit: ms
     -> DataType: Gauge
NumberDataPoints #0
Data point attributes:
     -> tcp.endpoint: Str(10.255.88.232:8088)
StartTimestamp: 2024-08-08 08:45:04.75587161 +0000 UTC
Timestamp: 2024-08-08 08:45:05.758205866 +0000 UTC
Value: 1
Metric #1
Descriptor:
     -> Name: tcpcheck.status
     -> Description: 1 if the TCP client successfully connected, otherwise 0.
     -> Unit: 1
     -> DataType: Sum
     -> IsMonotonic: false
     -> AggregationTemporality: Cumulative
NumberDataPoints #0
Data point attributes:
     -> tcp.endpoint: Str(10.255.88.232:8088)
StartTimestamp: 2024-08-08 08:45:04.75587161 +0000 UTC
Timestamp: 2024-08-08 08:45:05.758205866 +0000 UTC
Value: 1

Resource SchemaURL:
ScopeMetrics #0
ScopeMetrics SchemaURL:
InstrumentationScope otelcol/tcpcheckreceiver 1.0.0
Metric #0
Descriptor:
     -> Name: tcpcheck.duration
     -> Description: Measures the duration of TCP connection.
     -> Unit: ms
     -> DataType: Gauge
NumberDataPoints #0
Data point attributes:
     -> tcp.endpoint: Str(127.0.0.1:80)
StartTimestamp: 2024-08-08 08:42:18.432529413 +0000 UTC
Timestamp: 2024-08-08 08:42:19.437666882 +0000 UTC
Value: 0
Metric #1
Descriptor:
     -> Name: tcpcheck.error
     -> Description: Records errors occurring during TCP check.
     -> Unit: {error}
     -> DataType: Sum
     -> IsMonotonic: false
     -> AggregationTemporality: Cumulative
NumberDataPoints #0
Data point attributes:
     -> error.message: Str(dial tcp 127.0.0.1:80: connect: connection refused)
StartTimestamp: 2024-08-08 08:42:18.432529413 +0000 UTC
Timestamp: 2024-08-08 08:42:19.437666882 +0000 UTC
Value: 1
Metric #2
Descriptor:
     -> Name: tcpcheck.status
     -> Description: 1 if the TCP client successfully connected, otherwise 0.
     -> Unit: 1
     -> DataType: Sum
     -> IsMonotonic: false
     -> AggregationTemporality: Cumulative
NumberDataPoints #0
Data point attributes:
     -> tcp.endpoint: Str(127.0.0.1:80)
StartTimestamp: 2024-08-08 08:42:18.432529413 +0000 UTC
Timestamp: 2024-08-08 08:42:19.437666882 +0000 UTC
Value: 0

mx-psi

Hi, thanks for your contribution!

You will need a sponsor in order for us to accept this contribution. Please take a look at the instructions on adding new components. Thanks!

yanfeng1992 · 2024-08-08T09:19:39Z

Would you be willing to be my sponsor for this contribution?
Please take a look at the issue: #34414
@mx-psi

github-actions · 2024-08-23T05:20:37Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

crobert-1 · 2024-09-12T15:29:54Z

Hello @yanfeng1992, thanks for opening this PR! I'm going to close for now as this component will require a sponsor before it's able to move forward. Once a sponsor is found you're welcome to reopen 👍

yanfeng1992 · 2024-09-13T10:47:02Z

Hello @yanfeng1992, thanks for opening this PR! I'm going to close for now as this component will require a sponsor before it's able to move forward. Once a sponsor is found you're welcome to reopen 👍

@crobert-1 Would you be willing to be my sponsor for this contribution?

I saw that other people also need this receiver

#33718

And Fluent Bit also has a tcp health check plug-in
https://docs.fluentbit.io/manual/pipeline/inputs/health

receiver/tcpcheckreceiver/metadata.yaml

receiver/tcpcheckreceiver/internal/configtcp/configtcp.go

michael-burt · 2024-10-18T14:14:06Z

receiver/tcpcheckreceiver/scraper.go

+	if err == nil {
+		success = 1
+	}
+	s.mb.RecordTcpcheckDurationDataPoint(now, time.Since(start).Nanoseconds(), s.Config.TCPClientSettings.Endpoint)


Can we record duration in ms instead of nanoseconds?

michael-burt · 2024-10-18T14:14:42Z

receiver/tcpcheckreceiver/metadata.yaml

+    enabled: true
+    gauge:
+      value_type: int
+    unit: ns


Can we use ms instead of ns?

michael-burt · 2024-10-18T14:20:35Z

receiver/tcpcheckreceiver/README.md

+
+```yaml
+receivers:
+  sshcheck:


This is incorrect, also can you make this support multiple endpoints instead of just one as specified currently?

michael-burt · 2024-10-18T14:20:58Z

receiver/tcpcheckreceiver/scraper.go

+	}
+
+	if err = s.scrapeTCP(now); err != nil {
+		s.mb.RecordTcpcheckErrorDataPoint(now, int64(1), s.Endpoint, err.Error())


I think this implementation is not complete. I don't see where s.Endpoint comes from, I would expect the scrape to loop over s.Config.Targets or something.

michael-burt · 2024-10-18T14:23:24Z

Instead of using sshcheckreceiver as a reference, I would recommend looking at httpcheckreceiver instead. This component should support multiple TCP endpoint targets. It should also use a mutex for the metric update while looping over the targets as a go routine so that you can parallelize the probes.

github-actions · 2024-11-02T05:20:06Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

sponsor accepted

receiver/tcpcheckreceiver/README.md

receiver/tcpcheckreceiver/metadata.yaml

github-actions · 2024-11-18T05:20:51Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

Introduce a new receiver, TCP Check Receiver.This receiver creates stats by connecting to an TCP server. Related to open-telemetry#34414 N/A metadata.yaml, README. Signed-off-by: huangyanfeng <huangyanfeng1992@gmail.com>

ZenoCC-Peng · 2024-11-22T23:41:07Z

Hi @yanfeng1992,
Could I have your approval to start working on these refinements? I’d like to enhance the functionality to satisfy @michael-burt the requirements for the TCP checker.

yanfeng1992 · 2024-11-24T15:25:48Z

please go right ahead. @ZenoCC-Peng

ZenoCC-Peng · 2024-12-02T16:52:22Z

please go right ahead. @ZenoCC-Peng

Thanks, @yanfeng1992 will do.

github-actions · 2024-12-17T05:20:47Z

This PR was marked stale due to lack of activity. It will be closed in 14 days.

yanfeng1992 requested review from a team and mx-psi August 7, 2024 07:34

github-actions bot assigned bryan-aguilar Aug 7, 2024

yanfeng1992 force-pushed the tcp-checker branch from 98645b4 to e6bb4f8 Compare August 7, 2024 07:43

mx-psi previously requested changes Aug 7, 2024

View reviewed changes

yanfeng1992 force-pushed the tcp-checker branch 3 times, most recently from d53f92f to 5d5cdf3 Compare August 8, 2024 08:40

yanfeng1992 requested a review from mx-psi August 8, 2024 09:19

github-actions bot added the Stale label Aug 23, 2024

github-actions bot removed the Stale label Aug 30, 2024

yanfeng1992 closed this Sep 2, 2024

StephanSalas mentioned this pull request Sep 4, 2024

TCP version of HTTP Check Receiver #33718

Closed

yanfeng1992 reopened this Sep 12, 2024

yanfeng1992 force-pushed the tcp-checker branch from b4b440f to f6c3df2 Compare September 12, 2024 03:32

crobert-1 closed this Sep 12, 2024

atoulme reviewed Oct 12, 2024

View reviewed changes

receiver/tcpcheckreceiver/metadata.yaml Outdated Show resolved Hide resolved

atoulme reviewed Oct 12, 2024

View reviewed changes

receiver/tcpcheckreceiver/metadata.yaml Outdated Show resolved Hide resolved

atoulme reviewed Oct 12, 2024

View reviewed changes

receiver/tcpcheckreceiver/metadata.yaml Outdated Show resolved Hide resolved

atoulme reviewed Oct 12, 2024

View reviewed changes

receiver/tcpcheckreceiver/internal/configtcp/configtcp.go Outdated Show resolved Hide resolved

atoulme reopened this Oct 12, 2024

atoulme requested a review from a team as a code owner October 12, 2024 00:44

yanfeng1992 force-pushed the tcp-checker branch 2 times, most recently from f0c9284 to 4a8d8a2 Compare October 15, 2024 11:48

yanfeng1992 requested a review from atoulme October 15, 2024 13:17

yanfeng1992 force-pushed the tcp-checker branch from 4a8d8a2 to 1f6be7f Compare October 17, 2024 02:15

yanfeng1992 force-pushed the tcp-checker branch from acf0690 to 875ec5d Compare October 18, 2024 02:45

michael-burt reviewed Oct 18, 2024

View reviewed changes

receiver/tcpcheckreceiver/metadata.yaml

enabled: true

gauge:

value_type: int

unit: ns

Copy link

Contributor

michael-burt Oct 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use ms instead of ns?

michael-burt reviewed Oct 18, 2024

View reviewed changes

github-actions bot added the Stale label Nov 2, 2024

atoulme removed the Stale label Nov 3, 2024

atoulme reviewed Nov 3, 2024

View reviewed changes

receiver/tcpcheckreceiver/README.md Outdated Show resolved Hide resolved

atoulme reviewed Nov 3, 2024

View reviewed changes

receiver/tcpcheckreceiver/metadata.yaml Outdated Show resolved Hide resolved

github-actions bot added the Stale label Nov 18, 2024

yanfeng1992 force-pushed the tcp-checker branch 2 times, most recently from 3a79a86 to 229051c Compare November 21, 2024 12:36

yanfeng1992 marked this pull request as draft November 21, 2024 12:41

yanfeng1992 force-pushed the tcp-checker branch from 229051c to 09c94c3 Compare November 21, 2024 13:09

yanfeng1992 marked this pull request as ready for review November 21, 2024 13:10

github-actions bot assigned MovieStoreGuy Nov 21, 2024

yanfeng1992 requested a review from atoulme November 21, 2024 13:11

yanfeng1992 force-pushed the tcp-checker branch from 09c94c3 to 832d88e Compare November 21, 2024 13:20

[receiver/tcpcheck] New receiver

f154a27

Introduce a new receiver, TCP Check Receiver.This receiver creates stats by connecting to an TCP server. Related to open-telemetry#34414 N/A metadata.yaml, README. Signed-off-by: huangyanfeng <huangyanfeng1992@gmail.com>

yanfeng1992 force-pushed the tcp-checker branch from 832d88e to f154a27 Compare November 22, 2024 02:05

github-actions bot removed the Stale label Nov 22, 2024

github-actions bot added the Stale label Dec 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[receiver/tcpcheck] New receiver #34458

[receiver/tcpcheck] New receiver #34458

yanfeng1992 commented Aug 7, 2024 •

edited

Loading

mx-psi left a comment

yanfeng1992 commented Aug 8, 2024 •

edited

Loading

github-actions bot commented Aug 23, 2024

crobert-1 commented Sep 12, 2024

yanfeng1992 commented Sep 13, 2024 •

edited

Loading

michael-burt Oct 18, 2024

michael-burt Oct 18, 2024

michael-burt Oct 18, 2024

michael-burt Oct 18, 2024

michael-burt commented Oct 18, 2024

github-actions bot commented Nov 2, 2024

github-actions bot commented Nov 18, 2024

ZenoCC-Peng commented Nov 22, 2024

yanfeng1992 commented Nov 24, 2024

ZenoCC-Peng commented Dec 2, 2024

github-actions bot commented Dec 17, 2024

[receiver/tcpcheck] New receiver #34458

Are you sure you want to change the base?

[receiver/tcpcheck] New receiver #34458

Conversation

yanfeng1992 commented Aug 7, 2024 • edited Loading

mx-psi left a comment

Choose a reason for hiding this comment

yanfeng1992 commented Aug 8, 2024 • edited Loading

github-actions bot commented Aug 23, 2024

crobert-1 commented Sep 12, 2024

yanfeng1992 commented Sep 13, 2024 • edited Loading

michael-burt Oct 18, 2024

Choose a reason for hiding this comment

michael-burt Oct 18, 2024

Choose a reason for hiding this comment

michael-burt Oct 18, 2024

Choose a reason for hiding this comment

michael-burt Oct 18, 2024

Choose a reason for hiding this comment

michael-burt commented Oct 18, 2024

github-actions bot commented Nov 2, 2024

github-actions bot commented Nov 18, 2024

ZenoCC-Peng commented Nov 22, 2024

yanfeng1992 commented Nov 24, 2024

ZenoCC-Peng commented Dec 2, 2024

github-actions bot commented Dec 17, 2024

yanfeng1992 commented Aug 7, 2024 •

edited

Loading

yanfeng1992 commented Aug 8, 2024 •

edited

Loading

yanfeng1992 commented Sep 13, 2024 •

edited

Loading