Skip to content

[Fleet] Support URL query state in agent logs UI#84298

Merged
jen-huang merged 3 commits intoelastic:masterfrom
jen-huang:ingest/agent-logs-url
Nov 25, 2020
Merged

[Fleet] Support URL query state in agent logs UI#84298
jen-huang merged 3 commits intoelastic:masterfrom
jen-huang:ingest/agent-logs-url

Conversation

@jen-huang
Copy link
Contributor

@jen-huang jen-huang commented Nov 25, 2020

Summary

Resolves #83736. This PR adds URL query state to agent logs UI using Kibana's state syncing utilities. When user updates their query, filter, or date parameters in the logs table, the change will be reflected in the URL query string. On full page reload, the table state will be loaded from the same URL params.

This will be useful for other applications that want to link to this page with a predefined context.

Example URL that is generated for looking at agent and filebeat error logs, from within the past week, that includes FLEET:

{KBN_BASE_PATH}/app/fleet#/fleet/agents/{AGENT_ID}/logs?_q=(datasets:!(elastic_agent,elastic_agent.filebeat),end:now%2Fw,logLevels:!(error),query:FLEET,start:now%2Fw)

Note: most of this PR diff is moving the main agent logs component to its own file at agent_logs.tsx. You may want to focus more on reviewing the containers that were added to index.tsx.

Screenshots

Gif showing URL query being populated:

Nov-24-2020 16-52-31

And persistence of the table state on page reload:

Nov-24-2020 16-53-12

@jen-huang jen-huang added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v7.11.0 labels Nov 25, 2020
@jen-huang jen-huang self-assigned this Nov 25, 2020
@jen-huang jen-huang requested a review from a team November 25, 2020 00:54
@elasticmachine
Copy link
Contributor

elasticmachine commented Nov 25, 2020

Pinging @elastic/ingest-management (Team:Ingest Management)

nchaulet
nchaulet reviewed Nov 25, 2020
View reviewed changes
...c/applications/fleet/sections/agents/agent_details_page/components/agent_logs/agent_logs.tsx Outdated
<EuiPanel paddingSize="none">
<LogStream
height="100%"
startTimestamp={dateRangeTimestamps!.startTimestamp}
Copy link
Member

@nchaulet nchaulet Nov 25, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I do not think the bang operator is correct here, if I used this start:now-1D in the url D instead of d
Screen Shot 2020-11-25 at 10 50 43 AM

Copy link
Contributor Author

@jen-huang jen-huang Nov 25, 2020

Choose a reason for hiding this comment

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

good catch, looking into it..

Copy link
Contributor Author

@jen-huang jen-huang Nov 25, 2020

Choose a reason for hiding this comment

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

pushed up a fix, bang operator removed and it should handle invalid expressions better now (will reset back to default if the expression is invalid)

@jen-huang jen-huang requested a review from nchaulet November 25, 2020 18:58
nchaulet
nchaulet approved these changes Nov 25, 2020
View reviewed changes
Copy link
Member

@nchaulet nchaulet left a comment

Choose a reason for hiding this comment

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

🚀

@kibanamachine
Copy link
Contributor

kibanamachine commented Nov 25, 2020

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
fleet 439 440 +1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
fleet 1.1MB 1.1MB +3.2KB

History

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

