cleanup server-log action by pmuellr · Pull Request #53326 · elastic/kibana

pmuellr · 2019-12-17T19:39:22Z

Summary

make the level param optional, defaults to info
change the actions logger "tag" from "alerting" to "actions"
prefix the line logged with server-log:
remove control characters from message

- make the level param optional, defaults to info - change the actions logger "tag" from "alerting" to "actions" - remove control characters from message

mikecote · 2019-12-19T22:42:45Z

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

pmuellr · 2020-01-02T15:50:55Z

@elasticmachine merge upstream

peterschretlen · 2020-01-02T16:53:21Z

x-pack/legacy/plugins/actions/server/builtin_action_types/server_log.ts

+  const sanitizedMessage = withoutControlCharacters(params.message);
  try {
-    logger[params.level](params.message);
+    logger[params.level](`server-log: ${sanitizedMessage}`);


the prefix seems to be causing a test failure in:

kibana/x-pack/legacy/plugins/actions/server/builtin_action_types/server_log.test.ts

Lines 97 to 101 in 65de3c5

params: { message: 'message text here', level: 'info' },

config: {},

secrets: {},

});

expect(mockedLogger.info).toHaveBeenCalledWith('message text here');

ya, just pushed a commit with the fix

peterschretlen · 2020-01-02T16:55:12Z

x-pack/legacy/plugins/actions/server/builtin_action_types/lib/string_utils.ts

+ */
+
+// see: https://en.wikipedia.org/wiki/Unicode_control_characters
+const CONTROL_CHAR_PATTERN = /[\x00-\x1F]|[\x7F-\x9F]|[\u2028-\u2029]/g;


I think this will remove tabs as well? I think that is probably OK, but some might expect that to be valid whitespace.

true; it's likely to confuse customers, so I think we should probably just let that one pass through untranslated

peterschretlen · 2020-01-02T16:56:15Z

x-pack/legacy/plugins/actions/server/builtin_action_types/server_log.ts

