[jira] [Resolved] (TS-4681) traffic_top doc should explain output
[ https://issues.apache.org/jira/browse/TS-4681?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime resolved TS-4681. -- Resolution: Fixed 366399e Adds much more detail to the traffic_top docs, with explanations for all of the fields and references to the underlying TS statistics that are used. > traffic_top doc should explain output > - > > Key: TS-4681 > URL: https://issues.apache.org/jira/browse/TS-4681 > Project: Traffic Server > Issue Type: Task > Components: Documentation >Reporter: Miles Libbey >Assignee: Jon Sime > Fix For: Docs > > > The current traffic_top page > https://docs.trafficserver.apache.org/en/latest/appendices/command-line/traffic_top.en.html > contains just the cli option (#seconds to refresh). It doesn't explain any of > the output. > Would be nice to describe each of the line items. For instance, under the > Cache info column, what does Fresh mean (contrasting with Revalidate, Cold, > Changed)... and then what are the same in ms. > Probably could start with a screen shot and describe the mini-sections (like > status Code 'histogram' in the upper right; followed by 'histogram' of file > sizes). -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Work started] (TS-4715) clean up log format documentation
[ https://issues.apache.org/jira/browse/TS-4715?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Work on TS-4715 started by Jon Sime. > clean up log format documentation > - > > Key: TS-4715 > URL: https://issues.apache.org/jira/browse/TS-4715 > Project: Traffic Server > Issue Type: Improvement > Components: Documentation >Reporter: James Peach >Assignee: Jon Sime > Fix For: Docs > > > While looking at the log documentation, it seemed like we could make some > improvements > - Move the logging tags into a separate page. This would make it easier to > find them from the index and give us an opportunity to group them by category. > - Verify that all log fields are documented. Might be helpful to have a code > change or tool that lists them. > - Add logging tag anchor links. It would be helpful to be able to link to a > specific logging tag like we do for records.config variables. > - All mentions of log fields should like to their definitions. > - The "Custom Field Cross-Reference" section is confusing since there is > already a previous section documenting the predefined formats. We should > condense this. > - The "Log Field Slicing" section should be moved to the section that > describes the general log format syntax. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (TS-4715) clean up log format documentation
[ https://issues.apache.org/jira/browse/TS-4715?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15511702#comment-15511702 ] Jon Sime commented on TS-4715: -- Commit 6d2c6cb addresses almost all these points, and includes a lot of other cleanup/reorganization/additions to the Admin guide's logging chapter. It also bumps it up to a top-level chapter, instead of jamming it together with the monitoring sections into the slightly-obscuring "Event and Error Monitoring" where it used to be. There's now two separate, very simply labeled chapters: "Logging" and "Monitoring." I'm not closing this issue from that commit because I've yet to make an exhaustive pass through the docs to make sure all log field references are actually linked (instead of just listing the field name as a bareword), and verifying that all the log fields in the proxy code are actually in the docs now. Once those two things are taken care of, this issue will be fully addressed. > clean up log format documentation > - > > Key: TS-4715 > URL: https://issues.apache.org/jira/browse/TS-4715 > Project: Traffic Server > Issue Type: Improvement > Components: Documentation >Reporter: James Peach >Assignee: Jon Sime > Fix For: Docs > > > While looking at the log documentation, it seemed like we could make some > improvements > - Move the logging tags into a separate page. This would make it easier to > find them from the index and give us an opportunity to group them by category. > - Verify that all log fields are documented. Might be helpful to have a code > change or tool that lists them. > - Add logging tag anchor links. It would be helpful to be able to link to a > specific logging tag like we do for records.config variables. > - All mentions of log fields should like to their definitions. > - The "Custom Field Cross-Reference" section is confusing since there is > already a previous section documenting the predefined formats. We should > condense this. > - The "Log Field Slicing" section should be moved to the section that > describes the general log format syntax. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (TS-2171) cluster.config is undocumented
[
https://issues.apache.org/jira/browse/TS-2171?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime resolved TS-2171.
--
Resolution: Fixed
Added cluster.config documentation to Admin guide, with clear admonition that
the file itself is not to be modified directly, and with links back to the
clustering section of the guide for more information on how to actually go
about setting things up.
> cluster.config is undocumented
> --
>
> Key: TS-2171
> URL: https://issues.apache.org/jira/browse/TS-2171
> Project: Traffic Server
> Issue Type: Improvement
> Components: Documentation
>Reporter: Igor Galić
>Assignee: Jon Sime
> Fix For: Docs
>
>
> Ignoring its default configuration file in our tree, {cluster.config} is
> undocumented.
> We should change this.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Resolved] (TS-4564) Document metrics.config
[
https://issues.apache.org/jira/browse/TS-4564?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime resolved TS-4564.
--
Resolution: Fixed
Assignee: Jon Sime
Added documentation to Admin guide on the new Lua-based dynamic metrics
configuration file.
> Document metrics.config
> ---
>
> Key: TS-4564
> URL: https://issues.apache.org/jira/browse/TS-4564
> Project: Traffic Server
> Issue Type: Improvement
> Components: Documentation
>Reporter: James Peach
>Assignee: Jon Sime
> Fix For: Docs
>
>
> Document the {{metrics.config}} format and Lua API.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Resolved] (TS-3374) Issues with cache.config implementation
[ https://issues.apache.org/jira/browse/TS-3374?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime resolved TS-3374. -- Resolution: Fixed Fix Version/s: 7.0.0 Updated the cache.config documentation to clarify the matching behavior across multiple rules. > Issues with cache.config implementation > --- > > Key: TS-3374 > URL: https://issues.apache.org/jira/browse/TS-3374 > Project: Traffic Server > Issue Type: Bug > Components: Documentation >Reporter: Dan Morgan >Assignee: Jon Sime > Labels: cache-control > Fix For: 7.0.0, Docs > > > The documentation implies that entries in the cache.config file are processed > in 'order'. > For example, this example in the docs: > --- > The following example configures Traffic Server to revalidate gif and jpeg > objects in the domain mydomain.com every 6 hours, and all other objects in > mydomain.com every hour. The rules are applied in the order listed. > dest_domain=mydomain.com suffix=gif revalidate=6h > dest_domain=mydomain.com suffix=jpeg revalidate=6h > dest_domain=mydomain.com revalidate=1h > --- > However, running with version 5.1.2 and having the following lines: > dest_domain=mydomain.com prefix=somepath suffix=js revalidate=7d > dest_domain=mydomain.com suffix=js action=never-cache > I would expect it to not cache any .js URL's from mydomain.com, except those > that have a prefix of 'somepath'. However what happens is that the > action=never-cache is applied to all URL's having mydomain.com (even the ones > that have a prefix of 'somepath'). -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (TS-4738) Document Lua logging configuration
[
https://issues.apache.org/jira/browse/TS-4738?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime resolved TS-4738.
--
Resolution: Fixed
Added logging.config section to Admin docs and replaced the old logs_xml.config
section with an admonition that it's been dropped in favor of (and with a link
to) the new Lua configs.
> Document Lua logging configuration
> --
>
> Key: TS-4738
> URL: https://issues.apache.org/jira/browse/TS-4738
> Project: Traffic Server
> Issue Type: Improvement
> Components: Documentation
>Reporter: James Peach
>Assignee: Jon Sime
> Fix For: 7.0.0, Docs
>
>
> Update the logging documentation to document {{logging.config}} and remove
> the XML logging config documentation.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Resolved] (TS-3090) docs.trafficserver.apache.org introduces a very high barrier to get started
[ https://issues.apache.org/jira/browse/TS-3090?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime resolved TS-3090. -- Resolution: Fixed The Getting Started section of the Admin guide was added a while back with no subsequent calls for significant revisions or notes of major omissions. > docs.trafficserver.apache.org introduces a very high barrier to get started > --- > > Key: TS-3090 > URL: https://issues.apache.org/jira/browse/TS-3090 > Project: Traffic Server > Issue Type: Improvement > Components: Documentation >Reporter: Karl Richter >Assignee: Jon Sime > Fix For: Docs > > > Currently the administration guide introduces a unnecessary high barrier to > get started, examples include > * mentioning of default configuration in > https://docs.trafficserver.apache.org/en/latest/admin/getting-started.en.html#start-traffic-server, > but no link to alternative configurations (how to check out caching > features?) > * no overview over different modes and their control (it should be clear > how to start a caching proxy after reading the caching proxy section or if > not where to read further) > * Is it necessary to read about all different types of proxying > trafficserver offers or can the reader skip the sections about modes which > are not interesting? Please add a statement. > There are project where the user just can't get started out-of-the-box and > that is perfectly fine - there's nothing better sitting in front of the > chimney and reading a well written manual ;). If this is the case for > trafficserver please add a statement with a short explanation or state that > there's no getting started guide for reason X and Y. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (TS-3288) Document user restrictions of proxy.config.admin.user_id
[
https://issues.apache.org/jira/browse/TS-3288?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime resolved TS-3288.
--
Resolution: Fixed
Documentation of user ID restriction was confirmed to reflect the reality of
the code.
> Document user restrictions of proxy.config.admin.user_id
>
>
> Key: TS-3288
> URL: https://issues.apache.org/jira/browse/TS-3288
> Project: Traffic Server
> Issue Type: Improvement
> Components: Documentation
>Reporter: Karl Richter
>Assignee: Jon Sime
> Fix For: Docs
>
>
> The documentation of `proxy.config.admin.user_id`, e.g. at
>
> http://trafficserver.readthedocs.org/en/latest/reference/configuration/records.config.en.html#proxy-config-admin-user-id
> doesn't contain any statement on restrictions for valid effective users,
> except that root is forbidden if not bypassed. They must exist because
> specifying a user the same entry in `/etc/passwd` like `nobody` except a uid
> and gid differing by 1 causes requests to be rejected after
> `bin/trafficserver restart`.
> The consequence of {{--with-group}} and {{--with-user}} of {{configure}}
> should be mentioned as well, as well if there's none.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Resolved] (TS-4675) header_rewrite hook descriptions are wrong
[ https://issues.apache.org/jira/browse/TS-4675?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime resolved TS-4675. -- Resolution: Fixed Reordered the individual hooks in the documentation to reflect the order in which they occur during an event's life. Fixed the descriptions that were noted. > header_rewrite hook descriptions are wrong > -- > > Key: TS-4675 > URL: https://issues.apache.org/jira/browse/TS-4675 > Project: Traffic Server > Issue Type: Bug > Components: Documentation >Reporter: Miles Libbey >Assignee: Jon Sime > Fix For: Docs > > > - REMAP_PSEUDO_HOOK is not similar to READ_RESPONSE_HDR_HOOK. > - Think that READ_RESPONSE_HDR_HOOK and READ_REQUEST_PRE_REMAP_HOOK are > aliases to each other. > ( #define TS_HTTP_READ_REQUEST_PRE_REMAP_HOOK TS_HTTP_PRE_REMAP_HOOK /* > backwards compat */) > - Should note that READ_REQUEST_PRE_REMAP_HOOK/READ_REQUEST_HDR_HOOK can not > be applied to remap rules. Just global rules. > - REMAP_PSEUDO_HOOK doesn't show in > https://docs.trafficserver.apache.org/en/latest/developer-guide/plugins/hooks-and-transactions/index.en.html#http-transaction-state-diagram > , so don't know when it actually fires. > - We should present the hooks in order of their firing. Eg, > READ_RESPONSE_HDR_HOOK should be after pre_remap... > - Seems like we should have a diagram similar to > https://docs.trafficserver.apache.org/en/latest/developer-guide/plugins/hooks-and-transactions/index.en.html#http-transaction-state-diagram > on the page. (With the header_rewrite names, and simplified -- don't need > all the gory oval detail.) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Updated] (TS-4617) separate documentation language/version selections into central config
[ https://issues.apache.org/jira/browse/TS-4617?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime updated TS-4617: - Backport to Version: 5.3.2, 6.2.4 > separate documentation language/version selections into central config > -- > > Key: TS-4617 > URL: https://issues.apache.org/jira/browse/TS-4617 > Project: Traffic Server > Issue Type: Improvement > Components: Documentation >Reporter: Jon Sime >Assignee: Jon Sime > Fix For: Docs > > > Adding a new release, or a language, to the documentation should not require > backporting thatsphinx template change to all prior releases (as it currently > does). Storing the list of valid languages and versions in a central config > that can be magicked in by a little bit of javascript (common to all > releases' documentation templates) would let us avoid perpetual backporting. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (TS-4617) separate documentation language/version selections into central config
[ https://issues.apache.org/jira/browse/TS-4617?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15375620#comment-15375620 ] Jon Sime commented on TS-4617: -- Merged https://github.com/apache/trafficserver/commit/bffb3dd4b68a0a6568f956944f01b68e6efb926a which supports release-branch neutral configurations of available languages/versions for documentation. Falls back to a local docbuild compatible path so that the switcher will work seamlessly for both our official public docs site and any local working copies for people editing the docs. The commit above will need to be backported to our previous release branches (at least the ones we do docbuilds for), but then we shouldn't have to touch those branches again when we add new releases, or even new languages. > separate documentation language/version selections into central config > -- > > Key: TS-4617 > URL: https://issues.apache.org/jira/browse/TS-4617 > Project: Traffic Server > Issue Type: Improvement > Components: Documentation >Reporter: Jon Sime >Assignee: Jon Sime > Fix For: Docs > > > Adding a new release, or a language, to the documentation should not require > backporting thatsphinx template change to all prior releases (as it currently > does). Storing the list of valid languages and versions in a central config > that can be magicked in by a little bit of javascript (common to all > releases' documentation templates) would let us avoid perpetual backporting. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Work started] (TS-4617) separate documentation language/version selections into central config
[ https://issues.apache.org/jira/browse/TS-4617?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Work on TS-4617 started by Jon Sime. > separate documentation language/version selections into central config > -- > > Key: TS-4617 > URL: https://issues.apache.org/jira/browse/TS-4617 > Project: Traffic Server > Issue Type: Improvement > Components: Documentation >Reporter: Jon Sime >Assignee: Jon Sime > Fix For: Docs > > > Adding a new release, or a language, to the documentation should not require > backporting thatsphinx template change to all prior releases (as it currently > does). Storing the list of valid languages and versions in a central config > that can be magicked in by a little bit of javascript (common to all > releases' documentation templates) would let us avoid perpetual backporting. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (TS-4617) separate documentation language/version selections into central config
[ https://issues.apache.org/jira/browse/TS-4617?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime resolved TS-4617. -- Resolution: Fixed > separate documentation language/version selections into central config > -- > > Key: TS-4617 > URL: https://issues.apache.org/jira/browse/TS-4617 > Project: Traffic Server > Issue Type: Improvement > Components: Documentation >Reporter: Jon Sime >Assignee: Jon Sime > Fix For: Docs > > > Adding a new release, or a language, to the documentation should not require > backporting thatsphinx template change to all prior releases (as it currently > does). Storing the list of valid languages and versions in a central config > that can be magicked in by a little bit of javascript (common to all > releases' documentation templates) would let us avoid perpetual backporting. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (TS-1699) document proxy.config.http.doc_in_cache_skip_dns
[ https://issues.apache.org/jira/browse/TS-1699?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime resolved TS-1699. -- Resolution: Fixed > document proxy.config.http.doc_in_cache_skip_dns > > > Key: TS-1699 > URL: https://issues.apache.org/jira/browse/TS-1699 > Project: Traffic Server > Issue Type: Bug > Components: Documentation >Reporter: James Peach >Assignee: Jon Sime > Fix For: Docs > > > Authentication plugins typically attache to the OS_DNS_HOOK, but if they do > then they need to set proxy.config.http.doc_in_cache_skip_dns=0 so that the > DNS hook gets called on every request. > We should document this parameter. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (TS-4596) proxy.config.http.errors.log_error_pages is undocumented
[
https://issues.apache.org/jira/browse/TS-4596?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime resolved TS-4596.
--
Resolution: Fixed
> proxy.config.http.errors.log_error_pages is undocumented
>
>
> Key: TS-4596
> URL: https://issues.apache.org/jira/browse/TS-4596
> Project: Traffic Server
> Issue Type: Bug
> Components: Documentation
>Reporter: Miles Libbey
>Assignee: Jon Sime
>Priority: Minor
> Fix For: Docs
>
>
> The records.config setting
> proxy.config.http.errors.log_error_pages
> is undocumented.
> Think that this puts any 403/404 etc errors into the error.log file (in
> addition to the normal access logs).
> proxy/http/HttpTransact.cc: if (s->http_config_param->errors_log_error_pages
> && status_code >= HTTP_STATUS_BAD_REQUEST) {
> - its in INT
> - think the default is 1 (eg, true)
> - setting to 0 stops the bad requests from showing in error.log
> - Seems to be reloadable
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Work started] (TS-4596) proxy.config.http.errors.log_error_pages is undocumented
[
https://issues.apache.org/jira/browse/TS-4596?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Work on TS-4596 started by Jon Sime.
> proxy.config.http.errors.log_error_pages is undocumented
>
>
> Key: TS-4596
> URL: https://issues.apache.org/jira/browse/TS-4596
> Project: Traffic Server
> Issue Type: Bug
> Components: Documentation
>Reporter: Miles Libbey
>Assignee: Jon Sime
>Priority: Minor
> Fix For: Docs
>
>
> The records.config setting
> proxy.config.http.errors.log_error_pages
> is undocumented.
> Think that this puts any 403/404 etc errors into the error.log file (in
> addition to the normal access logs).
> proxy/http/HttpTransact.cc: if (s->http_config_param->errors_log_error_pages
> && status_code >= HTTP_STATUS_BAD_REQUEST) {
> - its in INT
> - think the default is 1 (eg, true)
> - setting to 0 stops the bad requests from showing in error.log
> - Seems to be reloadable
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Resolved] (TS-4377) fix records.config template links
[
https://issues.apache.org/jira/browse/TS-4377?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime resolved TS-4377.
--
Resolution: Fixed
> fix records.config template links
> -
>
> Key: TS-4377
> URL: https://issues.apache.org/jira/browse/TS-4377
> Project: Traffic Server
> Issue Type: Bug
> Components: Configuration
>Reporter: James Peach
>Assignee: Jon Sime
> Fix For: Docs
>
>
> The documentation links in the default {{records.config}} are stale. We
> should update these to the current documentation layout. While we are at it,
> each config file should have a link to its online documentation.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Assigned] (TS-4617) separate documentation language/version selections into central config
[ https://issues.apache.org/jira/browse/TS-4617?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime reassigned TS-4617: Assignee: Jon Sime > separate documentation language/version selections into central config > -- > > Key: TS-4617 > URL: https://issues.apache.org/jira/browse/TS-4617 > Project: Traffic Server > Issue Type: Improvement > Components: Documentation >Reporter: Jon Sime >Assignee: Jon Sime > > Adding a new release, or a language, to the documentation should not require > backporting thatsphinx template change to all prior releases (as it currently > does). Storing the list of valid languages and versions in a central config > that can be magicked in by a little bit of javascript (common to all > releases' documentation templates) would let us avoid perpetual backporting. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Created] (TS-4617) separate documentation language/version selections into central config
Jon Sime created TS-4617: Summary: separate documentation language/version selections into central config Key: TS-4617 URL: https://issues.apache.org/jira/browse/TS-4617 Project: Traffic Server Issue Type: Improvement Components: Documentation Reporter: Jon Sime Adding a new release, or a language, to the documentation should not require backporting thatsphinx template change to all prior releases (as it currently does). Storing the list of valid languages and versions in a central config that can be magicked in by a little bit of javascript (common to all releases' documentation templates) would let us avoid perpetual backporting. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Updated] (TS-4466) Add links to other versions/languages of the documentation
[ https://issues.apache.org/jira/browse/TS-4466?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime updated TS-4466: - Backport to Version: 5.3.3, 6.2.0 > Add links to other versions/languages of the documentation > -- > > Key: TS-4466 > URL: https://issues.apache.org/jira/browse/TS-4466 > Project: Traffic Server > Issue Type: Improvement > Components: Documentation >Reporter: Masakazu Kitajo >Assignee: Masakazu Kitajo > Fix For: 7.0.0 > > > The documentation pages generated with sphinx have lost links to other > versions or languages of the documentation since we moved them from RTD. > It would be better to add the links so that we can know existence of other > versions and can choose them easily. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Work started] (TS-2354) improve documentation about different type of timeouts
[ https://issues.apache.org/jira/browse/TS-2354?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Work on TS-2354 started by Jon Sime. > improve documentation about different type of timeouts > -- > > Key: TS-2354 > URL: https://issues.apache.org/jira/browse/TS-2354 > Project: Traffic Server > Issue Type: Task > Components: Documentation >Reporter: Daniel Vitor Morilha >Assignee: Jon Sime > Fix For: Docs > > > Traffic Server provides different types of timeouts: > - dns > - connect > - no activity > - active > I found no documentation about the timeouts, specially no activity and active. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Closed] (TS-4382) document the regex_revalidate plugin
[
https://issues.apache.org/jira/browse/TS-4382?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime closed TS-4382.
Resolution: Done
Regex Revalidate plugin now has official documentation.
> document the regex_revalidate plugin
>
>
> Key: TS-4382
> URL: https://issues.apache.org/jira/browse/TS-4382
> Project: Traffic Server
> Issue Type: Improvement
> Components: Documentation, Plugins
>Reporter: James Peach
>Assignee: Jon Sime
> Fix For: Docs
>
>
> Please document the {{regex_revalidate}} plugin and provide motivating
> examples of its use.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Work started] (TS-4382) document the regex_revalidate plugin
[
https://issues.apache.org/jira/browse/TS-4382?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Work on TS-4382 started by Jon Sime.
> document the regex_revalidate plugin
>
>
> Key: TS-4382
> URL: https://issues.apache.org/jira/browse/TS-4382
> Project: Traffic Server
> Issue Type: Improvement
> Components: Documentation, Plugins
>Reporter: James Peach
>Assignee: Jon Sime
> Fix For: Docs
>
>
> Please document the {{regex_revalidate}} plugin and provide motivating
> examples of its use.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Work started] (TS-4077) Clean up doc build warnings
[ https://issues.apache.org/jira/browse/TS-4077?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Work on TS-4077 started by Jon Sime. > Clean up doc build warnings > --- > > Key: TS-4077 > URL: https://issues.apache.org/jira/browse/TS-4077 > Project: Traffic Server > Issue Type: Bug > Components: Documentation >Reporter: Miles Libbey >Assignee: Jon Sime > Fix For: Docs > > > When building the documentation, there are a bunch of warnings about options, > invalid syntax etc. We should clean these up. > From a clean git repo: > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:160: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:176: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:195: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:281: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:305: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:360: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:413: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:457: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:483: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:520: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:541: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:568: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:584: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:612: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:640: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/cache-basics.en.rst:672: WARNING: > Malformed :option: u'traffic_ctl config reload', does not contain option > marker - or -- or / > trafficserver/doc/admin-guide/configuration/hierachical-caching.en.rst:18: > SEVERE: Problems with "include" directive path: > InputError: [Errno 2] No such file or directory: 'admin-guide/common.defs'. > trafficserver/doc/admin-guide/configuration/hierachical-caching.en.rst:173: > WARNING: Malformed :option: u'traffic_ctl config reload', does not contain > option marker - or -- or / > trafficserver/doc/admin-guide/configuration/hierachical-caching.en.rst:221: > WARNING: Malformed :option: u'traffic_ctl config reload', does not contain > option marker - or -- or / > trafficserver/doc/admin-guide/configuration/redirecting-http-requests.en.rst:265: > WARNING: Malformed :option: u'traffic_ctl config reload', does not contain > option marker - or -- or / > trafficserver/doc/admin-guide/configuration/redirecting-http-requests.en.rst:276: > WARNING: Malformed :option: u'traffic_ctl config reload', does not contain > option marker - or -- or / > trafficserver/doc/admin-guide/configuration/redirecting-http-requests.en.rst:297: > WARNING: Malformed :option: u'traffic_ctl config reload', does not contain > option marker - or -- or / > trafficserver/doc/admin-guide/configuration/redirecting-http-requests.en.rst:321: > WARNING: Malformed :option: u'traffic_ctl config reload', does not contain > option marker - or -- or / > trafficserver/doc/admin-guide/configuring-traffic-server.en.rst:65:
[jira] [Work started] (TS-1699) document proxy.config.http.doc_in_cache_skip_dns
[ https://issues.apache.org/jira/browse/TS-1699?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Work on TS-1699 started by Jon Sime. > document proxy.config.http.doc_in_cache_skip_dns > > > Key: TS-1699 > URL: https://issues.apache.org/jira/browse/TS-1699 > Project: Traffic Server > Issue Type: Bug > Components: Documentation >Reporter: James Peach >Assignee: Jon Sime > Fix For: Docs > > > Authentication plugins typically attache to the OS_DNS_HOOK, but if they do > then they need to set proxy.config.http.doc_in_cache_skip_dns=0 so that the > DNS hook gets called on every request. > We should document this parameter. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Closed] (TS-4037) various table of contents errors
[
https://issues.apache.org/jira/browse/TS-4037?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime closed TS-4037.
> various table of contents errors
>
>
> Key: TS-4037
> URL: https://issues.apache.org/jira/browse/TS-4037
> Project: Traffic Server
> Issue Type: Bug
> Components: Documentation
>Reporter: James Peach
>Assignee: Jon Sime
> Fix For: Docs
>
>
> Building the HTML docs on Fedora 22:
> {code}
> ...
> /opt/home/src/trafficserver.git/doc/admin-guide/configuration/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/configuration/reverse-proxying.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/index.en.rst:27: WARNING:
> toctree contains reference to nonexisting document
> u'admin-guide/troubleshooting.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/circonus.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/logstash.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/nagios.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/zabbix.en'
> ...
> /opt/home/src/trafficserver.git/doc/developer-guide/introduction/audience.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/introduction/preface/how-to-use-this-book.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/introduction/audience.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/introduction/preface/typographical-conventions.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/adding-statistics.en.rst:34:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/plugins/adding-statistics/coupled-statistics.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/adding-statistics.en.rst:34:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/plugins/adding-statistics/viewing-statistics-using-traffic-line.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/hooks-and-transactions/index.en.rst:157:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/plugins/hooks-and-transactions/trafficserver-timers.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/Protocol_state_diagram.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/protocol_sm_big.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/protocol_evt.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/txn_sm.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/troubleshooting-tips.en.rst:23:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/troubleshooting-tips/unable-to-debug-tags.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/troubleshooting-tips.en.rst:23:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/troubleshooting-tips/using-a-debugger.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/troubleshooting-tips.en.rst:23:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/troubleshooting-tips/debugging-memory-leaks.en'
> ...checking consistency...
> /opt/home/src/trafficserver.git/doc/admin-guide/configuring-traffic-server.en.rst::
> WARNING: document isn't included in any toctree
> /opt/home/src/trafficserver.git/doc/admin-guide/hierachical-caching.en.rst::
> WARNING: document isn't included in any toctree
> /opt/home/src/trafficserver.git/doc/admin-guide/transparent-proxy.en.rst::
> WARNING: document isn't included in any toctree
> /opt/home/src/trafficserver.git/doc/developer-guide/introduction/audience.en.rst::
> WARNING:
[jira] [Resolved] (TS-4037) various table of contents errors
[
https://issues.apache.org/jira/browse/TS-4037?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime resolved TS-4037.
--
Resolution: Fixed
All TOC warnings/errors have been cleared out from the doc build at this point.
> various table of contents errors
>
>
> Key: TS-4037
> URL: https://issues.apache.org/jira/browse/TS-4037
> Project: Traffic Server
> Issue Type: Bug
> Components: Documentation
>Reporter: James Peach
>Assignee: Jon Sime
> Fix For: Docs
>
>
> Building the HTML docs on Fedora 22:
> {code}
> ...
> /opt/home/src/trafficserver.git/doc/admin-guide/configuration/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/configuration/reverse-proxying.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/index.en.rst:27: WARNING:
> toctree contains reference to nonexisting document
> u'admin-guide/troubleshooting.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/circonus.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/logstash.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/nagios.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/zabbix.en'
> ...
> /opt/home/src/trafficserver.git/doc/developer-guide/introduction/audience.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/introduction/preface/how-to-use-this-book.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/introduction/audience.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/introduction/preface/typographical-conventions.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/adding-statistics.en.rst:34:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/plugins/adding-statistics/coupled-statistics.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/adding-statistics.en.rst:34:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/plugins/adding-statistics/viewing-statistics-using-traffic-line.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/hooks-and-transactions/index.en.rst:157:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/plugins/hooks-and-transactions/trafficserver-timers.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/Protocol_state_diagram.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/protocol_sm_big.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/protocol_evt.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/txn_sm.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/troubleshooting-tips.en.rst:23:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/troubleshooting-tips/unable-to-debug-tags.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/troubleshooting-tips.en.rst:23:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/troubleshooting-tips/using-a-debugger.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/troubleshooting-tips.en.rst:23:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/troubleshooting-tips/debugging-memory-leaks.en'
> ...checking consistency...
> /opt/home/src/trafficserver.git/doc/admin-guide/configuring-traffic-server.en.rst::
> WARNING: document isn't included in any toctree
> /opt/home/src/trafficserver.git/doc/admin-guide/hierachical-caching.en.rst::
> WARNING: document isn't included in any toctree
> /opt/home/src/trafficserver.git/doc/admin-guide/transparent-proxy.en.rst::
> WARNING: document isn't included in any
[jira] [Work started] (TS-4037) various table of contents errors
[
https://issues.apache.org/jira/browse/TS-4037?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Work on TS-4037 started by Jon Sime.
> various table of contents errors
>
>
> Key: TS-4037
> URL: https://issues.apache.org/jira/browse/TS-4037
> Project: Traffic Server
> Issue Type: Bug
> Components: Documentation
>Reporter: James Peach
>Assignee: Jon Sime
> Fix For: Docs
>
>
> Building the HTML docs on Fedora 22:
> {code}
> ...
> /opt/home/src/trafficserver.git/doc/admin-guide/configuration/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/configuration/reverse-proxying.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/index.en.rst:27: WARNING:
> toctree contains reference to nonexisting document
> u'admin-guide/troubleshooting.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/circonus.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/logstash.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/nagios.en'
> /opt/home/src/trafficserver.git/doc/admin-guide/monitoring/monitoring/third-party/index.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'admin-guide/monitoring/monitoring/third-party/zabbix.en'
> ...
> /opt/home/src/trafficserver.git/doc/developer-guide/introduction/audience.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/introduction/preface/how-to-use-this-book.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/introduction/audience.en.rst:25:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/introduction/preface/typographical-conventions.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/adding-statistics.en.rst:34:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/plugins/adding-statistics/coupled-statistics.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/adding-statistics.en.rst:34:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/plugins/adding-statistics/viewing-statistics-using-traffic-line.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/hooks-and-transactions/index.en.rst:157:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/plugins/hooks-and-transactions/trafficserver-timers.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/Protocol_state_diagram.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/protocol_sm_big.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/protocol_evt.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/plugins/new-protocol-plugins.en.rst:None:
> WARNING: image file not readable:
> developer-guide/plugins/../static/images/sdk/txn_sm.jpg
> /opt/home/src/trafficserver.git/doc/developer-guide/troubleshooting-tips.en.rst:23:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/troubleshooting-tips/unable-to-debug-tags.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/troubleshooting-tips.en.rst:23:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/troubleshooting-tips/using-a-debugger.en'
> /opt/home/src/trafficserver.git/doc/developer-guide/troubleshooting-tips.en.rst:23:
> WARNING: toctree contains reference to nonexisting document
> u'developer-guide/troubleshooting-tips/debugging-memory-leaks.en'
> ...checking consistency...
> /opt/home/src/trafficserver.git/doc/admin-guide/configuring-traffic-server.en.rst::
> WARNING: document isn't included in any toctree
> /opt/home/src/trafficserver.git/doc/admin-guide/hierachical-caching.en.rst::
> WARNING: document isn't included in any toctree
> /opt/home/src/trafficserver.git/doc/admin-guide/transparent-proxy.en.rst::
> WARNING: document isn't included in any toctree
>
[jira] [Work started] (TS-4286) Wrong configuration instructions in docs for disabling caching
[ https://issues.apache.org/jira/browse/TS-4286?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Work on TS-4286 started by Jon Sime. > Wrong configuration instructions in docs for disabling caching > -- > > Key: TS-4286 > URL: https://issues.apache.org/jira/browse/TS-4286 > Project: Traffic Server > Issue Type: Bug > Components: Docs >Reporter: Daniel Xu >Assignee: Jon Sime > Fix For: Docs > > > https://docs.trafficserver.apache.org/en/latest/admin-guide/configuration/cache-basics.en.html#disabling-http-object-caching > The docs tell you to turn off HTTP proxying via proxy.config.http.enabled > instead of telling you to turn off caching via proxy.config.http.cache.http -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (TS-4286) Wrong configuration instructions in docs for disabling caching
[ https://issues.apache.org/jira/browse/TS-4286?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime resolved TS-4286. -- Resolution: Fixed > Wrong configuration instructions in docs for disabling caching > -- > > Key: TS-4286 > URL: https://issues.apache.org/jira/browse/TS-4286 > Project: Traffic Server > Issue Type: Bug > Components: Docs >Reporter: Daniel Xu >Assignee: Jon Sime > Fix For: Docs > > > https://docs.trafficserver.apache.org/en/latest/admin-guide/configuration/cache-basics.en.html#disabling-http-object-caching > The docs tell you to turn off HTTP proxying via proxy.config.http.enabled > instead of telling you to turn off caching via proxy.config.http.cache.http -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (TS-4251) doc pages records config search anchors don't work
[ https://issues.apache.org/jira/browse/TS-4251?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime resolved TS-4251. -- Resolution: Fixed Took a slightly different approach on this, because the anchors in search results links are generated by the Sphinx search Javascript. I've updated the traffic-server.py domain for config vars to include an additional link ID (it comes through as just a span around the variable's header) which is the unaltered variable name. > doc pages records config search anchors don't work > --- > > Key: TS-4251 > URL: https://issues.apache.org/jira/browse/TS-4251 > Project: Traffic Server > Issue Type: Bug > Components: Documentation >Reporter: Miles Libbey >Assignee: Jon Sime > Fix For: Docs > > > When you search for a config, and click on the result, the anchor/hashtag at > the end of the url does not match the actual anchor/hashtag on the page. As > a result, the page does not focus on the config searched for. > For example: > 1) search for proxy.config.bin_path > (https://docs.trafficserver.apache.org/en/latest/search.html?q=proxy.config.bin_path_keywords=yes=default) > 2) Click on the proxy.config.bin_path link > (https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html?highlight=proxy.config.bin_path#proxy.config.bin_path) > 3) The records.config page will load, focused on the top of the page. > If the link used the hashtag #proxy-config-bin-path (instead of > #proxy.config.bin_path), it would focus on the right area > (https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html?highlight=proxy.config.bin_path#proxy-config-bin-path) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Work started] (TS-4251) doc pages records config search anchors don't work
[ https://issues.apache.org/jira/browse/TS-4251?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Work on TS-4251 started by Jon Sime. > doc pages records config search anchors don't work > --- > > Key: TS-4251 > URL: https://issues.apache.org/jira/browse/TS-4251 > Project: Traffic Server > Issue Type: Bug > Components: Documentation >Reporter: Miles Libbey >Assignee: Jon Sime > Fix For: Docs > > > When you search for a config, and click on the result, the anchor/hashtag at > the end of the url does not match the actual anchor/hashtag on the page. As > a result, the page does not focus on the config searched for. > For example: > 1) search for proxy.config.bin_path > (https://docs.trafficserver.apache.org/en/latest/search.html?q=proxy.config.bin_path_keywords=yes=default) > 2) Click on the proxy.config.bin_path link > (https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html?highlight=proxy.config.bin_path#proxy.config.bin_path) > 3) The records.config page will load, focused on the top of the page. > If the link used the hashtag #proxy-config-bin-path (instead of > #proxy.config.bin_path), it would focus on the right area > (https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html?highlight=proxy.config.bin_path#proxy-config-bin-path) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Resolved] (TS-4112) Docs: Caching Cookied Objects for any-content type
[
https://issues.apache.org/jira/browse/TS-4112?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jon Sime resolved TS-4112.
--
Resolution: Fixed
> Docs: Caching Cookied Objects for any-content type
> --
>
> Key: TS-4112
> URL: https://issues.apache.org/jira/browse/TS-4112
> Project: Traffic Server
> Issue Type: Bug
> Components: Docs, Documentation
>Reporter: Hiroaki Nakamura
>Assignee: Jon Sime
> Fix For: Docs
>
>
> At
> http://trafficserver.readthedocs.org/en/latest/admin-guide/configuration/cache-basics.en.html#caching-cookied-objects
> the doc says:
> {quote}
> By default, Traffic Server caches objects served in response to requests that
> contain cookies. This is true for all types of objects except for text.
> {quote}
> However, at
> http://trafficserver.readthedocs.org/en/latest/admin-guide/files/records.config.en.html#proxy-config-http-cache-cache-responses-to-cookies
> {quote}
> Default: 1
> 1 = cache for any content-type
> {quote}
> Also I see the default values is 1 for the config
> "proxy.config.http.cache.cache_responses_to_cookies" at the source code
> https://github.com/apache/trafficserver/blob/d197d75601772139ea489dc5686fd041dc3c257a/mgmt/RecordsConfig.cc#L643-L650
> {quote}
> // # cache responses to cookies has 4 options
> // #
> // # 0 - do not cache any responses to cookies
> // # 1 - cache for any content-type (ignore cookies)
> // # 2 - cache only for image types
> // # 3 - cache for all but text content-types
> // # 4 - cache for all but text content-types except OS response
> without "Set-Cookie" or with "Cache-Control: public"
> {RECT_CONFIG, "proxy.config.http.cache.cache_responses_to_cookies",
> RECD_INT, "1", RECU_DYNAMIC, RR_NULL, RECC_INT, "[0-4]", RECA_NULL}
> {quote}
> So we should fix the docs at
> http://trafficserver.readthedocs.org/en/latest/admin-guide/configuration/cache-basics.en.html#caching-cookied-objects
> with something like:
> By default, Traffic Server caches objects served in response to requests that
> contain cookies. This is true for all types of objects (including text
> content-type).
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Resolved] (TS-4086) Documentation for proxy.config.log.rolling_size_mb doesn't mention minimum size
[ https://issues.apache.org/jira/browse/TS-4086?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jon Sime resolved TS-4086. -- Resolution: Fixed Documentation for this setting now states the minimum value. > Documentation for proxy.config.log.rolling_size_mb doesn't mention minimum > size > > > Key: TS-4086 > URL: https://issues.apache.org/jira/browse/TS-4086 > Project: Traffic Server > Issue Type: Bug > Components: Logging >Reporter: Daniel Xu >Assignee: Jon Sime > Fix For: Docs > > > The minimum size to roll with is 10mb, but the documentation doesn't mention > this. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Created] (TS-3625) Some statistics not being gathered
Jon Sime created TS-3625: Summary: Some statistics not being gathered Key: TS-3625 URL: https://issues.apache.org/jira/browse/TS-3625 Project: Traffic Server Issue Type: Bug Components: Metrics Reporter: Jon Sime The following statistics appear to not have any data collected for them in recent versions of TS, instead only emitting a zero value. The list was put together by examining the stats_over_http output on a production instance which receives enough varied traffic that it should, in theory at least, cause most implemented statistics to go non-zero. proxy.node.cache.contents.num_docs proxy.node.cache_hit_mem_ratio_avg_10s_int_pct proxy.node.cache_hit_mem_ratio_int_pct proxy.node.current_cache_connections proxy.node.dns.lookup_avg_time_ms proxy.node.dns.lookups_per_second proxy.node.dns.total_dns_lookups proxy.node.http.transaction_frac_avg_10s.errors.aborts_int_pct proxy.node.http.transaction_frac_avg_10s.errors.connect_failed_int_pct proxy.node.http.transaction_frac_avg_10s.errors.early_hangups_int_pct proxy.node.http.transaction_frac_avg_10s.errors.empty_hangups_int_pct proxy.node.http.transaction_frac_avg_10s.errors.other_int_pct proxy.node.http.transaction_frac_avg_10s.errors.possible_aborts_int_pct proxy.node.http.transaction_frac_avg_10s.errors.pre_accept_hangups_int_pct proxy.node.http.transaction_frac_avg_10s.hit_fresh_int_pct proxy.node.http.transaction_frac_avg_10s.hit_revalidated_int_pct proxy.node.http.transaction_frac_avg_10s.miss_changed_int_pct proxy.node.http.transaction_frac_avg_10s.miss_client_no_cache_int_pct proxy.node.http.transaction_frac_avg_10s.miss_cold_int_pct proxy.node.http.transaction_frac_avg_10s.miss_not_cacheable_int_pct proxy.node.http.transaction_frac_avg_10s.other.unclassified_int_pct proxy.node.log.bytes_flush_to_disk proxy.node.log.bytes_lost_before_flush_to_disk proxy.node.log.bytes_lost_before_preproc proxy.node.log.bytes_lost_before_sent_to_network proxy.node.log.bytes_lost_before_written_to_disk proxy.node.log.bytes_received_from_network proxy.node.log.bytes_received_from_network_avg_10s proxy.node.log.bytes_sent_to_network proxy.node.log.bytes_sent_to_network_avg_10s proxy.node.log.bytes_written_to_disk proxy.node.log.event_log_access_aggr proxy.node.log.event_log_access_fail proxy.node.log.event_log_access_full proxy.node.log.event_log_access_ok proxy.node.log.event_log_access_skip proxy.node.log.event_log_error_aggr proxy.node.log.event_log_error_fail proxy.node.log.event_log_error_full proxy.node.log.event_log_error_ok proxy.node.log.event_log_error_skip proxy.node.log.num_flush_to_disk proxy.node.log.num_lost_before_flush_to_disk proxy.node.log.num_lost_before_sent_to_network proxy.node.log.num_received_from_network proxy.node.log.num_sent_to_network proxy.process.cache.directory_collision proxy.process.cache.evacuate.active proxy.process.cache.evacuate.failure proxy.process.cache.evacuate.success proxy.process.cache.frags_per_doc.1 proxy.process.cache.frags_per_doc.2 proxy.process.cache.frags_per_doc.3+ proxy.process.cache.gc_bytes_evacuated proxy.process.cache.gc_frags_evacuated proxy.process.cache.hdr_marshal_bytes proxy.process.cache.hdr_marshals proxy.process.cache.lookup.active proxy.process.cache.lookup.failure proxy.process.cache.lookup.success proxy.process.cache.percent_full proxy.process.cache.pread_count proxy.process.cache.read_busy.failure proxy.process.cache.read_busy.success proxy.process.cache.remove.active proxy.process.cache.remove.failure proxy.process.cache.remove.success proxy.process.cache.scan.active proxy.process.cache.scan.failure proxy.process.cache.scan.success proxy.process.cache.volume_0.directory_collision proxy.process.cache.volume_0.evacuate.active proxy.process.cache.volume_0.evacuate.failure proxy.process.cache.volume_0.evacuate.success proxy.process.cache.volume_0.frags_per_doc.1 proxy.process.cache.volume_0.frags_per_doc.2 proxy.process.cache.volume_0.frags_per_doc.3+ proxy.process.cache.volume_0.gc_bytes_evacuated proxy.process.cache.volume_0.gc_frags_evacuated proxy.process.cache.volume_0.hdr_marshal_bytes proxy.process.cache.volume_0.hdr_marshals proxy.process.cache.volume_0.lookup.active proxy.process.cache.volume_0.lookup.failure proxy.process.cache.volume_0.lookup.success proxy.process.cache.volume_0.pread_count proxy.process.cache.volume_0.remove.active proxy.process.cache.volume_0.remove.failure proxy.process.cache.volume_0.remove.success proxy.process.cache.volume_0.scan.active proxy.process.cache.volume_0.scan.failure proxy.process.cache.volume_0.scan.success proxy.process.cache.volume_0.update.active proxy.process.cache.volume_0.update.failure proxy.process.cache.volume_0.update.success proxy.process.cache.volume_0.vector_marshals proxy.process.cache.volume_0.write_bytes_stat proxy.process.dns.fail_avg_time proxy.process.dns.in_flight proxy.process.dns.lookup_avg_time
[jira] [Commented] (TS-3090) docs.trafficserver.apache.org introduces a very high barrier to get started
[ https://issues.apache.org/jira/browse/TS-3090?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14297465#comment-14297465 ] Jon Sime commented on TS-3090: -- A new Getting Started Guide was checked into the repository and may be viewed in the official documentation at: https://docs.trafficserver.apache.org/en/latest/getting-started.en.html This is intended as a replacement for the first chapter of the existing Administrator's Guide - separate from that guide and intended to provide a quick on-boarding process to new users, whereas the admin guide will likely see changes to keep its focus more firmly on the full range of capabilities offered by ATS. Additional comments, suggestions, and edits would be most welcome to continue improving the experience for those new to using and/or administering ATS. docs.trafficserver.apache.org introduces a very high barrier to get started --- Key: TS-3090 URL: https://issues.apache.org/jira/browse/TS-3090 Project: Traffic Server Issue Type: Improvement Components: Documentation Reporter: Karl Richter Assignee: Jon Sime Fix For: Docs Currently the administration guide introduces a unnecessary high barrier to get started, examples include * mentioning of default configuration in https://docs.trafficserver.apache.org/en/latest/admin/getting-started.en.html#start-traffic-server, but no link to alternative configurations (how to check out caching features?) * no overview over different modes and their control (it should be clear how to start a caching proxy after reading the caching proxy section or if not where to read further) * Is it necessary to read about all different types of proxying trafficserver offers or can the reader skip the sections about modes which are not interesting? Please add a statement. There are project where the user just can't get started out-of-the-box and that is perfectly fine - there's nothing better sitting in front of the chimney and reading a well written manual ;). If this is the case for trafficserver please add a statement with a short explanation or state that there's no getting started guide for reason X and Y. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
