Added filter (host name or ID) to query API route: /servercheck by rimashah25 · Pull Request #5545 · apache/trafficcontrol

rimashah25 · 2021-02-18T23:06:53Z

What does this PR (Pull Request) do?

This PR fixes RFE: API route to query servercheck data by host name or ID #3577

Which Traffic Control components are affected by this PR?

Traffic Ops
Documentation

What is the best way to verify this PR?

curl GET for the following calls:

Get all servers: /api/4.0/servercheck or using unknown query param
Get server with a specific param id: /api/4.0/servercheck?id=12

{
  "response": [
    {
      "adminState": "REPORTED",
      "cacheGroup": "CDN_in_a_Box_Mid-02",
      "id": 12,
      "hostName": "mid-02",
      "revalPending": false,
      "profile": "ATS_MID_TIER_CACHE",
      "type": "MID",
      "updPending": false
    }
  ]
}

Get server with a specific param name: /api/4.0/servercheck?name=edge

{
  "response": [
    {
      "adminState": "REPORTED",
      "cacheGroup": "CDN_in_a_Box_Edge",
      "id": 10,
      "hostName": "edge",
      "revalPending": false,
      "profile": "ATS_EDGE_TIER_CACHE",
      "type": "EDGE",
      "updPending": false
    }
  ]
}

Using both query param
Using server names and id that don't match in the DB.

If this is a bug fix, what versions of Traffic Control are affected?

The following criteria are ALL met by this PR

This PR includes tests OR I have explained why tests are unnecessary
This PR includes documentation OR I have explained why documentation is unnecessary
This PR includes an update to CHANGELOG.md OR such an update is not necessary
This PR includes any and all required license headers
This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY (see the Apache Software Foundation's security guidelines for details)

Additional Information

…ement/git-3577

…servercheck table

…ement/git-3577

ocket8888

So I'm noticing two things. First of all, the two query parameters cannot be used at the same time; it results in no filtering:

GET /api/3.0/servercheck?name=mid-01&id=11 HTTP/1.1
User-Agent: python-requests/2.24.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Wed, 24 Feb 2021 00:22:40 GMT; Max-Age=3600; HttpOnly
Vary: Accept-Encoding
X-Server-Name: traffic_ops_golang/
Date: Tue, 23 Feb 2021 23:22:40 GMT
Content-Length: 217

{
        "response": [
                {
                        "adminState": "REPORTED",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 11,
                        "hostName": "edge",
                        "revalPending": false,
                        "profile": "ATS_EDGE_TIER_CACHE",
                        "type": "EDGE",
                        "updPending": false
                },
                {
                        "adminState": "REPORTED",
                        "cacheGroup": "CDN_in_a_Box_Mid-01",
                        "id": 12,
                        "hostName": "mid-01",
                        "revalPending": false,
                        "profile": "ATS_MID_TIER_CACHE",
                        "type": "MID",
                        "updPending": false
                },
                {
                        "adminState": "REPORTED",
                        "cacheGroup": "CDN_in_a_Box_Mid-02",
                        "id": 6,
                        "hostName": "mid-02",
                        "revalPending": false,
                        "profile": "ATS_MID_TIER_CACHE",
                        "type": "MID",
                        "updPending": false
                }
        ]
}

If this is intended behavior and the two cannot both exist in the request, that should be documented, and ideally it'd return a warning-level alert indicating why filtering wasn't performed. Otherwise, if the intent is that they can both be used, then filtering when the id and hostname refer to the same server should result in an output length of exactly one, and if they do not refer to the same server, then it should return an empty array because nothing matches.

Secondly, if I give it a query parameter that it doesn't recognize or requires others, I can get back a response that includes non-cache servers:

GET /api/3.0/servercheck?page=1 HTTP/1.1
User-Agent: python-requests/2.24.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...
Vary: Accept-Encoding
X-Server-Name: traffic_ops_golang/
Date: Tue, 23 Feb 2021 23:27:46 GMT
Content-Length: 477

{
        "response": [
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 3,
                        "hostName": "db",
                        "revalPending": false,
                        "profile": "TRAFFIC_OPS_DB",
                        "type": "TRAFFIC_OPS_DB",
                        "updPending": false
                },
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 5,
                        "hostName": "dns",
                        "revalPending": false,
                        "profile": "BIND_ALL",
                        "type": "BIND",
                        "updPending": false
                },
                {
                        "adminState": "REPORTED",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 11,
                        "hostName": "edge",
                        "revalPending": false,
                        "profile": "ATS_EDGE_TIER_CACHE",
                        "type": "EDGE",
                        "updPending": false
                },
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 9,
                        "hostName": "enroller",
                        "revalPending": false,
                        "profile": "ENROLLER_ALL",
                        "type": "ENROLLER",
                        "updPending": false
                },
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 7,
                        "hostName": "influxdb",
                        "revalPending": false,
                        "profile": "INFLUXDB",
                        "type": "INFLUXDB",
                        "updPending": false
                },
                {
                        "adminState": "REPORTED",
                        "cacheGroup": "CDN_in_a_Box_Mid-01",
                        "id": 12,
                        "hostName": "mid-01",
                        "revalPending": false,
                        "profile": "ATS_MID_TIER_CACHE",
                        "type": "MID",
                        "updPending": false
                },
                {
                        "adminState": "REPORTED",
                        "cacheGroup": "CDN_in_a_Box_Mid-02",
                        "id": 6,
                        "hostName": "mid-02",
                        "revalPending": false,
                        "profile": "ATS_MID_TIER_CACHE",
                        "type": "MID",
                        "updPending": false
                },
                {
                        "adminState": "REPORTED",
                        "cacheGroup": "CDN_in_a_Box_Origin",
                        "id": 8,
                        "hostName": "origin",
                        "revalPending": false,
                        "profile": "ORG_MSO",
                        "type": "ORG",
                        "updPending": true
                },
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 2,
                        "hostName": "trafficmonitor",
                        "revalPending": false,
                        "profile": "RASCAL-Traffic_Monitor",
                        "type": "RASCAL",
                        "updPending": true
                },
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 13,
                        "hostName": "trafficops",
                        "revalPending": false,
                        "profile": "TRAFFIC_OPS",
                        "type": "TRAFFIC_OPS",
                        "updPending": false
                },
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 4,
                        "hostName": "trafficportal",
                        "revalPending": false,
                        "profile": "TRAFFIC_PORTAL",
                        "type": "TRAFFIC_PORTAL",
                        "updPending": false
                },
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 10,
                        "hostName": "trafficrouter",
                        "revalPending": false,
                        "profile": "CCR_CIAB",
                        "type": "CCR",
                        "updPending": true
                },
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 1,
                        "hostName": "trafficstats",
                        "revalPending": false,
                        "profile": "TRAFFIC_STATS",
                        "type": "TRAFFIC_STATS",
                        "updPending": false
                },
                {
                        "adminState": "ONLINE",
                        "cacheGroup": "CDN_in_a_Box_Edge",
                        "id": 14,
                        "hostName": "trafficvault",
                        "revalPending": false,
                        "profile": "RIAK_ALL",
                        "type": "RIAK",
                        "updPending": false
                }
        ]
}

