You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2020/07/30 23:03:29 UTC
[GitHub] [trafficcontrol] zrhoffman opened a new pull request #4931: Debug Traffic Stats in CDN-in-a-Box
zrhoffman opened a new pull request #4931:
URL: https://github.com/apache/trafficcontrol/pull/4931
<!--
************ 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 security@trafficcontrol.apache.org and follow the
guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
<!-- Explain the changes you made here. If this fixes an Issue, identify it by
replacing the text in the checkbox item with the Issue number e.g.
- [x] This PR fixes #9001 OR is not related to any Issue
^ This will automatically close Issue number 9001 when the Pull Request is
merged (The '#' is important).
Be sure you check the box properly, see the "The following criteria are ALL
met by this PR" section for details.
-->
This PR lets you use CDN-in-a-Box to debug Traffic Stats and adds the `TS_DEBUG_ENABLE` option in `variables.env` to allow the user to enable and disable debugging as needed.
- [x] This PR 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. -->
- CDN in a Box
- Documentation
- Traffic Stats (build script)
## 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. -->
* Build documentation
* In the CDN-in-a-Box directory, run `make debug traffic_stats/traffic_stats.rpm` and wait for it to complete
* Referring to the documentation, test debugging for Traffic Stats in CDN-in-a-Box
* Ensure behavior is unchanged from before this PR when `TS_DEBUG_ENABLE` is set to `false`
## 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] Debugging configuration, tests are unnecessary
- [x] This PR includes documentation
- [x] This PR includes an update to CHANGELOG.md
- [x] This PR includes any and all required license headers
- [x] 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)
<!--
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:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 merged pull request #4931: Debug Traffic Stats in CDN-in-a-Box
Posted by GitBox <gi...@apache.org>.
ocket8888 merged pull request #4931:
URL: https://github.com/apache/trafficcontrol/pull/4931
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [trafficcontrol] shamrickus commented on a change in pull request #4931: Debug Traffic Stats in CDN-in-a-Box
Posted by GitBox <gi...@apache.org>.
shamrickus commented on a change in pull request #4931:
URL: https://github.com/apache/trafficcontrol/pull/4931#discussion_r463825240
##########
File path: docs/source/development/debugging.rst
##########
@@ -298,6 +299,55 @@ Traffic Router
* When you see that Tomcat is listening for debugger connections on port 5005, start debugging using the debug configuration that you created.
+Traffic Stats
+===============
+
+* Navigate to the ``infrastructure/cdn-in-a-box`` directory. Remove the existing RPMs because they contain release Go binaries do not include useful debugging information. Rebuild the RPMs with no optimization, for debugging:
+
+.. code-block:: shell
+ :caption: Remove release RPMs, then build debug RPMs
+
+ make very-clean
+ make debug
+
+.. tip:: If you have gone through the steps to :ref:`dev-building-natively`, you can run ``make debug native`` instead of ``make debug`` to build the RPMs quickly.
+
+* Still in ``infrastructure/cdn-in-a-box``, open ``variables.env`` and set ``TS_DEBUG_ENABLE`` to ``true``.
+
+* Stop CDN-in-a-Box if it is running and remove any existing volumes. Rebuild the ``trafficstats`` image without reusing any cached layers to make sure it uses our fresh ``traffic_stats.rpm``. Then, start CDN-in-a-Box.
+
+.. code-block:: shell
+ :caption: docker-compose command for debugging Traffic Stats
+
+ alias mydc='docker-compose -f docker-compose.yml -f docker-compose.expose-ports.yml optional/docker-compose.debugging.yml'
+ mydc down -v
+ mydc build trafficstats-nondebug trafficstats
+ mydc up
+
+* Install `an IDE that supports delve <https://github.com/Microsoft/vscode-go/wiki/Debugging-Go-code-using-VS-Code>`_ and create a debugging configuration over port 2344. If you are using VS Code, the configuration should look like this:
+
+.. code-block:: json
+ :caption: VS Code launch.json for debugging Traffic Stats
+
+ {
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "name": "Traffic Stats",
+ "type": "go",
+ "request": "attach",
+ "mode": "remote",
+ "port": 2344,
Review comment:
Configured to use 2346 not 2344
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on pull request #4931: Debug Traffic Stats in CDN-in-a-Box
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on pull request #4931:
URL: https://github.com/apache/trafficcontrol/pull/4931#issuecomment-666768530
retest this please
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [trafficcontrol] zrhoffman commented on a change in pull request #4931: Debug Traffic Stats in CDN-in-a-Box
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #4931:
URL: https://github.com/apache/trafficcontrol/pull/4931#discussion_r463826442
##########
File path: docs/source/development/debugging.rst
##########
@@ -298,6 +299,55 @@ Traffic Router
* When you see that Tomcat is listening for debugger connections on port 5005, start debugging using the debug configuration that you created.
+Traffic Stats
+===============
+
+* Navigate to the ``infrastructure/cdn-in-a-box`` directory. Remove the existing RPMs because they contain release Go binaries do not include useful debugging information. Rebuild the RPMs with no optimization, for debugging:
+
+.. code-block:: shell
+ :caption: Remove release RPMs, then build debug RPMs
+
+ make very-clean
+ make debug
+
+.. tip:: If you have gone through the steps to :ref:`dev-building-natively`, you can run ``make debug native`` instead of ``make debug`` to build the RPMs quickly.
+
+* Still in ``infrastructure/cdn-in-a-box``, open ``variables.env`` and set ``TS_DEBUG_ENABLE`` to ``true``.
+
+* Stop CDN-in-a-Box if it is running and remove any existing volumes. Rebuild the ``trafficstats`` image without reusing any cached layers to make sure it uses our fresh ``traffic_stats.rpm``. Then, start CDN-in-a-Box.
+
+.. code-block:: shell
+ :caption: docker-compose command for debugging Traffic Stats
+
+ alias mydc='docker-compose -f docker-compose.yml -f docker-compose.expose-ports.yml optional/docker-compose.debugging.yml'
+ mydc down -v
+ mydc build trafficstats-nondebug trafficstats
+ mydc up
+
+* Install `an IDE that supports delve <https://github.com/Microsoft/vscode-go/wiki/Debugging-Go-code-using-VS-Code>`_ and create a debugging configuration over port 2344. If you are using VS Code, the configuration should look like this:
+
+.. code-block:: json
+ :caption: VS Code launch.json for debugging Traffic Stats
+
+ {
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "name": "Traffic Stats",
+ "type": "go",
+ "request": "attach",
+ "mode": "remote",
+ "port": 2344,
Review comment:
Thanks, docs corrected in 69a21be4ac.
----------------------------------------------------------------
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:
users@infra.apache.org