Skip to content

feat: Bot instances advanced filter#59374

Merged
nicholasmarais1158 merged 36 commits intomasterfrom
nicholasmarais1158/feat/mwi-bot-instances-query
Sep 26, 2025
Merged

feat: Bot instances advanced filter#59374
nicholasmarais1158 merged 36 commits intomasterfrom
nicholasmarais1158/feat/mwi-bot-instances-query

Conversation

@nicholasmarais1158
Copy link
Copy Markdown
Contributor

@nicholasmarais1158 nicholasmarais1158 commented Sep 19, 2025

Summary

This change adds an advanced search to the bot instances list.

The following fields can be accessed from the predicate language;

  • metadata.name (alias name)
  • spec.bot_name
  • spec.instance_id
  • status.latest_heartbeat.architecture
  • status.latest_heartbeat.os
  • status.latest_heartbeat.hostname
  • status.latest_heartbeat.one_shot
  • status.latest_heartbeat.version
  • status.latest_authentication.join_method

In addition to the standard functions, the following are bot instance specific;

  • more_than (e.g. more_than(status.latest_heartbeat.version, "18.7.25"))
  • less_than (e.g. less_than(status.latest_heartbeat.version, "18.7.25"))
  • between (e.g. between(status.latest_heartbeat.version, "18.7.25", "18.7.72"))
  • equals (e.g. equals(status.latest_heartbeat.version) == "18.7.25"))

Updates: #57994
Depends on: #59263

TODO:

  • Check if any docs need to be added to or amended (such as this) - no changes required for this change but will add details to the tclt reference when the --query flag is added.

Changes

  • Add expression parser with functions specific to bot instance resources
  • Support query parameter in webapi and RPC.
  • Add advanced filter to web UI
  • Fix an issue preventing submitting the SearchPanel form when the advanced toggle is present (affects tests only)

Demo

Screen.Recording.2025-09-19.at.17.40.42.mov

Reviewer notes

Creating bot instances (as well as heartbeat records) requires running tbot to enrol an instance. To make testing this feature easier, I've used a SQL script to insert instance resources into the backend directly. Here's the script;
bot_instances.sql

$ sqlite3 <your cluster's data dir>/backend/sqlite.db
sqlite> .read bot_instances.sql

Be sure to restart your cluster afterwards - the cache will not be notified of the changes.

@nicholasmarais1158 nicholasmarais1158 force-pushed the nicholasmarais1158/feat/mwi-bot-instances-query branch from 8fc7bf2 to 6128a1b Compare September 19, 2025 19:12
@nicholasmarais1158 nicholasmarais1158 force-pushed the nicholasmarais1158/feat/mwi-bot-instances-query branch from 6128a1b to 88a29f5 Compare September 19, 2025 19:51
@nicholasmarais1158 nicholasmarais1158 marked this pull request as ready for review September 20, 2025 08:03
Base automatically changed from nicholasmarais1158/feat/mwi-bot-instances-v2 to master September 25, 2025 12:24
…query

# Conflicts:
#	api/gen/proto/go/teleport/machineid/v1/bot_instance_service.pb.go
#	api/proto/teleport/machineid/v1/bot_instance_service.proto
#	lib/auth/machineid/machineidv1/bot_instance_service.go
#	lib/cache/bot_instance.go
#	lib/services/bot_instance.go
#	lib/services/local/bot_instance.go
#	lib/web/machineid.go
#	lib/web/machineid_test.go
#	web/packages/teleport/src/BotInstances/BotInstances.test.tsx
#	web/packages/teleport/src/BotInstances/BotInstances.tsx
@nicholasmarais1158
Copy link
Copy Markdown
Contributor Author

@strideynet @espadolini I've removed the general-use to_string function as it was too difficult to make it nil-safe. This was intended to allow version comparison using the basic == operator, like so; to_string(status.latest_heartbeat.version) == "1.0.0"

Instead I've added an equals function that only operates on *semver.Version and is not general-use (i.e. not contributed to the default set of functions/methods). It's used like this; equals(status.latest_heartbeat.version, "18.2") and allows loose matching on the given prefix.

@espadolini
Copy link
Copy Markdown
Contributor

loose matching on the given prefix

So a hypothetical Teleport v2026 is going to match "20" (or better yet, Teleport 19.12 will match "19.1"). 😓

The name "equals" is also a bit awkward, it's not really an equality if it's fuzzy IMO.

Will we be able to add functions with the same name and different type signatures in the future if we decide we need them? Or should the function name indicate that they operate on versions?

