Fix dry run mode #2651

ganmacs · 2019-10-15T06:31:11Z

Which issue(s) this PR fixes:
ref #2624

What this PR does / why we need it:

Show better log

Details

Example config

<system>
  workers 2
</system>

<worker 0>
  <source>
    @type fake
    secret very-secret-string0
    test 1
  </source>

  <match>
    @type null
  </match>
</worker>

<worker 1>
  <source>
    @type fake
    secret very-secret-string1
  </source>
  <match>
    @type null
  </match>
</worker>

normal mode

$ fluentd -c example/debug/secret.conf --dry-run

Before (supervisor and worker show same log about @type fake)

2019-10-15 15:16:44 +0900 [info]: parsing config file is succeeded path="example/debug/secret.conf"
2019-10-15 15:16:44 +0900 [info]: adding match pattern="**" type="null"
2019-10-15 15:16:44 +0900 [info]: adding match pattern="**" type="null"
2019-10-15 15:16:44 +0900 [info]: adding source type="fake"
2019-10-15 15:16:44 +0900 [info]: adding source type="fake"
2019-10-15 15:16:44 +0900 [info]: using configuration file: <ROOT>
  <system>
    workers 2
  </system>
  <worker 0>
    <source>
      @type fake
      secret xxxxxx
      test 1
    </source>
    <match>
      @type null
    </match>
  </worker>
  <worker 1>
    <source>
      @type fake
      secret xxxxxx
    </source>
    <match>
      @type null
    </match>
  </worker>
</ROOT>
2019-10-15 15:16:44 +0900 [warn]: parameter 'test' in <source>
  @type fake
  secret xxxxxx
  test 1
</source> is not used.
2019-10-15 15:16:44 +0900 [info]: starting fluentd-1.7.3 pid=91300 ruby="2.6.3"
2019-10-15 15:16:44 +0900 [info]: spawn command to main:  cmdline=["/Users/yuta.iwama/.rbenv/versions/2.6.3/bin/ruby", "-Eascii-8bit:ascii-8bit", "-rbundler/setup", "bin/fluentd", "-c", "example/debug/secret.conf", "-p", "plugins", "--under-supervisor"]
2019-10-15 15:16:45 +0900 [info]: #1 adding match pattern="**" type="null"
2019-10-15 15:16:45 +0900 [info]: gem 'fluentd' version '1.7.3'
2019-10-15 15:16:45 +0900 [info]: #0 adding match pattern="**" type="null"
2019-10-15 15:16:45 +0900 [info]: #0 adding source type="fake"
2019-10-15 15:16:45 +0900 [warn]: #0 parameter 'test' in <source>
  @type fake
  secret xxxxxx
  test 1
</source> is not used.

After(Removed duplicated log)

2019-10-15 15:16:44 +0900 [info]: parsing config file is succeeded path="example/debug/secret.conf"
2019-10-15 15:16:44 +0900 [info]: adding match pattern="**" type="null"
2019-10-15 15:16:44 +0900 [info]: adding match pattern="**" type="null"
2019-10-15 15:16:44 +0900 [info]: adding source type="fake"
2019-10-15 15:16:44 +0900 [info]: adding source type="fake"
2019-10-15 15:16:44 +0900 [info]: using configuration file: <ROOT>
  <system>
    workers 2
  </system>
  <worker 0>
    <source>
      @type fake
      secret xxxxxx
      test 1
    </source>
    <match>
      @type null
    </match>
  </worker>
  <worker 1>
    <source>
      @type fake
      secret xxxxxx
    </source>
    <match>
      @type null
    </match>
  </worker>
</ROOT>
2019-10-15 15:16:44 +0900 [warn]: parameter 'test' in <source>
  @type fake
  secret xxxxxx
  test 1
</source> is not used.

dry-run mode

$ fluentd -c example/debug/secret.conf --dry-run

Before

2019-10-15 15:16:07 +0900 [info]: parsing config file is succeeded path="example/debug/secret.conf"
2019-10-15 15:16:07 +0900 [info]: starting fluentd-1.7.3 as dry run mode ruby="2.6.3"
2019-10-15 15:16:07 +0900 [info]: adding match pattern="**" type="null"
2019-10-15 15:16:07 +0900 [info]: adding match pattern="**" type="null"
2019-10-15 15:16:07 +0900 [info]: adding source type="fake"
2019-10-15 15:16:07 +0900 [info]: adding source type="fake"
2019-10-15 15:16:07 +0900 [warn]: parameter 'test' in <source>
  @type fake
  secret xxxxxx
  test 1
</source> is not used.

After(show config)

