You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2016/10/17 15:34:25 UTC
[02/42] incubator-trafficcontrol git commit: update TS development
page
update TS development page
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/11219239
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/11219239
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/11219239
Branch: refs/heads/psql
Commit: 112192392afdeb29760b55c6adb5fb21dcab4815
Parents: 4bb44fc
Author: David Neuman <da...@gmail.com>
Authored: Fri Oct 7 11:32:56 2016 -0600
Committer: David Neuman <da...@gmail.com>
Committed: Fri Oct 7 11:32:56 2016 -0600
----------------------------------------------------------------------
docs/source/development/traffic_stats.rst | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/11219239/docs/source/development/traffic_stats.rst
----------------------------------------------------------------------
diff --git a/docs/source/development/traffic_stats.rst b/docs/source/development/traffic_stats.rst
index 186f13a..4c78bec 100644
--- a/docs/source/development/traffic_stats.rst
+++ b/docs/source/development/traffic_stats.rst
@@ -1,18 +1,18 @@
-..
+..
.. Copyright 2015 Comcast Cable Communications Management, LLC
-..
+..
.. 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.
-..
+..
Traffic Stats
*************
@@ -25,20 +25,21 @@ Software Requirements
=====================
To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
- * `Go 1.5.x or above <https://golang.org/doc/install>`_
+ * `Go 1.7.x or above <https://golang.org/doc/install>`_
* Access to a working instance of Traffic Ops
* Access to a working instance of Traffic Monitor
- * `InfluxDb version 0.10.0 or greater <https://influxdb.com/download/index.html>`_
+ * `InfluxDb version 1.0.0 or greater <https://influxdb.com/download/index.html>`_
Traffic Stats Project Tree Overview
=====================================
* **traffic_control/traffic_stats** - contains Go source files and Files used to create the Traffic Stats rpm.
* **traffic_control/traffic_stats/grafana/** - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.
+ * **traffic_control/traffic_stats/influxdb_tools/** - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.
-Go Formatting Conventions
+Go Formatting Conventions
============================
-In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code.
+In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code. It is also recommended to use `Go lint <https://github.com/golang/lint>`_.
Installing The Developer Environment
====================================
@@ -54,6 +55,5 @@ To install the Traffic Ops Developer environment:
Test Cases
==========
- Currently there are not automated tests for Traffic Stats :(.
- We hope to remedy this problem very soon!
+ Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!