tcp/unix input: Stop accepting connections after socket is closed #29712

andrewkroh · 2022-01-05T20:43:43Z

What does this PR do?

Stop accepting connections after tcp/unix socket is closed. This will suppress debug messages for net.ErrClosed.

2021-12-22T13:49:04.151Z	INFO	[tcp]	streaming/listener.go:172	StoppingTCPserver	{"address": "0.0.0.0:7000"}
2021-12-22T13:49:04.151Z	DEBUG	[tcp]	streaming/listener.go:129	Can not accept the connection	{"address": "0.0.0.0:7000", "error": "accept tcp [::]:7000: use of closed network connection"}

Why is it important?

This makes the shutdown process a little bit cleaning from a logging perspective.

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Logs

Sample log output of a starting, accepting a connection, disconnecting, and shutting down.

{
  "log.level": "info",
  "@timestamp": "2022-01-05T15:56:53.293-0500",
  "log.logger": "syslog",
  "log.origin": {
    "file.name": "syslog/input.go",
    "file.line": 147
  },
  "message": "Starting Syslog input",
  "service.name": "filebeat",
  "protocol": "tcp",
  "ecs.version": "1.6.0"
}
{
  "log.level": "debug",
  "@timestamp": "2022-01-05T15:56:53.293-0500",
  "log.logger": "tcp",
  "log.origin": {
    "file.name": "streaming/listener.go",
    "file.line": 141
  },
  "message": "Start accepting connections",
  "service.name": "filebeat",
  "address": "127.0.0.1:7000",
  "ecs.version": "1.6.0"
}
{
  "log.level": "debug",
  "@timestamp": "2022-01-05T15:56:58.775-0500",
  "log.logger": "tcp",
  "log.origin": {
    "file.name": "streaming/listener.go",
    "file.line": 185
  },
  "message": "New client connection.",
  "service.name": "filebeat",
  "address": "127.0.0.1:7000",
  "remote_address": "127.0.0.1:62085",
  "active_clients": 1,
  "ecs.version": "1.6.0"
}
{
  "log.level": "debug",
  "@timestamp": "2022-01-05T15:56:58.776-0500",
  "log.logger": "tcp",
  "log.origin": {
    "file.name": "streaming/listener.go",
    "file.line": 188
  },
  "message": "Client disconnected.",
  "service.name": "filebeat",
  "address": "127.0.0.1:7000",
  "remote_address": "127.0.0.1:62085",
  "active_clients": 0,
  "ecs.version": "1.6.0"
}
{
  "log.level": "debug",
  "@timestamp": "2022-01-05T15:57:02.287-0500",
  "log.logger": "tcp",
  "log.origin": {
    "file.name": "streaming/listener.go",
    "file.line": 200
  },
  "message": "Stopping socket listener. Waiting for all connections to close.",
  "service.name": "filebeat",
  "address": "127.0.0.1:7000",
  "ecs.version": "1.6.0"
}
{
  "log.level": "debug",
  "@timestamp": "2022-01-05T15:57:02.287-0500",
  "log.logger": "tcp",
  "log.origin": {
    "file.name": "streaming/listener.go",
    "file.line": 151
  },
  "message": "Stopped accepting connections",
  "service.name": "filebeat",
  "address": "127.0.0.1:7000",
  "ecs.version": "1.6.0"
}
{
  "log.level": "info",
  "@timestamp": "2022-01-05T15:57:02.287-0500",
  "log.logger": "tcp",
  "log.origin": {
    "file.name": "streaming/listener.go",
    "file.line": 203
  },
  "message": "Socket listener stopped",
  "service.name": "filebeat",
  "address": "127.0.0.1:7000",
  "ecs.version": "1.6.0"
}

elasticmachine · 2022-01-05T20:59:44Z

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

elasticmachine · 2022-01-05T20:59:45Z

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

filebeat/inputsource/common/streaming/listener.go