@nicholasmarais1158 nicholasmarais1158 added this pull request to the merge queue Sep 26, 2025
Merged via the queue into master with commit c848236 Sep 26, 2025
48 of 50 checks passed
@nicholasmarais1158 nicholasmarais1158 deleted the nicholasmarais1158/feat/mwi-bot-instances-query branch September 26, 2025 07:49
@backport-bot-workflows
Copy link
Copy Markdown
Contributor

@nicholasmarais1158 See the table below for backport results.

Branch Result
branch/v17 Failed
branch/v18 Failed

nicholasmarais1158 added a commit that referenced this pull request Oct 24, 2025
* Add version and hostname indexes to cache

* Add `ListBotInstancesV2` rpc and use request options

* Add v2 bot instance list endpoint

* Use v2 endpoint in web UI

* Pass signal through to support aborting requests

* Fix comment typo

* Rename util func

* Add expression parser

* Contribute `to_string` function to default parser

* Add API support for `query` filter

* Fix `SearchPanel` submit with advanced toggle

* Add advanced search to web UI

* Deprecate `ListBotInstances` rpc

* Encode hostname in cache key

* Address pre-release sorting in version numbers

* Rename bot instance cache utils

* Fix lint deprecation warnings

* Extract filter fields to message

* Replace `fmt.Sprintf("%06d", ...)`

* Update invalid sort field error

* Fallback to v1 endpoint if possible

* Use `strcase` for case-insensitive compare

* Backend results are filtered by bot name so no need to re-filter in `MatchBotInstance`

* Use `t.Context()`

* Remove expression methods

* Remove unnecessary fallback comments

* Return early if only bot name filter is required (backend only)

* Fix lint

* replace `to_string` with `equals` (version type only)

* Fix comment

* Remove unnecessary `to_string` tests

* Switch to a true equals function
# Conflicts:
#	lib/cache/bot_instance.go
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx
nicholasmarais1158 added a commit that referenced this pull request Oct 24, 2025
* Add version and hostname indexes to cache

* Add `ListBotInstancesV2` rpc and use request options

* Add v2 bot instance list endpoint

* Use v2 endpoint in web UI

* Pass signal through to support aborting requests

* Fix comment typo

* Rename util func

* Add expression parser

* Contribute `to_string` function to default parser

* Add API support for `query` filter

* Fix `SearchPanel` submit with advanced toggle

* Add advanced search to web UI

* Deprecate `ListBotInstances` rpc

* Encode hostname in cache key

* Address pre-release sorting in version numbers

* Rename bot instance cache utils

* Fix lint deprecation warnings

* Extract filter fields to message

* Replace `fmt.Sprintf("%06d", ...)`

* Update invalid sort field error

* Fallback to v1 endpoint if possible

* Use `strcase` for case-insensitive compare

* Backend results are filtered by bot name so no need to re-filter in `MatchBotInstance`

* Use `t.Context()`

* Remove expression methods

* Remove unnecessary fallback comments

* Return early if only bot name filter is required (backend only)

* Fix lint

* replace `to_string` with `equals` (version type only)

* Fix comment

* Remove unnecessary `to_string` tests

* Switch to a true equals function
# Conflicts:
#	lib/cache/bot_instance.go
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx
nicholasmarais1158 added a commit that referenced this pull request Oct 29, 2025
* Add version and hostname indexes to cache

* Add `ListBotInstancesV2` rpc and use request options

* Add v2 bot instance list endpoint

* Use v2 endpoint in web UI

* Pass signal through to support aborting requests

* Fix comment typo

* Rename util func

* Add expression parser

* Contribute `to_string` function to default parser

* Add API support for `query` filter

* Fix `SearchPanel` submit with advanced toggle

* Add advanced search to web UI

* Deprecate `ListBotInstances` rpc

* Encode hostname in cache key

* Address pre-release sorting in version numbers

* Rename bot instance cache utils

* Fix lint deprecation warnings

* Extract filter fields to message

* Replace `fmt.Sprintf("%06d", ...)`

* Update invalid sort field error

* Fallback to v1 endpoint if possible

* Use `strcase` for case-insensitive compare

* Backend results are filtered by bot name so no need to re-filter in `MatchBotInstance`

* Use `t.Context()`

* Remove expression methods

* Remove unnecessary fallback comments

* Return early if only bot name filter is required (backend only)

* Fix lint

* replace `to_string` with `equals` (version type only)

* Fix comment

* Remove unnecessary `to_string` tests

* Switch to a true equals function
# Conflicts:
#	lib/cache/bot_instance.go
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx

# Conflicts:
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx
nicholasmarais1158 added a commit that referenced this pull request Oct 30, 2025
* Add version and hostname indexes to cache