@jen-huang jen-huang merged commit 459263f into elastic:master Nov 25, 2020
@jen-huang jen-huang deleted the ingest/agent-logs-url branch November 25, 2020 21:30
@jen-huang jen-huang mentioned this pull request Nov 25, 2020
Merged
jen-huang added a commit that referenced this pull request Nov 25, 2020
@jen-huang
[Fleet] Support URL query state in agent logs UI (#84298) (#84378)
b6c0cbf 
* Initial attempt at URL state

* Break into smaller files

* Handle invalid date range expressions
gmmorris added a commit to gmmorris/kibana that referenced this pull request Nov 26, 2020
@gmmorris
Merge branch 'master' into alerts/fix-buggy-default-message
2c5348f 
* master: (70 commits)
  [Uptime] Fix headers io-ts type (elastic#84089)
  [fleet] Add config options to accepted docker env vars (elastic#84338)
  [Fleet] Support URL query state in agent logs UI (elastic#84298)
  [basePathProxy] include query in redirect (elastic#84356)
  [Security Solution] Add Endpoint policy feature checks (elastic#83972)
  Fix issues with show_license_expiration (elastic#84361)
  [Security Solution][Resolver] Add support for predefined schemas for endpoint and winlogbeat (elastic#84103)
  [cli/dev] log a warning when --no-base-path is used with --dev (elastic#84354)
  [Fleet] Support input-level vars & templates (elastic#83878)
  [APM] Elastic chart issues (elastic#84238)
  [Time to Visualize] Fix Unlink Action via Rollback of ReplacePanel (elastic#83873)
  redirect to visualize listing page when by value visualization editor doesn't have a value input (elastic#84287)
  add live region for field search (elastic#84310)
  [ML] Persisted URL state for Anomalies table (elastic#84314)
  [dev/cli] detect worker type using env, not cluster module (elastic#83977)
  [Workplace Search] Migrate DisplaySettings tree (elastic#84283)
  Deprecate `xpack.task_manager.index` setting (elastic#84155)
  [Search] Search batching using bfetch (again) (elastic#84043)
  Use .kibana instead of .kibana_current to mark migration completion (elastic#83373)
  [Monitoring] Only look at ES for the missing data alert for now (elastic#83839)
  ...
gmmorris added a commit to gmmorris/kibana that referenced this pull request Nov 26, 2020
@gmmorris
Merge branch 'master' into alerts/rename-resolved-to-recovered
f2bd0e0 
* master: (119 commits)
  [Uptime] Fix headers io-ts type (elastic#84089)
  [fleet] Add config options to accepted docker env vars (elastic#84338)
  [Fleet] Support URL query state in agent logs UI (elastic#84298)
  [basePathProxy] include query in redirect (elastic#84356)
  [Security Solution] Add Endpoint policy feature checks (elastic#83972)
  Fix issues with show_license_expiration (elastic#84361)
  [Security Solution][Resolver] Add support for predefined schemas for endpoint and winlogbeat (elastic#84103)
  [cli/dev] log a warning when --no-base-path is used with --dev (elastic#84354)
  [Fleet] Support input-level vars & templates (elastic#83878)
  [APM] Elastic chart issues (elastic#84238)
  [Time to Visualize] Fix Unlink Action via Rollback of ReplacePanel (elastic#83873)
  redirect to visualize listing page when by value visualization editor doesn't have a value input (elastic#84287)
  add live region for field search (elastic#84310)
  [ML] Persisted URL state for Anomalies table (elastic#84314)
  [dev/cli] detect worker type using env, not cluster module (elastic#83977)
  [Workplace Search] Migrate DisplaySettings tree (elastic#84283)
  Deprecate `xpack.task_manager.index` setting (elastic#84155)
  [Search] Search batching using bfetch (again) (elastic#84043)
  Use .kibana instead of .kibana_current to mark migration completion (elastic#83373)
  [Monitoring] Only look at ES for the missing data alert for now (elastic#83839)
  ...
gmmorris added a commit to gmmorris/kibana that referenced this pull request Dec 9, 2020
@gmmorris
Merge branch 'master' into alerts/rename-resolved-to-recovered
205e526 
* master: (119 commits)
  [Uptime] Fix headers io-ts type (elastic#84089)
  [fleet] Add config options to accepted docker env vars (elastic#84338)
  [Fleet] Support URL query state in agent logs UI (elastic#84298)
  [basePathProxy] include query in redirect (elastic#84356)
  [Security Solution] Add Endpoint policy feature checks (elastic#83972)
  Fix issues with show_license_expiration (elastic#84361)
  [Security Solution][Resolver] Add support for predefined schemas for endpoint and winlogbeat (elastic#84103)
  [cli/dev] log a warning when --no-base-path is used with --dev (elastic#84354)
  [Fleet] Support input-level vars & templates (elastic#83878)
  [APM] Elastic chart issues (elastic#84238)
  [Time to Visualize] Fix Unlink Action via Rollback of ReplacePanel (elastic#83873)
  redirect to visualize listing page when by value visualization editor doesn't have a value input (elastic#84287)
  add live region for field search (elastic#84310)
  [ML] Persisted URL state for Anomalies table (elastic#84314)
  [dev/cli] detect worker type using env, not cluster module (elastic#83977)
  [Workplace Search] Migrate DisplaySettings tree (elastic#84283)
  Deprecate `xpack.task_manager.index` setting (elastic#84155)
  [Search] Search batching using bfetch (again) (elastic#84043)
  Use .kibana instead of .kibana_current to mark migration completion (elastic#83373)
  [Monitoring] Only look at ES for the missing data alert for now (elastic#83839)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nchaulet nchaulet nchaulet approved these changes

Assignees

@jen-huang jen-huang

Labels

release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v7.11.0 v8.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Fleet] Add URL state to agent logs UI

4 participants

@jen-huang @elasticmachine @kibanamachine @nchaulet