mhoppa commented on a change in pull request #4114: Rewrite current stats from Perl to Golang URL: https://github.com/apache/trafficcontrol/pull/4114#discussion_r349117321
########## File path: docs/source/api/current_stats.rst ########## @@ -0,0 +1,90 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + + +.. _to-api-current-stats: + +***************** +``current_stats`` +***************** +An API endpoint that returns current statistics for each CDN and an aggregate across them all. + +.. versionadded:: 1.2 + +``GET`` +======= +Retrieves current stats for each CDN. Also includes aggregate stats across them. + +:Auth. Required: Yes +:Roles Required: None +:Response Type: Array + +Request Structure +----------------- +No parameters available. + +.. code-block:: http + :caption: Request Example + + GET /api/1.4/current_stats HTTP/1.1 + Host: trafficops.infra.ciab.test + User-Agent: curl/7.47.0 + Accept: */* + Cookie: mojolicious=... + +Response Structure +------------------ +:cdn: The name of the CDN +:connections: Current number of TCP connections maintained +:capacity: 85 percent capacity of the CDN in Gbps Review comment: TBH unsure why it is set that way -> https://github.com/apache/trafficcontrol/blob/master/traffic_ops/app/lib/Extensions/TrafficStats/API/CacheStats.pm#L183-L184 ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