elasticmachine · 2022-01-05T21:50:04Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Reason: null
Start Time: 2022-02-04T00:20:36.187+0000
Duration: 104 min 46 sec
Commit: 777767b

Test stats 🧪

Test	Results
Failed	0
Passed	9638
Skipped	1289
Total	10927

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

andrewkroh · 2022-01-06T01:36:42Z

Looks like I broke some system tests that look for particular log messages.

mergify · 2022-01-11T15:45:59Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b bugfix/fb/handle-net-err-closed-tcp-input upstream/bugfix/fb/handle-net-err-closed-tcp-input
git merge upstream/master
git push upstream bugfix/fb/handle-net-err-closed-tcp-input

Stop accepting connections after tcp/unix socket is closed. This will suppress debug messages for net.ErrClosed. 2021-12-22T13:49:04.151Z INFO [tcp] streaming/listener.go:172 StoppingTCPserver {"address": "0.0.0.0:7000"} 2021-12-22T13:49:04.151Z DEBUG [tcp] streaming/listener.go:129 Can not accept the connection {"address": "0.0.0.0:7000", "error": "accept tcp [::]:7000: use of closed network connection"}

andrewkroh · 2022-01-13T14:51:28Z

/test

mergify · 2022-01-24T21:46:47Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b bugfix/fb/handle-net-err-closed-tcp-input upstream/bugfix/fb/handle-net-err-closed-tcp-input
git merge upstream/master
git push upstream bugfix/fb/handle-net-err-closed-tcp-input

andrewkroh · 2022-01-24T23:27:03Z

/test

mergify · 2022-01-25T18:56:24Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b bugfix/fb/handle-net-err-closed-tcp-input upstream/bugfix/fb/handle-net-err-closed-tcp-input
git merge upstream/master
git push upstream bugfix/fb/handle-net-err-closed-tcp-input

andrewkroh · 2022-01-27T01:48:38Z

/test

filebeat/inputsource/common/streaming/listener.go

mergify · 2022-02-01T15:50:25Z

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b bugfix/fb/handle-net-err-closed-tcp-input upstream/bugfix/fb/handle-net-err-closed-tcp-input
git merge upstream/master
git push upstream bugfix/fb/handle-net-err-closed-tcp-input

…-err-closed-tcp-input

…9712) Stop accepting connections after tcp/unix socket is closed. This will suppress debug messages for net.ErrClosed. 2021-12-22T13:49:04.151Z INFO [tcp] streaming/listener.go:172 StoppingTCPserver {"address": "0.0.0.0:7000"} 2021-12-22T13:49:04.151Z DEBUG [tcp] streaming/listener.go:129 Can not accept the connection {"address": "0.0.0.0:7000", "error": "accept tcp [::]:7000: use of closed network connection"} (cherry picked from commit 8c79b67)

