ezelkow1 opened a new pull request #4993: URL: https://github.com/apache/trafficcontrol/pull/4993
<!-- ************ STOP!! ************ If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact the Apache Software Foundation Security Team at [email protected] and follow the guidelines at https://www.apache.org/security/ regarding vulnerability disclosure. --> ## What does this PR (Pull Request) do? Adds CSV parsing support to traffic monitor for the astats plugin. The astats parser will check the incoming content-type header to determine if it should parse the data as json or csv. Added a cfg option of http_polling_format that defaults to "text/json", this is what is sent on http requests to caches. Changing it to "text/csv" will enable the csv output if the cache's astats plugin as has support for CSV, otherwise astats will respond with "text/json" or "text/javascript" depending on the version. - [x] This PR fixes #REPLACE_ME OR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues --> ## Which Traffic Control components are affected by this PR? <!-- Please delete all components from this list that are NOT affected by this Pull Request. Also, feel free to add the name of a tool or script that is affected but not on the list. Additionally, if this Pull Request does NOT affect documentation, please explain why documentation is not required. --> - Documentation - Traffic Monitor ## What is the best way to verify this PR? <!-- Please include here ALL the steps necessary to test your Pull Request. If it includes tests (and most should), outline here the steps needed to run the tests. If not, lay out the manual testing procedure and please explain why tests are unnecessary for this Pull Request. --> Set the http_polling_format configuration option in TM to "text/csv" to send that in the accept header to caches. Using a cache that has a recent version of astats with CSV support then verify that the cache and its stats are reported correctly in TM. Tests exist in the traffic_monitor/cache directory ## If this is a bug fix, what versions of Traffic Control are affected? <!-- If this PR fixes a bug, please list here all of the affected versions - to the best of your knowledge. It's also pretty helpful to include a commit hash of where 'master' is at the time this PR is opened (if it affects master), because what 'master' means will change over time. For example, if this PR fixes a bug that's present in master (at commit hash '1df853c8'), in v4.0.0, and in the current 4.0.1 Release candidate (e.g. RC1), then this list would look like: - master (1df853c8) - 4.0.0 - 4.0.1 (RC1) If you don't know what other versions might have this bug, AND don't know how to find the commit hash of 'master', then feel free to leave this section blank (or, preferably, delete it entirely). --> ## The following criteria are ALL met by this PR <!-- Check the boxes to signify that the associated statement is true. To "check a box", replace the space inside of the square brackets with an 'x'. e.g. - [ x] <- Wrong - [x ] <- Wrong - [] <- Wrong - [*] <- Wrong - [x] <- Correct! --> - [x] This PR includes tests OR I have explained why tests are unnecessary - [x] 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 - [x] This PR includes any and all required license headers - [x] This PR ensures that database migration sequence is correct OR this PR does not include a database migration - [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details) ## Additional Information <!-- If you would like to include any additional information on the PR for potential reviewers please put it here. Some examples of this would be: - Before and after screenshots/gifs of the Traffic Portal if it is affected - Links to other dependent Pull Requests - References to relevant context (e.g. new/updates to dependent libraries, mailing list records, blueprints) Feel free to leave this section blank (or, preferably, delete it entirely). --> I have also included benchmarks for comparison to json usage: BenchmarkAstatsJson-8 5931 203527 ns/op 134475 B/op 2028 allocs/op BenchmarkAstatsCSV-8 8680 147683 ns/op 119839 B/op 812 allocs/op The CSV is ~40-50% faster depending on run while also greatly decreasing the amount of allocations per operation which should hopefully help with garbage collection pressures. <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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. --> ---------------------------------------------------------------- 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]