2019-10-15 15:15:23 +0900 [info]: parsing config file is succeeded path="example/debug/secret.conf"
2019-10-15 15:15:23 +0900 [info]: starting fluentd-1.7.3 as dry run mode ruby="2.6.3"
2019-10-15 15:15:23 +0900 [info]: adding match pattern="**" type="null"
2019-10-15 15:15:23 +0900 [info]: adding source type="fake"
2019-10-15 15:15:23 +0900 [info]: using configuration file: <ROOT>
  <system>
    workers 2
  </system>
  <worker 0>
    <source>
      @type fake
      secret xxxxxx
      test 1
    </source>
    <match>
      @type null
    </match>
  </worker>
  <worker 1>
    <source>
      @type fake
      secret xxxxxx
    </source>
    <match>
      @type null
    </match>
  </worker>
</ROOT>
2019-10-15 15:15:23 +0900 [warn]: parameter 'test' in <source>
  @type fake
  secret xxxxxx
  test 1
</source> is not used.

when config has an error

Details

Example config

<system>
  workers 2
</system>

<worker 0-1>
  <source>
    @type fake
    secret very-secret-string0
    test 1
  </source>

  <match>
    @type null
  </match>
</worker>

<worker 0-1>
  <source>
    @type fake
    secret very-secret-string1
  </source>

  <match>
    @type null
  </match>
</worker>

Before

2019-10-15 15:25:41 +0900 [info]: parsing config file is succeeded path="example/debug/secret.conf"
2019-10-15 15:25:41 +0900 [info]: starting fluentd-1.7.3 as dry run mode ruby="2.6.3"
2019-10-15 15:25:41 +0900 [info]: adding match pattern="**" type="null"
2019-10-15 15:25:41 +0900 [info]: adding match pattern="**" type="null"
2019-10-15 15:25:41 +0900 [info]: adding source type="fake"
2019-10-15 15:25:41 +0900 [info]: adding source type="fake"
2019-10-15 15:25:41 +0900 [warn]: parameter 'test' in <source>
  @type fake
  secret xxxxxx
  test 1
</source> is not used.

After(be able to detect an error when dry-run)

2019-10-15 15:25:37 +0900 [info]: parsing config file is succeeded path="example/debug/secret.conf"
2019-10-15 15:25:37 +0900 [info]: starting fluentd-1.7.3 as dry run mode ruby="2.6.3"
2019-10-15 15:25:37 +0900 [error]: config error file="example/debug/secret.conf" error_class=Fluent::ConfigError error="specified worker_id<0> collisions is detected on <worker> directive. Available worker id(s): []"

Docs Changes:

no need

Release Note:

Make starting log better and seal dumped config

repeatedly · 2019-10-16T02:12:58Z

lib/fluent/supervisor.rb

-      ensure
-        Fluent::Engine.dry_run_mode = false
-      end
+    def configure_supervise


configure_supervisor?

This change had been introduced since https://github.com/fluent/fluentd/pull/1580/files . but even if dry-run mode, config need to show itself Signed-off-by: Yuta Iwama <[email protected]>

and if supervisor_mode, worker_id returns -1 because we need to identify worker0 and supervisor Signed-off-by: Yuta Iwama <[email protected]>

Signed-off-by: Yuta Iwama <[email protected]>

ganmacs · 2019-10-31T02:32:48Z

I changed to fix #1576 at the same time. Could you take a look at this again? @repeatedly

2019-10-31 11:31:44 +0900 [info]: parsing config file is succeeded path="example/debug/rpc.conf"
2019-10-31 11:31:44 +0900 [info]: gem 'fluentd' version '1.8.0.rc2'
2019-10-31 11:31:44 +0900 [info]: using configuration file: <ROOT>
  <system>
    workers 2
    rpc_endpoint "127.0.0.1:9000"
  </system>
  <worker 0>
    <source>
      @type fake
      secret xxxxxx
    </source>
  </worker>
  <worker 1>
    <source>
      @type fake
      secret xxxxxx
    </source>
  </worker>
  <match>
    @type null
  </match>
</ROOT>

curl http://127.0.0.1:9000/api/config.dump                                                                                                        
{"ok":true}

2019-10-31 11:31:48 +0900 [info]: dump in-memory config
2019-10-31 11:31:48 +0900 [info]: <ROOT>
  <system>
    workers 2
    rpc_endpoint "127.0.0.1:9000"
  </system>
  <worker 0>
    <source>
      @type fake
      secret xxxxxx
    </source>
  </worker>
  <worker 1>
    <source>
      @type fake
      secret xxxxxx
    </source>
  </worker>
  <match>
    @type null
  </match>
</ROOT>

Signed-off-by: Yuta Iwama <[email protected]>

Adds error handling similar to worker process. Fluent::Engine.run_configure calls Fluent::Registry#search. It can run Kernel.require. It can raise LoadError, ConflictError and others. Without this error handling, Fluentd cannot log those errors. This makes a situation where Fluentd fails to start, but there is no error log in the log file. This solves that problem. This appears to be an oversight of the following fix: * #2651 Signed-off-by: Daijiro Fukuda <[email protected]>