…ement/git-3577 � Conflicts: � traffic_ops/v4-client/servercheck.go

ocket8888

It all seems to be working rather consistently now.

rimashah25 added 9 commits February 12, 2021 12:33

Adding query param to servercheck

70ec30a

Merge branch 'master' of github.com:apache/trafficcontrol into improv…

08aeefb

…ement/git-3577

Added name as queryparam to servercheck endpoint

296a5ce

Differentiate name and id param wrt where clause for both server and …

c82d0ea

…servercheck table

Merge branch 'master' of github.com:apache/trafficcontrol into improv…

f17c2b6

…ement/git-3577

Added tests

1ce8f1f

Updated documentation and changelog

d899f95

Updated servercheck.rst for v3

f6eab75

Updated function name in comments.

c4f520c

rimashah25 marked this pull request as ready for review February 19, 2021 16:08

ocket8888 self-assigned this Feb 19, 2021

ocket8888 reviewed Feb 22, 2021

View reviewed changes

Comment thread docs/source/api/v3/servercheck.rst Outdated

Comment thread traffic_ops/traffic_ops_golang/servercheck/servercheck.go Outdated

Comment thread traffic_ops/v4-client/servercheck.go

Comment thread traffic_ops/v4-client/servercheck.go Outdated

Update based on review commetns

3d1f745

ocket8888 reviewed Feb 22, 2021

View reviewed changes

Comment thread docs/source/api/v3/servercheck.rst

Comment thread docs/source/api/v3/servercheck.rst

Comment thread traffic_ops/v4-client/servercheck.go Outdated

updated rst and comment

46bf52d

ocket8888 suggested changes Feb 22, 2021

View reviewed changes

Comment thread docs/source/api/v3/servercheck.rst Outdated

rimashah25 requested a review from ocket8888 February 23, 2021 18:10

ocket8888 reviewed Feb 23, 2021

View reviewed changes

Comment thread docs/source/api/v3/servercheck.rst Outdated

Updated rst with tabs

3122143

rimashah25 force-pushed the improvement/git-3577 branch from fb3356a to 3122143 Compare February 23, 2021 20:19

ocket8888 reviewed Feb 23, 2021

View reviewed changes

rimashah25 added 4 commits February 25, 2021 13:31

Updated where clause logic to work against all query cases

7641b82

Updated comment

f7190e4

Merge branch 'master' of github.com:apache/trafficcontrol into improv…

ac85ba7

…ement/git-3577 � Conflicts: � traffic_ops/v4-client/servercheck.go

Fixed merge conflict

832174b

ocket8888 approved these changes Feb 26, 2021

View reviewed changes

ocket8888 merged commit 3aa3bc6 into apache:master Feb 26, 2021

rimashah25 deleted the improvement/git-3577 branch February 26, 2021 17:45

rawlinp added new feature A new feature, capability or behavior Traffic Ops related to Traffic Ops labels Mar 17, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added filter (host name or ID) to query API route: /servercheck#5545

Added filter (host name or ID) to query API route: /servercheck#5545
ocket8888 merged 16 commits intoapache:masterfrom
rimashah25:improvement/git-3577

rimashah25 commented Feb 18, 2021 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ocket8888 left a comment

Uh oh!

ocket8888 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

rimashah25 commented Feb 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR (Pull Request) do?

Which Traffic Control components are affected by this PR?

What is the best way to verify this PR?

If this is a bug fix, what versions of Traffic Control are affected?

The following criteria are ALL met by this PR

Additional Information

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ocket8888 left a comment

Choose a reason for hiding this comment

Uh oh!

ocket8888 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rimashah25 commented Feb 18, 2021 •

edited

Loading