…9712) (#30221) Stop accepting connections after tcp/unix socket is closed. This will suppress debug messages for net.ErrClosed. 2021-12-22T13:49:04.151Z INFO [tcp] streaming/listener.go:172 StoppingTCPserver {"address": "0.0.0.0:7000"} 2021-12-22T13:49:04.151Z DEBUG [tcp] streaming/listener.go:129 Can not accept the connection {"address": "0.0.0.0:7000", "error": "accept tcp [::]:7000: use of closed network connection"} (cherry picked from commit 8c79b67) Co-authored-by: Andrew Kroh <andrew.kroh@elastic.co>

andrewkroh added bug Filebeat Filebeat Team:Security-External Integrations Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team backport-v8.1.0 Automated backport with mergify labels Jan 5, 2022

botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Jan 5, 2022

andrewkroh force-pushed the bugfix/fb/handle-net-err-closed-tcp-input branch 2 times, most recently from 5acaf12 to ec60086 Compare January 5, 2022 20:58

andrewkroh marked this pull request as ready for review January 5, 2022 20:59

efd6 reviewed Jan 5, 2022

View reviewed changes

filebeat/inputsource/common/streaming/listener.go Outdated Show resolved Hide resolved

filebeat/inputsource/common/streaming/listener.go Outdated Show resolved Hide resolved

andrewkroh added 6 commits January 12, 2022 23:09

Modify framing type error construction

31b91aa

Combine defer statements

4894db1

Update log message in tests

639c85a

Fix tests

8d4ae92

Update another test

0563606

andrewkroh force-pushed the bugfix/fb/handle-net-err-closed-tcp-input branch from b570394 to 0563606 Compare January 13, 2022 04:10

Merge branch 'master' into bugfix/fb/handle-net-err-closed-tcp-input

353e898

Merge branch 'master' into bugfix/fb/handle-net-err-closed-tcp-input

cc9c871

andrewkroh requested a review from a team January 27, 2022 13:31

efd6 reviewed Jan 27, 2022

View reviewed changes

andrewkroh requested review from a team as code owners February 4, 2022 00:10

botelastic bot added the Team:Automation Label for the Observability productivity team label Feb 4, 2022

Make suggested changes

f288aed

andrewkroh force-pushed the bugfix/fb/handle-net-err-closed-tcp-input branch from 7a49dd3 to f288aed Compare February 4, 2022 00:13

andrewkroh removed request for a team February 4, 2022 00:13

andrewkroh removed the Team:Automation Label for the Observability productivity team label Feb 4, 2022

andrewkroh added 2 commits February 3, 2022 19:15

Merge remote-tracking branch 'elastic/main' into bugfix/fb/handle-net…

84d375d

…-err-closed-tcp-input

Fix changelog

777767b

andrewkroh requested a review from efd6 February 4, 2022 00:20

efd6 approved these changes Feb 4, 2022

View reviewed changes

andrewkroh merged commit 8c79b67 into elastic:main Feb 4, 2022

mergify bot mentioned this pull request Feb 4, 2022

[8.1](backport #29712) tcp/unix input: Stop accepting connections after socket is closed #30221

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tcp/unix input: Stop accepting connections after socket is closed #29712

tcp/unix input: Stop accepting connections after socket is closed #29712

andrewkroh commented Jan 5, 2022 •

edited

elasticmachine commented Jan 5, 2022

elasticmachine commented Jan 5, 2022

elasticmachine commented Jan 5, 2022 •

edited by jenkins-beats-ci bot

Build stats

Test stats 🧪

andrewkroh commented Jan 6, 2022

mergify bot commented Jan 11, 2022

andrewkroh commented Jan 13, 2022

mergify bot commented Jan 24, 2022

andrewkroh commented Jan 24, 2022

mergify bot commented Jan 25, 2022

andrewkroh commented Jan 27, 2022

mergify bot commented Feb 1, 2022

tcp/unix input: Stop accepting connections after socket is closed #29712

tcp/unix input: Stop accepting connections after socket is closed #29712

Conversation

andrewkroh commented Jan 5, 2022 • edited

What does this PR do?

Why is it important?

Checklist

Logs

elasticmachine commented Jan 5, 2022

elasticmachine commented Jan 5, 2022

elasticmachine commented Jan 5, 2022 • edited by jenkins-beats-ci bot

💚 Build Succeeded

Build stats

Test stats 🧪

💚 Flaky test report

🤖 GitHub comments

andrewkroh commented Jan 6, 2022

mergify bot commented Jan 11, 2022

andrewkroh commented Jan 13, 2022

mergify bot commented Jan 24, 2022

andrewkroh commented Jan 24, 2022

mergify bot commented Jan 25, 2022

andrewkroh commented Jan 27, 2022

mergify bot commented Feb 1, 2022

andrewkroh commented Jan 5, 2022 •

edited

elasticmachine commented Jan 5, 2022 •

edited by jenkins-beats-ci bot