Adds error handling similar to worker process. https://github.com/fluent/fluentd/blob/master/lib/fluent/supervisor.rb#L1149-L1164 `Fluent::Engine.run_configure` calls `Fluent::Registry#search`. It can run `Kernel.require`. It can raise `LoadError`, `ConflictError` and others. Without this error handling, Fluentd cannot log those errors. This makes a situation where Fluentd fails to start, but there is no error log in the log file. This solves that problem. This appears to be an oversight of the following fix: * #2651 Signed-off-by: Daijiro Fukuda <[email protected]>

**Which issue(s) this PR fixes**: None. **What this PR does / why we need it**: Adds error handling similar to worker process. https://github.com/fluent/fluentd/blob/8df10863769da32459aba2a1408134d0b8e7d9f4/lib/fluent/supervisor.rb#L1149-L1164 `Fluent::Engine.run_configure` calls `Fluent::Registry#search`. It can run `Kernel.require`. It can raise `LoadError`, `ConflictError` and others. Without this error handling, Fluentd cannot log those errors. This makes a situation where Fluentd fails to start, but there is no error log in the log file. This solves that problem. This appears to be an oversight of the following fix: * #2651 **Docs Changes**: Not needed. **Release Note**: The same as the title. Signed-off-by: Daijiro Fukuda <[email protected]>

ganmacs requested a review from repeatedly October 15, 2019 06:31

ganmacs self-assigned this Oct 15, 2019

repeatedly reviewed Oct 16, 2019

View reviewed changes

lib/fluent/supervisor.rb Outdated

ensure

Fluent::Engine.dry_run_mode = false

end

def configure_supervise

Copy link

Member

repeatedly Oct 16, 2019

Choose a reason for hiding this comment

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

configure_supervisor?

ganmacs force-pushed the fix-dry-run-mode branch from 3309da9 to fa21b1b Compare October 30, 2019 08:24

ganmacs added 4 commits October 31, 2019 10:45

Dump config if dry-run mode

5702b33

This change had been introduced since https://github.com/fluent/fluentd/pull/1580/files . but even if dry-run mode, config need to show itself Signed-off-by: Yuta Iwama <[email protected]>

Add supervisor_mode to Engine class

6f0ae3b

and if supervisor_mode, worker_id returns -1 because we need to identify worker0 and supervisor Signed-off-by: Yuta Iwama <[email protected]>

unify dry_run method and make @dry_run immutable

a1d6f36

Signed-off-by: Yuta Iwama <[email protected]>

unify the condition

1089d34

Signed-off-by: Yuta Iwama <[email protected]>

ganmacs force-pushed the fix-dry-run-mode branch from fa21b1b to 1089d34 Compare October 31, 2019 01:50

ganmacs added 2 commits October 31, 2019 11:10

rearrange code

6b64cfc

Signed-off-by: Yuta Iwama <[email protected]>

no need to assign dry_run to ivar

98e3034

Signed-off-by: Yuta Iwama <[email protected]>

ganmacs added the enhancement Feature request or improve operations label Oct 31, 2019

fixed failed spec

4db63ce

Signed-off-by: Yuta Iwama <[email protected]>

repeatedly self-requested a review November 1, 2019 11:56

repeatedly approved these changes Nov 1, 2019

View reviewed changes

ganmacs merged commit e4a1dd7 into fluent:master Nov 5, 2019

ganmacs deleted the fix-dry-run-mode branch November 5, 2019 01:55

cosmo0920 mentioned this pull request Dec 3, 2019

Make conpatible for Fluentd v1.8 uken/fluent-plugin-elasticsearch#677

Merged

7 tasks

abetomo mentioned this pull request Feb 21, 2023

Fix value of system_config.workers at run_configure #4066

Merged

daipom mentioned this pull request Mar 7, 2025

Add logging for errors about loading dependencies on startup #4858

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix dry run mode #2651

Fix dry run mode #2651

Uh oh!

ganmacs commented Oct 15, 2019 •

edited

Loading

Uh oh!

repeatedly Oct 16, 2019

Uh oh!

ganmacs commented Oct 31, 2019 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Fix dry run mode #2651

Fix dry run mode #2651

Uh oh!

Conversation

ganmacs commented Oct 15, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Show better log

normal mode

dry-run mode

when config has an error

Before

After(be able to detect an error when dry-run)

Uh oh!

repeatedly Oct 16, 2019

Choose a reason for hiding this comment

Uh oh!

ganmacs commented Oct 31, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ganmacs commented Oct 15, 2019 •

edited

Loading

ganmacs commented Oct 31, 2019 •

edited

Loading