+  const sanitizedMessage = withoutControlCharacters(params.message);
  try {
-    logger[params.level](params.message);
+    logger[params.level](`server-log: ${sanitizedMessage}`);


Maybe 'server-log' should be pulled out as a symbol, as it is also used in the action type name and id?

makes sense

peterschretlen

👍 LGTM

mikecote

LGTM!

kibanamachine · 2020-01-02T18:43:11Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 04c6005

History

💔 Build #17591 failed 65de3c5

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

- make the level param optional, defaults to info - change the actions logger "tag" from "alerting" to "actions" - remove control characters from message

* master: Rename `/api/security/oidc` to `/api/security/oidc/callback`. (elastic#53886) Updating transitive dependencies to use handlebars@4.5.3 (elastic#53899) [Reporting/Tests] consolidate functional test configs (elastic#52671) [Reporting] Correct the docvalue_fields params in the search query Download CSV from Dashboard Panel (elastic#52833) [Test/Newsfeed] Re-enable test and add news item to be filtered (elastic#53905) cleanup server-log action (elastic#53326) [Uptime] Delete uptime eslint rule skip (elastic#50912) [skip-ci] Expression Lifecycle Docs (elastic#51494) [Endpoint] add react router to endpoint app (elastic#53808) [SIEM][Detection Engine] Silence 409 errors on signal creation (elastic#53859) [Maps] get max_result_window and max_inner_result_window from index settings (elastic#53500) [ML] New Platform server shim: update analytics routes to use new platform router (elastic#53521) fixes typo on engine detection page (elastic#53877)

* master: Rename `/api/security/oidc` to `/api/security/oidc/callback`. (elastic#53886) Updating transitive dependencies to use handlebars@4.5.3 (elastic#53899) [Reporting/Tests] consolidate functional test configs (elastic#52671) [Reporting] Correct the docvalue_fields params in the search query Download CSV from Dashboard Panel (elastic#52833) [Test/Newsfeed] Re-enable test and add news item to be filtered (elastic#53905) cleanup server-log action (elastic#53326) [Uptime] Delete uptime eslint rule skip (elastic#50912) [skip-ci] Expression Lifecycle Docs (elastic#51494) [Endpoint] add react router to endpoint app (elastic#53808) [SIEM][Detection Engine] Silence 409 errors on signal creation (elastic#53859) [Maps] get max_result_window and max_inner_result_window from index settings (elastic#53500) [ML] New Platform server shim: update analytics routes to use new platform router (elastic#53521) fixes typo on engine detection page (elastic#53877) [Maps] push mapbox value extraction from VectorStyle and into DynamicStyleProperty (elastic#53806) Fix suggested value for time_zone in range query (elastic#53841) Clean up generic hooks, use react-use instead (elastic#53822)

…ris/kibana into alerting/created_at-and-updated_at * 'alerting/created_at-and-updated_at' of github.com:gmmorris/kibana: Rename `/api/security/oidc` to `/api/security/oidc/callback`. (elastic#53886) Updating transitive dependencies to use handlebars@4.5.3 (elastic#53899) [Reporting/Tests] consolidate functional test configs (elastic#52671) [Reporting] Correct the docvalue_fields params in the search query Download CSV from Dashboard Panel (elastic#52833) [Test/Newsfeed] Re-enable test and add news item to be filtered (elastic#53905) cleanup server-log action (elastic#53326) [Uptime] Delete uptime eslint rule skip (elastic#50912) [skip-ci] Expression Lifecycle Docs (elastic#51494) [Endpoint] add react router to endpoint app (elastic#53808) [SIEM][Detection Engine] Silence 409 errors on signal creation (elastic#53859) [Maps] get max_result_window and max_inner_result_window from index settings (elastic#53500) [ML] New Platform server shim: update analytics routes to use new platform router (elastic#53521) fixes typo on engine detection page (elastic#53877) [Maps] push mapbox value extraction from VectorStyle and into DynamicStyleProperty (elastic#53806) Fix suggested value for time_zone in range query (elastic#53841) Clean up generic hooks, use react-use instead (elastic#53822)

…t-types * alerting/created_at-and-updated_at: updatedAt should equal createdAt on creation Move index patterns: src/legacy/core_plugins/data 👉 src/plugins/data (elastic#53794) moved Task Manager server code under "server" directory (elastic#53777) Rename `/api/security/oidc` to `/api/security/oidc/callback`. (elastic#53886) Updating transitive dependencies to use handlebars@4.5.3 (elastic#53899) [Reporting/Tests] consolidate functional test configs (elastic#52671) [Reporting] Correct the docvalue_fields params in the search query Download CSV from Dashboard Panel (elastic#52833) [Test/Newsfeed] Re-enable test and add news item to be filtered (elastic#53905) cleanup server-log action (elastic#53326) [Uptime] Delete uptime eslint rule skip (elastic#50912) [skip-ci] Expression Lifecycle Docs (elastic#51494) [Endpoint] add react router to endpoint app (elastic#53808) [SIEM][Detection Engine] Silence 409 errors on signal creation (elastic#53859) [Maps] get max_result_window and max_inner_result_window from index settings (elastic#53500) [ML] New Platform server shim: update analytics routes to use new platform router (elastic#53521) fixes typo on engine detection page (elastic#53877) [Maps] push mapbox value extraction from VectorStyle and into DynamicStyleProperty (elastic#53806) Fix suggested value for time_zone in range query (elastic#53841) Clean up generic hooks, use react-use instead (elastic#53822)

cleanup server-log action

a57159c

- make the level param optional, defaults to info - change the actions logger "tag" from "alerting" to "actions" - remove control characters from message

pmuellr added Feature:Alerting v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.6.0 Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// labels Dec 17, 2019

Merge branch 'master' into actions/ensure-single-line

65de3c5

peterschretlen reviewed Jan 2, 2020

View reviewed changes

pmuellr added 2 commits January 2, 2020 12:05

fix broken jest test

9b7faca

apply fixes suggested in PR review

04c6005

peterschretlen approved these changes Jan 2, 2020

View reviewed changes

mikecote approved these changes Jan 2, 2020

View reviewed changes

pmuellr merged commit 592bc43 into elastic:master Jan 2, 2020

pmuellr mentioned this pull request Jan 2, 2020

[7.x] cleanup server-log action (#53326) #53914

Merged

pmuellr added a commit to pmuellr/kibana that referenced this pull request Jan 2, 2020

cleanup server-log action (elastic#53326)

188251c

- make the level param optional, defaults to info - change the actions logger "tag" from "alerting" to "actions" - remove control characters from message

pmuellr added a commit that referenced this pull request Jan 3, 2020

cleanup server-log action (#53326) (#53914)

4b2c4cf

- make the level param optional, defaults to info - change the actions logger "tag" from "alerting" to "actions" - remove control characters from message

pmuellr added the backported label Jan 3, 2020

pmuellr deleted the actions/ensure-single-line branch January 23, 2020 22:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cleanup server-log action#53326

cleanup server-log action#53326
pmuellr merged 4 commits intoelastic:masterfrom
pmuellr:actions/ensure-single-line

pmuellr commented Dec 17, 2019

Uh oh!

mikecote commented Dec 19, 2019

Uh oh!

pmuellr commented Jan 2, 2020

Uh oh!

peterschretlen Jan 2, 2020

Uh oh!

pmuellr Jan 2, 2020

Uh oh!

peterschretlen Jan 2, 2020

Uh oh!

pmuellr Jan 2, 2020

Uh oh!

peterschretlen Jan 2, 2020

Uh oh!

pmuellr Jan 2, 2020

Uh oh!

peterschretlen left a comment

Uh oh!

mikecote left a comment

Uh oh!

kibanamachine commented Jan 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	params: { message: 'message text here', level: 'info' },
	config: {},
	secrets: {},
	});
	expect(mockedLogger.info).toHaveBeenCalledWith('message text here');

Conversation

pmuellr commented Dec 17, 2019

Summary

Uh oh!

mikecote commented Dec 19, 2019

Uh oh!

pmuellr commented Jan 2, 2020

Uh oh!

peterschretlen Jan 2, 2020

Choose a reason for hiding this comment

Uh oh!

pmuellr Jan 2, 2020

Choose a reason for hiding this comment

Uh oh!

peterschretlen Jan 2, 2020

Choose a reason for hiding this comment

Uh oh!

pmuellr Jan 2, 2020

Choose a reason for hiding this comment

Uh oh!

peterschretlen Jan 2, 2020

Choose a reason for hiding this comment

Uh oh!

pmuellr Jan 2, 2020

Choose a reason for hiding this comment

Uh oh!

peterschretlen left a comment

Choose a reason for hiding this comment

Uh oh!

mikecote left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Jan 2, 2020

💚 Build Succeeded

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants