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/02/05 15:03:34 UTC

[GitHub] [trafficcontrol] zrhoffman opened a new pull request #4375: Debug TM, TO, or TO Perl CDN-in-a-Box containers

zrhoffman opened a new pull request #4375: Debug TM, TO, or TO Perl CDN-in-a-Box containers
URL: https://github.com/apache/trafficcontrol/pull/4375

## 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 Monitor, Traffic Ops, and Traffic Ops Perl and adds configuration options so that this behavior is only enabled when desired.
- [x] This PR is not related to any Issue

## 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 Monitor
- Traffic Ops

## What is the best way to verify this PR?

* Build documentation to make sure there are no warnings
* Make sure documentation is accurate and easy to follow
* Ensure RPMs and CDN-in-a-Box build
* Check whether debugging works in CDN-in-a-Box for:
- Traffic Monitor
- Traffic Ops
- Traffic Ops Perl

* Check that no debugging information or behavior is included when debug flags and variables are not used.
- When `pkg` is used instead of `pkg -d`, or CiaB's `make` is used instead of `make debug`, the `traffic_monitor` and `traffic_ops_golang` binaries should be roughly 2 MB smaller.
- In CiaB's `variables.env`, if `DEBUGGING_TM`, `DEBUGGING_TO`, or `DEBUGGING_TO_PERL` are not set to true, timeouts should be short (60 seconds or less) and the services should not try to use Delve or Devel::Camelcadedb to run.

* Jenkins should be able to build everything. That is essentially our test for the build scripts and docker environment.

## 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 '2697ebac'), in v3.0.0,
and in the current 3.0.1 Release candidate (e.g. RC1), then this list would
look like:

- master (2697ebac)
- 3.0.0
- 3.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).
-->
Not a bug fix.

## 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
- [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)

## 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).
-->

<!--
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.
-->
Debugging can be useful for a developer's own analysis, but it in no way replaces tests.

Comments, feedback, suggestions, and criticism are welcome.

----------------------------------------------------------------
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

With regards,
Apache Git Services