* Add `ListBotInstancesV2` rpc and use request options

* Add v2 bot instance list endpoint

* Use v2 endpoint in web UI

* Pass signal through to support aborting requests

* Fix comment typo

* Rename util func

* Add expression parser

* Contribute `to_string` function to default parser

* Add API support for `query` filter

* Fix `SearchPanel` submit with advanced toggle

* Add advanced search to web UI

* Deprecate `ListBotInstances` rpc

* Encode hostname in cache key

* Address pre-release sorting in version numbers

* Rename bot instance cache utils

* Fix lint deprecation warnings

* Extract filter fields to message

* Replace `fmt.Sprintf("%06d", ...)`

* Update invalid sort field error

* Fallback to v1 endpoint if possible

* Use `strcase` for case-insensitive compare

* Backend results are filtered by bot name so no need to re-filter in `MatchBotInstance`

* Use `t.Context()`

* Remove expression methods

* Remove unnecessary fallback comments

* Return early if only bot name filter is required (backend only)

* Fix lint

* replace `to_string` with `equals` (version type only)

* Fix comment

* Remove unnecessary `to_string` tests

* Switch to a true equals function
# Conflicts:
#	lib/cache/bot_instance.go
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx

# Conflicts:
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx
rhammonds-teleport pushed a commit that referenced this pull request Nov 6, 2025
* Add version and hostname indexes to cache

* Add `ListBotInstancesV2` rpc and use request options

* Add v2 bot instance list endpoint

* Use v2 endpoint in web UI

* Pass signal through to support aborting requests

* Fix comment typo

* Rename util func

* Add expression parser

* Contribute `to_string` function to default parser

* Add API support for `query` filter

* Fix `SearchPanel` submit with advanced toggle

* Add advanced search to web UI

* Deprecate `ListBotInstances` rpc

* Encode hostname in cache key

* Address pre-release sorting in version numbers

* Rename bot instance cache utils

* Fix lint deprecation warnings

* Extract filter fields to message

* Replace `fmt.Sprintf("%06d", ...)`

* Update invalid sort field error

* Fallback to v1 endpoint if possible

* Use `strcase` for case-insensitive compare

* Backend results are filtered by bot name so no need to re-filter in `MatchBotInstance`

* Use `t.Context()`

* Remove expression methods

* Remove unnecessary fallback comments

* Return early if only bot name filter is required (backend only)

* Fix lint

* replace `to_string` with `equals` (version type only)

* Fix comment

* Remove unnecessary `to_string` tests

