open-consul/website/source/docs
Matt Keeler ac78c23021
Implement data filtering of some endpoints (#5579)
Fixes: #4222 

# Data Filtering

This PR will implement filtering for the following endpoints:

## Supported HTTP Endpoints

- `/agent/checks`
- `/agent/services`
- `/catalog/nodes`
- `/catalog/service/:service`
- `/catalog/connect/:service`
- `/catalog/node/:node`
- `/health/node/:node`
- `/health/checks/:service`
- `/health/service/:service`
- `/health/connect/:service`
- `/health/state/:state`
- `/internal/ui/nodes`
- `/internal/ui/services`

More can be added going forward and any endpoint which is used to list some data is a good candidate.

## Usage

When using the HTTP API a `filter` query parameter can be used to pass a filter expression to Consul. Filter Expressions take the general form of:

```
<selector> == <value>
<selector> != <value>
<value> in <selector>
<value> not in <selector>
<selector> contains <value>
<selector> not contains <value>
<selector> is empty
<selector> is not empty
not <other expression>
<expression 1> and <expression 2>
<expression 1> or <expression 2>
```

Normal boolean logic and precedence is supported. All of the actual filtering and evaluation logic is coming from the [go-bexpr](https://github.com/hashicorp/go-bexpr) library

## Other changes

Adding the `Internal.ServiceDump` RPC endpoint. This will allow the UI to filter services better.
2019-04-16 12:00:15 -04:00
..
acl fix broken acl link (#5592) 2019-04-04 13:56:43 -04:00
agent Add additional raft metrics (#5628) 2019-04-09 16:09:22 -06:00
commands Implement data filtering of some endpoints (#5579) 2019-04-16 12:00:15 -04:00
connect [Docs] Connect Sidecar Proxies: Fixes 'must may' typo and adds formatting to follow other docs (#5397) 2019-03-18 11:48:56 -07:00
enterprise rename refs to areas guide to advanced-federation (#5603) 2019-04-03 17:20:58 -04:00
guides [docs] Connect in Production (#5503) 2019-04-04 09:52:35 -05:00
install [docs] Bootstrapping Guide -> Install docs (#5473) 2019-03-13 10:12:52 -05:00
internals Documentation and changes for verify_server_hostname (#5069) 2018-12-06 13:51:49 -08:00
platform/k8s [docs] security warning about Helm chart (#5561) 2019-04-04 16:58:57 -07:00
compatibility.html.md fix a couple html errors (#4456) 2018-07-26 16:30:24 -07:00
faq.html.md Remove all mention of Atlas, even in deprecated changelogs 2018-08-03 10:51:18 -07:00
index.html.md website: rename *.markdown to *.md 2017-05-17 20:25:45 +02:00
upgrade-specific.html.md Fix broken links (#5552) 2019-04-01 16:01:00 -04:00
upgrading.html.md Be more explicit about rolling upgrade process 2018-10-11 11:44:20 +01:00