* Switch to a true equals function
github-merge-queue bot pushed a commit that referenced this pull request Nov 13, 2025
* docs(rfd): Bot Instances at Scale (RFD0222) (#57888)

* docs(rfd): Bot Instance at Scale (RFD0222)

* Add Notion link

* First draft for review

* fix: Spell check

* Fix protobuf code block

* Make the document structure slightly clearer

* Add a section on data aggregation

* Add missing end of code block

* Add a bit more context on bots and instances

* Add plan for `tctl`

* Add an explanation for each UX example

* Rename semver functions

* Remove activity visualisation and required complexity

* cspell

* Pre-populate isn't the correct term

* Minor tweak

* Test plan additions

* Remove reference to activity visualization

* Clarify use of pagination in `tctl bots instances ls` and remove filter summary

* Refine predicate language functions

* Restructure protos

* Refine plans for resource storage and quantities

* Add webapi support for config, health and notices

* Expand backwards compatibility

* cspell

* State `tbot` config size limit

* Reduce config max size to 32Kb

* Add failsafe env var

* Reduce max notices to 10

* Explain updating related record expiry in-line with the instance

* Revert extracting service health records

* Move notices to earlier in the delivery plan

* Remove notices & config and expand the why and what

* Expand aggregate data and metrics, and rearrange sections

* Fix `version.between` snippet

* Updated approach to calculating bot instance counts

* Document `newer_than` predicate language function

---------

Co-authored-by: Dan Upton <daniel.upton@goteleport.com>

* feat: List bot instances version and hostname sort (#59263)

* Add version and hostname indexes to cache

* Add `ListBotInstancesV2` rpc and use request options

* Add v2 bot instance list endpoint

* Use v2 endpoint in web UI

* Pass signal through to support aborting requests

* Fix comment typo

* Rename util func

* Deprecate `ListBotInstances` rpc

* Encode hostname in cache key

* Address pre-release sorting in version numbers

* Rename bot instance cache utils

* Fix lint deprecation warnings

* Extract filter fields to message

* Replace `fmt.Sprintf("%06d", ...)`

* Update invalid sort field error

* Fallback to v1 endpoint if possible

* Use `strcase` for case-insensitive compare

* Backend results are filtered by bot name so no need to re-filter in `MatchBotInstance`

* Revert "Replace `fmt.Sprintf("%06d", ...)`"

This reverts commit 2fbd797.

* feat: Bot instances advanced filter (#59374)

* Add version and hostname indexes to cache

* Add `ListBotInstancesV2` rpc and use request options

* Add v2 bot instance list endpoint

* Use v2 endpoint in web UI

* Pass signal through to support aborting requests

* Fix comment typo

* Rename util func

* Add expression parser

* Contribute `to_string` function to default parser

* Add API support for `query` filter

* Fix `SearchPanel` submit with advanced toggle

* Add advanced search to web UI

* Deprecate `ListBotInstances` rpc

* Encode hostname in cache key

* Address pre-release sorting in version numbers

* Rename bot instance cache utils

* Fix lint deprecation warnings

* Extract filter fields to message

* Replace `fmt.Sprintf("%06d", ...)`

* Update invalid sort field error

* Fallback to v1 endpoint if possible

* Use `strcase` for case-insensitive compare

* Backend results are filtered by bot name so no need to re-filter in `MatchBotInstance`

* Use `t.Context()`

* Remove expression methods

* Remove unnecessary fallback comments

* Return early if only bot name filter is required (backend only)

* Fix lint

* replace `to_string` with `equals` (version type only)

* Fix comment

* Remove unnecessary `to_string` tests

* Switch to a true equals function
# Conflicts:
#	lib/cache/bot_instance.go
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx

# Conflicts:
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx

* fix: Rename bot instance version expression functions (#59819)

* feat(webui): New bot instances experience (#59655)

* Make `disableSearch` props optional for SearchPanel component

* Add a shared mock for TextEditor

* Make instance items selectable and include bot name

* Remove old bot instance details page

* Add new bot instances UI

* Add stories

* Add and amend tests

* Switch to arrow function

* Remove `null` from item selected callback

* Fix info guide wording
# Conflicts:
#	web/packages/teleport/src/BotInstances/Details/BotInstanceDetails.test.tsx
#	web/packages/teleport/src/BotInstances/Details/BotInstanceDetails.tsx
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx

* feat: Bot instances design review (#59897)

* Alternate sort menu icons

* Titles and close button

* Yaml background colour

* Spacing

* Keyboard selectable list items

* Fix selected list item padding

* Default scroll bars for list

* Clarify delete bot messaging

* Simplify `onClick`

* Use `FlexProps` type

* Revert "Alternate sort menu icons"

This reverts commit 4212dcd.

* feat: Add filtering and sort to `tctl bots instances ls` (#60273)

* Fix missing `--format` flag

* Use v2 rpc

* Add `--search` flag

* Add `--query` flag

* Add `--sort-index` and `--sort-order` flags

* Remove `generation` and add `version` fields to output

* Allow enabling the auth cache for the test process

* Add list bot instances tests

* Sync join method access logic between tctl and web

* Access `authentication.JoinMethod` safely

* Unhide `--format` flag

* Simplify version header label

* Fallback to v1 ListBotInstances

* Refactor to remove use of `authclient.ClientI`

* A way better fallback implementation 🙌

* typo 🙄

* Refactor to single interface
# Conflicts:
#	tool/tctl/common/bots_command.go

* docs: Add filter, sort and format flags to `tctl bots instances ls` reference (#60508)

* docs: Add filter, sort and format fields to `tctl bots instances ls` reference

* Using consistent capitalization

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* feat: Add service health to `tctl bots instances ls|show` (#60316)

* Add `service_health` to bot instance protos

* Add aggregated service health to `show`

* Add services section to `show`

* Add health status column to `ls`

* Extra tabs are not welcome

* Handle zero services when aggregating health status
# Conflicts:
#	tool/tctl/common/bots_command.go

* MWI: Add `/webapi/.../machine-id/bot-instance/metrics` endpoint (#59896)

* Add `autoupdate_bot_instance_report` to the editor role preset

* Add `/webapi/.../machine-id/bot-instance/metrics` endpoint

* Add missing error check in test

* Better error message when metrics aren't ready

* Allow users with `bot_instance:list` to read the `autoupdate_bot_instance_report`

* Move update timestamp onto upgrade statuses object

* Fix predicate language function names

* Remove erroneous comment

* Fix tests

* Add `refresh_after_seconds` to metrics response

* Return an empty `upgrade_statuses` if there is no report

* Replace `exact_version` helper with simple `==` operator

* Use `trace.Aggregate` to return both auth errors

* feat: Bot instance upgrade status dashboard (#60019)

* Add plumbing for new metrics endpoint

* Align version compatibility logic

* Fix mocked responses in stories

* Add new dashboard component

* Wire-in dashboard component

* Fix lint

* Explain dynamic `refetchInterval`

* docs: `onFilterSelected`

* Use typography components from design package

* Fix `onFilterSelected` naming inconsistencies

* A better nbsp

* Remove "control plane" terminology

* Refactor `GetBotInstanceMetricsResponse` type

* Handle out-of-date proxy

* Make instance list messaging filter aware

* Update chart title to "version compatibility"

* Keep "Last updated x minutes ago" label current

* Oops, forgot to update the test

* Remove unused `TitleText`

* Change dashboard title to "insights"

* Version compatibility design changes

* Fix tests after copy change, oops

* feat: Bot instance service health (#60133)

* Add tabs to instance details

* Add `kind` to bot instance heartbeat proto

* Extend `GetBotInstanceResponse` type

* Add `InfoTab` component for Overview tab

* Add `HealthTab` component for Services tab

* Wire-up tabs content

* Use `join_attrs.meta` for join token fields

* Fix links style

* Fix handling of unspecified health status

* Fix tab spacing

* Remove tab tooltips

* Replace service item background

* Add zero services story

* Support tctl instance kind

* Fix styled links

* Fix test

* Fix bot instances story

* feat: Allow instances to be selectable from bot details (#60717)

* Make instance items selectable from bot details

* Add test

* Fix mocked calls in stories

* fix: Bot instance health status dot inconsistency (#60786)

---------

Co-authored-by: Dan Upton <daniel.upton@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
nicholasmarais1158 added a commit that referenced this pull request Nov 18, 2025
* Add version and hostname indexes to cache

* Add `ListBotInstancesV2` rpc and use request options

* Add v2 bot instance list endpoint

* Use v2 endpoint in web UI

* Pass signal through to support aborting requests

* Fix comment typo

* Rename util func

* Add expression parser

* Contribute `to_string` function to default parser

* Add API support for `query` filter

* Fix `SearchPanel` submit with advanced toggle

* Add advanced search to web UI

* Deprecate `ListBotInstances` rpc

* Encode hostname in cache key

* Address pre-release sorting in version numbers

* Rename bot instance cache utils

* Fix lint deprecation warnings

* Extract filter fields to message

* Replace `fmt.Sprintf("%06d", ...)`

* Update invalid sort field error

* Fallback to v1 endpoint if possible

* Use `strcase` for case-insensitive compare

* Backend results are filtered by bot name so no need to re-filter in `MatchBotInstance`

* Use `t.Context()`

* Remove expression methods

* Remove unnecessary fallback comments

* Return early if only bot name filter is required (backend only)

* Fix lint

* replace `to_string` with `equals` (version type only)

* Fix comment

* Remove unnecessary `to_string` tests

* Switch to a true equals function
# Conflicts:
#	lib/cache/bot_instance.go
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx
nicholasmarais1158 added a commit that referenced this pull request Nov 18, 2025
* Add version and hostname indexes to cache

* Add `ListBotInstancesV2` rpc and use request options

* Add v2 bot instance list endpoint

* Use v2 endpoint in web UI

* Pass signal through to support aborting requests

* Fix comment typo

* Rename util func

* Add expression parser

* Contribute `to_string` function to default parser

* Add API support for `query` filter

* Fix `SearchPanel` submit with advanced toggle

* Add advanced search to web UI

* Deprecate `ListBotInstances` rpc

* Encode hostname in cache key

* Address pre-release sorting in version numbers

* Rename bot instance cache utils

* Fix lint deprecation warnings

* Extract filter fields to message

* Replace `fmt.Sprintf("%06d", ...)`

* Update invalid sort field error

* Fallback to v1 endpoint if possible

* Use `strcase` for case-insensitive compare

* Backend results are filtered by bot name so no need to re-filter in `MatchBotInstance`

* Use `t.Context()`

* Remove expression methods

* Remove unnecessary fallback comments

* Return early if only bot name filter is required (backend only)

* Fix lint

* replace `to_string` with `equals` (version type only)

* Fix comment

* Remove unnecessary `to_string` tests

* Switch to a true equals function
# Conflicts:
#	lib/cache/bot_instance.go
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx

# Conflicts:
#	web/packages/teleport/src/BotInstances/List/BotInstancesList.tsx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants